gdkevents.h 44.1 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 Jardon's avatar
Javier Jardon 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 (GDK_COMPILATION)
29 30 31
#error "Only <gdk/gdk.h> can be included directly."
#endif

32
#include <gdk/gdkversionmacros.h>
33
#include <gdk/gdkcolor.h>
Owen Taylor's avatar
Started  
Owen Taylor committed
34 35
#include <gdk/gdktypes.h>
#include <gdk/gdkdnd.h>
36
#include <gdk/gdkdevice.h>
Owen Taylor's avatar
Started  
Owen Taylor committed
37

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

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

/**
 * SECTION:event_structs
 * @Short_description: Data structures specific to each type of event
 * @Title: Event Structures
 *
 * The event structs contain data specific to each type of event in GDK.
 *
 * <note>
 * <para>
 * A common mistake is to forget to set the event mask of a widget so that
 * the required events are received. See gtk_widget_set_events().
 * </para>
 * </note>
 */


57 58
#define GDK_TYPE_EVENT          (gdk_event_get_type ())

59 60 61 62 63 64
/**
 * GDK_PRIORITY_EVENTS:
 *
 * This is the priority that events from the X server are given in the
 * <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 */
65
#define GDK_PRIORITY_EVENTS	(G_PRIORITY_DEFAULT)
66 67 68 69 70 71 72 73

/**
 * GDK_PRIORITY_REDRAW:
 *
 * This is the priority that the idle handler processing window updates
 * is given in the
 * <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 */
74 75
#define GDK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
/**
 * GDK_EVENT_PROPAGATE:
 *
 * Use this macro as the return value for continuing the propagation of
 * an event handler.
 *
 * Since: 3.4
 */
#define GDK_EVENT_PROPAGATE     (FALSE)

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

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
/**
 * GDK_BUTTON_PRIMARY:
 *
 * The primary button. This is typically the left mouse button, or the
 * right button in a left-handed setup.
 *
 * Since: 3.4
 */
#define GDK_BUTTON_PRIMARY      (1)

/**
 * GDK_BUTTON_MIDDLE:
 *
 * The middle button.
 *
 * Since: 3.4
 */
#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.
 *
 * Since: 3.4
 */
#define GDK_BUTTON_SECONDARY    (3)



Owen Taylor's avatar
Started  
Owen Taylor committed
127 128 129 130 131
typedef struct _GdkEventAny	    GdkEventAny;
typedef struct _GdkEventExpose	    GdkEventExpose;
typedef struct _GdkEventVisibility  GdkEventVisibility;
typedef struct _GdkEventMotion	    GdkEventMotion;
typedef struct _GdkEventButton	    GdkEventButton;
132
typedef struct _GdkEventTouch       GdkEventTouch;
133
typedef struct _GdkEventScroll      GdkEventScroll;  
Owen Taylor's avatar
Started  
Owen Taylor committed
134 135 136 137 138 139
typedef struct _GdkEventKey	    GdkEventKey;
typedef struct _GdkEventFocus	    GdkEventFocus;
typedef struct _GdkEventCrossing    GdkEventCrossing;
typedef struct _GdkEventConfigure   GdkEventConfigure;
typedef struct _GdkEventProperty    GdkEventProperty;
typedef struct _GdkEventSelection   GdkEventSelection;
Matthias Clasen's avatar
Matthias Clasen committed
140
typedef struct _GdkEventOwnerChange GdkEventOwnerChange;
Owen Taylor's avatar
Started  
Owen Taylor committed
141 142
typedef struct _GdkEventProximity   GdkEventProximity;
typedef struct _GdkEventDND         GdkEventDND;
Havoc Pennington's avatar
Havoc Pennington committed
143
typedef struct _GdkEventWindowState GdkEventWindowState;
144
typedef struct _GdkEventSetting     GdkEventSetting;
145
typedef struct _GdkEventGrabBroken  GdkEventGrabBroken;
Owen Taylor's avatar
Started  
Owen Taylor committed
146

Carlos Garnacho's avatar
Carlos Garnacho committed
147 148
typedef struct _GdkEventSequence    GdkEventSequence;

Owen Taylor's avatar
Started  
Owen Taylor committed
149 150
typedef union  _GdkEvent	    GdkEvent;

151 152 153
/**
 * GdkEventFunc:
 * @event: the #GdkEvent to process.
154
 * @data: (closure): user data set when the event handler was installed with
155 156 157 158 159
 *   gdk_event_handler_set().
 *
 * Specifies the type of function passed to gdk_event_handler_set() to
 * handle all GDK events.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
160 161 162 163 164
typedef void (*GdkEventFunc) (GdkEvent *event,
			      gpointer	data);

/* Event filtering */

165 166 167 168 169 170
/**
 * GdkXEvent:
 *
 * Used to represent native events (<type>XEvent</type>s for the X11
 * backend, <type>MSG</type>s for Win32).
 */
171 172 173
typedef void GdkXEvent;	  /* Can be cast to window system specific
			   * even type, XEvent on X11, MSG on Win32.
			   */
Owen Taylor's avatar
Started  
Owen Taylor committed
174

175 176 177 178 179 180 181 182 183
/**
 * GdkFilterReturn:
 * @GDK_FILTER_CONTINUE: event not handled, continue processing.
 * @GDK_FILTER_TRANSLATE: native event translated into a GDK event and stored
 *  in the <literal>event</literal> structure that was passed in.
 * @GDK_FILTER_REMOVE: event handled, terminate processing.
 *
 * Specifies the result of applying a #GdkFilterFunc to a native event.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
184 185
typedef enum {
  GDK_FILTER_CONTINUE,	  /* Event not handled, continue processesing */
186 187 188
  GDK_FILTER_TRANSLATE,	  /* Native event translated into a GDK event and
                             stored in the "event" structure that was
                             passed in */
