/*

 * Copyright (C) 2001 Peter Kelly (pmk@post.com)

 * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)

 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)

 * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.

 *

 * 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 MouseEvent_h

#define MouseEvent_h

#include "Clipboard.h"

#include "MouseRelatedEvent.h"

namespace WebCore {

    // Introduced in DOM Level 2

    class MouseEvent : public MouseRelatedEvent {

    public:

        static PassRefPtr<MouseEvent> create()

        {

            return adoptRef(new MouseEvent);

        }

        static PassRefPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,

            int detail, int screenX, int screenY, int pageX, int pageY,

            bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,

            PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard = 0, bool isSimulated = false)

        {

            return adoptRef(new MouseEvent(type, canBubble, cancelable, view, detail, screenX, screenY, pageX, pageY,

                ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, clipboard, isSimulated));

        }

        virtual ~MouseEvent();

        void initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,

                            int detail, int screenX, int screenY, int clientX, int clientY,

                            bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,

                            unsigned short button, PassRefPtr<EventTarget> relatedTarget);

        // WinIE uses 1,4,2 for left/middle/right but not for click (just for mousedown/up, maybe others),

        // but we will match the standard DOM.

        unsigned short button() const { return m_button; }

        bool buttonDown() const { return m_buttonDown; }

        EventTarget* relatedTarget() const { return m_relatedTarget.get(); }

        Clipboard* clipboard() const { return m_clipboard.get(); }

        Node* toElement() const;

        Node* fromElement() const;

        Clipboard* dataTransfer() const { return isDragEvent() ? m_clipboard.get() : 0; }

        virtual bool isMouseEvent() const;

        virtual bool isDragEvent() const;

        virtual int which() const;

    private:

        MouseEvent();

        MouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,

                   int detail, int screenX, int screenY, int pageX, int pageY,

                   bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,

                   PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard, bool isSimulated);

        unsigned short m_button;

        bool m_buttonDown;

        RefPtr<EventTarget> m_relatedTarget;

        RefPtr<Clipboard> m_clipboard;

    };

} // namespace WebCore

#endif // MouseEvent_h