src/third_party/WebKit/Source/core/rendering/HitTestResult.h

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