gdkevents.h 20 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2
3
4
5
6
7
8
9
10
11
12
13
14
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16
17
18
19
20
21
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23
 */
Matthias Clasen's avatar
Matthias Clasen committed
24

25
26
27
#ifndef __GDK_EVENTS_H__
#define __GDK_EVENTS_H__

28
#if !defined (__GDK_H_INSIDE__) && !defined (GTK_COMPILATION)
29
30
31
#error "Only <gdk/gdk.h> can be included directly."
#endif

32
#include <gdk/gdkdevice.h>
33
#include <gdk/gdkdevicetool.h>
Benjamin Otte's avatar
Benjamin Otte committed
34
35
36
37
#include <gdk/gdkdrag.h>
#include <gdk/gdkenums.h>
#include <gdk/gdktypes.h>
#include <gdk/gdkversionmacros.h>
Owen Taylor's avatar
Started    
Owen Taylor committed
38

39
G_BEGIN_DECLS
Owen Taylor's avatar
Started    
Owen Taylor committed
40

41

42
#define GDK_TYPE_EVENT          (gdk_event_get_type ())
43
#define GDK_TYPE_EVENT_SEQUENCE (gdk_event_sequence_get_type ())
44

45
46
47
48
#define GDK_IS_EVENT(obj)       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_EVENT))
#define GDK_EVENT(obj)          (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_EVENT, GdkEvent))

#define GDK_IS_EVENT_TYPE(event, type)  (gdk_event_get_event_type ((event)) == (type))
49

50
/**
Emmanuele Bassi's avatar
Emmanuele Bassi committed
51
 * GDK_PRIORITY_EVENTS: (value 0)
52
 *
Matthias Clasen's avatar
Matthias Clasen committed
53
 * This is the priority that events from the X server are given in the main loop.
54
 */
55
#define GDK_PRIORITY_EVENTS	(G_PRIORITY_DEFAULT)
56
57

/**
58
 * GDK_PRIORITY_REDRAW: (value 120)
59
 *
60
 * This is the priority that the idle handler processing surface updates
Matthias Clasen's avatar
Matthias Clasen committed
61
 * is given in the main loop.
62
 */
63
64
#define GDK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
 * GDK_EVENT_PROPAGATE:
 *
 * Use this macro as the return value for continuing the propagation of
 * an event handler.
 */
#define GDK_EVENT_PROPAGATE     (FALSE)

/**
 * GDK_EVENT_STOP:
 *
 * Use this macro as the return value for stopping the propagation of
 * an event handler.
 */
#define GDK_EVENT_STOP          (TRUE)
Owen Taylor's avatar
Started    
Owen Taylor committed
80

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * GDK_BUTTON_PRIMARY:
 *
 * The primary button. This is typically the left mouse button, or the
 * right button in a left-handed setup.
 */
#define GDK_BUTTON_PRIMARY      (1)

/**
 * GDK_BUTTON_MIDDLE:
 *
 * The middle button.
 */
#define GDK_BUTTON_MIDDLE       (2)

/**
 * GDK_BUTTON_SECONDARY:
 *
 * The secondary button. This is typically the right mouse button, or the
 * left button in a left-handed setup.
 */
#define GDK_BUTTON_SECONDARY    (3)

104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
typedef struct _GdkEventSequence        GdkEventSequence;
typedef struct _GdkEvent                GdkEvent;

#define GDK_TYPE_BUTTON_EVENT (gdk_button_event_get_type())
#define GDK_TYPE_CROSSING_EVENT (gdk_crossing_event_get_type())
#define GDK_TYPE_DELETE_EVENT (gdk_delete_event_get_type())
#define GDK_TYPE_DND_EVENT (gdk_dnd_event_get_type())
#define GDK_TYPE_FOCUS_EVENT (gdk_focus_event_get_type())
#define GDK_TYPE_GRAB_BROKEN_EVENT (gdk_grab_broken_event_get_type())
#define GDK_TYPE_KEY_EVENT (gdk_key_event_get_type())
#define GDK_TYPE_MOTION_EVENT (gdk_motion_event_get_type())
#define GDK_TYPE_PAD_EVENT (gdk_pad_event_get_type())
#define GDK_TYPE_PROXIMITY_EVENT (gdk_proximity_event_get_type())
#define GDK_TYPE_SCROLL_EVENT (gdk_scroll_event_get_type())
#define GDK_TYPE_TOUCH_EVENT (gdk_touch_event_get_type())
#define GDK_TYPE_TOUCHPAD_EVENT (gdk_touchpad_event_get_type())

