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/core/v8/ScriptWrappable.h"
28 #include "core/dom/DOMTimeStamp.h"
29 #include "core/events/EventPath.h"
30 #include "platform/heap/Handle.h"
31 #include "wtf/RefCounted.h"
32 #include "wtf/text/AtomicString.h"
37 class EventDispatcher;
38 class ExecutionContext;
49 class Event : public RefCountedWillBeGarbageCollectedFinalized<Event>, public ScriptWrappable {
77 static PassRefPtrWillBeRawPtr<Event> create()
79 return adoptRefWillBeNoop(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 adoptRefWillBeNoop(new Event(type, false, false));
89 static PassRefPtrWillBeRawPtr<Event> createCancelable(const AtomicString& type)
91 return adoptRefWillBeNoop(new Event(type, false, true));
93 static PassRefPtrWillBeRawPtr<Event> createBubble(const AtomicString& type)
95 return adoptRefWillBeNoop(new Event(type, true, false));
97 static PassRefPtrWillBeRawPtr<Event> createCancelableBubble(const AtomicString& type)
99 return adoptRefWillBeNoop(new Event(type, true, true));
102 static PassRefPtrWillBeRawPtr<Event> create(const AtomicString& type, const EventInit& initializer)
104 return adoptRefWillBeNoop(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(PassRefPtrWillBeRawPtr<EventTarget>);
117 EventTarget* currentTarget() const;
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(ExecutionContext*) const;
134 void setLegacyReturnValue(ExecutionContext*, bool 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;
147 virtual bool isRelatedEvent() const;
149 // Drag events are a subset of mouse events.
150 virtual bool isDragEvent() const;
152 // These events lack a DOM interface.
153 virtual bool isClipboardEvent() const;
154 virtual bool isBeforeTextInsertedEvent() const;
156 virtual bool isBeforeUnloadEvent() const;
158 bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
159 bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
161 bool defaultPrevented() const { return m_defaultPrevented; }
162 virtual void preventDefault()
165 m_defaultPrevented = true;
167 void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
169 bool defaultHandled() const { return m_defaultHandled; }
170 void setDefaultHandled() { m_defaultHandled = true; }
172 bool cancelBubble() const { return m_cancelBubble; }
173 void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
175 Event* underlyingEvent() const { return m_underlyingEvent.get(); }
176 void setUnderlyingEvent(PassRefPtrWillBeRawPtr<Event>);
178 EventPath& eventPath() { ASSERT(m_eventPath); return *m_eventPath; }
179 EventPath& ensureEventPath();
181 PassRefPtrWillBeRawPtr<StaticNodeList> path() const;
183 bool isBeingDispatched() const { return eventPhase(); }
185 virtual void trace(Visitor*);
189 Event(const AtomicString& type, bool canBubble, bool cancelable);
190 Event(const AtomicString& type, const EventInit&);
192 virtual void receivedTarget();
193 bool dispatched() const { return m_target; }
200 bool m_propagationStopped;
201 bool m_immediatePropagationStopped;
202 bool m_defaultPrevented;
203 bool m_defaultHandled;
206 unsigned short m_eventPhase;
207 RawPtrWillBeMember<EventTarget> m_currentTarget;
208 RefPtrWillBeMember<EventTarget> m_target;
209 DOMTimeStamp m_createTime;
210 RefPtrWillBeMember<Event> m_underlyingEvent;
211 OwnPtrWillBeMember<EventPath> m_eventPath;
214 #define DEFINE_EVENT_TYPE_CASTS(typeName) \
215 DEFINE_TYPE_CASTS(typeName, Event, event, event->is##typeName(), event.is##typeName())