gdkevents.h 39.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 15 16 17 18 19 20 21 22 23
 * 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * 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
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25
 */
Matthias Clasen's avatar
Matthias Clasen committed
26

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

Owen Taylor's avatar
Started  
Owen Taylor committed
31 32 33
#ifndef __GDK_EVENTS_H__
#define __GDK_EVENTS_H__

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

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

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

/**
 * 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>
 */


59 60
#define GDK_TYPE_EVENT          (gdk_event_get_type ())

61 62 63 64 65 66
/**
 * 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>.
 */
67
#define GDK_PRIORITY_EVENTS	(G_PRIORITY_DEFAULT)
68 69 70 71 72 73 74 75

/**
 * 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>.
 */
76 77
#define GDK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
/**
 * 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
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 127 128
/**
 * 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
129 130 131 132 133
typedef struct _GdkEventAny	    GdkEventAny;
typedef struct _GdkEventExpose	    GdkEventExpose;
typedef struct _GdkEventVisibility  GdkEventVisibility;
typedef struct _GdkEventMotion	    GdkEventMotion;
typedef struct _GdkEventButton	    GdkEventButton;
134
typedef struct _GdkEventScroll      GdkEventScroll;  
Owen Taylor's avatar
Started  
Owen Taylor committed
135 136 137 138 139 140
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
141
typedef struct _GdkEventOwnerChange GdkEventOwnerChange;
Owen Taylor's avatar
Started  
Owen Taylor committed
142 143
typedef struct _GdkEventProximity   GdkEventProximity;
typedef struct _GdkEventDND         GdkEventDND;
Havoc Pennington's avatar
Havoc Pennington committed
144
typedef struct _GdkEventWindowState GdkEventWindowState;
145
typedef struct _GdkEventSetting     GdkEventSetting;
146
typedef struct _GdkEventGrabBroken  GdkEventGrabBroken;
Owen Taylor's avatar
Started  
Owen Taylor committed
147 148 149

typedef union  _GdkEvent	    GdkEvent;

150 151 152
/**
 * GdkEventFunc:
 * @event: the #GdkEvent to process.
153
 * @data: (closure): user data set when the event handler was installed with
154 155 156 157 158
 *   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
159 160 161 162 163
typedef void (*GdkEventFunc) (GdkEvent *event,
			      gpointer	data);

/* Event filtering */

164 165 166 167 168 169
/**
 * GdkXEvent:
 *
 * Used to represent native events (<type>XEvent</type>s for the X11
 * backend, <type>MSG</type>s for Win32).
 */
170 171 172
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
173

174 175 176 177 178 179 180 181 182
/**
 * 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
183 184
typedef enum {
  GDK_FILTER_CONTINUE,	  /* Event not handled, continue processesing */
185 186 187
  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
188 189 190
  GDK_FILTER_REMOVE	  /* Terminate processing, removing event */
} GdkFilterReturn;

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
/**
 * 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
208 209 210 211 212
typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
					  GdkEvent *event,
					  gpointer  data);


213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 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 270 271 272 273
/**
 * 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.
 * @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.
 * @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.
 * @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.
Owen Taylor's avatar
Started  
Owen Taylor committed
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 299 300 301 302 303 304 305 306 307
 */
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,
  GDK_3BUTTON_PRESS	= 6,
  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
308
  GDK_SCROLL            = 31,
309
  GDK_WINDOW_STATE      = 32,
Matthias Clasen's avatar
Matthias Clasen committed
310
  GDK_SETTING           = 33,
311
  GDK_OWNER_CHANGE      = 34,
312
  GDK_GRAB_BROKEN       = 35,
313 314
  GDK_DAMAGE            = 36,
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Started  
Owen Taylor committed
315 316
} GdkEventType;

317 318 319 320 321 322 323 324
/**
 * 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.
 */
325 326
typedef enum
{
Owen Taylor's avatar
Started  
Owen Taylor committed
327 328 329 330 331
  GDK_VISIBILITY_UNOBSCURED,
  GDK_VISIBILITY_PARTIAL,
  GDK_VISIBILITY_FULLY_OBSCURED
} GdkVisibilityState;

332 333 334 335 336 337 338 339 340
/**
 * 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.
 *
 * Specifies the direction for #GdkEventScroll.
 */
341 342 343 344 345 346 347 348
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
  GDK_SCROLL_RIGHT
} GdkScrollDirection;

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/**
 * 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
369 370 371 372 373 374 375 376 377 378 379
 */
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;

380 381 382 383 384 385 386 387 388 389 390
/**
 * 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).
 *
 * Specifies the crossing mode for #GdkEventCrossing.
Owen Taylor's avatar
Started  
Owen Taylor committed
391 392 393 394 395
 */
