Implement an Event constructor.
[WebKit-https.git] / Source / WebCore / dom / Event.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, 2007, 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 Event_h
25 #define Event_h
26
27 #include "Clipboard.h"
28 #include "DOMTimeStamp.h"
29 #include <wtf/RefCounted.h>
30 #include <wtf/text/AtomicString.h>
31
32 namespace WebCore {
33
34     class EventTarget;
35     class EventDispatcher;
36
37     struct EventConfiguration {
38         EventConfiguration();
39
40         bool bubbles;
41         bool cancelable;
42         bool defaultPrevented;
43         double timeStamp;
44     };
45
46     class Event : public RefCounted<Event> {
47     public:
48         enum PhaseType { 
49             CAPTURING_PHASE     = 1, 
50             AT_TARGET           = 2,
51             BUBBLING_PHASE      = 3 
52         };
53
54         enum EventType {
55             MOUSEDOWN           = 1,
56             MOUSEUP             = 2,
57             MOUSEOVER           = 4,
58             MOUSEOUT            = 8,
59             MOUSEMOVE           = 16,
60             MOUSEDRAG           = 32,
61             CLICK               = 64,
62             DBLCLICK            = 128,
63             KEYDOWN             = 256,
64             KEYUP               = 512,
65             KEYPRESS            = 1024,
66             DRAGDROP            = 2048,
67             FOCUS               = 4096,
68             BLUR                = 8192,
69             SELECT              = 16384,
70             CHANGE              = 32768
71         };
72
73         static PassRefPtr<Event> create()
74         {
75             return adoptRef(new Event);
76         }
77         static PassRefPtr<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
78         {
79             return adoptRef(new Event(type, canBubble, cancelable));
80         }
81         static PassRefPtr<Event> create(const AtomicString& type, const EventConfiguration& eventConfiguration)
82         {
83             return adoptRef(new Event(type, eventConfiguration));
84         }
85         virtual ~Event();
86
87         void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
88
89         const AtomicString& type() const { return m_type; }
90         
91         EventTarget* target() const { return m_target.get(); }
92         void setTarget(PassRefPtr<EventTarget>);
93
94         EventTarget* currentTarget() const { return m_currentTarget; }
95         void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
96
97         unsigned short eventPhase() const { return m_eventPhase; }
98         void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
99
100         bool bubbles() const { return m_canBubble; }
101         bool cancelable() const { return m_cancelable; }
102         DOMTimeStamp timeStamp() const { return m_createTime; }
103
104         void stopPropagation() { m_propagationStopped = true; }
105         void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
106         
107         // IE Extensions
108         EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
109
110         bool returnValue() const { return !defaultPrevented(); }
111         void setReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
112
113         Clipboard* clipboardData() const { return isClipboardEvent() ? clipboard() : 0; }
114
115         virtual bool isCustomEvent() const;
116         virtual bool isUIEvent() const;
117         virtual bool isMouseEvent() const;
118         virtual bool isMutationEvent() const;
119         virtual bool isKeyboardEvent() const;
120         virtual bool isTextEvent() const;
121         virtual bool isCompositionEvent() const;
122         virtual bool isDragEvent() const; // a subset of mouse events
123         virtual bool isClipboardEvent() const;
124         virtual bool isMessageEvent() const;
125         virtual bool isWheelEvent() const;
126         virtual bool isBeforeTextInsertedEvent() const;
127         virtual bool isOverflowEvent() const;
128         virtual bool isPageTransitionEvent() const;
129         virtual bool isPopStateEvent() const;
130         virtual bool isProgressEvent() const;
131         virtual bool isXMLHttpRequestProgressEvent() const;
132         virtual bool isWebKitAnimationEvent() const;
133         virtual bool isWebKitTransitionEvent() const;
134         virtual bool isBeforeLoadEvent() const;
135         virtual bool isHashChangeEvent() const;
136 #if ENABLE(SVG)
137         virtual bool isSVGZoomEvent() const;
138 #endif
139 #if ENABLE(DOM_STORAGE)
140         virtual bool isStorageEvent() const;
141 #endif
142 #if ENABLE(INDEXED_DATABASE)
143         virtual bool isIDBVersionChangeEvent() const;
144 #endif
145 #if ENABLE(WEB_AUDIO)
146         virtual bool isAudioProcessingEvent() const;
147         virtual bool isOfflineAudioCompletionEvent() const;
148 #endif
149         virtual bool isErrorEvent() const;
150 #if ENABLE(TOUCH_EVENTS)
151         virtual bool isTouchEvent() const;
152 #endif
153 #if ENABLE(DEVICE_ORIENTATION)
154         virtual bool isDeviceMotionEvent() const;
155         virtual bool isDeviceOrientationEvent() const;
156 #endif
157 #if ENABLE(INPUT_SPEECH)
158         virtual bool isSpeechInputEvent() const;
159 #endif
160 #if ENABLE(WEB_SOCKETS)
161         virtual bool isCloseEvent() const;
162 #endif
163 #if ENABLE(MEDIA_STREAM)
164         virtual bool isMediaStreamEvent() const;
165 #endif
166         bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
167         bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
168
169         bool defaultPrevented() const { return m_defaultPrevented; }
170         void preventDefault() { if (m_cancelable) m_defaultPrevented = true; }
171         void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
172
173         bool defaultHandled() const { return m_defaultHandled; }
174         void setDefaultHandled() { m_defaultHandled = true; }
175
176         bool cancelBubble() const { return m_cancelBubble; }
177         void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
178
179         Event* underlyingEvent() const { return m_underlyingEvent.get(); }
180         void setUnderlyingEvent(PassRefPtr<Event>);
181
182         virtual bool storesResultAsString() const;
183         virtual void storeResult(const String&);
184
185         virtual Clipboard* clipboard() const { return 0; }
186
187         bool isBeingDispatched() const { return eventPhase(); }
188
189     protected:
190         Event();
191         Event(const AtomicString& type, bool canBubble, bool cancelable);
192         Event(const AtomicString&, const EventConfiguration&);
193
194         virtual void receivedTarget();
195         bool dispatched() const { return m_target; }
196
197     private:
198         AtomicString m_type;
199         bool m_canBubble;
200         bool m_cancelable;
201
202         bool m_propagationStopped;
203         bool m_immediatePropagationStopped;
204         bool m_defaultPrevented;
205         bool m_defaultHandled;
206         bool m_cancelBubble;
207
208         unsigned short m_eventPhase;
209         EventTarget* m_currentTarget;
210         RefPtr<EventTarget> m_target;
211         DOMTimeStamp m_createTime;
212
213         RefPtr<Event> m_underlyingEvent;
214     };
215
216 } // namespace WebCore
217
218 #endif // Event_h