1/*
2 * This file is part of the WebKit open source project.
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 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 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public License
15 * along with this library; see the file COPYING.LIB. If not, write to
16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20#if !defined(__WEBKITDOM_H_INSIDE__) && !defined(BUILDING_WEBKIT)
21#error "Only <webkitdom/webkitdom.h> can be included directly."
22#endif
23
24#ifndef WebKitDOMMouseEvent_h
25#define WebKitDOMMouseEvent_h
26
27#include <glib-object.h>
28#include <webkitdom/WebKitDOMUIEvent.h>
29#include <webkitdom/webkitdomdefines.h>
30
31G_BEGIN_DECLS
32
33#define WEBKIT_DOM_TYPE_MOUSE_EVENT (webkit_dom_mouse_event_get_type())
34#define WEBKIT_DOM_MOUSE_EVENT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_DOM_TYPE_MOUSE_EVENT, WebKitDOMMouseEvent))
35#define WEBKIT_DOM_MOUSE_EVENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), WEBKIT_DOM_TYPE_MOUSE_EVENT, WebKitDOMMouseEventClass)
36#define WEBKIT_DOM_IS_MOUSE_EVENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_DOM_TYPE_MOUSE_EVENT))
37#define WEBKIT_DOM_IS_MOUSE_EVENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), WEBKIT_DOM_TYPE_MOUSE_EVENT))
38#define WEBKIT_DOM_MOUSE_EVENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), WEBKIT_DOM_TYPE_MOUSE_EVENT, WebKitDOMMouseEventClass))
39
40struct _WebKitDOMMouseEvent {
41 WebKitDOMUIEvent parent_instance;
42};
43
44struct _WebKitDOMMouseEventClass {
45 WebKitDOMUIEventClass parent_class;
46};
47
48WEBKIT_DEPRECATED GType
49webkit_dom_mouse_event_get_type(void);
50
51/**
52 * webkit_dom_mouse_event_init_mouse_event:
53 * @self: A #WebKitDOMMouseEvent
54 * @type: A #gchar
55 * @canBubble: A #gboolean
56 * @cancelable: A #gboolean
57 * @view: A #WebKitDOMDOMWindow
58 * @detail: A #glong
59 * @screenX: A #glong
60 * @screenY: A #glong
61 * @clientX: A #glong
62 * @clientY: A #glong
63 * @ctrlKey: A #gboolean
64 * @altKey: A #gboolean
65 * @shiftKey: A #gboolean
66 * @metaKey: A #gboolean
67 * @button: A #gushort
68 * @relatedTarget: A #WebKitDOMEventTarget
69 *
70 *
71 * Deprecated: 2.22: Use JavaScriptCore API instead
72**/
73WEBKIT_DEPRECATED void
74webkit_dom_mouse_event_init_mouse_event(WebKitDOMMouseEvent* self, const gchar* type, gboolean canBubble, gboolean cancelable, WebKitDOMDOMWindow* view, glong detail, glong screenX, glong screenY, glong clientX, glong clientY, gboolean ctrlKey, gboolean altKey, gboolean shiftKey, gboolean metaKey, gushort button, WebKitDOMEventTarget* relatedTarget);
75
76/**
77 * webkit_dom_mouse_event_get_screen_x:
78 * @self: A #WebKitDOMMouseEvent
79 *
80 * Returns: A #glong
81 *
82 * Deprecated: 2.22: Use JavaScriptCore API instead
83**/
84WEBKIT_DEPRECATED glong
85webkit_dom_mouse_event_get_screen_x(WebKitDOMMouseEvent* self);
86
87/**
88 * webkit_dom_mouse_event_get_screen_y:
89 * @self: A #WebKitDOMMouseEvent
90 *
91 * Returns: A #glong
92 *
93 * Deprecated: 2.22: Use JavaScriptCore API instead
94**/
95WEBKIT_DEPRECATED glong
96webkit_dom_mouse_event_get_screen_y(WebKitDOMMouseEvent* self);
97
98/**
99 * webkit_dom_mouse_event_get_client_x:
100 * @self: A #WebKitDOMMouseEvent
101 *
102 * Returns: A #glong
103 *
104 * Deprecated: 2.22: Use JavaScriptCore API instead
105**/
106WEBKIT_DEPRECATED glong
107webkit_dom_mouse_event_get_client_x(WebKitDOMMouseEvent* self);
108
109/**
110 * webkit_dom_mouse_event_get_client_y:
111 * @self: A #WebKitDOMMouseEvent
112 *
113 * Returns: A #glong
114 *
115 * Deprecated: 2.22: Use JavaScriptCore API instead
116**/
117WEBKIT_DEPRECATED glong
118webkit_dom_mouse_event_get_client_y(WebKitDOMMouseEvent* self);
119
120/**
121 * webkit_dom_mouse_event_get_ctrl_key:
122 * @self: A #WebKitDOMMouseEvent
123 *
124 * Returns: A #gboolean
125 *
126 * Deprecated: 2.22: Use JavaScriptCore API instead
127**/
128WEBKIT_DEPRECATED gboolean
129webkit_dom_mouse_event_get_ctrl_key(WebKitDOMMouseEvent* self);
130
131/**
132 * webkit_dom_mouse_event_get_shift_key:
133 * @self: A #WebKitDOMMouseEvent
134 *
135 * Returns: A #gboolean
136 *
137 * Deprecated: 2.22: Use JavaScriptCore API instead
138**/
139WEBKIT_DEPRECATED gboolean
140webkit_dom_mouse_event_get_shift_key(WebKitDOMMouseEvent* self);
141
142/**
143 * webkit_dom_mouse_event_get_alt_key:
144 * @self: A #WebKitDOMMouseEvent
145 *
146 * Returns: A #gboolean
147 *
148 * Deprecated: 2.22: Use JavaScriptCore API instead
149**/
150WEBKIT_DEPRECATED gboolean
151webkit_dom_mouse_event_get_alt_key(WebKitDOMMouseEvent* self);
152
153/**
154 * webkit_dom_mouse_event_get_meta_key:
155 * @self: A #WebKitDOMMouseEvent
156 *
157 * Returns: A #gboolean
158 *
159 * Deprecated: 2.22: Use JavaScriptCore API instead
160**/
161WEBKIT_DEPRECATED gboolean
162webkit_dom_mouse_event_get_meta_key(WebKitDOMMouseEvent* self);
163
164/**
165 * webkit_dom_mouse_event_get_button:
166 * @self: A #WebKitDOMMouseEvent
167 *
168 * Returns: A #gushort
169 *
170 * Deprecated: 2.22: Use JavaScriptCore API instead
171**/
172WEBKIT_DEPRECATED gushort
173webkit_dom_mouse_event_get_button(WebKitDOMMouseEvent* self);
174
175/**
176 * webkit_dom_mouse_event_get_related_target:
177 * @self: A #WebKitDOMMouseEvent
178 *
179 * Returns: (transfer full): A #WebKitDOMEventTarget
180 *
181 * Deprecated: 2.22: Use JavaScriptCore API instead
182**/
183WEBKIT_DEPRECATED WebKitDOMEventTarget*
184webkit_dom_mouse_event_get_related_target(WebKitDOMMouseEvent* self);
185
186/**
187 * webkit_dom_mouse_event_get_offset_x:
188 * @self: A #WebKitDOMMouseEvent
189 *
190 * Returns: A #glong
191 *
192 * Deprecated: 2.22: Use JavaScriptCore API instead
193**/
194WEBKIT_DEPRECATED glong
195webkit_dom_mouse_event_get_offset_x(WebKitDOMMouseEvent* self);
196
197/**
198 * webkit_dom_mouse_event_get_offset_y:
199 * @self: A #WebKitDOMMouseEvent
200 *
201 * Returns: A #glong
202 *
203 * Deprecated: 2.22: Use JavaScriptCore API instead
204**/
205WEBKIT_DEPRECATED glong
206webkit_dom_mouse_event_get_offset_y(WebKitDOMMouseEvent* self);
207
208/**
209 * webkit_dom_mouse_event_get_x:
210 * @self: A #WebKitDOMMouseEvent
211 *
212 * Returns: A #glong
213 *
214 * Deprecated: 2.22: Use JavaScriptCore API instead
215**/
216WEBKIT_DEPRECATED glong
217webkit_dom_mouse_event_get_x(WebKitDOMMouseEvent* self);
218
219/**
220 * webkit_dom_mouse_event_get_y:
221 * @self: A #WebKitDOMMouseEvent
222 *
223 * Returns: A #glong
224 *
225 * Deprecated: 2.22: Use JavaScriptCore API instead
226**/
227WEBKIT_DEPRECATED glong
228webkit_dom_mouse_event_get_y(WebKitDOMMouseEvent* self);
229
230/**
231 * webkit_dom_mouse_event_get_from_element:
232 * @self: A #WebKitDOMMouseEvent
233 *
234 * Returns: (transfer none): A #WebKitDOMNode
235 *
236 * Deprecated: 2.22: Use JavaScriptCore API instead
237**/
238WEBKIT_DEPRECATED WebKitDOMNode*
239webkit_dom_mouse_event_get_from_element(WebKitDOMMouseEvent* self);
240
241/**
242 * webkit_dom_mouse_event_get_to_element:
243 * @self: A #WebKitDOMMouseEvent
244 *
245 * Returns: (transfer none): A #WebKitDOMNode
246 *
247 * Deprecated: 2.22: Use JavaScriptCore API instead
248**/
249WEBKIT_DEPRECATED WebKitDOMNode*
250webkit_dom_mouse_event_get_to_element(WebKitDOMMouseEvent* self);
251
252G_END_DECLS
253
254#endif /* WebKitDOMMouseEvent_h */
255