typedef enum
{
  GDK_CROSSING_NORMAL,
  GDK_CROSSING_GRAB,
396 397 398 399
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
  GDK_CROSSING_STATE_CHANGED
Owen Taylor's avatar
Started  
Owen Taylor committed
400 401
} GdkCrossingMode;

402 403 404 405 406 407 408
/**
 * 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
409 410 411 412 413 414
typedef enum
{
  GDK_PROPERTY_NEW_VALUE,
  GDK_PROPERTY_DELETE
} GdkPropertyState;

415 416 417 418 419 420 421 422 423 424
/**
 * 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.
425
 * @GDK_WINDOW_STATE_FOCUSED: the window is presented as focused (with active decorations).
426 427 428
 *
 * Specifies the state of a toplevel window.
 */
Havoc Pennington's avatar
Havoc Pennington committed
429 430
typedef enum
{
431 432 433 434
  GDK_WINDOW_STATE_WITHDRAWN  = 1 << 0,
  GDK_WINDOW_STATE_ICONIFIED  = 1 << 1,
  GDK_WINDOW_STATE_MAXIMIZED  = 1 << 2,
  GDK_WINDOW_STATE_STICKY     = 1 << 3,
435 436
  GDK_WINDOW_STATE_FULLSCREEN = 1 << 4,
  GDK_WINDOW_STATE_ABOVE      = 1 << 5,
437 438
  GDK_WINDOW_STATE_BELOW      = 1 << 6,
  GDK_WINDOW_STATE_FOCUSED    = 1 << 7
Havoc Pennington's avatar
Havoc Pennington committed
439 440
} GdkWindowState;

441 442 443 444 445 446 447 448 449
/**
 * 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.
 */
450 451 452 453 454 455 456
typedef enum
{
  GDK_SETTING_ACTION_NEW,
  GDK_SETTING_ACTION_CHANGED,
  GDK_SETTING_ACTION_DELETED
} GdkSettingAction;

457 458 459 460 461 462 463 464
/**
 * 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
465 466 467 468 469 470 471
typedef enum
{
  GDK_OWNER_CHANGE_NEW_OWNER,
  GDK_OWNER_CHANGE_DESTROY,
  GDK_OWNER_CHANGE_CLOSE
} GdkOwnerChange;

472 473 474 475 476 477 478 479 480 481 482
/**
 * 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
483 484 485 486 487 488 489
struct _GdkEventAny
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
};

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
/**
 * 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
506 507 508 509 510 511
struct _GdkEventExpose
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkRectangle area;
512
  cairo_region_t *region;
Owen Taylor's avatar
Started  
Owen Taylor committed
513 514 515
  gint count; /* If non-zero, how many more events follow. */
};

516 517 518 519 520 521 522 523 524 525 526
/**
 * 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
527 528 529 530 531 532 533 534
struct _GdkEventVisibility
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkVisibilityState state;
};

535 536 537 538 539 540 541 542 543 544 545
/**
 * 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.
546 547 548
 * @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.
549 550 551 552 553 554 555 556 557 558
 * @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
559 560 561 562 563 564 565 566
struct _GdkEventMotion
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
567
  gdouble *axes;
Owen Taylor's avatar
Started  
Owen Taylor committed
568 569
  guint state;
  gint16 is_hint;
570
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
571 572 573
  gdouble x_root, y_root;
};

574 575 576 577 578 579 580 581 582 583 584 585
/**
 * 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.
586 587 588
 * @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.
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
 * @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,
 * %GDK_2BUTTON_PRESS, %GDK_3BUTTON_PRESS, and %GDK_BUTTON_RELEASE.
 *
 * 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
634 635 636 637 638 639 640 641
struct _GdkEventButton
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
642
  gdouble *axes;
Owen Taylor's avatar
Started  
Owen Taylor committed
643 644
  guint state;
  guint button;
645
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
646 647 648
  gdouble x_root, y_root;
};

649 650 651 652 653 654 655 656 657
/**
 * 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.
658 659 660
 * @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.
661 662 663 664 665 666 667 668 669 670 671 672
 * @direction: the direction to scroll to (one of %GDK_SCROLL_UP,
 *   %GDK_SCROLL_DOWN, %GDK_SCROLL_LEFT and %GDK_SCROLL_RIGHT).
 * @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.
 */
673 674 675 676 677 678 679 680 681 682
struct _GdkEventScroll
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
  guint state;
  GdkScrollDirection direction;
683
  GdkDevice *device;
684 685 686
  gdouble x_root, y_root;
};

