Add invalid bounding box concept to SVG containers
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGContainer.h
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2007 Rob Buis <buis@kde.org>
4  * Copyright (C) 2009 Google, Inc.  All rights reserved.
5  * Copyright (C) 2009 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef RenderSVGContainer_h
24 #define RenderSVGContainer_h
25
26 #if ENABLE(SVG)
27
28 #include "RenderSVGModelObject.h"
29
30 namespace WebCore {
31
32 class SVGElement;
33
34 class RenderSVGContainer : public RenderSVGModelObject {
35 public:
36     explicit RenderSVGContainer(SVGStyledElement*);
37     virtual ~RenderSVGContainer();
38
39     const RenderObjectChildList* children() const { return &m_children; }
40     RenderObjectChildList* children() { return &m_children; }
41
42     virtual void paint(PaintInfo&, const LayoutPoint&);
43     virtual void setNeedsBoundariesUpdate() { m_needsBoundariesUpdate = true; }
44     virtual bool didTransformToRootUpdate() { return false; }
45     bool isObjectBoundingBoxValid() const { return m_objectBoundingBoxValid; }
46
47 protected:
48     virtual RenderObjectChildList* virtualChildren() { return children(); }
49     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
50
51     virtual bool isSVGContainer() const { return true; }
52     virtual const char* renderName() const { return "RenderSVGContainer"; }
53
54     virtual void layout();
55
56     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint&);
57
58     virtual FloatRect objectBoundingBox() const { return m_objectBoundingBox; }
59     virtual FloatRect strokeBoundingBox() const { return m_strokeBoundingBox; }
60     virtual FloatRect repaintRectInLocalCoordinates() const { return m_repaintBoundingBox; }
61
62     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction);
63
64     // Allow RenderSVGTransformableContainer to hook in at the right time in layout()
65     virtual bool calculateLocalTransform() { return false; }
66
67     // Allow RenderSVGViewportContainer to hook in at the right times in layout(), paint() and nodeAtFloatPoint()
68     virtual void calcViewport() { }
69     virtual void applyViewportClip(PaintInfo&) { }
70     virtual bool pointIsInsideViewportClip(const FloatPoint& /*pointInParent*/) { return true; }
71
72     virtual void determineIfLayoutSizeChanged() { }
73
74     bool selfWillPaint();
75     void updateCachedBoundaries();
76
77 private:
78     RenderObjectChildList m_children;
79     FloatRect m_objectBoundingBox;
80     bool m_objectBoundingBoxValid;
81     FloatRect m_strokeBoundingBox;
82     FloatRect m_repaintBoundingBox;
83     bool m_needsBoundariesUpdate : 1;
84 };
85   
86 inline RenderSVGContainer* toRenderSVGContainer(RenderObject* object)
87 {
88     ASSERT(!object || object->isSVGContainer());
89     return static_cast<RenderSVGContainer*>(object);
90 }
91
92 inline const RenderSVGContainer* toRenderSVGContainer(const RenderObject* object)
93 {
94     ASSERT(!object || object->isSVGContainer());
95     return static_cast<const RenderSVGContainer*>(object);
96 }
97
98 // This will catch anyone doing an unnecessary cast.
99 void toRenderSVGContainer(const RenderSVGContainer*);
100
101 } // namespace WebCore
102
103 #endif // ENABLE(SVG)
104 #endif // RenderSVGContainer_h