gdkevents.h 15.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2 3 4 5 6 7 8 9 10 11 12 13 14 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
Owen Taylor committed
31 32 33
#ifndef __GDK_EVENTS_H__
#define __GDK_EVENTS_H__

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

39
G_BEGIN_DECLS
Owen Taylor's avatar
Owen Taylor committed
40

41 42
#define GDK_TYPE_EVENT          (gdk_event_get_type ())

43 44 45
#define GDK_PRIORITY_EVENTS	(G_PRIORITY_DEFAULT)
#define GDK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)

Owen Taylor's avatar
Owen Taylor committed
46 47 48 49 50 51 52

typedef struct _GdkEventAny	    GdkEventAny;
typedef struct _GdkEventExpose	    GdkEventExpose;
typedef struct _GdkEventNoExpose    GdkEventNoExpose;
typedef struct _GdkEventVisibility  GdkEventVisibility;
typedef struct _GdkEventMotion	    GdkEventMotion;
typedef struct _GdkEventButton	    GdkEventButton;
53
typedef struct _GdkEventScroll      GdkEventScroll;  
Owen Taylor's avatar
Owen Taylor committed
54 55 56 57 58 59
typedef struct _GdkEventKey	    GdkEventKey;
typedef struct _GdkEventFocus	    GdkEventFocus;
typedef struct _GdkEventCrossing    GdkEventCrossing;
typedef struct _GdkEventConfigure   GdkEventConfigure;
typedef struct _GdkEventProperty    GdkEventProperty;
typedef struct _GdkEventSelection   GdkEventSelection;
60
typedef struct _GdkEventOwnerChange GdkEventOwnerChange;
Owen Taylor's avatar
Owen Taylor committed
61 62 63
typedef struct _GdkEventProximity   GdkEventProximity;
typedef struct _GdkEventClient	    GdkEventClient;
typedef struct _GdkEventDND         GdkEventDND;
64
typedef struct _GdkEventWindowState GdkEventWindowState;
65
typedef struct _GdkEventSetting     GdkEventSetting;
66
typedef struct _GdkEventGrabBroken  GdkEventGrabBroken;
Owen Taylor's avatar
Owen Taylor committed
67 68 69 70 71 72 73 74

typedef union  _GdkEvent	    GdkEvent;

typedef void (*GdkEventFunc) (GdkEvent *event,
			      gpointer	data);

/* Event filtering */

75 76 77 78 79 80
/**
 * GdkXEvent:
 *
 * Used to represent native events (<type>XEvent</type>s for the X11
 * backend, <type>MSG</type>s for Win32).
 */
81 82 83
typedef void GdkXEvent;	  /* Can be cast to window system specific
			   * even type, XEvent on X11, MSG on Win32.
			   */
Owen Taylor's avatar
Owen Taylor committed
84

85 86 87 88 89 90 91 92 93
/**
 * 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
Owen Taylor committed
94 95
typedef enum {
  GDK_FILTER_CONTINUE,	  /* Event not handled, continue processesing */
96 97 98
  GDK_FILTER_TRANSLATE,	  /* Native event translated into a GDK event and
                             stored in the "event" structure that was
                             passed in */
Owen Taylor's avatar
Owen Taylor committed
99 100 101
  GDK_FILTER_REMOVE	  /* Terminate processing, removing event */
} GdkFilterReturn;

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/**
 * 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
Owen Taylor committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
					  GdkEvent *event,
					  gpointer  data);


/* Event types.
 *   Nothing: No event occurred.
 *   Delete: A window delete event was sent by the window manager.
 *	     The specified window should be deleted.
 *   Destroy: A window has been destroyed.
 *   Expose: Part of a window has been uncovered.
 *   NoExpose: Same as expose, but no expose event was generated.
 *   VisibilityNotify: A window has become fully/partially/not obscured.
 *   MotionNotify: The mouse has moved.
 *   ButtonPress: A mouse button was pressed.
 *   ButtonRelease: A mouse button was release.
 *   KeyPress: A key was pressed.
 *   KeyRelease: A key was released.
 *   EnterNotify: A window was entered.
 *   LeaveNotify: A window was exited.
 *   FocusChange: The focus window has changed. (The focus window gets
 *		  keyboard events).
 *   Resize: A window has been resized.
 *   Map: A window has been mapped. (It is now visible on the screen).
 *   Unmap: A window has been unmapped. (It is no longer visible on
 *	    the screen).
145
 *   Scroll: A mouse wheel was scrolled either up or down.
Owen Taylor's avatar
Owen Taylor committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
 */
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,
180
  GDK_NO_EXPOSE		= 30,