Owen Taylor's avatar
Started  
Owen Taylor committed
189 190 191
  GDK_FILTER_REMOVE	  /* Terminate processing, removing event */
} GdkFilterReturn;

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
/**
 * GdkFilterFunc:
 * @xevent: the native event to filter.
 * @event: the GDK event to which the X event will be translated.
 * @data: user data set when the filter was installed.
 *
 * Specifies the type of function used to filter native events before they are
 * converted to GDK events.
 *
 * When a filter is called, @event is unpopulated, except for
 * <literal>event->window</literal>. The filter may translate the native
 * event to a GDK event and store the result in @event, or handle it without
 * translation. If the filter translates the event and processing should
 * continue, it should return %GDK_FILTER_TRANSLATE.
 *
 * Returns: a #GdkFilterReturn value.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
209 210 211 212 213
typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
					  GdkEvent *event,
					  gpointer  data);


214 215 216 217 218 219 220 221 222 223 224 225 226 227
/**
 * GdkEventType:
 * @GDK_NOTHING: a special code to indicate a null event.
 * @GDK_DELETE: the window manager has requested that the toplevel window be
 *   hidden or destroyed, usually when the user clicks on a special icon in the
 *   title bar.
 * @GDK_DESTROY: the window has been destroyed.
 * @GDK_EXPOSE: all or part of the window has become visible and needs to be
 *   redrawn.
 * @GDK_MOTION_NOTIFY: the pointer (usually a mouse) has moved.
 * @GDK_BUTTON_PRESS: a mouse button has been pressed.
 * @GDK_2BUTTON_PRESS: a mouse button has been double-clicked (clicked twice
 *   within a short period of time). Note that each click also generates a
 *   %GDK_BUTTON_PRESS event.
228
 * @GDK_DOUBLE_BUTTON_PRESS: alias for %GDK_2BUTTON_PRESS, added in 3.6.
229 230
 * @GDK_3BUTTON_PRESS: a mouse button has been clicked 3 times in a short period
 *   of time. Note that each click also generates a %GDK_BUTTON_PRESS event.
231
 * @GDK_TRIPLE_BUTTON_PRESS: alias for %GDK_3BUTTON_PRESS, added in 3.6.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
 * @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.
 * @GDK_ENTER_NOTIFY: the pointer has entered the window.
 * @GDK_LEAVE_NOTIFY: the pointer has left the window.
 * @GDK_FOCUS_CHANGE: the keyboard focus has entered or left the window.
 * @GDK_CONFIGURE: the size, position or stacking order of the window has changed.
 *   Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows.
 * @GDK_MAP: the window has been mapped.
 * @GDK_UNMAP: the window has been unmapped.
 * @GDK_PROPERTY_NOTIFY: a property on the window has been changed or deleted.
 * @GDK_SELECTION_CLEAR: the application has lost ownership of a selection.
 * @GDK_SELECTION_REQUEST: another application has requested a selection.
 * @GDK_SELECTION_NOTIFY: a selection has been received.
 * @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.
 * @GDK_DRAG_ENTER: the mouse has entered the window while a drag is in progress.
 * @GDK_DRAG_LEAVE: the mouse has left the window while a drag is in progress.
 * @GDK_DRAG_MOTION: the mouse has moved in the window while a drag is in
 *   progress.
 * @GDK_DRAG_STATUS: the status of the drag operation initiated by the window
 *   has changed.
 * @GDK_DROP_START: a drop operation onto the window has started.
 * @GDK_DROP_FINISHED: the drop operation initiated by the window has completed.
 * @GDK_CLIENT_EVENT: a message has been received from another application.
 * @GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
 * @GDK_SCROLL: the scroll wheel was turned
 * @GDK_WINDOW_STATE: the state of a window has changed. See #GdkWindowState
 *   for the possible window states
 * @GDK_SETTING: a setting has been modified.
 * @GDK_OWNER_CHANGE: the owner of a selection has changed. This event type
 *   was added in 2.6
 * @GDK_GRAB_BROKEN: a pointer or keyboard grab was broken. This event type
 *   was added in 2.8.
 * @GDK_DAMAGE: the content of the window has been changed. This event type
 *   was added in 2.14.
270 271 272 273 274 275 276 277
 * @GDK_TOUCH_BEGIN: A new touch event sequence has just started. This event
 *   type was added in 3.4.
 * @GDK_TOUCH_UPDATE: A touch event sequence has been updated. This event type
 *   was added in 3.4.
 * @GDK_TOUCH_END: A touch event sequence has finished. This event type
 *   was added in 3.4.
 * @GDK_TOUCH_CANCEL: A touch event sequence has been canceled. This event type
 *   was added in 3.4.
278 279 280 281 282 283 284
 * @GDK_EVENT_LAST: marks the end of the GdkEventType enumeration. Added in 2.18
 *
 * Specifies the type of the event.
 *
 * Do not confuse these events with the signals that GTK+ widgets emit.
 * Although many of these events result in corresponding signals being emitted,
 * the events are often transformed or filtered along the way.
285 286 287 288 289 290 291
 *
 * In some language bindings, the values %GDK_2BUTTON_PRESS and
 * %GDK_3BUTTON_PRESS would translate into something syntactically
 * invalid (eg <literal>Gdk.EventType.2ButtonPress</literal>, where a
 * symbol is not allowed to start with a number). In that case, the
 * aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can
 * be used instead.
Owen Taylor's avatar
Started  
Owen Taylor committed
292 293 294 295 296 297 298 299 300 301
 */
