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#include "ExceptionCode.h"
28
29namespace WebCore {
30
31class FloatRect;
32class SVGElement;
33
34class SVGLocatable {
35public:
36    virtual ~SVGLocatable() { }
37
38    // 'SVGLocatable' functions
39    virtual SVGElement* nearestViewportElement() const = 0;
40    virtual SVGElement* farthestViewportElement() const = 0;
41
42    enum StyleUpdateStrategy { AllowStyleUpdate, DisallowStyleUpdate };
43
44    virtual FloatRect getBBox(StyleUpdateStrategy) const = 0;
45    virtual AffineTransform getCTM(StyleUpdateStrategy) const = 0;
46    virtual AffineTransform getScreenCTM(StyleUpdateStrategy) const = 0;
47    AffineTransform getTransformToElement(SVGElement*, ExceptionCode&, StyleUpdateStrategy = AllowStyleUpdate) const;
48
49    static SVGElement* nearestViewportElement(const SVGElement*);
50    static SVGElement* farthestViewportElement(const SVGElement*);
51
52    enum CTMScope {
53        NearestViewportScope, // Used for getCTM()
54        ScreenScope // Used for getScreenCTM()
55    };
56
57protected:
58    virtual AffineTransform localCoordinateSpaceTransform(SVGLocatable::CTMScope) const { return AffineTransform(); }
59
60    static FloatRect getBBox(const SVGElement*, StyleUpdateStrategy);
61    static AffineTransform computeCTM(const SVGElement*, CTMScope, StyleUpdateStrategy);
62};
63
64} // namespace WebCore
65
66#endif // ENABLE(SVG)
67#endif // SVGLocatable_h
68