Reviewed by Darin Adler.
[WebKit-https.git] / WebCore / dom / EventTarget.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
6  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
7  *           (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
29  *
30  */
31
32 #ifndef EventTarget_h
33 #define EventTarget_h
34
35 #include <wtf/Forward.h>
36
37 namespace WebCore {
38
39     class AtomicString;
40     class DOMApplicationCache;
41     class Event;
42     class EventListener;
43     class EventTargetNode;
44     class Frame;
45     class MessagePort;
46     class RegisteredEventListener;
47     class SVGElementInstance;
48     class XMLHttpRequest;
49     class XMLHttpRequestUpload;
50
51     typedef int ExceptionCode;
52
53     template<typename T> class DeprecatedValueList;
54     typedef DeprecatedValueList<RefPtr<RegisteredEventListener> > RegisteredEventListenerList;
55
56     class EventTarget {
57     public:
58         virtual MessagePort* toMessagePort();
59         virtual EventTargetNode* toNode();
60         virtual XMLHttpRequest* toXMLHttpRequest();
61         virtual XMLHttpRequestUpload* toXMLHttpRequestUpload();
62 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
63         virtual DOMApplicationCache* toDOMApplicationCache();
64 #endif
65 #if ENABLE(SVG)
66         virtual SVGElementInstance* toSVGElementInstance();
67 #endif
68
69         virtual Frame* associatedFrame() const = 0;
70
71         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) = 0;
72         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) = 0;
73         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&) = 0;
74
75         void ref() { refEventTarget(); }
76         void deref() { derefEventTarget(); }
77
78         // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
79         // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
80         virtual void* preDispatchEventHandler(Event*) { return 0; }
81         virtual void postDispatchEventHandler(Event*, void* dataFromPreDispatch) { }
82
83     protected:
84         virtual ~EventTarget();
85
86     private:
87         virtual void refEventTarget() = 0;
88         virtual void derefEventTarget() = 0;
89     };
90
91 #ifndef NDEBUG
92 void forbidEventDispatch();
93 void allowEventDispatch();
94 bool eventDispatchForbidden();
95 #else
96 inline void forbidEventDispatch() { }
97 inline void allowEventDispatch() { }
98 #endif // NDEBUG 
99
100 }
101 #endif