typedef enum
{
  GDK_NOTHING		= -1,
  GDK_DELETE		= 0,
  GDK_DESTROY		= 1,
  GDK_EXPOSE		= 2,
  GDK_MOTION_NOTIFY	= 3,
  GDK_BUTTON_PRESS	= 4,
  GDK_2BUTTON_PRESS	= 5,
302
  GDK_DOUBLE_BUTTON_PRESS = GDK_2BUTTON_PRESS,
Owen Taylor's avatar
Started  
Owen Taylor committed
303
  GDK_3BUTTON_PRESS	= 6,
304
  GDK_TRIPLE_BUTTON_PRESS = GDK_3BUTTON_PRESS,
Owen Taylor's avatar
Started  
Owen Taylor committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
  GDK_BUTTON_RELEASE	= 7,
  GDK_KEY_PRESS		= 8,
  GDK_KEY_RELEASE	= 9,
  GDK_ENTER_NOTIFY	= 10,
  GDK_LEAVE_NOTIFY	= 11,
  GDK_FOCUS_CHANGE	= 12,
  GDK_CONFIGURE		= 13,
  GDK_MAP		= 14,
  GDK_UNMAP		= 15,
  GDK_PROPERTY_NOTIFY	= 16,
  GDK_SELECTION_CLEAR	= 17,
  GDK_SELECTION_REQUEST = 18,
  GDK_SELECTION_NOTIFY	= 19,
  GDK_PROXIMITY_IN	= 20,
  GDK_PROXIMITY_OUT	= 21,
  GDK_DRAG_ENTER        = 22,
  GDK_DRAG_LEAVE        = 23,
  GDK_DRAG_MOTION       = 24,
  GDK_DRAG_STATUS       = 25,
  GDK_DROP_START        = 26,
  GDK_DROP_FINISHED     = 27,
  GDK_CLIENT_EVENT	= 28,
  GDK_VISIBILITY_NOTIFY = 29,
Havoc Pennington's avatar
Havoc Pennington committed
328
  GDK_SCROLL            = 31,
329
  GDK_WINDOW_STATE      = 32,
Matthias Clasen's avatar
Matthias Clasen committed
330
  GDK_SETTING           = 33,
331
  GDK_OWNER_CHANGE      = 34,
332
  GDK_GRAB_BROKEN       = 35,
333
  GDK_DAMAGE            = 36,
334 335 336 337
  GDK_TOUCH_BEGIN       = 37,
  GDK_TOUCH_UPDATE      = 38,
  GDK_TOUCH_END         = 39,
  GDK_TOUCH_CANCEL      = 40,
338
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Started  
Owen Taylor committed
339 340
} GdkEventType;

341 342 343 344 345 346 347 348
/**
 * GdkVisibilityState:
 * @GDK_VISIBILITY_UNOBSCURED: the window is completely visible.
 * @GDK_VISIBILITY_PARTIAL: the window is partially visible.
 * @GDK_VISIBILITY_FULLY_OBSCURED: the window is not visible at all.
 *
 * Specifies the visiblity status of a window for a #GdkEventVisibility.
 */
349 350
typedef enum
{
Owen Taylor's avatar
Started  
Owen Taylor committed
351 352 353 354 355
  GDK_VISIBILITY_UNOBSCURED,
  GDK_VISIBILITY_PARTIAL,
  GDK_VISIBILITY_FULLY_OBSCURED
} GdkVisibilityState;

356 357 358 359 360 361
/**
 * GdkScrollDirection:
 * @GDK_SCROLL_UP: the window is scrolled up.
 * @GDK_SCROLL_DOWN: the window is scrolled down.
 * @GDK_SCROLL_LEFT: the window is scrolled to the left.
 * @GDK_SCROLL_RIGHT: the window is scrolled to the right.
362
 * @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values
363
 *   in #GdkEventScroll. See gdk_event_get_scroll_deltas(). Since: 3.4
364 365 366
 *
 * Specifies the direction for #GdkEventScroll.
 */
367 368 369 370 371
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
372 373
  GDK_SCROLL_RIGHT,
  GDK_SCROLL_SMOOTH
374 375
} GdkScrollDirection;

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
/**
 * GdkNotifyType:
 * @GDK_NOTIFY_ANCESTOR: the window is entered from an ancestor or
 *   left towards an ancestor.
 * @GDK_NOTIFY_VIRTUAL: the pointer moves between an ancestor and an
 *   inferior of the window.
 * @GDK_NOTIFY_INFERIOR: the window is entered from an inferior or
 *   left towards an inferior.
 * @GDK_NOTIFY_NONLINEAR: the window is entered from or left towards
 *   a window which is neither an ancestor nor an inferior.
 * @GDK_NOTIFY_NONLINEAR_VIRTUAL: the pointer moves between two windows
 *   which are not ancestors of each other and the window is part of
 *   the ancestor chain between one of these windows and their least
 *   common ancestor.
 * @GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred.
 *
 * Specifies the kind of crossing for #GdkEventCrossing.
 *
 * See the X11 protocol specification of <type>LeaveNotify</type> for
 * full details of crossing event generation.
Owen Taylor's avatar
Started  
Owen Taylor committed
396 397 398 399 400 401 402 403 404 405 406
 */
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;

407 408 409 410 411 412 413 414 415
/**
 * 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.
 * @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
 *   state (e.g. sensitivity).
416 417 418 419 420 421 422
 * @GDK_CROSSING_TOUCH_BEGIN: crossing because a touch sequence has begun,
 *   this event is synthetic as the pointer might have not left the window.
 * @GDK_CROSSING_TOUCH_END: crossing because a touch sequence has ended,
 *   this event is synthetic as the pointer might have not left the window.
 * @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
 *   is synthetic as the pointer didn't leave the window.
423 424
 *
 * Specifies the crossing mode for #GdkEventCrossing.
Owen Taylor's avatar
Started  
Owen Taylor committed
425 426 427 428 429
 */
typedef enum
{
  GDK_CROSSING_NORMAL,
  GDK_CROSSING_GRAB,
430 431 432
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
433 434 435 436
  GDK_CROSSING_STATE_CHANGED,
  GDK_CROSSING_TOUCH_BEGIN,
  GDK_CROSSING_TOUCH_END,
  GDK_CROSSING_DEVICE_SWITCH
Owen Taylor's avatar
Started  
Owen Taylor committed
437 438
} GdkCrossingMode;

439 440 441 442 443 444 445
/**
 * GdkPropertyState:
 * @GDK_PROPERTY_NEW_VALUE: the property value was changed.
 * @GDK_PROPERTY_DELETE: the property was deleted.
 *
 * Specifies the type of a property change for a #GdkEventProperty.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
446 447 448 449 450 451
typedef enum
{
  GDK_PROPERTY_NEW_VALUE,
  GDK_PROPERTY_DELETE
} GdkPropertyState;

452 453 454 455 456 457 458 459 460 461
/**
 * GdkWindowState:
 * @GDK_WINDOW_STATE_WITHDRAWN: the window is not shown.
 * @GDK_WINDOW_STATE_ICONIFIED: the window is minimized.
 * @GDK_WINDOW_STATE_MAXIMIZED: the window is maximized.
 * @GDK_WINDOW_STATE_STICKY: the window is sticky.
 * @GDK_WINDOW_STATE_FULLSCREEN: the window is maximized without
 *   decorations.
 * @GDK_WINDOW_STATE_ABOVE: the window is kept above other windows.
 * @GDK_WINDOW_STATE_BELOW: the window is kept below other windows.
462
 * @GDK_WINDOW_STATE_FOCUSED: the window is presented as focused (with active decorations).
463 464 465
 *
 * Specifies the state of a toplevel window.
 */
