gdkevents.h 13.8 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 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
#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 37 38
#include <gdk/gdktypes.h>
#include <gdk/gdkdnd.h>
#include <gdk/gdkinput.h>

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
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
78 79 80

typedef enum {
  GDK_FILTER_CONTINUE,	  /* Event not handled, continue processesing */
81 82 83
  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
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  GDK_FILTER_REMOVE	  /* Terminate processing, removing event */
} GdkFilterReturn;

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).
113
 *   Scroll: A mouse wheel was scrolled either up or down.
Owen Taylor's avatar
Owen Taylor committed
114 115 116 117 118 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 145 146 147
 */
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,
148
  GDK_NO_EXPOSE		= 30,
149
  GDK_SCROLL            = 31,
150
  GDK_WINDOW_STATE      = 32,
151
  GDK_SETTING           = 33,
152
  GDK_OWNER_CHANGE      = 34,
153
  GDK_GRAB_BROKEN       = 35,
154 155
  GDK_DAMAGE            = 36,
  GDK_EVENT_LAST        /* helper variable for decls */
Owen Taylor's avatar
Owen Taylor committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
} GdkEventType;

/* Event masks. (Used to select what types of events a window
 *  will receive).
 */
typedef enum
{
  GDK_EXPOSURE_MASK		= 1 << 1,
  GDK_POINTER_MOTION_MASK	= 1 << 2,
  GDK_POINTER_MOTION_HINT_MASK	= 1 << 3,
  GDK_BUTTON_MOTION_MASK	= 1 << 4,
  GDK_BUTTON1_MOTION_MASK	= 1 << 5,
  GDK_BUTTON2_MOTION_MASK	= 1 << 6,
  GDK_BUTTON3_MOTION_MASK	= 1 << 7,
  GDK_BUTTON_PRESS_MASK		= 1 << 8,
  GDK_BUTTON_RELEASE_MASK	= 1 << 9,
  GDK_KEY_PRESS_MASK		= 1 << 10,
  GDK_KEY_RELEASE_MASK		= 1 << 11,
  GDK_ENTER_NOTIFY_MASK		= 1 << 12,
  GDK_LEAVE_NOTIFY_MASK		= 1 << 13,
  GDK_FOCUS_CHANGE_MASK		= 1 << 14,
  GDK_STRUCTURE_MASK		= 1 << 15,
  GDK_PROPERTY_CHANGE_MASK	= 1 << 16,
  GDK_VISIBILITY_NOTIFY_MASK	= 1 << 17,
  GDK_PROXIMITY_IN_MASK		= 1 << 18,
  GDK_PROXIMITY_OUT_MASK	= 1 << 19,
  GDK_SUBSTRUCTURE_MASK		= 1 << 20,
183 184
  GDK_SCROLL_MASK               = 1 << 21,
  GDK_ALL_EVENTS_MASK		= 0x3FFFFE
Owen Taylor's avatar
Owen Taylor committed
185 186
} GdkEventMask;

187 188
typedef enum
{
Owen Taylor's avatar
Owen Taylor committed
189 190 191 192 193
  GDK_VISIBILITY_UNOBSCURED,
  GDK_VISIBILITY_PARTIAL,
  GDK_VISIBILITY_FULLY_OBSCURED
} GdkVisibilityState;

194 195 196 197 198 199 200 201
typedef enum
{
  GDK_SCROLL_UP,
  GDK_SCROLL_DOWN,
  GDK_SCROLL_LEFT,
  GDK_SCROLL_RIGHT
} GdkScrollDirection;

