33e0cfa7af7fe9265386ddc282355ec793365c14
[WebKit-https.git] / Source / WebCore / rendering / HitTestResult.h
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19 */
20 #ifndef HitTestResult_h
21 #define HitTestResult_h
22
23 #include "FloatRect.h"
24 #include "LayoutTypes.h"
25 #include "TextDirection.h"
26 #include <wtf/Forward.h>
27 #include <wtf/ListHashSet.h>
28 #include <wtf/OwnPtr.h>
29 #include <wtf/RefPtr.h>
30
31 namespace WebCore {
32
33 class Element;
34 class Frame;
35 #if ENABLE(VIDEO)
36 class HTMLMediaElement;
37 #endif
38 class Image;
39 class KURL;
40 class Node;
41 class RenderRegion;
42 class Scrollbar;
43
44 class HitTestResult {
45 public:
46     typedef ListHashSet<RefPtr<Node> > NodeSet;
47
48     HitTestResult();
49     HitTestResult(const LayoutPoint&);
50     // Pass non-negative padding values to perform a rect-based hit test.
51     HitTestResult(const LayoutPoint& centerPoint, unsigned topPadding, unsigned rightPadding, unsigned bottomPadding, unsigned leftPadding);
52     HitTestResult(const HitTestResult&);
53     ~HitTestResult();
54     HitTestResult& operator=(const HitTestResult&);
55
56     Node* innerNode() const { return m_innerNode.get(); }
57     Node* innerNonSharedNode() const { return m_innerNonSharedNode.get(); }
58     LayoutPoint point() const { return m_point; }
59     LayoutPoint localPoint() const { return m_localPoint; }
60     Element* URLElement() const { return m_innerURLElement.get(); }
61     Scrollbar* scrollbar() const { return m_scrollbar.get(); }
62     bool isOverWidget() const { return m_isOverWidget; }
63
64     RenderRegion* region() const { return m_region; }
65     void setRegion(RenderRegion* region) { m_region = region; }
66
67     void setToNonShadowAncestor();
68
69     void setInnerNode(Node*);
70     void setInnerNonSharedNode(Node*);
71     void setPoint(const LayoutPoint& p) { m_point = p; }
72     void setLocalPoint(const LayoutPoint& p) { m_localPoint = p; }
73     void setURLElement(Element*);
74     void setScrollbar(Scrollbar*);
75     void setIsOverWidget(bool b) { m_isOverWidget = b; }
76
77     Frame* targetFrame() const;
78     bool isSelected() const;
79     String spellingToolTip(TextDirection&) const;
80     String replacedString() const;
81     String title(TextDirection&) const;
82     String innerTextIfTruncated(TextDirection&) const;
83     String altDisplayString() const;
84     String titleDisplayString() const;
85     Image* image() const;
86     IntRect imageRect() const;
87     KURL absoluteImageURL() const;
88     KURL absoluteMediaURL() const;
89     KURL absoluteLinkURL() const;
90     String textContent() const;
91     bool isLiveLink() const;
92     bool isContentEditable() const;
93     void toggleMediaControlsDisplay() const;
94     void toggleMediaLoopPlayback() const;
95     void enterFullscreenForVideo() const;
96     bool mediaControlsEnabled() const;
97     bool mediaLoopEnabled() const;
98     bool mediaPlaying() const;
99     bool mediaSupportsFullscreen() const;
100     void toggleMediaPlayState() const;
101     bool mediaHasAudio() const;
102     bool mediaIsVideo() const;
103     bool mediaMuted() const;
104     void toggleMediaMuteState() const;
105
106     // Rect-based hit test related methods.
107     bool isRectBasedTest() const { return m_isRectBased; }
108     LayoutRect rectForPoint(const LayoutPoint&) const;
109     static LayoutRect rectForPoint(const LayoutPoint&, unsigned topPadding, unsigned rightPadding, unsigned bottomPadding, unsigned leftPadding);
110     int topPadding() const { return m_topPadding; }
111     int rightPadding() const { return m_rightPadding; }
112     int bottomPadding() const { return m_bottomPadding; }
113     int leftPadding() const { return m_leftPadding; }
114
115     // Returns true if it is rect-based hit test and needs to continue until the rect is fully
116     // enclosed by the boundaries of a node.
117     bool addNodeToRectBasedTestResult(Node*, const LayoutPoint& pointInContainer, const IntRect& = IntRect());
118     bool addNodeToRectBasedTestResult(Node*, const LayoutPoint& pointInContainer, const FloatRect&);
119     void append(const HitTestResult&);
120
121     // If m_rectBasedTestResult is 0 then set it to a new NodeSet. Return *m_rectBasedTestResult. Lazy allocation makes
122     // sense because the NodeSet is seldom necessary, and it's somewhat expensive to allocate and initialize. This method does
123     // the same thing as mutableRectBasedTestResult(), but here the return value is const.
124     const NodeSet& rectBasedTestResult() const;
125
126 private:
127     NodeSet& mutableRectBasedTestResult(); // See above.
128
129 #if ENABLE(VIDEO)
130     HTMLMediaElement* mediaElement() const;
131 #endif
132
133     RefPtr<Node> m_innerNode;
134     RefPtr<Node> m_innerNonSharedNode;
135     LayoutPoint m_point;
136     LayoutPoint m_localPoint; // A point in the local coordinate space of m_innerNonSharedNode's renderer. Allows us to efficiently
137                               // determine where inside the renderer we hit on subsequent operations.
138     RefPtr<Element> m_innerURLElement;
139     RefPtr<Scrollbar> m_scrollbar;
140     bool m_isOverWidget; // Returns true if we are over a widget (and not in the border/padding area of a RenderWidget for example).
141     bool m_isRectBased;
142     int m_topPadding;
143     int m_rightPadding;
144     int m_bottomPadding;
145     int m_leftPadding;
146     
147     RenderRegion* m_region; // The region we're inside.
148
149     mutable OwnPtr<NodeSet> m_rectBasedTestResult;
150 };
151
152 // Formula:
153 // x = p.x() - rightPadding
154 // y = p.y() - topPadding
155 // width = leftPadding + rightPadding + 1
156 // height = topPadding + bottomPadding + 1
157 inline LayoutRect HitTestResult::rectForPoint(const LayoutPoint& point) const
158 {
159     return rectForPoint(point, m_topPadding, m_rightPadding, m_bottomPadding, m_leftPadding);
160 }
161
162 String displayString(const String&, const Node*);
163
164 } // namespace WebCore
165
166 #endif // HitTestResult_h