Havoc Pennington's avatar
Havoc Pennington committed
466 467
typedef enum
{
468 469 470 471
  GDK_WINDOW_STATE_WITHDRAWN  = 1 << 0,
  GDK_WINDOW_STATE_ICONIFIED  = 1 << 1,
  GDK_WINDOW_STATE_MAXIMIZED  = 1 << 2,
  GDK_WINDOW_STATE_STICKY     = 1 << 3,
472 473
  GDK_WINDOW_STATE_FULLSCREEN = 1 << 4,
  GDK_WINDOW_STATE_ABOVE      = 1 << 5,
474 475
  GDK_WINDOW_STATE_BELOW      = 1 << 6,
  GDK_WINDOW_STATE_FOCUSED    = 1 << 7
Havoc Pennington's avatar
Havoc Pennington committed
476 477
} GdkWindowState;

478 479 480 481 482 483 484 485 486
/**
 * GdkSettingAction:
 * @GDK_SETTING_ACTION_NEW: a setting was added.
 * @GDK_SETTING_ACTION_CHANGED: a setting was changed.
 * @GDK_SETTING_ACTION_DELETED: a setting was deleted.
 *
 * Specifies the kind of modification applied to a setting in a
 * #GdkEventSetting.
 */
487 488 489 490 491 492 493
typedef enum
{
  GDK_SETTING_ACTION_NEW,
  GDK_SETTING_ACTION_CHANGED,
  GDK_SETTING_ACTION_DELETED
} GdkSettingAction;

494 495 496 497 498 499 500 501
/**
 * GdkOwnerChange:
 * @GDK_OWNER_CHANGE_NEW_OWNER: some other app claimed the ownership
 * @GDK_OWNER_CHANGE_DESTROY: the window was destroyed
 * @GDK_OWNER_CHANGE_CLOSE: the client was closed
 *
 * Specifies why a selection ownership was changed.
 */
Matthias Clasen's avatar
Matthias Clasen committed
502 503 504 505 506 507 508
typedef enum
{
  GDK_OWNER_CHANGE_NEW_OWNER,
  GDK_OWNER_CHANGE_DESTROY,
  GDK_OWNER_CHANGE_CLOSE
} GdkOwnerChange;

509 510 511 512 513 514 515 516 517 518 519
/**
 * GdkEventAny:
 * @type: the type of the event.
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 *
 * Contains the fields which are common to all event structs.
 * Any event pointer can safely be cast to a pointer to a #GdkEventAny to
 * access these fields.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
520 521 522 523 524 525 526
struct _GdkEventAny
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
};

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
/**
 * GdkEventExpose:
 * @type: the type of the event (%GDK_EXPOSE or %GDK_DAMAGE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @area: bounding box of @region.
 * @region: the region that needs to be redrawn.
 * @count: the number of contiguous %GDK_EXPOSE events following this one.
 *   The only use for this is "exposure compression", i.e. handling all
 *   contiguous %GDK_EXPOSE events in one go, though GDK performs some
 *   exposure compression so this is not normally needed.
 *
 * Generated when all or part of a window becomes visible and needs to be
 * redrawn.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
543 544 545 546 547 548
struct _GdkEventExpose
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkRectangle area;
549
  cairo_region_t *region;
Owen Taylor's avatar
Started  
Owen Taylor committed
550 551 552
  gint count; /* If non-zero, how many more events follow. */
};