typedef struct _GdkButtonEvent          GdkButtonEvent;
typedef struct _GdkCrossingEvent        GdkCrossingEvent;
typedef struct _GdkDeleteEvent          GdkDeleteEvent;
typedef struct _GdkDNDEvent             GdkDNDEvent;
typedef struct _GdkFocusEvent           GdkFocusEvent;
typedef struct _GdkGrabBrokenEvent      GdkGrabBrokenEvent;
typedef struct _GdkKeyEvent             GdkKeyEvent;
typedef struct _GdkMotionEvent          GdkMotionEvent;
typedef struct _GdkPadEvent             GdkPadEvent;
typedef struct _GdkProximityEvent       GdkProximityEvent;
typedef struct _GdkScrollEvent          GdkScrollEvent;
typedef struct _GdkTouchEvent           GdkTouchEvent;
typedef struct _GdkTouchpadEvent        GdkTouchpadEvent;
Owen Taylor's avatar
Started    
Owen Taylor committed
134

135
136
/**
 * GdkEventType:
137
 * @GDK_DELETE: the window manager has requested that the toplevel surface be
138
139
140
141
142
143
144
 *   hidden or destroyed, usually when the user clicks on a special icon in the
 *   title bar.
 * @GDK_MOTION_NOTIFY: the pointer (usually a mouse) has moved.
 * @GDK_BUTTON_PRESS: a mouse button has been pressed.
 * @GDK_BUTTON_RELEASE: a mouse button has been released.
 * @GDK_KEY_PRESS: a key has been pressed.
 * @GDK_KEY_RELEASE: a key has been released.
145
146
147
 * @GDK_ENTER_NOTIFY: the pointer has entered the surface.
 * @GDK_LEAVE_NOTIFY: the pointer has left the surface.
 * @GDK_FOCUS_CHANGE: the keyboard focus has entered or left the surface.
148
149
150
151
 * @GDK_PROXIMITY_IN: an input device has moved into contact with a sensing
 *   surface (e.g. a touchscreen or graphics tablet).
 * @GDK_PROXIMITY_OUT: an input device has moved out of contact with a sensing
 *   surface.
152
153
154
 * @GDK_DRAG_ENTER: the mouse has entered the surface while a drag is in progress.
 * @GDK_DRAG_LEAVE: the mouse has left the surface while a drag is in progress.
 * @GDK_DRAG_MOTION: the mouse has moved in the surface while a drag is in
155
 *   progress.
156
 * @GDK_DROP_START: a drop operation onto the surface has started.
157
 * @GDK_SCROLL: the scroll wheel was turned
Matthias Clasen's avatar
Matthias Clasen committed
158
159
160
161
162
 * @GDK_GRAB_BROKEN: a pointer or keyboard grab was broken.
 * @GDK_TOUCH_BEGIN: A new touch event sequence has just started.
 * @GDK_TOUCH_UPDATE: A touch event sequence has been updated.
 * @GDK_TOUCH_END: A touch event sequence has finished.
 * @GDK_TOUCH_CANCEL: A touch event sequence has been canceled.
163
 * @GDK_TOUCHPAD_SWIPE: A touchpad swipe gesture event, the current state
Matthias Clasen's avatar
Matthias Clasen committed
164
 *   is determined by its phase field.
165
 * @GDK_TOUCHPAD_PINCH: A touchpad pinch gesture event, the current state
Matthias Clasen's avatar
Matthias Clasen committed
166
167
168
169
170
171
172
 *   is determined by its phase field.
 * @GDK_PAD_BUTTON_PRESS: A tablet pad button press event.
 * @GDK_PAD_BUTTON_RELEASE: A tablet pad button release event.
 * @GDK_PAD_RING: A tablet pad axis event from a "ring".
 * @GDK_PAD_STRIP: A tablet pad axis event from a "strip".
 * @GDK_PAD_GROUP_MODE: A tablet pad group mode change.
 * @GDK_EVENT_LAST: marks the end of the GdkEventType enumeration.
173
174
 *
 * Specifies the type of the event.
Owen Taylor's avatar
Started    
Owen Taylor committed
175
176
177
 */
