WebCore:
[WebKit-https.git] / WebCore / dom / EventTargetNode.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2001 Dirk Mueller (mueller@kde.org)
7  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  *
24  */
25
26 #ifndef DOM_EventTargetNodeImpl_h
27 #define DOM_EventTargetNodeImpl_h
28
29 #include "Node.h"
30
31 namespace WebCore {
32
33 template <typename T> class DeprecatedValueList;
34
35 class EventTargetNode : public Node {
36 public:
37     EventTargetNode(Document*);
38     virtual ~EventTargetNode();
39
40     virtual bool isEventTargetNode() const { return true; }
41
42     void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
43     void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
44     void removeAllEventListeners();
45
46     void setHTMLEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
47     void removeHTMLEventListener(const AtomicString& eventType);
48     bool dispatchHTMLEvent(const AtomicString& eventType, bool canBubble, bool cancelable);
49     EventListener *getHTMLEventListener(const AtomicString& eventType);
50
51     bool dispatchGenericEvent(PassRefPtr<Event>, ExceptionCode&, bool tempEvent = false);
52     bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&, bool tempEvent = false);
53     bool dispatchSubtreeModifiedEvent(bool childrenChanged = true);
54     void dispatchWindowEvent(const AtomicString& eventType, bool canBubble, bool cancelable);
55     bool dispatchUIEvent(const AtomicString& eventType, int detail = 0, PassRefPtr<Event> underlyingEvent = 0);
56     bool dispatchKeyEvent(const PlatformKeyboardEvent&);
57     void dispatchWheelEvent(PlatformWheelEvent&);
58     bool dispatchMouseEvent(const PlatformMouseEvent&, const AtomicString& eventType,
59         int clickCount = 0, Node* relatedTarget = 0);
60     bool dispatchMouseEvent(const AtomicString& eventType, int button, int clickCount,
61         int pageX, int pageY, int screenX, int screenY,
62         bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
63         bool isSimulated = false, Node* relatedTarget = 0, PassRefPtr<Event> underlyingEvent = 0);
64     void dispatchSimulatedMouseEvent(const AtomicString& eventType, PassRefPtr<Event> underlyingEvent = 0);
65     void dispatchSimulatedClick(PassRefPtr<Event> underlyingEvent, bool sendMouseEvents = false, bool showPressedLook = true);
66
67     void handleLocalEvents(Event*, bool useCapture);
68
69     virtual void dispatchFocusEvent();
70     virtual void dispatchBlurEvent();
71
72     virtual void insertedIntoDocument();
73     virtual void removedFromDocument();
74     
75     // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
76     // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
77     virtual void* preDispatchEventHandler(Event*) { return 0; }
78     virtual void postDispatchEventHandler(Event*, void* dataFromPreDispatch) { }
79
80     /**
81      * Perform the default action for an event e.g. submitting a form
82      */
83     virtual void defaultEventHandler(Event*);
84
85     /**
86      * Used for disabled form elements; if true, prevents mouse events from being dispatched
87      * to event listeners, and prevents DOMActivate events from being sent at all.
88      */
89     virtual bool disabled() const;
90     
91 #ifndef NDEBUG
92     virtual void dump(TextStream*, DeprecatedString indent = "") const;
93 #endif
94
95 protected:
96     typedef DeprecatedValueList<RefPtr<RegisteredEventListener> > RegisteredEventListenerList;
97     RegisteredEventListenerList* m_regdListeners;
98 };
99
100 inline EventTargetNode* EventTargetNodeCast(Node* n) 
101
102     ASSERT(n->isEventTargetNode());
103     return static_cast<EventTargetNode*>(n); 
104 }
105
106 inline const EventTargetNode* EventTargetNodeCast(const Node* n) 
107
108     ASSERT(n->isEventTargetNode());
109     return static_cast<const EventTargetNode*>(n); 
110 }
111
112 #ifndef NDEBUG
113
114 void forbidEventDispatch();
115 void allowEventDispatch();
116 bool eventDispatchForbidden();
117
118 #else
119
120 inline void forbidEventDispatch() { }
121 inline void allowEventDispatch() { }
122
123 #endif // NDEBUG 
124
125 } // namespace WebCore
126
127 #endif // DOM_EventTargetNodeImpl_h