Debian Codegraph @

libgdome/events/gdome-evt-event.h

raw
1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 2; tab-width: 2 -*- */
2 /* gdome-evt-event.h
3 *
4 * Copyright (C) 1999 Raph Levien <[email protected]>
5 * Copyright (C) 2000 Mathieu Lacage <[email protected]>
6 * Copyright (C) 2000 Anders Carlsson <[email protected]>
7 * Copyright (C) 2001 Paolo Casarini <[email protected]>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 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 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 */
23
24
25 /* --------------------------------------------------------------- */
26 /* --------------------------- Event --------------------------- */
27 /* --------------------------------------------------------------- */
28
29
30 #ifndef GDOME_EVENT_FILE
31 #define GDOME_EVENT_FILE
32
33 #include <libxml/tree.h>
34
35 struct _GdomeEventVtab {
36 void (*ref) (GdomeEvent *self, GdomeException *exc);
37 void (*unref) (GdomeEvent *self, GdomeException *exc);
38 gpointer (*query_interface) (GdomeEvent *self, const char *interface, GdomeException *exc);
39 GdomeBoolean (*bubbles) (GdomeEvent *self, GdomeException *exc);
40 GdomeBoolean (*cancelable) (GdomeEvent *self, GdomeException *exc);
41 GdomeEventTarget *(*currentTarget) (GdomeEvent *self, GdomeException *exc);
42 unsigned short (*eventPhase) (GdomeEvent *self, GdomeException *exc);
43 GdomeEventTarget *(*target) (GdomeEvent *self, GdomeException *exc);
44 GdomeDOMTimeStamp (*timeStamp) (GdomeEvent *self, GdomeException *exc);
45 GdomeDOMString *(*type) (GdomeEvent *self, GdomeException *exc);
46 void (*initEvent) (GdomeEvent *self, GdomeDOMString *eventTypeArg, GdomeBoolean canBubbleArg, GdomeBoolean cancelableArg, GdomeException *exc);
47 void (*preventDefault) (GdomeEvent *self, GdomeException *exc);
48 void (*stopPropagation) (GdomeEvent *self, GdomeException *exc);
49 };
50
51 typedef struct _Gdome_evt_Event Gdome_evt_Event;
52
53 struct _Gdome_evt_Event {
54 GdomeEvent super;
55 const GdomeEventVtab *vtab;
56 GdomeEventType etype;
57 int refcnt;
58
59 GdomeBoolean bubbles;
60 GdomeBoolean cancelable;
61 xmlNode *currentTarget;
62 unsigned short eventPhase;
63 GdomeNode *target;
64 GdomeDOMTimeStamp timestamp;
65 guint32 type;
66 GdomeBoolean propagation_stopped;
67 GdomeBoolean default_prevented;
68 };
69
70 GdomeEvent * gdome_evt_evnt_mkref (void);
71 void gdome_evt_evnt_ref (GdomeEvent *self,
72 GdomeException *exc);
73 void gdome_evt_evnt_unref (GdomeEvent *self,
74 GdomeException *exc);
75 gpointer gdome_evt_evnt_query_interface (GdomeEvent *self,
76 const char *interface,
77 GdomeException *exc);
78 GdomeDOMString * gdome_evt_evnt_type (GdomeEvent *self,
79 GdomeException *exc);
80 GdomeEventTarget * gdome_evt_evnt_target (GdomeEvent *self,
81 GdomeException *exc);
82 GdomeEventTarget * gdome_evt_evnt_currentTarget (GdomeEvent *self,
83 GdomeException *exc);
84 unsigned short gdome_evt_evnt_eventPhase (GdomeEvent *self,
85 GdomeException *exc);
86 GdomeBoolean gdome_evt_evnt_bubbles (GdomeEvent *self,
87 GdomeException *exc);
88 GdomeBoolean gdome_evt_evnt_cancelable (GdomeEvent *self,
89 GdomeException *exc);
90 GdomeDOMTimeStamp gdome_evt_evnt_timeStamp (GdomeEvent *self,
91 GdomeException *exc);
92 void gdome_evt_evnt_stopPropagation (GdomeEvent *self,
93 GdomeException *exc);
94 void gdome_evt_evnt_preventDefault (GdomeEvent *self,
95 GdomeException *exc);
96 void gdome_evt_evnt_initEvent (GdomeEvent *self,
97 GdomeDOMString *eventTypeArg,
98 GdomeBoolean canBubbleArg,
99 GdomeBoolean cancelableArg,
100 GdomeException *exc);
101
102 /* The following are constants corresponding to the
103 * event types that Gdome2 can handle. These constants
104 * are used internally only and should not be exposed to the
105 * public API
106 */
107 enum _Gdome_xml_EventCodes {
108 DOM_SUBTREE_MODIFIED_EVENT_TYPE = 0x01,
109 DOM_NODE_INSERTED_EVENT_TYPE = 0x02,
110 DOM_NODE_REMOVED_EVENT_TYPE = 0x04,
111 DOM_NODE_REMOVED_FROM_DOCUMENT_EVENT_TYPE = 0x08,
112 DOM_NODE_INSERTED_INTO_DOCUMENT_EVENT_TYPE = 0x10,
113 DOM_ATTR_MODIFIED_EVENT_TYPE = 0x20,
114 DOM_CHARACTER_DATA_MODIFIED_EVENT_TYPE = 0x40,
115
116 DOM_ALL_EVENT_TYPES = (-1)
117 };
118
119 /* Some auxiliary functions */
120 guint32 gdome_evt_evnt_codeOfName (const char *name);
121 const char* gdome_evt_evnt_nameOfCode (guint32 code);
122 void gdome_evt_evnt_initEventByCode (GdomeEvent *self,
123 guint32 eventTypeArg,
124 GdomeBoolean canBubbleArg,
125 GdomeBoolean cancelableArg,
126 GdomeException *exc);
127
128
129 extern const GdomeEventVtab gdome_evt_evnt_vtab;
130
131 #endif /* GDOME_EVENT_FILE */