/*

 * This file is part of the HTML rendering engine for KDE.

 *

 * Copyright (C) 2006 Apple Computer, Inc.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public License

 * along with this library; see the file COPYING.LIB.  If not, write to

 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,

 * Boston, MA 02110-1301, USA.

 *

*/

#ifndef HitTestResult_h

#define HitTestResult_h

#include "IntPoint.h"

#include <wtf/RefPtr.h>

namespace WebCore {

class Element;

class Frame;

class Image;

class KURL;

class IntRect;

class Node;

class PlatformScrollbar;

class String;

class HitTestResult {

public:

    HitTestResult(const IntPoint&);

    HitTestResult(const HitTestResult&);

    ~HitTestResult();

    HitTestResult& operator=(const HitTestResult&);

    Node* innerNode() const { return m_innerNode.get(); }

    Node* innerNonSharedNode() const { return m_innerNonSharedNode.get(); }

    IntPoint point() const { return m_point; }

    IntPoint localPoint() const { return m_localPoint; }

    Element* URLElement() const { return m_innerURLElement.get(); }

    PlatformScrollbar* scrollbar() const { return m_scrollbar.get(); }

    void setToNonShadowAncestor();

    void setInnerNode(Node*);

    void setInnerNonSharedNode(Node*);

    void setPoint(const IntPoint& p) { m_point = p; }

    void setLocalPoint(const IntPoint& p) { m_localPoint = p; }

    void setURLElement(Element*);

    void setScrollbar(PlatformScrollbar*);

    Frame* targetFrame() const;

    IntRect boundingBox() const;

    bool isSelected() const;

    String spellingToolTip() const;

    String title() const;

    String altDisplayString() const;

    String titleDisplayString() const;

    Image* image() const;

    IntRect imageRect() const;

    KURL absoluteImageURL() const;

    KURL absoluteLinkURL() const;

    String textContent() const;

    bool isLiveLink() const;

    bool isContentEditable() const;

private:

    RefPtr<Node> m_innerNode;

    RefPtr<Node> m_innerNonSharedNode;

    IntPoint m_point;

    IntPoint m_localPoint; // A point in the local coordinate space of m_innerNonSharedNode's renderer.  Allows us to efficiently

                           // determine where inside the renderer we hit on subsequent operations.

    RefPtr<Element> m_innerURLElement;

    RefPtr<PlatformScrollbar> m_scrollbar;

};

String displayString(const String&, const Node*);

} // namespace WebCore

#endif // HitTestResult_h