typedef enum
{
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
  GDK_DELETE,
  GDK_MOTION_NOTIFY,
  GDK_BUTTON_PRESS,
  GDK_BUTTON_RELEASE,
  GDK_KEY_PRESS,
  GDK_KEY_RELEASE,
  GDK_ENTER_NOTIFY,
  GDK_LEAVE_NOTIFY,
  GDK_FOCUS_CHANGE,
  GDK_PROXIMITY_IN,
  GDK_PROXIMITY_OUT,
  GDK_DRAG_ENTER,
  GDK_DRAG_LEAVE,
  GDK_DRAG_MOTION,
  GDK_DROP_START,
  GDK_SCROLL,
  GDK_GRAB_BROKEN,
  GDK_TOUCH_BEGIN,
  GDK_TOUCH_UPDATE,
  GDK_TOUCH_END,
  GDK_TOUCH_CANCEL,
  GDK_TOUCHPAD_SWIPE,
  GDK_TOUCHPAD_PINCH,
  GDK_PAD_BUTTON_PRESS,
  GDK_PAD_BUTTON_RELEASE,
  GDK_PAD_RING,
  GDK_PAD_STRIP,
  GDK_PAD_GROUP_MODE,
206
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Started    
Owen Taylor committed
207
208
} GdkEventType;

209
210
211
212
213
214
215
216
217
/**
 * GdkTouchpadGesturePhase:
 * @GDK_TOUCHPAD_GESTURE_PHASE_BEGIN: The gesture has begun.
 * @GDK_TOUCHPAD_GESTURE_PHASE_UPDATE: The gesture has been updated.
 * @GDK_TOUCHPAD_GESTURE_PHASE_END: The gesture was finished, changes
 *   should be permanently applied.
 * @GDK_TOUCHPAD_GESTURE_PHASE_CANCEL: The gesture was cancelled, all
 *   changes should be undone.
 *
Matthias Clasen's avatar
Matthias Clasen committed
218
219
220
221
222
 * Specifies the current state of a touchpad gesture.
 *
 * All gestures are guaranteed to begin with an event with phase
 * %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events
 * with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE.
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 *
 * A finished gesture may have 2 possible outcomes, an event with phase
 * %GDK_TOUCHPAD_GESTURE_PHASE_END will be emitted when the gesture is
 * considered successful, this should be used as the hint to perform any
 * permanent changes.

 * Cancelled gestures may be so for a variety of reasons, due to hardware
 * or the compositor, or due to the gesture recognition layers hinting the
 * gesture did not finish resolutely (eg. a 3rd finger being added during
 * a pinch gesture). In these cases, the last event will report the phase
 * %GDK_TOUCHPAD_GESTURE_PHASE_CANCEL, this should be used as a hint
 * to undo any visible/permanent changes that were done throughout the
 * progress of the gesture.
 */
typedef enum
{
  GDK_TOUCHPAD_GESTURE_PHASE_BEGIN,
  GDK_TOUCHPAD_GESTURE_PHASE_UPDATE,
  GDK_TOUCHPAD_GESTURE_PHASE_END,
  GDK_TOUCHPAD_GESTURE_PHASE_CANCEL
} GdkTouchpadGesturePhase;

245
246
/**
 * GdkScrollDirection:
247
248
249
250
 * @GDK_SCROLL_UP: the surface is scrolled up.
 * @GDK_SCROLL_DOWN: the surface is scrolled down.
 * @GDK_SCROLL_LEFT: the surface is scrolled to the left.
 * @GDK_SCROLL_RIGHT: the surface is scrolled to the right.
251
 * @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values
252
 *   in scroll events. See gdk_scroll_event_get_deltas()
253
 *
254
 * Specifies the direction for scroll events.
255
 */
256
257
258
259
260
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
261
262
  GDK_SCROLL_RIGHT,
  GDK_SCROLL_SMOOTH
263
264
} GdkScrollDirection;

