Add an eventPhase NONE constant
[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 EventInit {
38         EventInit();
39         
40         bool bubbles;
41         bool cancelable;
42     };
43
44     class Event : public RefCounted<Event> {
45     public:
46         enum PhaseType { 
47             NONE                = 0,
48             CAPTURING_PHASE     = 1, 
49             AT_TARGET           = 2,
50             BUBBLING_PHASE      = 3 
51         };
52
53         enum EventType {
54             MOUSEDOWN           = 1,
55             MOUSEUP             = 2,
56             MOUSEOVER           = 4,
57             MOUSEOUT            = 8,
58             MOUSEMOVE           = 16,
59             MOUSEDRAG           = 32,
60             CLICK               = 64,
61             DBLCLICK            = 128,
62             KEYDOWN             = 256,
63             KEYUP               = 512,
64             KEYPRESS            = 1024,
65             DRAGDROP            = 2048,
66             FOCUS               = 4096,
67             BLUR                = 8192,
68             SELECT              = 16384,
69             CHANGE              = 32768
70         };
71
72         static PassRefPtr<Event> create()
73         {
74             return adoptRef(new Event);
75         }
76         static PassRefPtr<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
77         {
78             return adoptRef(new Event(type, canBubble, cancelable));
79         }
80
81         static PassRefPtr<Event> create(const AtomicString& type, const EventInit& initializer)
82         {
83             return adoptRef(new Event(type, initializer));
84         }
85
86         virtual ~Event();
87
88         void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
89
90         const AtomicString& type() const { return m_type; }
91         
92         EventTarget* target() const { return m_target.get(); }
93         void setTarget(PassRefPtr<EventTarget>);
94
95         EventTarget* currentTarget() const { return m_currentTarget; }
96         void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
97
98         unsigned short eventPhase() const { return m_eventPhase; }
99         void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
100
101         bool bubbles() const { return m_canBubble; }
102         bool cancelable() const { return m_cancelable; }
103         DOMTimeStamp timeStamp() const { return m_createTime; }
104
105         void stopPropagation() { m_propagationStopped = true; }
106         void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
107         
108         // IE Extensions
109         EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
110
111         bool returnValue() const { return !defaultPrevented(); }
112         void setReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
113
114         Clipboard* clipboardData() const { return isClipboardEvent() ? clipboard() : 0; }
115
116         virtual const AtomicString& interfaceName() const;
117         bool hasInterface(const AtomicString&) const;
118
119         // These events are general classes of events.
120         virtual bool isUIEvent() const;
121         virtual bool isMouseEvent() const;
122         virtual bool isKeyboardEvent() const;
123
124         // Drag events are a subset of mouse events.
125         virtual bool isDragEvent() const;
126
127         // These events lack a DOM interface.
128         virtual bool isClipboardEvent() const;
129         virtual bool isBeforeTextInsertedEvent() const;
130
131         bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
132         bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
133
134         bool defaultPrevented() const { return m_defaultPrevented; }
135         void preventDefault() { if (m_cancelable) m_defaultPrevented = true; }
136         void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
137
138         bool defaultHandled() const { return m_defaultHandled; }
139         void setDefaultHandled() { m_defaultHandled = true; }
140
141         bool cancelBubble() const { return m_cancelBubble; }
142         void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
143
144         Event* underlyingEvent() const { return m_underlyingEvent.get(); }
145         void setUnderlyingEvent(PassRefPtr<Event>);
146
147         virtual bool storesResultAsString() const;
148         virtual void storeResult(const String&);
149
150         virtual Clipboard* clipboard() const { return 0; }
151
152         bool isBeingDispatched() const { return eventPhase(); }
153
154     protected:
155         Event();
156         Event(const AtomicString& type, bool canBubble, bool cancelable);
157         Event(const AtomicString& type, const EventInit&);
158
159         virtual void receivedTarget();
160         bool dispatched() const { return m_target; }
161
162     private:
163         AtomicString m_type;
164         bool m_canBubble;
165         bool m_cancelable;
166
167         bool m_propagationStopped;
168         bool m_immediatePropagationStopped;
169         bool m_defaultPrevented;
170         bool m_defaultHandled;
171         bool m_cancelBubble;
172
173         unsigned short m_eventPhase;
174         EventTarget* m_currentTarget;
175         RefPtr<EventTarget> m_target;
176         DOMTimeStamp m_createTime;
177
178         RefPtr<Event> m_underlyingEvent;
179     };
180
181 } // namespace WebCore
182
183 #endif // Event_h