1/*
2* Copyright (C) 2011 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 WebHitTestInfo_h
27#define WebHitTestInfo_h
28
29#include "../WebPoint.h"
30#include "../WebPrivateOwnPtr.h"
31#include "../WebURL.h"
32
33namespace WebCore {
34class HitTestResult;
35class Node;
36}
37
38namespace WebKit {
39
40// Properties of a hit test result, i.e. properties of the nodes at a given point
41// (the hit point) on the page. Both urls may be populated at the same time, for
42// example in the instance of an <img> inside an <a>.
43class WebHitTestInfo {
44public:
45    WebHitTestInfo();
46    WebHitTestInfo(const WebHitTestInfo&);
47    ~WebHitTestInfo();
48
49    // The absolute URL of the link returned by the hit test.
50    WEBKIT_API WebURL linkURL() const;
51
52    // The absolute URL of the image returned by the hit test.
53    WEBKIT_API WebURL imageURL() const;
54
55    // The node that got hit.
56    WEBKIT_API WebCore::Node* node() const;
57
58    // Point coordinates of the hit.
59    WEBKIT_API WebPoint point() const;
60
61    // True iff the hit was on an editable field or node.
62    WEBKIT_API bool isContentEditable() const;
63
64#if WEBKIT_IMPLEMENTATION
65    WebHitTestInfo(const WebCore::HitTestResult&);
66    WebHitTestInfo& operator=(const WebCore::HitTestResult&);
67    operator WebCore::HitTestResult() const;
68#endif
69
70protected:
71    WebPrivateOwnPtr<WebCore::HitTestResult> m_private;
72};
73
74} // namespace WebKit
75
76#endif
77