gdkevents.h 21.4 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
 *   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.
172
173
 * @GDK_TOUCHPAD_HOLD: A touchpad hold gesture event, the current state
 *   is determined by its phase field. Since: 4.6
Matthias Clasen's avatar
Matthias Clasen committed
174
 * @GDK_EVENT_LAST: marks the end of the GdkEventType enumeration.
175
176
 *
 * Specifies the type of the event.
Owen Taylor's avatar
Started  
Owen Taylor committed
177
178
179
 */
typedef enum
{
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
206
207
  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,
208
  GDK_TOUCHPAD_HOLD,
209
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Started  
Owen Taylor committed
210
211
} GdkEventType;

212
213
214
215
216
217
218
219
220
/**
 * 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
221
222
223
224
225
 * 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.
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 *
 * 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;

248
249
/**
 * GdkScrollDirection:
250
251
252
253
 * @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.
254
 * @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values
255
 *   in scroll events. See gdk_scroll_event_get_deltas()
256
 *
257
 * Specifies the direction for scroll events.
258
 */
259
260
261
262
263
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
264
265
  GDK_SCROLL_RIGHT,
  GDK_SCROLL_SMOOTH
266
267
} GdkScrollDirection;

268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/**
 * GdkScrollUnit:
 * @GDK_SCROLL_UNIT_WHEEL: The delta is in number of wheel clicks.
 * @GDK_SCROLL_UNIT_SURFACE: The delta is in surface pixels to scroll directly
 *   on screen.
 *
 * Specifies the unit of scroll deltas.
 *
 * When you get %GDK_SCROLL_UNIT_WHEEL, a delta of 1.0 means 1 wheel detent
 * click in the south direction, 2.0 means 2 wheel detent clicks in the south
 * direction... This is the same logic for negative values but in the north
 * direction.
 *
 * If you get %GDK_SCROLL_UNIT_SURFACE, are managing a scrollable view and get a
 * value of 123, you have to scroll 123 surface logical pixels right if it's
 * @delta_x or down if it's @delta_y. This is the same logic for negative values
 * but you have to scroll left instead of right if it's @delta_x and up instead
 * of down if it's @delta_y.
 *
 * 1 surface logical pixel is equal to 1 real screen pixel multiplied by the
 * final scale factor of your graphical interface (the product of the desktop
 * scale factor and eventually a custom scale factor in your app).
 *
 * Since: 4.8
 */
typedef enum
{
  GDK_SCROLL_UNIT_WHEEL,
  GDK_SCROLL_UNIT_SURFACE
} GdkScrollUnit;

299
300
/**
 * GdkNotifyType:
301
 * @GDK_NOTIFY_ANCESTOR: the surface is entered from an ancestor or
302
303
 *   left towards an ancestor.
 * @GDK_NOTIFY_VIRTUAL: the pointer moves between an ancestor and an
304
305
 *   inferior of the surface.
 * @GDK_NOTIFY_INFERIOR: the surface is entered from an inferior or
306
 *   left towards an inferior.
307
308
309
310
311
 * @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
312
313
314
 *   common ancestor.
 * @GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred.
 *
315
 * Specifies the kind of crossing for enter and leave events.
316
 *
317
 * See the X11 protocol specification of LeaveNotify for
318
 * full details of crossing event generation.
Owen Taylor's avatar
Started  
Owen Taylor committed
319
320
321
322
323
324
325
326
327
328
329
 */
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;

330
331
332
333
334
/**
 * 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
335
336
337
 * @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
338
 *   state (e.g. sensitivity).
339
 * @GDK_CROSSING_TOUCH_BEGIN: crossing because a touch sequence has begun,
340
 *   this event is synthetic as the pointer might have not left the surface.
341
 * @GDK_CROSSING_TOUCH_END: crossing because a touch sequence has ended,
342
 *   this event is synthetic as the pointer might have not left the surface.
343
344
 * @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
345
 *   is synthetic as the pointer didn’t leave the surface.
346
 *
347
 * Specifies the crossing mode for enter and leave events.
Owen Taylor's avatar
Started  
Owen Taylor committed
348
349
350
351
352
 */
