Event.h shouldn't need to know about every ifdef and feature that uses events
[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             CAPTURING_PHASE     = 1, 
48             AT_TARGET           = 2,
49             BUBBLING_PHASE      = 3 
50         };
51
52         enum EventType {
53             MOUSEDOWN           = 1,
54             MOUSEUP             = 2,
55             MOUSEOVER           = 4,
56             MOUSEOUT            = 8,
57             MOUSEMOVE           = 16,
58             MOUSEDRAG           = 32,
59             CLICK               = 64,
60             DBLCLICK            = 128,
61             KEYDOWN             = 256,
62             KEYUP               = 512,
63             KEYPRESS            = 1024,
64             DRAGDROP            = 2048,
65             FOCUS               = 4096,
66             BLUR                = 8192,
67             SELECT              = 16384,
68             CHANGE              = 32768
69         };
70
71         static PassRefPtr<Event> create()
72         {
73             return adoptRef(new Event);
74         }
75         static PassRefPtr<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
76         {
77             return adoptRef(new Event(type, canBubble, cancelable));
78         }
79
80         static PassRefPtr<Event> create(const AtomicString& type, const EventInit& initializer)
81         {
82             return adoptRef(new Event(type, initializer));
83         }
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 const AtomicString& interfaceName() const;
116
117         // These are needed for the CPP bindings.
118         virtual bool isUIEvent() const;
119         virtual bool isMouseEvent() const;
120         virtual bool isMutationEvent() const;
121
122         virtual bool isDragEvent() const; // a subset of mouse events
123
124         // FIXME: Remove these! Callers should use interfaceName() instead.
125         virtual bool isKeyboardEvent() const;
126         virtual bool isTextEvent() const;
127         virtual bool isCompositionEvent() const;
128         virtual bool isClipboardEvent() const;
129         virtual bool isMessageEvent() const;
130         virtual bool isWheelEvent() const;
131         virtual bool isBeforeTextInsertedEvent() const;
132         virtual bool isOverflowEvent() const;
133         virtual bool isPageTransitionEvent() const;
134         virtual bool isProgressEvent() const;
135         virtual bool isBeforeLoadEvent() const;
136 #if ENABLE(SVG)
137         virtual bool isSVGZoomEvent() const;
138 #endif
139         virtual bool isErrorEvent() const;
140
141         bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
142         bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
143
144         bool defaultPrevented() const { return m_defaultPrevented; }
145         void preventDefault() { if (m_cancelable) m_defaultPrevented = true; }
146         void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
147
148         bool defaultHandled() const { return m_defaultHandled; }
149         void setDefaultHandled() { m_defaultHandled = true; }
150
151         bool cancelBubble() const { return m_cancelBubble; }
152         void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
153
154         Event* underlyingEvent() const { return m_underlyingEvent.get(); }
155         void setUnderlyingEvent(PassRefPtr<Event>);
156
157         virtual bool storesResultAsString() const;
158         virtual void storeResult(const String&);
159
160         virtual Clipboard* clipboard() const { return 0; }
161
162         bool isBeingDispatched() const { return eventPhase(); }
163
164     protected:
165         Event();
166         Event(const AtomicString& type, bool canBubble, bool cancelable);
167         Event(const AtomicString& type, const EventInit&);
168
169         virtual void receivedTarget();
170         bool dispatched() const { return m_target; }
171
172     private:
173         AtomicString m_type;
174         bool m_canBubble;
175         bool m_cancelable;
176
177         bool m_propagationStopped;
178         bool m_immediatePropagationStopped;
179         bool m_defaultPrevented;
180         bool m_defaultHandled;
181         bool m_cancelBubble;
182
183         unsigned short m_eventPhase;
184         EventTarget* m_currentTarget;
185         RefPtr<EventTarget> m_target;
186         DOMTimeStamp m_createTime;
187
188         RefPtr<Event> m_underlyingEvent;
189     };
190
191 } // namespace WebCore
192
193 #endif // Event_h