181
  GDK_SCROLL            = 31,
182
  GDK_WINDOW_STATE      = 32,
183
  GDK_SETTING           = 33,
184
  GDK_OWNER_CHANGE      = 34,
185
  GDK_GRAB_BROKEN       = 35,
186 187
  GDK_DAMAGE            = 36,
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Owen Taylor committed
188 189
} GdkEventType;

190 191
typedef enum
{
Owen Taylor's avatar
Owen Taylor committed
192 193 194 195 196
  GDK_VISIBILITY_UNOBSCURED,
  GDK_VISIBILITY_PARTIAL,
  GDK_VISIBILITY_FULLY_OBSCURED
} GdkVisibilityState;

197 198 199 200 201 202 203 204
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
  GDK_SCROLL_RIGHT
} GdkScrollDirection;

Owen Taylor's avatar
Owen Taylor committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
/* Types of enter/leave notifications.
 *   Ancestor:
 *   Virtual:
 *   Inferior:
 *   Nonlinear:
 *   NonlinearVirtual:
 *   Unknown: An unknown type of enter/leave event occurred.
 */
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;

/* Enter/leave event modes.
 *   NotifyNormal
 *   NotifyGrab
 *   NotifyUngrab
 */
typedef enum
{
  GDK_CROSSING_NORMAL,
  GDK_CROSSING_GRAB,
232 233 234 235
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
  GDK_CROSSING_STATE_CHANGED
Owen Taylor's avatar
Owen Taylor committed
236 237 238 239 240 241 242 243
} GdkCrossingMode;

typedef enum
{
  GDK_PROPERTY_NEW_VALUE,
  GDK_PROPERTY_DELETE
} GdkPropertyState;

244 245
typedef enum
{
246 247 248 249
  GDK_WINDOW_STATE_WITHDRAWN  = 1 << 0,
  GDK_WINDOW_STATE_ICONIFIED  = 1 << 1,
  GDK_WINDOW_STATE_MAXIMIZED  = 1 << 2,
  GDK_WINDOW_STATE_STICKY     = 1 << 3,
250 251 252
  GDK_WINDOW_STATE_FULLSCREEN = 1 << 4,
  GDK_WINDOW_STATE_ABOVE      = 1 << 5,
  GDK_WINDOW_STATE_BELOW      = 1 << 6
253 254
} GdkWindowState;

255 256 257 258 259 260 261
typedef enum
{
  GDK_SETTING_ACTION_NEW,
  GDK_SETTING_ACTION_CHANGED,
  GDK_SETTING_ACTION_DELETED
} GdkSettingAction;

262 263 264 265 266 267 268
typedef enum
{
  GDK_OWNER_CHANGE_NEW_OWNER,
  GDK_OWNER_CHANGE_DESTROY,
  GDK_OWNER_CHANGE_CLOSE
} GdkOwnerChange;

Owen Taylor's avatar
Owen Taylor committed
269 270 271 272 273 274 275 276 277 278 279 280 281
struct _GdkEventAny
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
};

struct _GdkEventExpose
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkRectangle area;
282
  cairo_region_t *region;
Owen Taylor's avatar
Owen Taylor committed
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 308
  gint count; /* If non-zero, how many more events follow. */
};

struct _GdkEventNoExpose
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
};

