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