Implement MouseEvent constructor
[WebKit-https.git] / Source / WebCore / dom / MouseEvent.h
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 "Clipboard.h"
28 #include "EventDispatchMediator.h"
29 #include "MouseRelatedEvent.h"
30
31 namespace WebCore {
32
33 class EventDispatcher;
34 class PlatformMouseEvent;
35
36 struct 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     RefPtr<EventTarget> relatedTarget;
49 };
50
51 class MouseEvent : public MouseRelatedEvent {
52 public:
53     static PassRefPtr<MouseEvent> create()
54     {
55         return adoptRef(new MouseEvent);
56     }
57
58     static PassRefPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
59         int detail, int screenX, int screenY, int pageX, int pageY,
60 #if ENABLE(POINTER_LOCK)
61         int movementX, int movementY,
62 #endif
63         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
64         PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard = 0, bool isSimulated = false)
65     {
66         return adoptRef(new MouseEvent(type, canBubble, cancelable, view, detail, screenX, screenY, pageX, pageY,
67 #if ENABLE(POINTER_LOCK)
68         movementX, movementY,
69 #endif
70         ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, clipboard, isSimulated));
71     }
72
73     static PassRefPtr<MouseEvent> create(const AtomicString& eventType, PassRefPtr<AbstractView>, const PlatformMouseEvent&, int detail, PassRefPtr<Node> relatedTarget);
74
75     static PassRefPtr<MouseEvent> create(const AtomicString& eventType, const MouseEventInit&);
76
77     virtual ~MouseEvent();
78
79     void initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,
80         int detail, int screenX, int screenY, int clientX, int clientY,
81         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
82         unsigned short button, PassRefPtr<EventTarget> relatedTarget);
83
84     // WinIE uses 1,4,2 for left/middle/right but not for click (just for mousedown/up, maybe others),
85     // but we will match the standard DOM.
86     unsigned short button() const { return m_button; }
87     bool buttonDown() const { return m_buttonDown; }
88     EventTarget* relatedTarget() const { return m_relatedTarget.get(); }
89     void setRelatedTarget(PassRefPtr<EventTarget> relatedTarget) { m_relatedTarget = relatedTarget; }
90
91     Clipboard* clipboard() const { return m_clipboard.get(); }
92
93     Node* toElement() const;
94     Node* fromElement() const;
95
96     Clipboard* dataTransfer() const { return isDragEvent() ? m_clipboard.get() : 0; }
97
98     virtual const AtomicString& interfaceName() const;
99
100     virtual bool isMouseEvent() const;
101     virtual bool isDragEvent() const;
102     virtual int which() const;
103
104     virtual PassRefPtr<Event> cloneFor(HTMLIFrameElement*) const OVERRIDE;
105
106 protected:
107     MouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,
108         int detail, int screenX, int screenY, int pageX, int pageY,
109 #if ENABLE(POINTER_LOCK)
110         int movementX, int movementY,
111 #endif
112         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
113         PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard>, bool isSimulated);
114
115     MouseEvent(const AtomicString& type, const MouseEventInit&);
116
117     MouseEvent();
118
119 private:
120     unsigned short m_button;
121     bool m_buttonDown;
122     RefPtr<EventTarget> m_relatedTarget;
123     RefPtr<Clipboard> m_clipboard;
124 };
125
126 class SimulatedMouseEvent : public MouseEvent {
127 public:
128     static PassRefPtr<SimulatedMouseEvent> create(const AtomicString& eventType, PassRefPtr<AbstractView>, PassRefPtr<Event> underlyingEvent);
129     virtual ~SimulatedMouseEvent();
130
131 private:
132     SimulatedMouseEvent(const AtomicString& eventType, PassRefPtr<AbstractView>, PassRefPtr<Event> underlyingEvent);
133 };
134
135 class MouseEventDispatchMediator : public EventDispatchMediator {
136 public:
137     enum MouseEventType { SyntheticMouseEvent, NonSyntheticMouseEvent};
138     static PassRefPtr<MouseEventDispatchMediator> create(PassRefPtr<MouseEvent>, MouseEventType = NonSyntheticMouseEvent);
139
140 private:
141     explicit MouseEventDispatchMediator(PassRefPtr<MouseEvent>, MouseEventType);
142     MouseEvent* event() const;
143
144     virtual bool dispatchEvent(EventDispatcher*) const OVERRIDE;
145     bool isSyntheticMouseEvent() const { return m_mouseEventType == SyntheticMouseEvent; }
146     MouseEventType m_mouseEventType;
147 };
148
149 inline MouseEvent* toMouseEvent(Event* event)
150 {
151     ASSERT(event && event->isMouseEvent());
152     return static_cast<MouseEvent*>(event);
153 }
154
155 } // namespace WebCore
156
157 #endif // MouseEvent_h