summaryrefslogtreecommitdiffstats
path: root/WebCore/dom/EventTarget.h
diff options
context:
space:
mode:
Diffstat (limited to 'WebCore/dom/EventTarget.h')
-rw-r--r--WebCore/dom/EventTarget.h116
1 files changed, 116 insertions, 0 deletions
diff --git a/WebCore/dom/EventTarget.h b/WebCore/dom/EventTarget.h
new file mode 100644
index 0000000..87e6810
--- /dev/null
+++ b/WebCore/dom/EventTarget.h
@@ -0,0 +1,116 @@
+/*
+ * This file is part of the DOM implementation for KDE.
+ *
+ * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
+ * (C) 1999 Antti Koivisto (koivisto@kde.org)
+ * (C) 2001 Dirk Mueller (mueller@kde.org)
+ * Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
+ * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
+ * (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#ifndef EventTarget_h
+#define EventTarget_h
+
+#include <wtf/Forward.h>
+
+namespace WebCore {
+
+ class AtomicString;
+ class Event;
+ class EventListener;
+ class EventTargetNode;
+ class RegisteredEventListener;
+ class SVGElementInstance;
+ class XMLHttpRequest;
+
+ typedef int ExceptionCode;
+
+ template<typename T> class DeprecatedValueList;
+ typedef DeprecatedValueList<RefPtr<RegisteredEventListener> > RegisteredEventListenerList;
+
+ class EventTarget {
+ public:
+ virtual EventTargetNode* toNode();
+ virtual XMLHttpRequest* toXMLHttpRequest();
+
+#if ENABLE(SVG)
+ virtual SVGElementInstance* toSVGElementInstance();
+#endif
+
+ virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) = 0;
+ virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) = 0;
+ virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&, bool tempEvent = false) = 0;
+
+ void ref() { refEventTarget(); }
+ void deref() { derefEventTarget(); }
+
+ // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
+ // has been dispatched. The data pointer is handed back by the preDispatch and passed to postDispatch.
+ virtual void* preDispatchEventHandler(Event*) { return 0; }
+ virtual void postDispatchEventHandler(Event*, void* dataFromPreDispatch) { }
+
+ protected:
+ virtual ~EventTarget();
+
+ void addEventListener(EventTargetNode* referenceNode, const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
+ void removeEventListener(EventTargetNode* referenceNode, const AtomicString& eventType, EventListener*, bool useCapture);
+
+ bool dispatchGenericEvent(EventTargetNode* referenceNode, PassRefPtr<Event>, ExceptionCode&, bool tempEvent);
+ void removeAllEventListeners(EventTargetNode* referenceNode);
+
+ void insertedIntoDocument(EventTargetNode* referenceNode);
+ void removedFromDocument(EventTargetNode* referenceNode);
+
+ void handleLocalEvents(EventTargetNode* referenceNode, Event*, bool useCapture);
+
+ // For non SVG elements it will return 'referenceNode' and not modify it.
+ // For SVG elements it eventually returns an event target not equal to 'referenceNode'.
+ //
+ // If 'referenceNode' is a child of a SVG <use> element it will return the corresponding SVGElementInstance
+ // as new event target - and 'referenceNode' will be set to the shadow tree element associated with
+ // the SVGElementInstance. Be sure to always dispatch/handle your events on this new event target.
+ EventTarget* eventTargetRespectingSVGTargetRules(EventTargetNode*& referenceNode);
+
+ private:
+ virtual void refEventTarget() = 0;
+ virtual void derefEventTarget() = 0;
+ };
+
+#ifndef NDEBUG
+
+void forbidEventDispatch();
+void allowEventDispatch();
+bool eventDispatchForbidden();
+
+#else
+
+inline void forbidEventDispatch() { }
+inline void allowEventDispatch() { }
+
+#endif // NDEBUG
+
+}
+#endif