typedef enum
{
  GDK_CROSSING_NORMAL,
  GDK_CROSSING_GRAB,
353
354
355
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
356
357
358
359
  GDK_CROSSING_STATE_CHANGED,
  GDK_CROSSING_TOUCH_BEGIN,
  GDK_CROSSING_TOUCH_END,
  GDK_CROSSING_DEVICE_SWITCH
Owen Taylor's avatar
Started  
Owen Taylor committed
360
361
} GdkCrossingMode;

362
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
363
GType                   gdk_event_get_type              (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
364
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
365
GType                   gdk_event_sequence_get_type     (void) G_GNUC_CONST;
366

367
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
368
GdkEvent *              gdk_event_ref                   (GdkEvent *event);
369
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
370
void                    gdk_event_unref                 (GdkEvent *event);
371

Matthias Clasen's avatar
Matthias Clasen committed
372
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
373
GdkEventType            gdk_event_get_event_type        (GdkEvent *event);
374

375
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
376
377
GdkSurface *            gdk_event_get_surface           (GdkEvent *event);

378
379
380
GDK_AVAILABLE_IN_ALL
GdkSeat *               gdk_event_get_seat              (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
381
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
382
GdkDevice *             gdk_event_get_device            (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
383

Matthias Clasen's avatar
Matthias Clasen committed
384
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
385
386
GdkDeviceTool *         gdk_event_get_device_tool       (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
387
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
388
guint32                 gdk_event_get_time              (GdkEvent *event);
389

Matthias Clasen's avatar
Matthias Clasen committed
390
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
391
392
GdkDisplay *            gdk_event_get_display           (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
393
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
394
GdkEventSequence *      gdk_event_get_event_sequence    (GdkEvent *event);
395

Matthias Clasen's avatar
Matthias Clasen committed
396
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
397
GdkModifierType         gdk_event_get_modifier_state    (GdkEvent *event);
398

399
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
400
401
402
gboolean                gdk_event_get_position          (GdkEvent  *event,
					                 double	   *x,
					                 double	   *y);
403
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
404
405
406
gboolean                gdk_event_get_axes              (GdkEvent  *event,
                                                         double   **axes,
                                                         guint     *n_axes);
407
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
408
409
410
gboolean                gdk_event_get_axis              (GdkEvent   *event,
                                                         GdkAxisUse  axis_use,
                                                         double     *value);
Matthias Clasen's avatar
Matthias Clasen committed
411
GDK_AVAILABLE_IN_ALL
412
413
414
GdkTimeCoord *          gdk_event_get_history           (GdkEvent *event,
                                                         guint    *out_n_coords);
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
415
gboolean                gdk_event_get_pointer_emulated (GdkEvent *event);
416

417
418
GDK_AVAILABLE_IN_ALL
GType                   gdk_button_event_get_type       (void) G_GNUC_CONST;
419
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
420
guint                   gdk_button_event_get_button     (GdkEvent *event);
421
GDK_AVAILABLE_IN_ALL
422
423
GType                   gdk_scroll_event_get_type       (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
424
GdkScrollDirection      gdk_scroll_event_get_direction  (GdkEvent *event);
425
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
426
427
428
void                    gdk_scroll_event_get_deltas     (GdkEvent *event,
                                                         double   *delta_x,
                                                         double   *delta_y);
429
430
GDK_AVAILABLE_IN_4_8
GdkScrollUnit           gdk_scroll_event_get_unit       (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
431

Matthias Clasen's avatar
Matthias Clasen committed
432
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
433
gboolean                gdk_scroll_event_is_stop        (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
434
GDK_AVAILABLE_IN_ALL
435
436
GType                   gdk_key_event_get_type          (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
437
guint                   gdk_key_event_get_keyval        (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
438
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
439
guint                   gdk_key_event_get_keycode       (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
440
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
441
GdkModifierType         gdk_key_event_get_consumed_modifiers (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
442
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
443
444
445
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
446
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
447
gboolean                gdk_key_event_is_modifier       (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
448
GDK_AVAILABLE_IN_ALL
449
450
GType                   gdk_focus_event_get_type        (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
451
gboolean                gdk_focus_event_get_in          (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
452
GDK_AVAILABLE_IN_ALL
453
454
GType                   gdk_touch_event_get_type        (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
455
gboolean                gdk_touch_event_get_emulating_pointer (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
456
GDK_AVAILABLE_IN_ALL
457
458
GType                   gdk_crossing_event_get_type     (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
459
GdkCrossingMode         gdk_crossing_event_get_mode     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
460
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
461
GdkNotifyType           gdk_crossing_event_get_detail   (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
462
GDK_AVAILABLE_IN_ALL
463
464
465
466
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
467
468
GdkTouchpadGesturePhase
                        gdk_touchpad_event_get_gesture_phase (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
469
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
470
guint                   gdk_touchpad_event_get_n_fingers     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
471
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
472
473
474
void                    gdk_touchpad_event_get_deltas        (GdkEvent *event,
                                                              double   *dx,
                                                              double   *dy);
Matthias Clasen's avatar
Matthias Clasen committed
475
GDK_AVAILABLE_IN_ALL
476
477
478
479
480
481
482
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
483
GDK_AVAILABLE_IN_ALL
484
485
486
void                    gdk_pad_event_get_axis_value    (GdkEvent *event,
                                                         guint    *index,
                                                         double   *value);
Matthias Clasen's avatar
Matthias Clasen committed
487
GDK_AVAILABLE_IN_ALL
488
489
490
void                    gdk_pad_event_get_group_mode    (GdkEvent *event,
                                                         guint    *group,
                                                         guint    *mode);
Matthias Clasen's avatar
Matthias Clasen committed
491
GDK_AVAILABLE_IN_ALL
492
GType                   gdk_dnd_event_get_type          (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
493
GDK_AVAILABLE_IN_ALL
494
GdkDrop *               gdk_dnd_event_get_drop          (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
495
GDK_AVAILABLE_IN_ALL
496
GType                   gdk_grab_broken_event_get_type  (void) G_GNUC_CONST;
Matthias Clasen's avatar
Matthias Clasen committed
497
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
498
GdkSurface *            gdk_grab_broken_event_get_grab_surface (GdkEvent *event);
499
500
GDK_AVAILABLE_IN_ALL
gboolean                gdk_grab_broken_event_get_implicit     (GdkEvent *event);
Matthias Clasen's avatar
Matthias Clasen committed
501
502

GDK_AVAILABLE_IN_ALL
503
504
505
506
507
508
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
509
510
511
512

GDK_AVAILABLE_IN_ALL
gboolean                gdk_event_triggers_context_menu (GdkEvent *event);

Matthias Clasen's avatar
Matthias Clasen committed
513
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
514
515
516
gboolean                gdk_events_get_distance         (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *distance);
Matthias Clasen's avatar
Matthias Clasen committed
517
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
518
519
520
gboolean                gdk_events_get_angle            (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *angle);
521
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
522
523
524
525
gboolean                gdk_events_get_center           (GdkEvent *event1,
                                                         GdkEvent *event2,
                                                         double   *x,
                                                         double   *y);
526

Matthias Clasen's avatar
Matthias Clasen committed
527
/**
Matthias Clasen's avatar
Matthias Clasen committed
528
529
530
 * 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
531
 *   (specifically, the currently active group) is ignored
Matthias Clasen's avatar
Matthias Clasen committed
532
 * @GDK_KEY_MATCH_EXACT: The key event matches
Matthias Clasen's avatar
Matthias Clasen committed
533
 *
Matthias Clasen's avatar
Matthias Clasen committed
534
535
536
 * 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
537
 */
Matthias Clasen's avatar
Matthias Clasen committed
538
typedef enum {
Matthias Clasen's avatar
Matthias Clasen committed
539
540
541
542
  GDK_KEY_MATCH_NONE,
  GDK_KEY_MATCH_PARTIAL,
  GDK_KEY_MATCH_EXACT
} GdkKeyMatch;
Matthias Clasen's avatar
Matthias Clasen committed
543
544

GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
545
546
547
GdkKeyMatch            gdk_key_event_matches (GdkEvent        *event,
                                              guint            keyval,
                                              GdkModifierType  modifiers);
Matthias Clasen's avatar
Matthias Clasen committed
548

Matthias Clasen's avatar
Matthias Clasen committed
549
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
550
551
552
gboolean               gdk_key_event_get_match (GdkEvent        *event,
                                                guint           *keyval,
                                                GdkModifierType *modifiers);
Matthias Clasen's avatar
Matthias Clasen committed
553

554
G_END_DECLS
Owen Taylor's avatar
Started  
Owen Taylor committed
555
556

#endif /* __GDK_EVENTS_H__ */