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.
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.
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.
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.
27 #include "bindings/v8/ScriptWrappable.h"
28 #include "core/dom/DOMTimeStamp.h"
29 #include "core/events/EventPath.h"
30 #include "heap/Handle.h"
31 #include "wtf/RefCounted.h"
32 #include "wtf/text/AtomicString.h"
37 class EventDispatcher;
38 class HTMLIFrameElement;
49 class Event : public RefCountedWillBeRefCountedGarbageCollected<Event>, public ScriptWrappable {
77 static PassRefPtrWillBeRawPtr<Event> create()
79 return adoptRefWillBeRefCountedGarbageCollected(new Event);
82 // A factory for a simple event. The event doesn't bubble, and isn't
84 // http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#fire-a-simple-event
85 static PassRefPtrWillBeRawPtr<Event> create(const AtomicString& type)
87 return adoptRefWillBeRefCountedGarbageCollected(new Event(type, false, false));
89 static PassRefPtrWillBeRawPtr<Event> createCancelable(const AtomicString& type)
91 return adoptRefWillBeRefCountedGarbageCollected(new Event(type, false, true));
93 static PassRefPtrWillBeRawPtr<Event> createBubble(const AtomicString& type)
95 return adoptRefWillBeRefCountedGarbageCollected(new Event(type, true, false));
97 static PassRefPtrWillBeRawPtr<Event> createCancelableBubble(const AtomicString& type)
99 return adoptRefWillBeRefCountedGarbageCollected(new Event(type, true, true));
102 static PassRefPtrWillBeRawPtr<Event> create(const AtomicString& type, const EventInit& initializer)
104 return adoptRefWillBeRefCountedGarbageCollected(new Event(type, initializer));
109 void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
111 const AtomicString& type() const { return m_type; }
112 void setType(const AtomicString& type) { m_type = type; }
114 EventTarget* target() const { return m_target.get(); }
115 void setTarget(PassRefPtr<EventTarget>);
117 EventTarget* currentTarget() const { return m_currentTarget; }
118 void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
120 unsigned short eventPhase() const { return m_eventPhase; }
121 void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
123 bool bubbles() const { return m_canBubble; }
124 bool cancelable() const { return m_cancelable; }
125 DOMTimeStamp timeStamp() const { return m_createTime; }
127 void stopPropagation() { m_propagationStopped = true; }
128 void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
131 EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
133 bool legacyReturnValue() const { return !defaultPrevented(); }
134 void setLegacyReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
136 virtual const AtomicString& interfaceName() const;
137 bool hasInterface(const AtomicString&) const;
139 // These events are general classes of events.
140 virtual bool isUIEvent() const;
141 virtual bool isMouseEvent() const;
142 virtual bool isFocusEvent() const;
143 virtual bool isKeyboardEvent() const;
144 virtual bool isTouchEvent() const;
145 virtual bool isGestureEvent() const;
146 virtual bool isWheelEvent() const;
148 // Drag events are a subset of mouse events.
149 virtual bool isDragEvent() const;
151 // These events lack a DOM interface.
152 virtual bool isClipboardEvent() const;
153 virtual bool isBeforeTextInsertedEvent() const;
155 virtual bool isBeforeUnloadEvent() const;
157 bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
158 bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
160 bool defaultPrevented() const { return m_defaultPrevented; }
161 void preventDefault()
164 m_defaultPrevented = true;
166 void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
168 bool defaultHandled() const { return m_defaultHandled; }
169 void setDefaultHandled() { m_defaultHandled = true; }
171 bool cancelBubble() const { return m_cancelBubble; }
172 void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
174 Event* underlyingEvent() const { return m_underlyingEvent.get(); }
175 void setUnderlyingEvent(PassRefPtr<Event>);
177 EventPath& eventPath() { ASSERT(m_eventPath); return *m_eventPath; }
178 EventPath& ensureEventPath();
180 PassRefPtr<NodeList> path() const;
182 bool isBeingDispatched() const { return eventPhase(); }
184 virtual void trace(Visitor*);
188 Event(const AtomicString& type, bool canBubble, bool cancelable);
189 Event(const AtomicString& type, const EventInit&);
191 virtual void receivedTarget();
192 bool dispatched() const { return m_target; }
199 bool m_propagationStopped;
200 bool m_immediatePropagationStopped;
201 bool m_defaultPrevented;
202 bool m_defaultHandled;
205 unsigned short m_eventPhase;
206 EventTarget* m_currentTarget;
207 RefPtr<EventTarget> m_target;
208 DOMTimeStamp m_createTime;
209 RefPtr<Event> m_underlyingEvent;
210 OwnPtr<EventPath> m_eventPath;
213 #define DEFINE_EVENT_TYPE_CASTS(typeName) \
214 DEFINE_TYPE_CASTS(typeName, Event, event, event->is##typeName(), event.is##typeName())
216 } // namespace WebCore