Owen Taylor's avatar
Owen Taylor committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
/* 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,
229 230 231 232
  GDK_CROSSING_UNGRAB,
  GDK_CROSSING_GTK_GRAB,
  GDK_CROSSING_GTK_UNGRAB,
  GDK_CROSSING_STATE_CHANGED
Owen Taylor's avatar
Owen Taylor committed
233 234 235 236 237 238 239 240
} GdkCrossingMode;

typedef enum
{
  GDK_PROPERTY_NEW_VALUE,
  GDK_PROPERTY_DELETE
} GdkPropertyState;

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

252 253 254 255 256 257 258
typedef enum
{
  GDK_SETTING_ACTION_NEW,
  GDK_SETTING_ACTION_CHANGED,
  GDK_SETTING_ACTION_DELETED
} GdkSettingAction;

259 260 261 262 263 264 265
typedef enum
{
  GDK_OWNER_CHANGE_NEW_OWNER,
  GDK_OWNER_CHANGE_DESTROY,
  GDK_OWNER_CHANGE_CLOSE
} GdkOwnerChange;

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

struct _GdkEventExpose
{
  GdkEventType type;
  GdkWindow *window;
  gint8 send_event;
  GdkRectangle area;
279
  GdkRegion *region;
Owen Taylor's avatar
Owen Taylor committed
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
  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;
306
  gdouble *axes;
Owen Taylor's avatar
Owen Taylor committed
307 308
  guint state;
  gint16 is_hint;
309
  GdkDevice *device;
Owen Taylor's avatar
Owen Taylor committed
310 311 312 313 314 315 316 317 318 319 320
  gdouble x_root, y_root;
};

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

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

Owen Taylor's avatar
Owen Taylor committed
342 343 344 345 346 347 348 349 350 351
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
352
  guint16 hardware_keycode;
Havoc Pennington's avatar
Havoc Pennington committed
353
  guint8 group;
354
  guint is_modifier : 1;
Owen Taylor's avatar
Owen Taylor committed
355 356 357 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
};

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;
387 388 389
  gint x, y;
  gint width;
  gint height;
Owen Taylor's avatar
Owen Taylor committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
};

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
411
  GdkNativeWindow requestor;
Owen Taylor's avatar
Owen Taylor committed
412 413
};

414 415 416 417 418 419 420 421 422 423 424 425
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
426 427 428 429 430 431 432 433 434
/* 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;
435
  GdkDevice *device;
Owen Taylor's avatar
Owen Taylor committed
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
};

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

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

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

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

Owen Taylor's avatar
Owen Taylor committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
/* 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;
500
  GdkEventScroll            scroll;
Owen Taylor's avatar
Owen Taylor committed
501 502 503 504 505 506
  GdkEventKey		    key;
  GdkEventCrossing	    crossing;
  GdkEventFocus		    focus_change;
  GdkEventConfigure	    configure;
  GdkEventProperty	    property;
  GdkEventSelection	    selection;
507
  GdkEventOwnerChange  	    owner_change;
Owen Taylor's avatar
Owen Taylor committed
508 509 510
  GdkEventProximity	    proximity;
  GdkEventClient	    client;
  GdkEventDND               dnd;
511
  GdkEventWindowState       window_state;
512
  GdkEventSetting           setting;
513
  GdkEventGrabBroken        grab_broken;
Owen Taylor's avatar
Owen Taylor committed
514 515
};

Matthias Clasen's avatar
Matthias Clasen committed
516
GType     gdk_event_get_type            (void) G_GNUC_CONST;
517

Owen Taylor's avatar
Owen Taylor committed
518 519 520 521 522
gboolean  gdk_events_pending	 	(void);
GdkEvent* gdk_event_get			(void);

GdkEvent* gdk_event_peek                (void);
GdkEvent* gdk_event_get_graphics_expose (GdkWindow 	*window);
523
void      gdk_event_put	 		(const GdkEvent *event);
Owen Taylor's avatar
Owen Taylor committed
524

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

529 530
guint32   gdk_event_get_time            (const GdkEvent  *event);
gboolean  gdk_event_get_state           (const GdkEvent  *event,
531
                                         GdkModifierType *state);
532
gboolean  gdk_event_get_coords		(const GdkEvent  *event,
533 534
					 gdouble	 *x_win,
					 gdouble	 *y_win);
535
gboolean  gdk_event_get_root_coords	(const GdkEvent  *event,
536 537
					 gdouble	 *x_root,
					 gdouble	 *y_root);
538
gboolean  gdk_event_get_axis            (const GdkEvent  *event,
539 540
                                         GdkAxisUse       axis_use,
                                         gdouble         *value);
541
void      gdk_event_request_motions     (const GdkEventMotion *event);
Owen Taylor's avatar
Owen Taylor committed
542 543 544 545
void	  gdk_event_handler_set 	(GdkEventFunc    func,
					 gpointer        data,
					 GDestroyNotify  notify);

546 547 548
void       gdk_event_set_screen         (GdkEvent        *event,
                                         GdkScreen       *screen);
GdkScreen *gdk_event_get_screen         (const GdkEvent  *event);
549

Owen Taylor's avatar
Owen Taylor committed
550 551
void	  gdk_set_show_events		(gboolean	 show_events);
gboolean  gdk_get_show_events		(void);
Owen Taylor's avatar
Owen Taylor committed
552

553
#ifndef GDK_MULTIHEAD_SAFE
Owen Taylor's avatar
Owen Taylor committed
554 555 556 557
void gdk_add_client_message_filter (GdkAtom       message_type,
				    GdkFilterFunc func,
				    gpointer      data);

558 559
gboolean gdk_setting_get (const gchar *name,
			  GValue      *value); 
560
#endif /* GDK_MULTIHEAD_SAFE */
Owen Taylor's avatar
Owen Taylor committed
561

562
G_END_DECLS
Owen Taylor's avatar
Owen Taylor committed
563 564

#endif /* __GDK_EVENTS_H__ */