struct _GdkEventVisibility
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkVisibilityState state;
};

struct _GdkEventMotion
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
309
  gdouble *axes;
Owen Taylor's avatar
Owen Taylor committed
310 311
  guint state;
  gint16 is_hint;
312
  GdkDevice *device;
Owen Taylor's avatar
Owen Taylor committed
313 314 315 316 317 318 319 320 321 322 323
  gdouble x_root, y_root;
};

struct _GdkEventButton
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
324
  gdouble *axes;
Owen Taylor's avatar
Owen Taylor committed
325 326
  guint state;
  guint button;
327
  GdkDevice *device;
Owen Taylor's avatar
Owen Taylor committed
328 329 330
  gdouble x_root, y_root;
};

331 332 333 334 335 336 337 338 339 340
struct _GdkEventScroll
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
  gdouble x;
  gdouble y;
  guint state;
  GdkScrollDirection direction;
341
  GdkDevice *device;
342 343 344
  gdouble x_root, y_root;
};

Owen Taylor's avatar
Owen Taylor committed
345 346 347 348 349 350 351 352 353 354
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
355
  guint16 hardware_keycode;
Havoc Pennington's avatar
Havoc Pennington committed
356
  guint8 group;
357
  guint is_modifier : 1;
Owen Taylor's avatar
Owen Taylor committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
};

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;
};

struct _GdkEventFocus
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gint16 in;
};

struct _GdkEventConfigure
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
390 391 392
  gint x, y;
  gint width;
  gint height;
Owen Taylor's avatar
Owen Taylor committed
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
};

struct _GdkEventProperty
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom atom;
  guint32 time;
  guint state;
};

struct _GdkEventSelection
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom selection;
  GdkAtom target;
  GdkAtom property;
  guint32 time;
Elliot Lee's avatar
Elliot Lee committed
414
  GdkNativeWindow requestor;
Owen Taylor's avatar
Owen Taylor committed
415 416
};

417 418 419 420 421 422 423 424 425 426 427 428
struct _GdkEventOwnerChange
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkNativeWindow owner;
  GdkOwnerChange reason;
  GdkAtom selection;
  guint32 time;
  guint32 selection_time;
};

Owen Taylor's avatar
Owen Taylor committed
429 430 431 432 433 434 435 436 437
/* This event type will be used pretty rarely. It only is important
   for XInput aware programs that are drawing their own cursor */

struct _GdkEventProximity
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  guint32 time;
438
  GdkDevice *device;
Owen Taylor's avatar
Owen Taylor committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
};

struct _GdkEventClient
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkAtom message_type;
  gushort data_format;
  union {
    char b[20];
    short s[10];
    long l[5];
  } data;
};

455 456 457 458 459 460 461 462
struct _GdkEventSetting
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkSettingAction action;
  char *name;
};
463 464 465 466 467 468 469 470 471 472

struct _GdkEventWindowState
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkWindowState changed_mask;
  GdkWindowState new_window_state;
};

473 474 475 476 477
struct _GdkEventGrabBroken {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  gboolean keyboard;
Matthias Clasen's avatar
Matthias Clasen committed
478
  gboolean implicit;
479
  GdkWindow *grab_window;
480 481
};

Owen Taylor's avatar
Owen Taylor committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
/* Event types for DND */

struct _GdkEventDND {
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkDragContext *context;

  guint32 time;
  gshort x_root, y_root;
};

union _GdkEvent
{
  GdkEventType		    type;
  GdkEventAny		    any;
  GdkEventExpose	    expose;
  GdkEventNoExpose	    no_expose;
  GdkEventVisibility	    visibility;
  GdkEventMotion	    motion;
  GdkEventButton	    button;
503
  GdkEventScroll            scroll;
Owen Taylor's avatar
Owen Taylor committed
504 505 506 507 508 509
  GdkEventKey		    key;
  GdkEventCrossing	    crossing;
  GdkEventFocus		    focus_change;
  GdkEventConfigure	    configure;
  GdkEventProperty	    property;
  GdkEventSelection	    selection;
510
  GdkEventOwnerChange  	    owner_change;
Owen Taylor's avatar
Owen Taylor committed
511 512 513
  GdkEventProximity	    proximity;
  GdkEventClient	    client;
  GdkEventDND               dnd;
514
  GdkEventWindowState       window_state;
515
  GdkEventSetting           setting;
516
  GdkEventGrabBroken        grab_broken;
Owen Taylor's avatar
Owen Taylor committed
517 518
};