265
266
/**
 * GdkNotifyType:
267
 * @GDK_NOTIFY_ANCESTOR: the surface is entered from an ancestor or
268
269
 *   left towards an ancestor.
 * @GDK_NOTIFY_VIRTUAL: the pointer moves between an ancestor and an
270
271
 *   inferior of the surface.
 * @GDK_NOTIFY_INFERIOR: the surface is entered from an inferior or
272
 *   left towards an inferior.
273
274
275
276
277
 * @GDK_NOTIFY_NONLINEAR: the surface is entered from or left towards
 *   a surface which is neither an ancestor nor an inferior.
 * @GDK_NOTIFY_NONLINEAR_VIRTUAL: the pointer moves between two surfaces
 *   which are not ancestors of each other and the surface is part of
 *   the ancestor chain between one of these surfaces and their least
278
279
280
 *   common ancestor.
 * @GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred.
 *
281
 * Specifies the kind of crossing for enter and leave events.
282
 *
283
 * See the X11 protocol specification of LeaveNotify for
284
 * full details of crossing event generation.
Owen Taylor's avatar
Started    
Owen Taylor committed
285
286
287
288
289
290
291
292
293
294
295
 */
typedef enum
{
  GDK_NOTIFY_ANCESTOR		= 0,
  GDK_NOTIFY_VIRTUAL		= 1,
  GDK_NOTIFY_INFERIOR		= 2,
  GDK_NOTIFY_NONLINEAR		= 3,
  GDK_NOTIFY_NONLINEAR_VIRTUAL	= 4,
  GDK_NOTIFY_UNKNOWN		= 5
} GdkNotifyType;

296
297
298
299
300
/**
 * GdkCrossingMode:
 * @GDK_CROSSING_NORMAL: crossing because of pointer motion.
 * @GDK_CROSSING_GRAB: crossing because a grab is activated.
 * @GDK_CROSSING_UNGRAB: crossing because a grab is deactivated.
Matthias Clasen's avatar
Matthias Clasen committed
301
302
303
 * @GDK_CROSSING_GTK_GRAB: crossing because a GTK grab is activated.
 * @GDK_CROSSING_GTK_UNGRAB: crossing because a GTK grab is deactivated.
 * @GDK_CROSSING_STATE_CHANGED: crossing because a GTK widget changed
304
 *   state (e.g. sensitivity).
305
 * @GDK_CROSSING_TOUCH_BEGIN: crossing because a touch sequence has begun,
306
 *   this event is synthetic as the pointer might have not left the surface.
307
 * @GDK_CROSSING_TOUCH_END: crossing because a touch sequence has ended,
308
 *   this event is synthetic as the pointer might have not left the surface.
309
310
 * @GDK_CROSSING_DEVICE_SWITCH: crossing because of a device switch (i.e.
 *   a mouse taking control of the pointer after a touch device), this event
311
 *   is synthetic as the pointer didn’t leave the surface.
312
 *
313
 * Specifies the crossing mode for enter and leave events.
Owen Taylor's avatar
Started    
Owen Taylor committed
314
315
316
317
318
 */
typedef enum
{
  GDK_CROSSING_NORMAL,
  GDK_CROSSING_GRAB,
319
320
321
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
322
323
324
325
  GDK_CROSSING_STATE_CHANGED,
  GDK_CROSSING_TOUCH_BEGIN,
  GDK_CROSSING_TOUCH_END,
  GDK_CROSSING_DEVICE_SWITCH
Owen Taylor's avatar
Started    
Owen Taylor committed
326
327
} GdkCrossingMode;

