Source/WebCore/svg/SVGLocatable.h

   1 /*
   2  * Copyright (C) 2004, 2005 Nikolas Zimmermann <zimmermann@kde.org>
   3  * Copyright (C) 2004, 2005, 2007 Rob Buis <buis@kde.org>
   4  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public License
  17  * along with this library; see the file COPYING.LIB.  If not, write to
  18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef SVGLocatable_h
  23 #define SVGLocatable_h
  24
  25 #if ENABLE(SVG)
  26 #include "AffineTransform.h"
  27
  28 namespace WebCore {
  29
  30 class FloatRect;
  31 class SVGElement;
  32
  33 typedef int ExceptionCode;
  34
  35 class SVGLocatable {
  36 public:
  37     virtual ~SVGLocatable() { }
  38
  39     // 'SVGLocatable' functions
  40     virtual SVGElement* nearestViewportElement() const = 0;
  41     virtual SVGElement* farthestViewportElement() const = 0;
  42
  43     enum StyleUpdateStrategy { AllowStyleUpdate, DisallowStyleUpdate };
  44
  45     virtual FloatRect getBBox(StyleUpdateStrategy) = 0;
  46     virtual AffineTransform getCTM(StyleUpdateStrategy) = 0;
  47     virtual AffineTransform getScreenCTM(StyleUpdateStrategy) = 0;
  48     AffineTransform getTransformToElement(SVGElement*, ExceptionCode&, StyleUpdateStrategy = AllowStyleUpdate);
  49
  50     static SVGElement* nearestViewportElement(const SVGElement*);
  51     static SVGElement* farthestViewportElement(const SVGElement*);
  52
  53     enum CTMScope {
  54         NearestViewportScope, // Used for getCTM()
  55         ScreenScope // Used for getScreenCTM()
  56     };
  57
  58 protected:
  59     virtual AffineTransform localCoordinateSpaceTransform(SVGLocatable::CTMScope) const { return AffineTransform(); }
  60
  61     static FloatRect getBBox(SVGElement*, StyleUpdateStrategy);
  62     static AffineTransform computeCTM(SVGElement*, CTMScope, StyleUpdateStrategy);
  63 };
  64
  65 } // namespace WebCore
  66
  67 #endif // ENABLE(SVG)
  68 #endif // SVGLocatable_h