Matthias Clasen's avatar
Matthias Clasen committed
519
GType     gdk_event_get_type            (void) G_GNUC_CONST;
520

Owen Taylor's avatar
Owen Taylor committed
521 522 523 524
gboolean  gdk_events_pending	 	(void);
GdkEvent* gdk_event_get			(void);

GdkEvent* gdk_event_peek                (void);
525
void      gdk_event_put	 		(const GdkEvent *event);
Owen Taylor's avatar
Owen Taylor committed
526

527
GdkEvent* gdk_event_new                 (GdkEventType    type);
528
GdkEvent* gdk_event_copy     		(const GdkEvent *event);
Owen Taylor's avatar
Owen Taylor committed
529
void	  gdk_event_free     		(GdkEvent 	*event);
530

531 532
guint32   gdk_event_get_time            (const GdkEvent  *event);
gboolean  gdk_event_get_state           (const GdkEvent  *event,
533
                                         GdkModifierType *state);
534
gboolean  gdk_event_get_coords		(const GdkEvent  *event,
535 536
					 gdouble	 *x_win,
					 gdouble	 *y_win);
537
gboolean  gdk_event_get_root_coords	(const GdkEvent  *event,
538 539
					 gdouble	 *x_root,
					 gdouble	 *y_root);
540
gboolean  gdk_event_get_axis            (const GdkEvent  *event,
541 542
                                         GdkAxisUse       axis_use,
                                         gdouble         *value);
543 544 545
void       gdk_event_set_device         (GdkEvent        *event,
                                         GdkDevice       *device);
GdkDevice* gdk_event_get_device         (const GdkEvent  *event);
546
void      gdk_event_request_motions     (const GdkEventMotion *event);
547 548 549 550 551 552 553 554 555 556 557 558

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
Owen Taylor committed
559 560 561 562
void	  gdk_event_handler_set 	(GdkEventFunc    func,
					 gpointer        data,
					 GDestroyNotify  notify);

563 564 565
void       gdk_event_set_screen         (GdkEvent        *event,
                                         GdkScreen       *screen);
GdkScreen *gdk_event_get_screen         (const GdkEvent  *event);
566

Owen Taylor's avatar
Owen Taylor committed
567 568
void	  gdk_set_show_events		(gboolean	 show_events);
gboolean  gdk_get_show_events		(void);
Owen Taylor's avatar
Owen Taylor committed
569

570
#ifndef GDK_MULTIHEAD_SAFE
Owen Taylor's avatar
Owen Taylor committed
571

572 573 574 575 576 577 578 579 580
gboolean gdk_setting_get                           (const gchar *name,
                                                    GValue          *value);
void gdk_add_client_message_filter                 (GdkAtom          message_type,
                                                    GdkFilterFunc    func,
                                                    gpointer         data);
gboolean gdk_event_send_client_message             (GdkEvent        *event,
                                                    GdkNativeWindow  winid);
void     gdk_event_send_clientmessage_toall        (GdkEvent        *event);

581
#endif /* GDK_MULTIHEAD_SAFE */
Owen Taylor's avatar
Owen Taylor committed
582

583 584 585 586
gboolean gdk_event_send_client_message_for_display (GdkDisplay      *display,
                                                    GdkEvent        *event,
                                                    GdkNativeWindow  winid);

587
G_END_DECLS
Owen Taylor's avatar
Owen Taylor committed
588 589

#endif /* __GDK_EVENTS_H__ */