Source/WebKit/chromium/public/android/WebHitTestInfo.h

/*
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1.  Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebHitTestInfo_h
#define WebHitTestInfo_h

#include "../WebPoint.h"
#include "../WebPrivateOwnPtr.h"
#include "../WebURL.h"

namespace WebCore {
class HitTestResult;
class Node;
}

namespace WebKit {

// Properties of a hit test result, i.e. properties of the nodes at a given point
// (the hit point) on the page. Both urls may be populated at the same time, for
// example in the instance of an <img> inside an <a>.
class WebHitTestInfo {
public:
    WebHitTestInfo();
    WebHitTestInfo(const WebHitTestInfo&);
    ~WebHitTestInfo();

    // The absolute URL of the link returned by the hit test.
    WEBKIT_API WebURL linkURL() const;

    // The absolute URL of the image returned by the hit test.
    WEBKIT_API WebURL imageURL() const;

    // The node that got hit.
    WEBKIT_API WebCore::Node* node() const;

    // Point coordinates of the hit.
    WEBKIT_API WebPoint point() const;

    // True iff the hit was on an editable field or node.
    WEBKIT_API bool isContentEditable() const;

#if WEBKIT_IMPLEMENTATION
    WebHitTestInfo(const WebCore::HitTestResult&);
    WebHitTestInfo& operator=(const WebCore::HitTestResult&);
    operator WebCore::HitTestResult() const;
#endif

protected:
    WebPrivateOwnPtr<WebCore::HitTestResult> m_private;
};

} // namespace WebKit

#endif