1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __GDK_EVENTS_H__
28 #define __GDK_EVENTS_H__
30 #include <gdk/gdkcolor.h>
31 #include <gdk/gdktypes.h>
32 #include <gdk/gdkdnd.h>
33 #include <gdk/gdkinput.h>
37 #define GDK_TYPE_EVENT (gdk_event_get_type ())
39 #define GDK_PRIORITY_EVENTS (G_PRIORITY_DEFAULT)
40 #define GDK_PRIORITY_REDRAW (G_PRIORITY_HIGH_IDLE + 20)
43 typedef struct _GdkEventAny GdkEventAny;
44 typedef struct _GdkEventExpose GdkEventExpose;
45 typedef struct _GdkEventNoExpose GdkEventNoExpose;
46 typedef struct _GdkEventVisibility GdkEventVisibility;
47 typedef struct _GdkEventMotion GdkEventMotion;
48 typedef struct _GdkEventButton GdkEventButton;
49 typedef struct _GdkEventScroll GdkEventScroll;
50 typedef struct _GdkEventKey GdkEventKey;
51 typedef struct _GdkEventFocus GdkEventFocus;
52 typedef struct _GdkEventCrossing GdkEventCrossing;
53 typedef struct _GdkEventConfigure GdkEventConfigure;
54 typedef struct _GdkEventProperty GdkEventProperty;
55 typedef struct _GdkEventSelection GdkEventSelection;
56 typedef struct _GdkEventOwnerChange GdkEventOwnerChange;
57 typedef struct _GdkEventProximity GdkEventProximity;
58 typedef struct _GdkEventClient GdkEventClient;
59 typedef struct _GdkEventDND GdkEventDND;
60 typedef struct _GdkEventWindowState GdkEventWindowState;
61 typedef struct _GdkEventSetting GdkEventSetting;
62 typedef struct _GdkEventGrabBroken GdkEventGrabBroken;
64 typedef union _GdkEvent GdkEvent;
66 typedef void (*GdkEventFunc) (GdkEvent *event,
71 typedef void GdkXEvent; /* Can be cast to window system specific
72 * even type, XEvent on X11, MSG on Win32.
76 GDK_FILTER_CONTINUE, /* Event not handled, continue processesing */
77 GDK_FILTER_TRANSLATE, /* Native event translated into a GDK event and
78 stored in the "event" structure that was
80 GDK_FILTER_REMOVE /* Terminate processing, removing event */
83 typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
89 * Nothing: No event occurred.
90 * Delete: A window delete event was sent by the window manager.
91 * The specified window should be deleted.
92 * Destroy: A window has been destroyed.
93 * Expose: Part of a window has been uncovered.
94 * NoExpose: Same as expose, but no expose event was generated.
95 * VisibilityNotify: A window has become fully/partially/not obscured.
96 * MotionNotify: The mouse has moved.
97 * ButtonPress: A mouse button was pressed.
98 * ButtonRelease: A mouse button was release.
99 * KeyPress: A key was pressed.
100 * KeyRelease: A key was released.
101 * EnterNotify: A window was entered.
102 * LeaveNotify: A window was exited.
103 * FocusChange: The focus window has changed. (The focus window gets
105 * Resize: A window has been resized.
106 * Map: A window has been mapped. (It is now visible on the screen).
107 * Unmap: A window has been unmapped. (It is no longer visible on
109 * Scroll: A mouse wheel was scrolled either up or down.
117 GDK_MOTION_NOTIFY = 3,
118 GDK_BUTTON_PRESS = 4,
119 GDK_2BUTTON_PRESS = 5,
120 GDK_3BUTTON_PRESS = 6,
121 GDK_BUTTON_RELEASE = 7,
124 GDK_ENTER_NOTIFY = 10,
125 GDK_LEAVE_NOTIFY = 11,
126 GDK_FOCUS_CHANGE = 12,
130 GDK_PROPERTY_NOTIFY = 16,
131 GDK_SELECTION_CLEAR = 17,
132 GDK_SELECTION_REQUEST = 18,
133 GDK_SELECTION_NOTIFY = 19,
134 GDK_PROXIMITY_IN = 20,
135 GDK_PROXIMITY_OUT = 21,
138 GDK_DRAG_MOTION = 24,
139 GDK_DRAG_STATUS = 25,
141 GDK_DROP_FINISHED = 27,
142 GDK_CLIENT_EVENT = 28,
143 GDK_VISIBILITY_NOTIFY = 29,
146 GDK_WINDOW_STATE = 32,
148 GDK_OWNER_CHANGE = 34,
152 /* Event masks. (Used to select what types of events a window
157 GDK_EXPOSURE_MASK = 1 << 1,
158 GDK_POINTER_MOTION_MASK = 1 << 2,
159 GDK_POINTER_MOTION_HINT_MASK = 1 << 3,
160 GDK_BUTTON_MOTION_MASK = 1 << 4,
161 GDK_BUTTON1_MOTION_MASK = 1 << 5,
162 GDK_BUTTON2_MOTION_MASK = 1 << 6,
163 GDK_BUTTON3_MOTION_MASK = 1 << 7,
164 GDK_BUTTON_PRESS_MASK = 1 << 8,
165 GDK_BUTTON_RELEASE_MASK = 1 << 9,
166 GDK_KEY_PRESS_MASK = 1 << 10,
167 GDK_KEY_RELEASE_MASK = 1 << 11,
168 GDK_ENTER_NOTIFY_MASK = 1 << 12,
169 GDK_LEAVE_NOTIFY_MASK = 1 << 13,
170 GDK_FOCUS_CHANGE_MASK = 1 << 14,
171 GDK_STRUCTURE_MASK = 1 << 15,
172 GDK_PROPERTY_CHANGE_MASK = 1 << 16,
173 GDK_VISIBILITY_NOTIFY_MASK = 1 << 17,
174 GDK_PROXIMITY_IN_MASK = 1 << 18,
175 GDK_PROXIMITY_OUT_MASK = 1 << 19,
176 GDK_SUBSTRUCTURE_MASK = 1 << 20,
177 GDK_SCROLL_MASK = 1 << 21,
178 GDK_ALL_EVENTS_MASK = 0x3FFFFE
183 GDK_VISIBILITY_UNOBSCURED,
184 GDK_VISIBILITY_PARTIAL,
185 GDK_VISIBILITY_FULLY_OBSCURED
186 } GdkVisibilityState;
194 } GdkScrollDirection;
196 /* Types of enter/leave notifications.
202 * Unknown: An unknown type of enter/leave event occurred.
206 GDK_NOTIFY_ANCESTOR = 0,
207 GDK_NOTIFY_VIRTUAL = 1,
208 GDK_NOTIFY_INFERIOR = 2,
209 GDK_NOTIFY_NONLINEAR = 3,
210 GDK_NOTIFY_NONLINEAR_VIRTUAL = 4,
211 GDK_NOTIFY_UNKNOWN = 5
214 /* Enter/leave event modes.
228 GDK_PROPERTY_NEW_VALUE,
234 GDK_WINDOW_STATE_WITHDRAWN = 1 << 0,
235 GDK_WINDOW_STATE_ICONIFIED = 1 << 1,
236 GDK_WINDOW_STATE_MAXIMIZED = 1 << 2,
237 GDK_WINDOW_STATE_STICKY = 1 << 3,
238 GDK_WINDOW_STATE_FULLSCREEN = 1 << 4,
239 GDK_WINDOW_STATE_ABOVE = 1 << 5,
240 GDK_WINDOW_STATE_BELOW = 1 << 6
245 GDK_SETTING_ACTION_NEW,
246 GDK_SETTING_ACTION_CHANGED,
247 GDK_SETTING_ACTION_DELETED
252 GDK_OWNER_CHANGE_NEW_OWNER,
253 GDK_OWNER_CHANGE_DESTROY,
254 GDK_OWNER_CHANGE_CLOSE
264 struct _GdkEventExpose
271 gint count; /* If non-zero, how many more events follow. */
274 struct _GdkEventNoExpose
281 struct _GdkEventVisibility
286 GdkVisibilityState state;
289 struct _GdkEventMotion
301 gdouble x_root, y_root;
304 struct _GdkEventButton
316 gdouble x_root, y_root;
319 struct _GdkEventScroll
328 GdkScrollDirection direction;
330 gdouble x_root, y_root;
343 guint16 hardware_keycode;
345 guint is_modifier : 1;
348 struct _GdkEventCrossing
353 GdkWindow *subwindow;
359 GdkCrossingMode mode;
360 GdkNotifyType detail;
365 struct _GdkEventFocus
373 struct _GdkEventConfigure
383 struct _GdkEventProperty
393 struct _GdkEventSelection
402 GdkNativeWindow requestor;
405 struct _GdkEventOwnerChange
410 GdkNativeWindow owner;
411 GdkOwnerChange reason;
414 guint32 selection_time;
417 /* This event type will be used pretty rarely. It only is important
418 for XInput aware programs that are drawing their own cursor */
420 struct _GdkEventProximity
429 struct _GdkEventClient
434 GdkAtom message_type;
443 struct _GdkEventSetting
448 GdkSettingAction action;
452 struct _GdkEventWindowState
457 GdkWindowState changed_mask;
458 GdkWindowState new_window_state;
461 struct _GdkEventGrabBroken {
467 GdkWindow *grab_window;
470 /* Event types for DND */
472 struct _GdkEventDND {
476 GdkDragContext *context;
479 gshort x_root, y_root;
486 GdkEventExpose expose;
487 GdkEventNoExpose no_expose;
488 GdkEventVisibility visibility;
489 GdkEventMotion motion;
490 GdkEventButton button;
491 GdkEventScroll scroll;
493 GdkEventCrossing crossing;
494 GdkEventFocus focus_change;
495 GdkEventConfigure configure;
496 GdkEventProperty property;
497 GdkEventSelection selection;
498 GdkEventOwnerChange owner_change;
499 GdkEventProximity proximity;
500 GdkEventClient client;
502 GdkEventWindowState window_state;
503 GdkEventSetting setting;
504 GdkEventGrabBroken grab_broken;
507 GType gdk_event_get_type (void) G_GNUC_CONST;
509 gboolean gdk_events_pending (void);
510 GdkEvent* gdk_event_get (void);
512 GdkEvent* gdk_event_peek (void);
513 GdkEvent* gdk_event_get_graphics_expose (GdkWindow *window);
514 void gdk_event_put (const GdkEvent *event);
516 GdkEvent* gdk_event_new (GdkEventType type);
517 GdkEvent* gdk_event_copy (const GdkEvent *event);
518 void gdk_event_free (GdkEvent *event);
520 guint32 gdk_event_get_time (const GdkEvent *event);
521 gboolean gdk_event_get_state (const GdkEvent *event,
522 GdkModifierType *state);
523 gboolean gdk_event_get_coords (const GdkEvent *event,
526 gboolean gdk_event_get_root_coords (const GdkEvent *event,
529 gboolean gdk_event_get_axis (const GdkEvent *event,
532 void gdk_event_request_motions (const GdkEventMotion *event);
533 void gdk_event_handler_set (GdkEventFunc func,
535 GDestroyNotify notify);
537 void gdk_event_set_screen (GdkEvent *event,
539 GdkScreen *gdk_event_get_screen (const GdkEvent *event);
541 void gdk_set_show_events (gboolean show_events);
542 gboolean gdk_get_show_events (void);
544 #ifndef GDK_MULTIHEAD_SAFE
545 void gdk_add_client_message_filter (GdkAtom message_type,
549 gboolean gdk_setting_get (const gchar *name,
551 #endif /* GDK_MULTIHEAD_SAFE */
555 #endif /* __GDK_EVENTS_H__ */