553 554 555 556 557 558 559 560 561 562 563
/**
 * GdkEventVisibility:
 * @type: the type of the event (%GDK_VISIBILITY_NOTIFY).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @state: the new visibility state (%GDK_VISIBILITY_FULLY_OBSCURED,
 *   %GDK_VISIBILITY_PARTIAL or %GDK_VISIBILITY_UNOBSCURED).
 *
 * Generated when the window visibility status has changed.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
564 565 566 567 568 569 570 571
struct _GdkEventVisibility
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkVisibilityState state;
};

572 573 574 575 576 577 578 579 580 581 582
/**
 * GdkEventMotion:
 * @type: the type of the event.
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @time: the time of the event in milliseconds.
 * @x: the x coordinate of the pointer relative to the window.
 * @y: the y coordinate of the pointer relative to the window.
 * @axes: @x, @y translated to the axes of @device, or %NULL if @device is
 *   the mouse.
583 584 585
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType.
586 587 588 589 590 591 592 593 594 595
 * @is_hint: set to 1 if this event is just a hint, see the
 *   %GDK_POINTER_MOTION_HINT_MASK value of #GdkEventMask.
 * @device: the device where the event originated.
 * @x_root: the x coordinate of the pointer relative to the root of the
 *   screen.
 * @y_root: the y coordinate of the pointer relative to the root of the
 *   screen.
 *
 * Generated when the pointer moves.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
596 597 598 599 600 601 602 603
struct _GdkEventMotion
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
604
  gdouble *axes;
Owen Taylor's avatar
Started  
Owen Taylor committed
605 606
  guint state;
  gint16 is_hint;
607
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
608 609 610
  gdouble x_root, y_root;
};

611 612 613 614 615 616 617 618 619 620 621 622
/**
 * GdkEventButton:
 * @type: the type of the event (%GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS,
 *   %GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @time: the time of the event in milliseconds.
 * @x: the x coordinate of the pointer relative to the window.
 * @y: the y coordinate of the pointer relative to the window.
 * @axes: @x, @y translated to the axes of @device, or %NULL if @device is
 *   the mouse.
623 624 625
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType.
626 627 628 629 630 631 632 633 634 635 636 637
 * @button: the button which was pressed or released, numbered from 1 to 5.
 *   Normally button 1 is the left mouse button, 2 is the middle button,
 *   and 3 is the right button. On 2-button mice, the middle button can
 *   often be simulated by pressing both mouse buttons together.
 * @device: the device where the event originated.
 * @x_root: the x coordinate of the pointer relative to the root of the
 *   screen.
 * @y_root: the y coordinate of the pointer relative to the root of the
 *   screen.
 *
 * Used for button press and button release events. The
 * @type field will be one of %GDK_BUTTON_PRESS,
638
 * %GDK_2BUTTON_PRESS, %GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE,
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
 *
 * Double and triple-clicks result in a sequence of events being received.
 * For double-clicks the order of events will be:
 * <orderedlist>
 * <listitem><para>%GDK_BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
 * <listitem><para>%GDK_BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_2BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
 * </orderedlist>
 * Note that the first click is received just like a normal
 * button press, while the second click results in a %GDK_2BUTTON_PRESS
 * being received just after the %GDK_BUTTON_PRESS.
 *
 * Triple-clicks are very similar to double-clicks, except that
 * %GDK_3BUTTON_PRESS is inserted after the third click. The order of the
 * events is:
 * <orderedlist>
 * <listitem><para>%GDK_BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
 * <listitem><para>%GDK_BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_2BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
 * <listitem><para>%GDK_BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_3BUTTON_PRESS</para></listitem>
 * <listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
 * </orderedlist>
 *
 * For a double click to occur, the second button press must occur within
 * 1/4 of a second of the first. For a triple click to occur, the third
 * button press must also occur within 1/2 second of the first button press.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
671 672 673 674 675 676 677 678
struct _GdkEventButton
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
679
  gdouble *axes;
Owen Taylor's avatar
Started  
Owen Taylor committed
680 681
  guint state;
  guint button;
682
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
683 684 685
  gdouble x_root, y_root;
};

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
/**
 * GdkEventTouch:
 * @type: the type of the event (%GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE,
 *   %GDK_TOUCH_END, %GDK_TOUCH_CANCEL)
 * @window: the window which received the event
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>)
 * @time: the time of the event in milliseconds.
 * @x: the x coordinate of the pointer relative to the window
 * @y: the y coordinate of the pointer relative to the window
 * @axes: @x, @y translated to the axes of @device, or %NULL if @device is
 *   the mouse
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType
 * @sequence: the event sequence that the event belongs to
 * @emulating_pointer: whether the event should be used for emulating
 *   pointer event
 * @device: the device where the event originated
 * @x_root: the x coordinate of the pointer relative to the root of the
 *   screen
 * @y_root: the y coordinate of the pointer relative to the root of the
 *   screen
 *
 * Used for touch events.
 * @type field will be one of %GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE,
 * %GDK_TOUCH_END or %GDK_TOUCH_CANCEL.
 *
 * Touch events are grouped into sequences by means of the @sequence
 * field, which can also be obtained with gdk_event_get_event_sequence().
 * Each sequence begins with a %GDK_TOUCH_BEGIN event, followed by
 * any number of %GDK_TOUCH_UPDATE events, and ends with a %GDK_TOUCH_END
 * (or %GDK_TOUCH_CANCEL) event. With multitouch devices, there may be
 * several active sequences at the same time.
 */
struct _GdkEventTouch
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
  gdouble *axes;
  guint state;
  GdkEventSequence *sequence;
  gboolean emulating_pointer;
  GdkDevice *device;
  gdouble x_root, y_root;
};

737 738 739 740 741 742 743 744 745
/**
 * GdkEventScroll:
 * @type: the type of the event (%GDK_SCROLL).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @time: the time of the event in milliseconds.
 * @x: the x coordinate of the pointer relative to the window.
 * @y: the y coordinate of the pointer relative to the window.
746 747 748
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType.
749
 * @direction: the direction to scroll to (one of %GDK_SCROLL_UP,
750 751
 *   %GDK_SCROLL_DOWN, %GDK_SCROLL_LEFT, %GDK_SCROLL_RIGHT or
 *   %GDK_SCROLL_SMOOTH).
752 753 754 755 756 757 758 759 760
 * @device: the device where the event originated.
 * @x_root: the x coordinate of the pointer relative to the root of the
 *   screen.
 * @y_root: the y coordinate of the pointer relative to the root of the
 *   screen.
 *
 * Generated from button presses for the buttons 4 to 7. Wheel mice are
 * usually configured to generate button press events for buttons 4 and 5
 * when the wheel is turned.
761 762 763 764 765
 *
 * Some GDK backends can also generate 'smooth' scroll events, which
 * can be recognized by the %GDK_SCROLL_SMOOTH scroll direction. For
 * these, the scroll deltas can be obtained with
 * gdk_event_get_scroll_deltas().
766
 */
767 768 769 770 771 772 773 774 775 776
struct _GdkEventScroll
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
  guint state;
  GdkScrollDirection direction;
777
  GdkDevice *device;
778
  gdouble x_root, y_root;
779 780
  gdouble delta_x;
  gdouble delta_y;
781 782
};

