1/*
2 * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3 * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5 * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 * Library General Public License for more details.
16 *
17 * You should have received a copy of the GNU Library General Public License
18 * along with this library; see the file COPYING.LIB.  If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
21 *
22 */
23
24#ifndef MouseEvent_h
25#define MouseEvent_h
26
27#include "core/events/EventDispatchMediator.h"
28#include "core/events/MouseRelatedEvent.h"
29
30namespace WebCore {
31
32class Clipboard;
33class EventDispatcher;
34class PlatformMouseEvent;
35
36struct MouseEventInit : public UIEventInit {
37    MouseEventInit();
38
39    int screenX;
40    int screenY;
41    int clientX;
42    int clientY;
43    bool ctrlKey;
44    bool altKey;
45    bool shiftKey;
46    bool metaKey;
47    unsigned short button;
48    RefPtrWillBeMember<EventTarget> relatedTarget;
49};
50
51class MouseEvent : public MouseRelatedEvent {
52public:
53    static PassRefPtrWillBeRawPtr<MouseEvent> create()
54    {
55        return adoptRefWillBeNoop(new MouseEvent);
56    }
57
58    static PassRefPtrWillBeRawPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtrWillBeRawPtr<AbstractView>,
59        int detail, int screenX, int screenY, int pageX, int pageY,
60        int movementX, int movementY,
61        bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
62        PassRefPtrWillBeRawPtr<EventTarget> relatedTarget, PassRefPtrWillBeRawPtr<Clipboard>, bool isSimulated = false);
63
64    static PassRefPtrWillBeRawPtr<MouseEvent> create(const AtomicString& eventType, PassRefPtrWillBeRawPtr<AbstractView>, const PlatformMouseEvent&, int detail, PassRefPtrWillBeRawPtr<Node> relatedTarget);
65
66    static PassRefPtrWillBeRawPtr<MouseEvent> create(const AtomicString& eventType, const MouseEventInit&);
67
68    virtual ~MouseEvent();
69
70    void initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtrWillBeRawPtr<AbstractView>,
71        int detail, int screenX, int screenY, int clientX, int clientY,
72        bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
73        unsigned short button, PassRefPtrWillBeRawPtr<EventTarget> relatedTarget);
74
75    // WinIE uses 1,4,2 for left/middle/right but not for click (just for mousedown/up, maybe others),
76    // but we will match the standard DOM.
77    unsigned short button() const { return m_button; }
78    bool buttonDown() const { return m_buttonDown; }
79    EventTarget* relatedTarget() const { return m_relatedTarget.get(); }
80    EventTarget* relatedTarget(bool& isNull) const { isNull = !m_relatedTarget; return m_relatedTarget.get(); }
81    void setRelatedTarget(PassRefPtrWillBeRawPtr<EventTarget> relatedTarget) { m_relatedTarget = relatedTarget; }
82
83    Node* toElement() const;
84    Node* fromElement() const;
85
86    Clipboard* dataTransfer() const { return isDragEvent() ? m_clipboard.get() : 0; }
87
88    virtual const AtomicString& interfaceName() const OVERRIDE;
89
90    virtual bool isMouseEvent() const OVERRIDE;
91    virtual bool isDragEvent() const OVERRIDE FINAL;
92    virtual int which() const OVERRIDE FINAL;
93
94    virtual void trace(Visitor*) OVERRIDE;
95
96protected:
97    MouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtrWillBeRawPtr<AbstractView>,
98        int detail, int screenX, int screenY, int pageX, int pageY,
99        int movementX, int movementY,
100        bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
101        PassRefPtrWillBeRawPtr<EventTarget> relatedTarget, PassRefPtrWillBeRawPtr<Clipboard>, bool isSimulated);
102
103    MouseEvent(const AtomicString& type, const MouseEventInit&);
104
105    MouseEvent();
106
107private:
108    unsigned short m_button;
109    bool m_buttonDown;
110    RefPtrWillBeMember<EventTarget> m_relatedTarget;
111    RefPtrWillBeMember<Clipboard> m_clipboard;
112};
113
114class SimulatedMouseEvent FINAL : public MouseEvent {
115public:
116    static PassRefPtrWillBeRawPtr<SimulatedMouseEvent> create(const AtomicString& eventType, PassRefPtrWillBeRawPtr<AbstractView>, PassRefPtrWillBeRawPtr<Event> underlyingEvent);
117    virtual ~SimulatedMouseEvent();
118
119    virtual void trace(Visitor*) OVERRIDE;
120
121private:
122    SimulatedMouseEvent(const AtomicString& eventType, PassRefPtrWillBeRawPtr<AbstractView>, PassRefPtrWillBeRawPtr<Event> underlyingEvent);
123};
124
125class MouseEventDispatchMediator FINAL : public EventDispatchMediator {
126public:
127    enum MouseEventType { SyntheticMouseEvent, NonSyntheticMouseEvent};
128    static PassRefPtrWillBeRawPtr<MouseEventDispatchMediator> create(PassRefPtrWillBeRawPtr<MouseEvent>, MouseEventType = NonSyntheticMouseEvent);
129
130private:
131    explicit MouseEventDispatchMediator(PassRefPtrWillBeRawPtr<MouseEvent>, MouseEventType);
132    MouseEvent* event() const;
133
134    virtual bool dispatchEvent(EventDispatcher*) const OVERRIDE;
135    bool isSyntheticMouseEvent() const { return m_mouseEventType == SyntheticMouseEvent; }
136    MouseEventType m_mouseEventType;
137};
138
139DEFINE_EVENT_TYPE_CASTS(MouseEvent);
140
141} // namespace WebCore
142
143#endif // MouseEvent_h
144