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