783 784 785 786 787 788 789
/**
 * GdkEventKey:
 * @type: the type of the event (%GDK_KEY_PRESS or %GDK_KEY_RELEASE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @time: the time of the event in milliseconds.
790 791 792
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType.
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
 * @keyval: the key that was pressed or released. See the
 *   <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file for a
 *   complete list of GDK key codes.
 * @length: the length of @string.
 * @string: a string containing the an approximation of the text that
 *   would result from this keypress. The only correct way to handle text
 *   input of text is using input methods (see #GtkIMContext), so this
 *   field is deprecated and should never be used.
 *   (gdk_unicode_to_keyval() provides a non-deprecated way of getting
 *   an approximate translation for a key.) The string is encoded in the
 *   encoding of the current locale (Note: this for backwards compatibility:
 *   strings in GTK+ and GDK are typically in UTF-8.) and NUL-terminated.
 *   In some cases, the translation of the key code will be a single
 *   NUL byte, in which case looking at @length is necessary to distinguish
 *   it from the an empty translation.
 * @hardware_keycode: the raw code of the key that was pressed or released.
 * @group: the keyboard group.
 * @is_modifier: a flag that indicates if @hardware_keycode is mapped to a
 *   modifier. Since 2.10
 *
 * Describes a key press or key release event.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
815 816 817 818 819 820 821 822 823 824
struct _GdkEventKey
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  guint state;
  guint keyval;
  gint length;
  gchar *string;
Havoc Pennington's avatar
Havoc Pennington committed
825
  guint16 hardware_keycode;
Havoc Pennington's avatar
Havoc Pennington committed
826
  guint8 group;
827
  guint is_modifier : 1;
Owen Taylor's avatar
Started  
Owen Taylor committed
828 829
};

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
/**
 * GdkEventCrossing:
 * @type: the type of the event (%GDK_ENTER_NOTIFY or %GDK_LEAVE_NOTIFY).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *  <function>XSendEvent</function>).
 * @subwindow: the window that was entered or left.
 * @time: the time of the event in milliseconds.
 * @x: the x coordinate of the pointer relative to the window.
 * @y: the y coordinate of the pointer relative to the window.
 * @x_root: the x coordinate of the pointer relative to the root of the screen.
 * @y_root: the y coordinate of the pointer relative to the root of the screen.
 * @mode: the crossing mode (%GDK_CROSSING_NORMAL, %GDK_CROSSING_GRAB,
 *  %GDK_CROSSING_UNGRAB, %GDK_CROSSING_GTK_GRAB, %GDK_CROSSING_GTK_UNGRAB or
 *  %GDK_CROSSING_STATE_CHANGED).  %GDK_CROSSING_GTK_GRAB, %GDK_CROSSING_GTK_UNGRAB,
 *  and %GDK_CROSSING_STATE_CHANGED were added in 2.14 and are always synthesized,
 *  never native.
 * @detail: the kind of crossing that happened (%GDK_NOTIFY_INFERIOR,
 *  %GDK_NOTIFY_ANCESTOR, %GDK_NOTIFY_VIRTUAL, %GDK_NOTIFY_NONLINEAR or
 *  %GDK_NOTIFY_NONLINEAR_VIRTUAL).
 * @focus: %TRUE if @window is the focus window or an inferior.
851 852 853
 * @state: (type GdkModifierType): a bit-mask representing the state of
 *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
 *   buttons. See #GdkModifierType.
854 855 856
 *
 * Generated when the pointer enters or leaves a window.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
struct _GdkEventCrossing
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkWindow *subwindow;
  guint32 time;
  gdouble x;
  gdouble y;
  gdouble x_root;
  gdouble y_root;
  GdkCrossingMode mode;
  GdkNotifyType detail;
  gboolean focus;
  guint state;
};

874 875 876 877 878 879 880 881 882 883 884
/**
 * GdkEventFocus:
 * @type: the type of the event (%GDK_FOCUS_CHANGE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @in: %TRUE if the window has gained the keyboard focus, %FALSE if
 *   it has lost the focus.
 *
 * Describes a change of keyboard focus.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
885 886 887 888 889 890 891 892
struct _GdkEventFocus
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gint16 in;
};

893 894 895 896 897 898 899 900 901 902 903 904 905
/**
 * GdkEventConfigure:
 * @type: the type of the event (%GDK_CONFIGURE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @x: the new x coordinate of the window, relative to its parent.
 * @y: the new y coordinate of the window, relative to its parent.
 * @width: the new width of the window.
 * @height: the new height of the window.
 *
 * Generated when a window size or position has changed.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
906 907 908 909 910
struct _GdkEventConfigure
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
911 912 913
  gint x, y;
  gint width;
  gint height;
Owen Taylor's avatar
Started  
Owen Taylor committed
914 915
};

916 917 918 919 920 921 922 923
/**
 * GdkEventProperty:
 * @type: the type of the event (%GDK_PROPERTY_NOTIFY).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @atom: the property that was changed.
 * @time: the time of the event in milliseconds.
924 925
 * @state: (type GdkPropertyState): whether the property was changed
 *   (%GDK_PROPERTY_NEW_VALUE) or deleted (%GDK_PROPERTY_DELETE).
926 927 928
 *
 * Describes a property change on a window.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
929 930 931 932 933 934 935 936 937 938
struct _GdkEventProperty
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom atom;
  guint32 time;
  guint state;
};

939 940 941 942 943 944 945 946 947 948 949
/**
 * GdkEventSelection:
 * @type: the type of the event (%GDK_SELECTION_CLEAR,
 *   %GDK_SELECTION_NOTIFY or %GDK_SELECTION_REQUEST).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @selection: the selection.
 * @target: the target to which the selection should be converted.
 * @property: the property in which to place the result of the conversion.
 * @time: the time of the event in milliseconds.
950
 * @requestor: the window on which to place @property or %NULL if none.
951 952 953 954
 *
 * Generated when a selection is requested or ownership of a selection
 * is taken over by another client application.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
955 956 957 958 959 960 961 962 963
struct _GdkEventSelection
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom selection;
  GdkAtom target;
  GdkAtom property;
  guint32 time;
964
  GdkWindow *requestor;
Owen Taylor's avatar
Started  
Owen Taylor committed
965 966
};

967 968 969
/**
 * GdkEventOwnerChange:
 * @type: the type of the event (%GDK_OWNER_CHANGE).
970
 * @window: the window which received the event
971
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
972 973 974 975 976
 *   <function>XSendEvent</function>)
 * @owner: the new owner of the selection, or %NULL if there is none
 * @reason: the reason for the ownership change as a #GdkOwnerChange value
 * @selection: the atom identifying the selection
 * @time: the timestamp of the event
977
 * @selection_time: the time at which the selection ownership was taken
978
 *   over
979 980 981 982 983 984 985
 *
 * Generated when the owner of a selection changes. On X11, this
 * information is only available if the X server supports the XFIXES
 * extension.
 *
 * Since: 2.6
 */
Matthias Clasen's avatar
Matthias Clasen committed
986 987 988 989 990
struct _GdkEventOwnerChange
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
991
  GdkWindow *owner;
