dlls/mshtml/htmlevent.h

   1 /*
   2  * Copyright 2008 Jacek Caban for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 typedef enum {
  20     EVENTID_INVALID_ID = -1,
  21     EVENTID_DOMCONTENTLOADED,
  22     EVENTID_ABORT,
  23     EVENTID_AFTERPRINT,
  24     EVENTID_ANIMATIONEND,
  25     EVENTID_ANIMATIONSTART,
  26     EVENTID_BEFOREACTIVATE,
  27     EVENTID_BEFOREPRINT,
  28     EVENTID_BEFOREUNLOAD,
  29     EVENTID_BLUR,
  30     EVENTID_CHANGE,
  31     EVENTID_CLICK,
  32     EVENTID_CONTEXTMENU,
  33     EVENTID_DATAAVAILABLE,
  34     EVENTID_DBLCLICK,
  35     EVENTID_DRAG,
  36     EVENTID_DRAGSTART,
  37     EVENTID_ERROR,
  38     EVENTID_FOCUS,
  39     EVENTID_FOCUSIN,
  40     EVENTID_FOCUSOUT,
  41     EVENTID_HELP,
  42     EVENTID_INPUT,
  43     EVENTID_KEYDOWN,
  44     EVENTID_KEYPRESS,
  45     EVENTID_KEYUP,
  46     EVENTID_LOAD,
  47     EVENTID_LOADEND,
  48     EVENTID_LOADSTART,
  49     EVENTID_MESSAGE,
  50     EVENTID_MOUSEDOWN,
  51     EVENTID_MOUSEMOVE,
  52     EVENTID_MOUSEOUT,
  53     EVENTID_MOUSEOVER,
  54     EVENTID_MOUSEUP,
  55     EVENTID_MOUSEWHEEL,
  56     EVENTID_MSTHUMBNAILCLICK,
  57     EVENTID_PAGEHIDE,
  58     EVENTID_PAGESHOW,
  59     EVENTID_PASTE,
  60     EVENTID_PROGRESS,
  61     EVENTID_READYSTATECHANGE,
  62     EVENTID_RESIZE,
  63     EVENTID_SCROLL,
  64     EVENTID_SELECTIONCHANGE,
  65     EVENTID_SELECTSTART,
  66     EVENTID_STORAGE,
  67     EVENTID_STORAGECOMMIT,
  68     EVENTID_SUBMIT,
  69     EVENTID_TIMEOUT,
  70     EVENTID_UNLOAD,
  71     EVENTID_VISIBILITYCHANGE,
  72     EVENTID_LAST
  73 } eventid_t;
  74
  75 typedef struct DOMEvent {
  76     DispatchEx dispex;
  77     IDOMEvent IDOMEvent_iface;
  78
  79     nsIDOMEvent *nsevent;
  80
  81     eventid_t event_id;
  82     WCHAR *type;
  83     EventTarget *target;
  84     EventTarget *current_target;
  85     ULONGLONG time_stamp;
  86     BOOL bubbles;
  87     BOOL cancelable;
  88     BOOL prevent_default;
  89     BOOL stop_propagation;
  90     BOOL stop_immediate_propagation;
  91     BOOL trusted;
  92     DOM_EVENT_PHASE phase;
  93
  94     IHTMLEventObj *event_obj;
  95     BOOL no_event_obj;
  96 } DOMEvent;
  97
  98 const WCHAR *get_event_name(eventid_t);
  99 void check_event_attr(HTMLDocumentNode*,nsIDOMElement*);
 100 void traverse_event_target(EventTarget*,nsCycleCollectionTraversalCallback*);
 101 void release_event_target(EventTarget*);
 102 HRESULT set_event_handler(EventTarget*,eventid_t,VARIANT*);
 103 HRESULT get_event_handler(EventTarget*,eventid_t,VARIANT*);
 104 HRESULT attach_event(EventTarget*,BSTR,IDispatch*,VARIANT_BOOL*);
 105 HRESULT detach_event(EventTarget*,BSTR,IDispatch*);
 106 HRESULT fire_event(HTMLDOMNode*,const WCHAR*,VARIANT*,VARIANT_BOOL*);
 107 void update_doc_cp_events(HTMLDocumentNode*,cp_static_data_t*);
 108 HRESULT doc_init_events(HTMLDocumentNode*);
 109 void detach_events(HTMLDocumentNode *doc);
 110 HRESULT create_event_obj(DOMEvent*,compat_mode_t,IHTMLEventObj**);
 111 void bind_target_event(HTMLDocumentNode*,EventTarget*,const WCHAR*,IDispatch*);
 112 HRESULT ensure_doc_nsevent_handler(HTMLDocumentNode*,nsIDOMNode*,eventid_t);
 113
 114 void dispatch_event(EventTarget*,DOMEvent*);
 115
 116 HRESULT create_document_event(HTMLDocumentNode*,eventid_t,DOMEvent**);
 117 HRESULT create_document_event_str(HTMLDocumentNode*,const WCHAR*,IDOMEvent**);
 118 HRESULT create_event_from_nsevent(nsIDOMEvent*,compat_mode_t,DOMEvent**);
 119 HRESULT create_message_event(HTMLDocumentNode*,IHTMLWindow2*,VARIANT*,DOMEvent**);
 120 HRESULT create_storage_event(HTMLDocumentNode*,BSTR,BSTR,BSTR,const WCHAR*,BOOL,DOMEvent**);
 121
 122 void init_nsevents(HTMLDocumentNode*);
 123 void release_nsevents(HTMLDocumentNode*);
 124 void add_nsevent_listener(HTMLDocumentNode*,nsIDOMNode*,LPCWSTR);
 125 void detach_nsevent(HTMLDocumentNode*,const WCHAR*);
 126
 127 /* We extend dispex vtbl for EventTarget functions to avoid separated vtbl. */
 128 typedef struct {
 129     dispex_static_data_vtbl_t dispex_vtbl;
 130     IDispatch *(*get_dispatch_this)(DispatchEx*);
 131     nsISupports *(*get_gecko_target)(DispatchEx*);
 132     void (*bind_event)(DispatchEx*,eventid_t);
 133     EventTarget *(*get_parent_event_target)(DispatchEx*);
 134     HRESULT (*pre_handle_event)(DispatchEx*,DOMEvent*);
 135     HRESULT (*handle_event)(DispatchEx*,DOMEvent*,BOOL*);
 136     ConnectionPointContainer *(*get_cp_container)(DispatchEx*);
 137     IHTMLEventObj *(*set_current_event)(DispatchEx*,IHTMLEventObj*);
 138 } event_target_vtbl_t;
 139
 140 IHTMLEventObj *default_set_current_event(HTMLInnerWindow*,IHTMLEventObj*);
 141
 142 nsISupports *HTMLElement_get_gecko_target(DispatchEx*);
 143 void HTMLElement_bind_event(DispatchEx*,eventid_t);
 144 EventTarget *HTMLElement_get_parent_event_target(DispatchEx*);
 145 HRESULT HTMLElement_handle_event(DispatchEx*,DOMEvent*,BOOL*);
 146 ConnectionPointContainer *HTMLElement_get_cp_container(DispatchEx*);
 147 IHTMLEventObj *HTMLElement_set_current_event(DispatchEx*,IHTMLEventObj*);
 148
 149 #define HTMLELEMENT_DISPEX_VTBL_ENTRIES                 \
 150     .populate_props      = HTMLElement_populate_props
 151
 152 #define HTMLELEMENT_EVENT_TARGET_VTBL_ENTRIES                       \
 153     .get_gecko_target        = HTMLElement_get_gecko_target,        \
 154     .bind_event              = HTMLElement_bind_event,              \
 155     .get_parent_event_target = HTMLElement_get_parent_event_target, \
 156     .get_cp_container        = HTMLElement_get_cp_container,        \
 157     .set_current_event       = HTMLElement_set_current_event
 158
 159 static inline EventTarget *get_node_event_prop_target(HTMLDOMNode *node, eventid_t eid)
 160 {
 161     return node->vtbl->get_event_prop_target ? node->vtbl->get_event_prop_target(node, eid) : &node->event_target;
 162 }
 163
 164 static inline HRESULT set_node_event(HTMLDOMNode *node, eventid_t eid, VARIANT *var)
 165 {
 166     return set_event_handler(get_node_event_prop_target(node, eid), eid, var);
 167 }
 168
 169 static inline HRESULT get_node_event(HTMLDOMNode *node, eventid_t eid, VARIANT *var)
 170 {
 171     return get_event_handler(get_node_event_prop_target(node, eid), eid, var);
 172 }
 173
 174 static inline HRESULT set_doc_event(HTMLDocumentNode *doc, eventid_t eid, VARIANT *var)
 175 {
 176     return set_event_handler(&doc->node.event_target, eid, var);
 177 }
 178
 179 static inline HRESULT get_doc_event(HTMLDocumentNode *doc, eventid_t eid, VARIANT *var)
 180 {
 181     return get_event_handler(&doc->node.event_target, eid, var);
 182 }