687 688 689 690 691 692 693
/**
 * 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.
694 695 696
 * @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.
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
 * @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
719 720 721 722 723 724 725 726 727 728
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
729
  guint16 hardware_keycode;
Havoc Pennington's avatar
Havoc Pennington committed
730
  guint8 group;
731
  guint is_modifier : 1;
Owen Taylor's avatar
Started  
Owen Taylor committed
732 733
};

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
/**
 * 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.
755 756 757
 * @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.
758 759 760
 *
 * Generated when the pointer enters or leaves a window.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
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;
};

778 779 780 781 782 783 784 785 786 787 788
/**
 * 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
789 790 791 792 793 794 795 796
struct _GdkEventFocus
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gint16 in;
};

797 798 799 800 801 802 803 804 805 806 807 808 809
/**
 * 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
810 811 812 813 814
struct _GdkEventConfigure
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
815 816 817
  gint x, y;
  gint width;
  gint height;
Owen Taylor's avatar
Started  
Owen Taylor committed
818 819
};

820 821 822 823 824 825 826 827 828 829 830 831 832
/**
 * 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.
 * @state: whether the property was changed (%GDK_PROPERTY_NEW_VALUE) or
 *   deleted (%GDK_PROPERTY_DELETE).
 *
 * Describes a property change on a window.
 */
Owen Taylor's avatar
Started  
Owen Taylor committed
833 834 835 836 837 838 839 840 841 842
struct _GdkEventProperty
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom atom;
  guint32 time;
  guint state;
};

843 844 845 846 847 848 849 850 851 852 853
/**
 * 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.
854
 * @requestor: the window on which to place @property or %NULL if none.
855 856 857 858
 *
 * 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
859 860 861 862 863 864 865 866 867
struct _GdkEventSelection
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom selection;
  GdkAtom target;
  GdkAtom property;
  guint32 time;
868
  GdkWindow *requestor;
Owen Taylor's avatar
Started  
Owen Taylor committed
869 870
};

871 872 873
/**
 * GdkEventOwnerChange:
 * @type: the type of the event (%GDK_OWNER_CHANGE).
874
 * @window: the window which received the event
875
 * @send_event: %TRUE if the event was sent explicitly (e.g. using
876 877 878 879 880
 *   <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
881
 * @selection_time: the time at which the selection ownership was taken
882
 *   over
883 884 885 886 887 888 889
 *
 * 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
890 891 892 893 894
struct _GdkEventOwnerChange
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
895
  GdkWindow *owner;
Matthias Clasen's avatar
Matthias Clasen committed
896 897 898 899 900 901
  GdkOwnerChange reason;
  GdkAtom selection;
  guint32 time;
  guint32 selection_time;
};

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
/**
 * 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
920 921 922 923 924 925
struct _GdkEventProximity
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
926
  GdkDevice *device;
Owen Taylor's avatar
Started  
Owen Taylor committed
927 928
};

929 930 931 932 933 934 935 936 937 938 939 940
/**
 * 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.
 */
941 942 943 944 945 946 947 948
struct _GdkEventSetting
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkSettingAction action;
  char *name;
};
Havoc Pennington's avatar
Havoc Pennington committed
949

950 951 952 953 954 955 956 957 958 959 960 961
/**
 * 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
962 963 964 965 966 967 968 969 970
struct _GdkEventWindowState
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkWindowState changed_mask;
  GdkWindowState new_window_state;
};

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
/**
 * 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
 */