Matthias Clasen's avatar
Matthias Clasen committed
992 993 994 995 996 997
  GdkOwnerChange reason;
  GdkAtom selection;
  guint32 time;
  guint32 selection_time;
};

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
/**
 * GdkEventProximity:
 * @type: the type of the event (%GDK_PROXIMITY_IN or %GDK_PROXIMITY_OUT).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using <function>XSendEvent</function>).
 * @time: the time of the event in milliseconds.
 * @device: the device where the event originated.
 *
 * Proximity events are generated when using GDK's wrapper for the
 * XInput extension. The XInput extension is an add-on for standard X
 * that allows you to use nonstandard devices such as graphics tablets.
 * A proximity event indicates that the stylus has moved in or out of
 * contact with the tablet, or perhaps that the user's finger has moved
 * in or out of contact with a touch screen.
 *
 * This event type will be used pretty rarely. It only is important for
 * XInput aware programs that are drawing their own cursor.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
1016 1017 1018 1019 1020 1021
struct _GdkEventProximity
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
1022
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
1023 1024
};

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/**
 * GdkEventSetting:
 * @type: the type of the event (%GDK_SETTING).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @action: what happened to the setting (%GDK_SETTING_ACTION_NEW,
 *   %GDK_SETTING_ACTION_CHANGED or %GDK_SETTING_ACTION_DELETED).
 * @name: the name of the setting.
 *
 * Generated when a setting is modified.
 */
1037 1038 1039 1040 1041 1042 1043 1044
struct _GdkEventSetting
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkSettingAction action;
  char *name;
};
Havoc Pennington's avatar
Havoc Pennington committed
1045

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
/**
 * GdkEventWindowState:
 * @type: the type of the event (%GDK_WINDOW_STATE).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @changed_mask: mask specifying what flags have changed.
 * @new_window_state: the new window state, a combination of
 *   #GdkWindowState bits.
 *
 * Generated when the state of a toplevel window changes.
 */
Havoc Pennington's avatar
Havoc Pennington committed
1058 1059 1060 1061 1062 1063 1064 1065 1066
struct _GdkEventWindowState
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkWindowState changed_mask;
  GdkWindowState new_window_state;
};

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
/**
 * GdkEventGrabBroken:
 * @type: the type of the event (%GDK_GRAB_BROKEN)
 * @window: the window which received the event, i.e. the window
 *   that previously owned the grab
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @keyboard: %TRUE if a keyboard grab was broken, %FALSE if a pointer
 *   grab was broken
 * @implicit: %TRUE if the broken grab was implicit
 * @grab_window: If this event is caused by another grab in the same
 *   application, @grab_window contains the new grab window. Otherwise
 *   @grab_window is %NULL.
 *
 * Generated when a pointer or keyboard grab is broken. On X11, this happens
 * when the grab window becomes unviewable (i.e. it or one of its ancestors
 * is unmapped), or if the same application grabs the pointer or keyboard
 * again. Note that implicit grabs (which are initiated by button presses)
 * can also cause #GdkEventGrabBroken events.
 *
 * Since: 2.8
 */
