2 * Copyright (C) 2012 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
26 #ifndef WebHitTestResult_h
27 #define WebHitTestResult_h
29 #include "../platform/WebPrivateOwnPtr.h"
38 class WebHitTestResultPrivate;
43 // Properties of a hit test result, i.e. properties of the nodes at a given point
44 // (the hit point) on the page. Both urls may be populated at the same time, for
45 // example in the instance of an <img> inside an <a>.
46 class WebHitTestResult {
48 WebHitTestResult() { }
49 WebHitTestResult(const WebHitTestResult& info) { assign(info); }
50 ~WebHitTestResult() { reset(); }
52 BLINK_EXPORT void assign(const WebHitTestResult&);
53 BLINK_EXPORT void reset();
54 BLINK_EXPORT bool isNull() const;
56 // The node that was hit (only one for point-based tests).
57 BLINK_EXPORT WebNode node() const;
59 // Coordinates of the point that was hit. Relative to the node.
60 BLINK_EXPORT WebPoint localPoint() const;
62 // If a link (eg. anchor or area tag) is hit, return the element.
63 // Return null otheriwse.
64 BLINK_EXPORT WebElement urlElement() const;
66 // If an image is hit, return the image source. Return empty otherwise.
67 BLINK_EXPORT WebURL absoluteImageURL() const;
69 // If an link is hit, return the link url source. Return empty otherwise.
70 BLINK_EXPORT WebURL absoluteLinkURL() const;
72 // Return whether an editable input element was hit.
73 BLINK_EXPORT bool isContentEditable() const;
75 #if BLINK_IMPLEMENTATION
76 WebHitTestResult(const WebCore::HitTestResult&);
77 WebHitTestResult& operator=(const WebCore::HitTestResult&);
81 WebPrivateOwnPtr<WebHitTestResultPrivate> m_private;