993 994 995 996 997
struct _GdkEventGrabBroken {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gboolean keyboard;
Matthias Clasen's avatar
Matthias Clasen committed
998
  gboolean implicit;
999
  GdkWindow *grab_window;
1000 1001
};

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
/**
 * 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
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
struct _GdkEventDND {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkDragContext *context;

  guint32 time;
  gshort x_root, y_root;
};

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
/**
 * 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
1069 1070 1071 1072 1073 1074 1075 1076
union _GdkEvent
{
  GdkEventType		    type;
  GdkEventAny		    any;
  GdkEventExpose	    expose;
  GdkEventVisibility	    visibility;
  GdkEventMotion	    motion;
  GdkEventButton	    button;
1077
  GdkEventScroll            scroll;
Owen Taylor's avatar
Started  
Owen Taylor committed
1078 1079 1080 1081 1082 1083
  GdkEventKey		    key;
  GdkEventCrossing	    crossing;
  GdkEventFocus		    focus_change;
  GdkEventConfigure	    configure;
  GdkEventProperty	    property;
  GdkEventSelection	    selection;
Matthias Clasen's avatar
Matthias Clasen committed
1084
  GdkEventOwnerChange  	    owner_change;
Owen Taylor's avatar
Started  
Owen Taylor committed
1085 1086
  GdkEventProximity	    proximity;
  GdkEventDND               dnd;
Havoc Pennington's avatar
Havoc Pennington committed
1087
  GdkEventWindowState       window_state;
1088
  GdkEventSetting           setting;
1089
  GdkEventGrabBroken        grab_broken;
Owen Taylor's avatar
Started  
Owen Taylor committed
1090 1091
};

Matthias Clasen's avatar
Matthias Clasen committed
1092
GType     gdk_event_get_type            (void) G_GNUC_CONST;
1093

Owen Taylor's avatar
Started  
Owen Taylor committed
1094 1095 1096 1097
gboolean  gdk_events_pending	 	(void);
GdkEvent* gdk_event_get			(void);

GdkEvent* gdk_event_peek                (void);
1098
void      gdk_event_put	 		(const GdkEvent *event);
Owen Taylor's avatar
Started  
Owen Taylor committed
1099

1100
GdkEvent* gdk_event_new                 (GdkEventType    type);
1101
GdkEvent* gdk_event_copy     		(const GdkEvent *event);
Owen Taylor's avatar
Started  
Owen Taylor committed
1102
void	  gdk_event_free     		(GdkEvent 	*event);
1103

1104 1105
guint32   gdk_event_get_time            (const GdkEvent  *event);
gboolean  gdk_event_get_state           (const GdkEvent  *event,
1106
                                         GdkModifierType *state);
1107
gboolean  gdk_event_get_coords		(const GdkEvent  *event,
1108 1109
					 gdouble	 *x_win,
					 gdouble	 *y_win);
1110 1111 1112
gboolean  gdk_event_get_root_coords	(const GdkEvent *event,
					 gdouble	*x_root,
					 gdouble	*y_root);
1113
GDK_AVAILABLE_IN_3_2
1114 1115
gboolean  gdk_event_get_button          (const GdkEvent *event,
                                         guint          *button);
1116
GDK_AVAILABLE_IN_3_2
1117 1118
gboolean  gdk_event_get_click_count     (const GdkEvent *event,
                                         guint          *click_count);
1119
GDK_AVAILABLE_IN_3_2
1120 1121
gboolean  gdk_event_get_keyval          (const GdkEvent *event,
                                         guint          *keyval);
1122
GDK_AVAILABLE_IN_3_2
1123 1124
gboolean  gdk_event_get_keycode         (const GdkEvent *event,
                                         guint16        *keycode);
1125
GDK_AVAILABLE_IN_3_2
1126 1127
gboolean gdk_event_get_scroll_direction (const GdkEvent *event,
                                         GdkScrollDirection *direction);
1128
gboolean  gdk_event_get_axis            (const GdkEvent  *event,
1129 1130
                                         GdkAxisUse       axis_use,
                                         gdouble         *value);
1131 1132 1133
void       gdk_event_set_device         (GdkEvent        *event,
                                         GdkDevice       *device);
GdkDevice* gdk_event_get_device         (const GdkEvent  *event);
1134 1135 1136
void       gdk_event_set_source_device  (GdkEvent        *event,
                                         GdkDevice       *device);
GdkDevice* gdk_event_get_source_device  (const GdkEvent  *event);
1137
void       gdk_event_request_motions    (const GdkEventMotion *event);
1138
GDK_AVAILABLE_IN_3_4
1139
gboolean   gdk_event_triggers_context_menu (const GdkEvent *event);
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151

gboolean  gdk_events_get_distance       (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *distance);
gboolean  gdk_events_get_angle          (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *angle);
gboolean  gdk_events_get_center         (GdkEvent        *event1,
                                         GdkEvent        *event2,
                                         gdouble         *x,
                                         gdouble         *y);

Owen Taylor's avatar
Started  
Owen Taylor committed
1152 1153 1154 1155
void	  gdk_event_handler_set 	(GdkEventFunc    func,
					 gpointer        data,
					 GDestroyNotify  notify);

1156 1157 1158
void       gdk_event_set_screen         (GdkEvent        *event,
                                         GdkScreen       *screen);
GdkScreen *gdk_event_get_screen         (const GdkEvent  *event);
1159

Owen Taylor's avatar
Owen Taylor committed
1160 1161
void	  gdk_set_show_events		(gboolean	 show_events);
gboolean  gdk_get_show_events		(void);
Owen Taylor's avatar
Started  
Owen Taylor committed
1162

1163
#ifndef GDK_MULTIHEAD_SAFE
Owen Taylor's avatar
Started  
Owen Taylor committed
1164

1165 1166 1167
gboolean gdk_setting_get                           (const gchar *name,
                                                    GValue          *value);

1168
#endif /* GDK_MULTIHEAD_SAFE */
Owen Taylor's avatar
Started  
Owen Taylor committed
1169

1170
G_END_DECLS
Owen Taylor's avatar
Started  
Owen Taylor committed
1171 1172

#endif /* __GDK_EVENTS_H__ */