328
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
329
GType                   gdk_event_get_type              (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
330
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
331
GType                   gdk_event_sequence_get_type     (void) G_GNUC_CONST;
332

333
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
334
GdkEvent *              gdk_event_ref                   (GdkEvent *event);
335
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
336
void                    gdk_event_unref                 (GdkEvent *event);
337

Matthias Clasen's avatar
Matthias Clasen committed
338
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
339
GdkEventType            gdk_event_get_event_type        (GdkEvent *event);
340

341
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
342
343
GdkSurface *            gdk_event_get_surface           (GdkEvent *event);

344
345
346
GDK_AVAILABLE_IN_ALL
GdkSeat *               gdk_event_get_seat              (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
347
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
348
GdkDevice *             gdk_event_get_device            (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
349

Matthias Clasen's avatar
Matthias Clasen committed
350
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
351
352
GdkDeviceTool *         gdk_event_get_device_tool       (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
353
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
354
guint32                 gdk_event_get_time              (GdkEvent *event);
355

Matthias Clasen's avatar
Matthias Clasen committed
356
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
357
358
GdkDisplay *            gdk_event_get_display           (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
359
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
360
GdkEventSequence *      gdk_event_get_event_sequence    (GdkEvent *event);
361

Matthias Clasen's avatar
Matthias Clasen committed
362
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
363
GdkModifierType         gdk_event_get_modifier_state    (GdkEvent *event);
364

365
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
366
367
368
gboolean                gdk_event_get_position          (GdkEvent  *event,
					                 double	   *x,
					                 double	   *y);
369
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
370
371
372
gboolean                gdk_event_get_axes              (GdkEvent  *event,
                                                         double   **axes,
                                                         guint     *n_axes);
373
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
374
375
376
gboolean                gdk_event_get_axis              (GdkEvent   *event,
                                                         GdkAxisUse  axis_use,
                                                         double     *value);
Matthias Clasen's avatar
Matthias Clasen committed
377
GDK_AVAILABLE_IN_ALL
378
379
380
GdkTimeCoord *          gdk_event_get_history           (GdkEvent *event,
                                                         guint    *out_n_coords);
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
381
gboolean                gdk_event_get_pointer_emulated (GdkEvent *event);
382

383
384
GDK_AVAILABLE_IN_ALL
GType                   gdk_button_event_get_type       (void) G_GNUC_CONST;
385
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
386
guint                   gdk_button_event_get_button     (GdkEvent *event);
387
GDK_AVAILABLE_IN_ALL
388
389
GType                   gdk_scroll_event_get_type       (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
390
GdkScrollDirection      gdk_scroll_event_get_direction  (GdkEvent *event);
391
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
392
393
394
void                    gdk_scroll_event_get_deltas     (GdkEvent *event,
                                                         double   *delta_x,
                                                         double   *delta_y);
Matthias Clasen's avatar
Matthias Clasen committed
395

Matthias Clasen's avatar
Matthias Clasen committed
396
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
397
gboolean                gdk_scroll_event_is_stop        (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
398
GDK_AVAILABLE_IN_ALL
399
400
GType                   gdk_key_event_get_type          (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
401
guint                   gdk_key_event_get_keyval        (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
402
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
403
guint                   gdk_key_event_get_keycode       (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
404
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
405
GdkModifierType         gdk_key_event_get_consumed_modifiers (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
406
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
407
408
409
guint                   gdk_key_event_get_layout        (GdkEvent *event);
GDK_AVAILABLE_IN_ALL
guint                   gdk_key_event_get_level         (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
410
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
411
gboolean                gdk_key_event_is_modifier       (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
412
GDK_AVAILABLE_IN_ALL
413
414
GType                   gdk_focus_event_get_type        (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
415
gboolean                gdk_focus_event_get_in          (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
416
GDK_AVAILABLE_IN_ALL
417
418
GType                   gdk_touch_event_get_type        (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
419
gboolean                gdk_touch_event_get_emulating_pointer (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
420
GDK_AVAILABLE_IN_ALL
421
422
GType                   gdk_crossing_event_get_type     (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
423
GdkCrossingMode         gdk_crossing_event_get_mode     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
424
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
425
GdkNotifyType           gdk_crossing_event_get_detail   (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
426
GDK_AVAILABLE_IN_ALL
427
428
429
430
gboolean                gdk_crossing_event_get_focus    (GdkEvent *event);
GDK_AVAILABLE_IN_ALL
GType                   gdk_touchpad_event_get_type     (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
431
432
GdkTouchpadGesturePhase
                        gdk_touchpad_event_get_gesture_phase (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
433
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
434
guint                   gdk_touchpad_event_get_n_fingers     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
435
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
436
437
438
void                    gdk_touchpad_event_get_deltas        (GdkEvent *event,
                                                              double   *dx,
                                                              double   *dy);
Matthias Clasen's avatar
Matthias Clasen committed
439
GDK_AVAILABLE_IN_ALL
440
441
442
443
444
445
446
double                  gdk_touchpad_event_get_pinch_angle_delta (GdkEvent *event);
GDK_AVAILABLE_IN_ALL
double                  gdk_touchpad_event_get_pinch_scale       (GdkEvent *event);
GDK_AVAILABLE_IN_ALL
GType                   gdk_pad_event_get_type          (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
guint                   gdk_pad_event_get_button        (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
447
GDK_AVAILABLE_IN_ALL
448
449
450
void                    gdk_pad_event_get_axis_value    (GdkEvent *event,
                                                         guint    *index,
                                                         double   *value);
Matthias Clasen's avatar
Matthias Clasen committed
451
GDK_AVAILABLE_IN_ALL
452
453
454
void                    gdk_pad_event_get_group_mode    (GdkEvent *event,
                                                         guint    *group,
                                                         guint    *mode);
Matthias Clasen's avatar
Matthias Clasen committed
455
GDK_AVAILABLE_IN_ALL
456
GType                   gdk_dnd_event_get_type          (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
457
GDK_AVAILABLE_IN_ALL
458
GdkDrop *               gdk_dnd_event_get_drop          (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
459
GDK_AVAILABLE_IN_ALL
460
GType                   gdk_grab_broken_event_get_type  (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
461
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
462
GdkSurface *            gdk_grab_broken_event_get_grab_surface (GdkEvent *event);
463
464
GDK_AVAILABLE_IN_ALL
gboolean                gdk_grab_broken_event_get_implicit     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
465
466

GDK_AVAILABLE_IN_ALL
467
468
469
470
471
472
GType                   gdk_motion_event_get_type       (void) G_GNUC_CONST;

GDK_AVAILABLE_IN_ALL
GType                   gdk_delete_event_get_type       (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
GType                   gdk_proximity_event_get_type    (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
473
474
475
476

GDK_AVAILABLE_IN_ALL
gboolean                gdk_event_triggers_context_menu (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
477
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
478
479
480
gboolean                gdk_events_get_distance         (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *distance);
Matthias Clasen's avatar
Matthias Clasen committed
481
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
482
483
484
gboolean                gdk_events_get_angle            (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *angle);
485
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
486
487
488
489
gboolean                gdk_events_get_center           (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *x,
                                                         double   *y);
490

Matthias Clasen's avatar
Matthias Clasen committed
491
/**
Matthias Clasen's avatar
Matthias Clasen committed
492
493
494
 * GdkKeyMatch:
 * @GDK_KEY_MATCH_NONE: The key event does not match
 * @GDK_KEY_MATCH_PARTIAL: The key event matches if keyboard state
Matthias Clasen's avatar
Matthias Clasen committed
495
 *   (specifically, the currently active group) is ignored
Matthias Clasen's avatar
Matthias Clasen committed
496
 * @GDK_KEY_MATCH_EXACT: The key event matches
Matthias Clasen's avatar
Matthias Clasen committed
497
 *
Matthias Clasen's avatar
Matthias Clasen committed
498
499
500
 * Describes how well an event matches a given keyval and modifiers.
 *
 * `GdkKeyMatch` values are returned by [method@Gdk.KeyEvent.matches].
Matthias Clasen's avatar
Matthias Clasen committed
501
 */
Matthias Clasen's avatar
Matthias Clasen committed
502
typedef enum {
Matthias Clasen's avatar
Matthias Clasen committed
503
504
505
506
  GDK_KEY_MATCH_NONE,
  GDK_KEY_MATCH_PARTIAL,
  GDK_KEY_MATCH_EXACT
} GdkKeyMatch;
Matthias Clasen's avatar
Matthias Clasen committed
507
508

GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
509
510
511
GdkKeyMatch            gdk_key_event_matches (GdkEvent        *event,
                                              guint            keyval,
                                              GdkModifierType  modifiers);
Matthias Clasen's avatar
Matthias Clasen committed
512

Matthias Clasen's avatar
Matthias Clasen committed
513
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
514
515
516
gboolean               gdk_key_event_get_match (GdkEvent        *event,
                                                guint           *keyval,
                                                GdkModifierType *modifiers);
Matthias Clasen's avatar
Matthias Clasen committed
517

518
G_END_DECLS
Owen Taylor's avatar
Started    
Owen Taylor committed
519
520

#endif /* __GDK_EVENTS_H__ */