1089 1090 1091 1092 1093
struct _GdkEventGrabBroken {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gboolean keyboard;
Matthias Clasen's avatar
Matthias Clasen committed
1094
  gboolean implicit;
1095
  GdkWindow *grab_window;
1096 1097
};

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
/**
 * GdkEventDND:
 * @type: the type of the event (%GDK_DRAG_ENTER, %GDK_DRAG_LEAVE,
 *   %GDK_DRAG_MOTION, %GDK_DRAG_STATUS, %GDK_DROP_START or
 *   %GDK_DROP_FINISHED).
 * @window: the window which received the event.
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
 *   <function>XSendEvent</function>).
 * @context: the #GdkDragContext for the current DND operation.
 * @time: the time of the event in milliseconds.
 * @x_root: the x coordinate of the pointer relative to the root of the
 *   screen, only set for %GDK_DRAG_MOTION and %GDK_DROP_START.
 * @y_root: the y coordinate of the pointer relative to the root of the
 *   screen, only set for %GDK_DRAG_MOTION and %GDK_DROP_START.
 *
 * Generated during DND operations.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
struct _GdkEventDND {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkDragContext *context;

  guint32 time;
  gshort x_root, y_root;
};

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
/**
 * GdkEvent:
 *
 * The #GdkEvent struct contains a union of all of the event structs,
 * and allows access to the data fields in a number of ways.
 *
 * The event type is always the first field in all of the event structs, and
 * can always be accessed with the following code, no matter what type of
 * event it is:
 * <informalexample>
 * <programlisting>
 *   GdkEvent *event;
 *   GdkEventType type;
 *
 *   type = event->type;
 * </programlisting>
 * </informalexample>
 *
 * To access other fields of the event structs, the pointer to the event
 * can be cast to the appropriate event struct pointer, or the union member
 * name can be used. For example if the event type is %GDK_BUTTON_PRESS
 * then the x coordinate of the button press can be accessed with:
 * <informalexample>
 * <programlisting>
 *   GdkEvent *event;
 *   gdouble x;
 *
 *   x = ((GdkEventButton*)event)->x;
 * </programlisting>
 * </informalexample>
 * or:
 * <informalexample>
 * <programlisting>
 *   GdkEvent *event;
 *   gdouble x;
 *
 *   x = event->button.x;
 * </programlisting>
 * </informalexample>
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
1165 1166 1167 1168 1169 1170 1171 1172
union _GdkEvent
{
  GdkEventType		    type;
  GdkEventAny		    any;
  GdkEventExpose	    expose;
  GdkEventVisibility	    visibility;
  GdkEventMotion	    motion;
  GdkEventButton	    button;
1173
  GdkEventTouch             touch;
1174
  GdkEventScroll            scroll;
Owen Taylor's avatar
Started  
Owen Taylor committed
1175 1176 1177 1178 1179 1180
  GdkEventKey		    key;
  GdkEventCrossing	    crossing;
  GdkEventFocus		    focus_change;
  GdkEventConfigure	    configure;
  GdkEventProperty	    property;
  GdkEventSelection	    selection;
Matthias Clasen's avatar
Matthias Clasen committed
1181
  GdkEventOwnerChange  	    owner_change;
Owen Taylor's avatar
Started  
Owen Taylor committed
1182 1183
  GdkEventProximity	    proximity;
  GdkEventDND               dnd;
Havoc Pennington's avatar
Havoc Pennington committed
1184
  GdkEventWindowState       window_state;
1185
  GdkEventSetting           setting;
1186
  GdkEventGrabBroken        grab_broken;
Owen Taylor's avatar
Started  
Owen Taylor committed
1187 1188
};

1189
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
1190
GType     gdk_event_get_type            (void) G_GNUC_CONST;
1191

1192
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Started  
Owen Taylor committed
1193
gboolean  gdk_events_pending	 	(void);
1194
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Started  
Owen Taylor committed
1195 1196
GdkEvent* gdk_event_get			(void);

1197
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Started  
Owen Taylor committed
1198
GdkEvent* gdk_event_peek                (void);
1199
GDK_AVAILABLE_IN_ALL
1200
void      gdk_event_put	 		(const GdkEvent *event);
Owen Taylor's avatar
Started  
Owen Taylor committed
1201

1202
GDK_AVAILABLE_IN_ALL
1203
GdkEvent* gdk_event_new                 (GdkEventType    type);
1204
GDK_AVAILABLE_IN_ALL
1205
GdkEvent* gdk_event_copy     		(const GdkEvent *event);
1206
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Started  
Owen Taylor committed
1207
void	  gdk_event_free     		(GdkEvent 	*event);
1208

1209
GDK_AVAILABLE_IN_ALL
1210
guint32   gdk_event_get_time            (const GdkEvent  *event);
1211
GDK_AVAILABLE_IN_ALL
1212
gboolean  gdk_event_get_state           (const GdkEvent  *event,
1213
                                         GdkModifierType *state);
1214
GDK_AVAILABLE_IN_ALL
1215
gboolean  gdk_event_get_coords		(const GdkEvent  *event,
1216 1217
					 gdouble	 *x_win,
					 gdouble	 *y_win);
1218
GDK_AVAILABLE_IN_ALL
1219 1220 1221
gboolean  gdk_event_get_root_coords	(const GdkEvent *event,
					 gdouble	*x_root,
					 gdouble	*y_root);
1222
GDK_AVAILABLE_IN_3_2
1223 1224
gboolean  gdk_event_get_button          (const GdkEvent *event,
                                         guint          *button);
1225
GDK_AVAILABLE_IN_3_2
1226 1227
gboolean  gdk_event_get_click_count     (const GdkEvent *event,
                                         guint          *click_count);
1228
GDK_AVAILABLE_IN_3_2
1229 1230
gboolean  gdk_event_get_keyval          (const GdkEvent *event,
                                         guint          *keyval);
1231
GDK_AVAILABLE_IN_3_2
1232 1233
gboolean  gdk_event_get_keycode         (const GdkEvent *event,
                                         guint16        *keycode);
1234
GDK_AVAILABLE_IN_3_2
1235 1236
gboolean gdk_event_get_scroll_direction (const GdkEvent *event,
                                         GdkScrollDirection *direction);
1237 1238 1239 1240 1241
GDK_AVAILABLE_IN_3_4
gboolean  gdk_event_get_scroll_deltas   (const GdkEvent *event,
                                         gdouble         *delta_x,
                                         gdouble         *delta_y);

1242
GDK_AVAILABLE_IN_ALL
1243
gboolean  gdk_event_get_axis            (const GdkEvent  *event,
1244 1245
                                         GdkAxisUse       axis_use,
                                         gdouble         *value);
1246
GDK_AVAILABLE_IN_ALL
1247 1248
void       gdk_event_set_device         (GdkEvent        *event,
                                         GdkDevice       *device);
1249
GDK_AVAILABLE_IN_ALL
1250
GdkDevice* gdk_event_get_device         (const GdkEvent  *event);
1251
GDK_AVAILABLE_IN_ALL
1252 1253
void       gdk_event_set_source_device  (GdkEvent        *event,
                                         GdkDevice       *device);
1254
GDK_AVAILABLE_IN_ALL
1255
GdkDevice* gdk_event_get_source_device  (const GdkEvent  *event);
1256
GDK_AVAILABLE_IN_ALL
1257
void       gdk_event_request_motions    (const GdkEventMotion *event);
1258
GDK_AVAILABLE_IN_3_4
1259
gboolean   gdk_event_triggers_context_menu (const GdkEvent *event);
1260

1261
GDK_AVAILABLE_IN_ALL
1262 1263 1264
gboolean  gdk_events_get_distance       (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *distance);
1265
GDK_AVAILABLE_IN_ALL
1266 1267 1268
gboolean  gdk_events_get_angle          (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *angle);
1269
GDK_AVAILABLE_IN_ALL
1270 1271 1272 1273 1274
gboolean  gdk_events_get_center         (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *x,
                                         gdouble         *y);

1275
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Started  
Owen Taylor committed
1276 1277 1278 1279
void	  gdk_event_handler_set 	(GdkEventFunc    func,
					 gpointer        data,
					 GDestroyNotify  notify);

1280
GDK_AVAILABLE_IN_ALL
1281 1282
void       gdk_event_set_screen         (GdkEvent        *event,
                                         GdkScreen       *screen);
1283
GDK_AVAILABLE_IN_ALL
1284
GdkScreen *gdk_event_get_screen         (const GdkEvent  *event);
1285

Carlos Garnacho's avatar
Carlos Garnacho committed
1286 1287 1288
GDK_AVAILABLE_IN_3_4
GdkEventSequence *gdk_event_get_event_sequence (const GdkEvent *event);

1289
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
1290
void	  gdk_set_show_events		(gboolean	 show_events);
1291
GDK_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
1292
gboolean  gdk_get_show_events		(void);
Owen Taylor's avatar
Started  
Owen Taylor committed
1293

1294
#ifndef GDK_MULTIHEAD_SAFE
Owen Taylor's avatar
Started  
Owen Taylor committed
1295

1296
GDK_AVAILABLE_IN_ALL
1297 1298 1299
gboolean gdk_setting_get                           (const gchar *name,
                                                    GValue          *value);

1300
#endif /* GDK_MULTIHEAD_SAFE */
Owen Taylor's avatar
Started  
Owen Taylor committed
1301

1302
G_END_DECLS
Owen Taylor's avatar