Run clang-modernize and let it add a bunch of missing overrides.
[WebKit.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, 2013 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 "MouseRelatedEvent.h"
28
29 namespace WebCore {
30
31 class Clipboard;
32 class PlatformMouseEvent;
33
34 struct MouseEventInit : public UIEventInit {
35     MouseEventInit();
36
37     int screenX;
38     int screenY;
39     int clientX;
40     int clientY;
41     bool ctrlKey;
42     bool altKey;
43     bool shiftKey;
44     bool metaKey;
45     unsigned short button;
46     RefPtr<EventTarget> relatedTarget;
47 };
48
49 class MouseEvent : public MouseRelatedEvent {
50 public:
51     static PassRefPtr<MouseEvent> create()
52     {
53         return adoptRef(new MouseEvent);
54     }
55
56     static PassRefPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, PassRefPtr<AbstractView>,
57         int detail, int screenX, int screenY, int pageX, int pageY,
58 #if ENABLE(POINTER_LOCK)
59         int movementX, int movementY,
60 #endif
61         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
62         PassRefPtr<EventTarget> relatedTarget);
63
64     static PassRefPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, PassRefPtr<AbstractView>,
65         int detail, int screenX, int screenY, int pageX, int pageY,
66 #if ENABLE(POINTER_LOCK)
67         int movementX, int movementY,
68 #endif
69         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
70         PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard>, bool isSimulated = false);
71
72     static PassRefPtr<MouseEvent> create(const AtomicString& eventType, PassRefPtr<AbstractView>, const PlatformMouseEvent&, int detail, PassRefPtr<Node> relatedTarget);
73
74     static PassRefPtr<MouseEvent> create(const AtomicString& eventType, const MouseEventInit&);
75
76     virtual ~MouseEvent();
77
78     void initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,
79         int detail, int screenX, int screenY, int clientX, int clientY,
80         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
81         unsigned short button, PassRefPtr<EventTarget> relatedTarget);
82
83     // WinIE uses 1,4,2 for left/middle/right but not for click (just for mousedown/up, maybe others),
84     // but we will match the standard DOM.
85     unsigned short button() const { return m_button; }
86     bool buttonDown() const { return m_buttonDown; }
87     virtual EventTarget* relatedTarget() const override final { return m_relatedTarget.get(); }
88     void setRelatedTarget(PassRefPtr<EventTarget> relatedTarget) { m_relatedTarget = relatedTarget; }
89
90     Clipboard* clipboard() const override { return m_clipboard.get(); }
91
92     Node* toElement() const;
93     Node* fromElement() const;
94
95     Clipboard* dataTransfer() const { return isDragEvent() ? m_clipboard.get() : 0; }
96
97     virtual EventInterface eventInterface() const override;
98
99     virtual bool isMouseEvent() const override;
100     virtual bool isDragEvent() const override;
101     virtual int which() const override;
102
103     virtual PassRefPtr<Event> cloneFor(HTMLIFrameElement*) const override;
104
105 protected:
106     MouseEvent(const AtomicString& type, bool canBubble, bool cancelable, double timestamp, PassRefPtr<AbstractView>,
107         int detail, int screenX, int screenY, int pageX, int pageY,
108 #if ENABLE(POINTER_LOCK)
109         int movementX, int movementY,
110 #endif
111         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
112         PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard>, bool isSimulated);
113
114     MouseEvent(const AtomicString& type, const MouseEventInit&);
115
116     MouseEvent();
117
118 private:
119     unsigned short m_button;
120     bool m_buttonDown;
121     RefPtr<EventTarget> m_relatedTarget;
122     RefPtr<Clipboard> m_clipboard;
123 };
124
125 class SimulatedMouseEvent : public MouseEvent {
126 public:
127     static PassRefPtr<SimulatedMouseEvent> create(const AtomicString& eventType, PassRefPtr<AbstractView>, PassRefPtr<Event> underlyingEvent, Element* target);
128     virtual ~SimulatedMouseEvent();
129
130 private:
131     SimulatedMouseEvent(const AtomicString& eventType, PassRefPtr<AbstractView>, PassRefPtr<Event> underlyingEvent, Element* target);
132 };
133
134 inline MouseEvent* toMouseEvent(Event* event)
135 {
136     ASSERT_WITH_SECURITY_IMPLICATION(event && event->isMouseEvent());
137     return static_cast<MouseEvent*>(event);
138 }
139
140 inline MouseEvent& toMouseEvent(Event& event)
141 {
142     ASSERT(event.isMouseEvent());
143     return static_cast<MouseEvent&>(event);
144 }
145
146 } // namespace WebCore
147
148 #endif // MouseEvent_h