• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2 * Copyright (C) 2012 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 
26 #ifndef WebHitTestResult_h
27 #define WebHitTestResult_h
28 
29 #include "../platform/WebPrivateOwnPtr.h"
30 
31 namespace WebCore {
32 class HitTestResult;
33 }
34 
35 namespace blink {
36 
37 class WebElement;
38 class WebNode;
39 class WebURL;
40 struct WebPoint;
41 
42 // Properties of a hit test result, i.e. properties of the nodes at a given point
43 // (the hit point) on the page. Both urls may be populated at the same time, for
44 // example in the instance of an <img> inside an <a>.
45 class WebHitTestResult {
46 public:
WebHitTestResult()47     WebHitTestResult() { }
WebHitTestResult(const WebHitTestResult & info)48     WebHitTestResult(const WebHitTestResult& info) { assign(info); }
~WebHitTestResult()49     ~WebHitTestResult() { reset(); }
50 
51     BLINK_EXPORT void assign(const WebHitTestResult&);
52     BLINK_EXPORT void reset();
53     BLINK_EXPORT bool isNull() const;
54 
55     // The node that was hit (only one for point-based tests).
56     BLINK_EXPORT WebNode node() const;
57 
58     // Coordinates of the point that was hit. Relative to the node.
59     BLINK_EXPORT WebPoint localPoint() const;
60 
61     // If a link (eg. anchor or area tag) is hit, return the element.
62     // Return null otheriwse.
63     BLINK_EXPORT WebElement urlElement() const;
64 
65     // If an image is hit, return the image source. Return empty otherwise.
66     BLINK_EXPORT WebURL absoluteImageURL() const;
67 
68     // If an link is hit, return the link url source. Return empty otherwise.
69     BLINK_EXPORT WebURL absoluteLinkURL() const;
70 
71     // Return whether an editable input element was hit.
72     BLINK_EXPORT bool isContentEditable() const;
73 
74 #if BLINK_IMPLEMENTATION
75     WebHitTestResult(const WebCore::HitTestResult&);
76     WebHitTestResult& operator=(const WebCore::HitTestResult&);
77     operator WebCore::HitTestResult() const;
78 #endif
79 
80 protected:
81     WebPrivateOwnPtr<WebCore::HitTestResult> m_private;
82 };
83 
84 } // namespace blink
85 
86 #endif
87