1 /* 2 * Copyright (C) 2006 Apple Computer, 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 "core/rendering/HitTestLocation.h" 26 #include "core/rendering/HitTestRequest.h" 27 #include "platform/geometry/FloatQuad.h" 28 #include "platform/geometry/FloatRect.h" 29 #include "platform/geometry/LayoutRect.h" 30 #include "platform/text/TextDirection.h" 31 #include "wtf/Forward.h" 32 #include "wtf/ListHashSet.h" 33 #include "wtf/OwnPtr.h" 34 #include "wtf/RefPtr.h" 35 36 namespace WebCore { 37 38 class Element; 39 class Frame; 40 class HTMLMediaElement; 41 class Image; 42 class KURL; 43 class Node; 44 class RenderObject; 45 class RenderRegion; 46 class Scrollbar; 47 48 class HitTestResult { 49 public: 50 typedef ListHashSet<RefPtr<Node> > NodeSet; 51 52 HitTestResult(); 53 HitTestResult(const LayoutPoint&); 54 // Pass non-negative padding values to perform a rect-based hit test. 55 HitTestResult(const LayoutPoint& centerPoint, unsigned topPadding, unsigned rightPadding, unsigned bottomPadding, unsigned leftPadding); 56 HitTestResult(const HitTestLocation&); 57 HitTestResult(const HitTestResult&); 58 ~HitTestResult(); 59 HitTestResult& operator=(const HitTestResult&); 60 innerNode()61 Node* innerNode() const { return m_innerNode.get(); } innerPossiblyPseudoNode()62 Node* innerPossiblyPseudoNode() const { return m_innerPossiblyPseudoNode.get(); } 63 Element* innerElement() const; innerNonSharedNode()64 Node* innerNonSharedNode() const { return m_innerNonSharedNode.get(); } URLElement()65 Element* URLElement() const { return m_innerURLElement.get(); } scrollbar()66 Scrollbar* scrollbar() const { return m_scrollbar.get(); } isOverWidget()67 bool isOverWidget() const { return m_isOverWidget; } 68 69 // Forwarded from HitTestLocation isRectBasedTest()70 bool isRectBasedTest() const { return m_hitTestLocation.isRectBasedTest(); } 71 72 // The hit-tested point in the coordinates of the main frame. pointInMainFrame()73 const LayoutPoint& pointInMainFrame() const { return m_hitTestLocation.point(); } roundedPointInMainFrame()74 IntPoint roundedPointInMainFrame() const { return roundedIntPoint(pointInMainFrame()); } 75 76 // The hit-tested point in the coordinates of the innerNode frame, the frame containing innerNode. pointInInnerNodeFrame()77 const LayoutPoint& pointInInnerNodeFrame() const { return m_pointInInnerNodeFrame; } roundedPointInInnerNodeFrame()78 IntPoint roundedPointInInnerNodeFrame() const { return roundedIntPoint(pointInInnerNodeFrame()); } 79 Frame* innerNodeFrame() const; 80 81 // The hit-tested point in the coordinates of the inner node. localPoint()82 const LayoutPoint& localPoint() const { return m_localPoint; } setLocalPoint(const LayoutPoint & p)83 void setLocalPoint(const LayoutPoint& p) { m_localPoint = p; } 84 85 RenderObject* renderer() const; 86 87 void setToNodesInDocumentTreeScope(); 88 void setToShadowHostIfInUserAgentShadowRoot(); 89 hitTestLocation()90 const HitTestLocation& hitTestLocation() const { return m_hitTestLocation; } 91 92 void setInnerNode(Node*); 93 void setInnerNonSharedNode(Node*); 94 void setURLElement(Element*); 95 void setScrollbar(Scrollbar*); setIsFirstLetter(bool b)96 void setIsFirstLetter(bool b) { m_isFirstLetter = b; } setIsOverWidget(bool b)97 void setIsOverWidget(bool b) { m_isOverWidget = b; } 98 99 Frame* targetFrame() const; 100 bool isSelected() const; 101 String spellingToolTip(TextDirection&) const; 102 String title(TextDirection&) const; 103 const AtomicString& altDisplayString() const; 104 String titleDisplayString() const; 105 Image* image() const; 106 IntRect imageRect() const; 107 KURL absoluteImageURL() const; 108 KURL absoluteMediaURL() const; 109 KURL absoluteLinkURL() const; 110 String textContent() const; 111 bool isLiveLink() const; 112 bool isMisspelled() const; 113 bool isContentEditable() const; 114 115 bool isOverLink() const; 116 // Returns true if it is rect-based hit test and needs to continue until the rect is fully 117 // enclosed by the boundaries of a node. 118 bool addNodeToRectBasedTestResult(Node*, const HitTestRequest&, const HitTestLocation& pointInContainer, const LayoutRect& = LayoutRect()); 119 bool addNodeToRectBasedTestResult(Node*, const HitTestRequest&, const HitTestLocation& pointInContainer, const FloatRect&); 120 void append(const HitTestResult&); 121 122 // If m_rectBasedTestResult is 0 then set it to a new NodeSet. Return *m_rectBasedTestResult. Lazy allocation makes 123 // sense because the NodeSet is seldom necessary, and it's somewhat expensive to allocate and initialize. This method does 124 // the same thing as mutableRectBasedTestResult(), but here the return value is const. 125 const NodeSet& rectBasedTestResult() const; 126 127 Node* targetNode() const; 128 129 private: 130 NodeSet& mutableRectBasedTestResult(); // See above. 131 HTMLMediaElement* mediaElement() const; 132 133 HitTestLocation m_hitTestLocation; 134 135 RefPtr<Node> m_innerNode; 136 RefPtr<Node> m_innerPossiblyPseudoNode; 137 RefPtr<Node> m_innerNonSharedNode; 138 LayoutPoint m_pointInInnerNodeFrame; // The hit-tested point in innerNode frame coordinates. 139 LayoutPoint m_localPoint; // A point in the local coordinate space of m_innerNonSharedNode's renderer. Allows us to efficiently 140 // determine where inside the renderer we hit on subsequent operations. 141 RefPtr<Element> m_innerURLElement; 142 RefPtr<Scrollbar> m_scrollbar; 143 bool m_isOverWidget; // Returns true if we are over a widget (and not in the border/padding area of a RenderWidget for example). 144 bool m_isFirstLetter; 145 146 mutable OwnPtr<NodeSet> m_rectBasedTestResult; 147 }; 148 149 } // namespace WebCore 150 151 #endif // HitTestResult_h 152