1 /* GDK - The GTK+ 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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
28 #error "Only <gdk/gdk.h> can be included directly."
31 #ifndef __GDK_EVENTS_H__
32 #define __GDK_EVENTS_H__
34 #include <gdk/gdkcolor.h>
35 #include <gdk/gdktypes.h>
36 #include <gdk/gdkdnd.h>
37 #include <gdk/gdkinput.h>
41 #define GDK_TYPE_EVENT (gdk_event_get_type ())
43 #define GDK_PRIORITY_EVENTS (G_PRIORITY_DEFAULT)
44 #define GDK_PRIORITY_REDRAW (G_PRIORITY_HIGH_IDLE + 20)
47 typedef struct _GdkEventAny GdkEventAny;
48 typedef struct _GdkEventExpose GdkEventExpose;
49 typedef struct _GdkEventNoExpose GdkEventNoExpose;
50 typedef struct _GdkEventVisibility GdkEventVisibility;
51 typedef struct _GdkEventMotion GdkEventMotion;
52 typedef struct _GdkEventButton GdkEventButton;
53 typedef struct _GdkEventScroll GdkEventScroll;
54 typedef struct _GdkEventKey GdkEventKey;
55 typedef struct _GdkEventFocus GdkEventFocus;
56 typedef struct _GdkEventCrossing GdkEventCrossing;
57 typedef struct _GdkEventConfigure GdkEventConfigure;
58 typedef struct _GdkEventProperty GdkEventProperty;
59 typedef struct _GdkEventSelection GdkEventSelection;
60 typedef struct _GdkEventOwnerChange GdkEventOwnerChange;
61 typedef struct _GdkEventProximity GdkEventProximity;
62 typedef struct _GdkEventClient GdkEventClient;
63 typedef struct _GdkEventDND GdkEventDND;
64 typedef struct _GdkEventWindowState GdkEventWindowState;
65 typedef struct _GdkEventSetting GdkEventSetting;
66 typedef struct _GdkEventGrabBroken GdkEventGrabBroken;
68 typedef union _GdkEvent GdkEvent;
70 typedef void (*GdkEventFunc) (GdkEvent *event,
75 typedef void GdkXEvent; /* Can be cast to window system specific
76 * even type, XEvent on X11, MSG on Win32.
80 GDK_FILTER_CONTINUE, /* Event not handled, continue processesing */
81 GDK_FILTER_TRANSLATE, /* Native event translated into a GDK event and
82 stored in the "event" structure that was
84 GDK_FILTER_REMOVE /* Terminate processing, removing event */
87 typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent,
93 * Nothing: No event occurred.
94 * Delete: A window delete event was sent by the window manager.
95 * The specified window should be deleted.
96 * Destroy: A window has been destroyed.
97 * Expose: Part of a window has been uncovered.
98 * NoExpose: Same as expose, but no expose event was generated.
99 * VisibilityNotify: A window has become fully/partially/not obscured.
100 * MotionNotify: The mouse has moved.
101 * ButtonPress: A mouse button was pressed.
102 * ButtonRelease: A mouse button was release.
103 * KeyPress: A key was pressed.
104 * KeyRelease: A key was released.
105 * EnterNotify: A window was entered.
106 * LeaveNotify: A window was exited.
107 * FocusChange: The focus window has changed. (The focus window gets
109 * Resize: A window has been resized.
110 * Map: A window has been mapped. (It is now visible on the screen).
111 * Unmap: A window has been unmapped. (It is no longer visible on
113 * Scroll: A mouse wheel was scrolled either up or down.
121 GDK_MOTION_NOTIFY = 3,
122 GDK_BUTTON_PRESS = 4,
123 GDK_2BUTTON_PRESS = 5,
124 GDK_3BUTTON_PRESS = 6,
125 GDK_BUTTON_RELEASE = 7,
128 GDK_ENTER_NOTIFY = 10,
129 GDK_LEAVE_NOTIFY = 11,
130 GDK_FOCUS_CHANGE = 12,
134 GDK_PROPERTY_NOTIFY = 16,
135 GDK_SELECTION_CLEAR = 17,
136 GDK_SELECTION_REQUEST = 18,
137 GDK_SELECTION_NOTIFY = 19,
138 GDK_PROXIMITY_IN = 20,
139 GDK_PROXIMITY_OUT = 21,
142 GDK_DRAG_MOTION = 24,
143 GDK_DRAG_STATUS = 25,
145 GDK_DROP_FINISHED = 27,
146 GDK_CLIENT_EVENT = 28,
147 GDK_VISIBILITY_NOTIFY = 29,
150 GDK_WINDOW_STATE = 32,
152 GDK_OWNER_CHANGE = 34,
153 GDK_GRAB_BROKEN = 35,
157 /* Event masks. (Used to select what types of events a window
162 GDK_EXPOSURE_MASK = 1 << 1,
163 GDK_POINTER_MOTION_MASK = 1 << 2,
164 GDK_POINTER_MOTION_HINT_MASK = 1 << 3,
165 GDK_BUTTON_MOTION_MASK = 1 << 4,
166 GDK_BUTTON1_MOTION_MASK = 1 << 5,
167 GDK_BUTTON2_MOTION_MASK = 1 << 6,
168 GDK_BUTTON3_MOTION_MASK = 1 << 7,
169 GDK_BUTTON_PRESS_MASK = 1 << 8,
170 GDK_BUTTON_RELEASE_MASK = 1 << 9,
171 GDK_KEY_PRESS_MASK = 1 << 10,
172 GDK_KEY_RELEASE_MASK = 1 << 11,
173 GDK_ENTER_NOTIFY_MASK = 1 << 12,
174 GDK_LEAVE_NOTIFY_MASK = 1 << 13,
175 GDK_FOCUS_CHANGE_MASK = 1 << 14,
176 GDK_STRUCTURE_MASK = 1 << 15,
177 GDK_PROPERTY_CHANGE_MASK = 1 << 16,
178 GDK_VISIBILITY_NOTIFY_MASK = 1 << 17,
179 GDK_PROXIMITY_IN_MASK = 1 << 18,
180 GDK_PROXIMITY_OUT_MASK = 1 << 19,
181 GDK_SUBSTRUCTURE_MASK = 1 << 20,
182 GDK_SCROLL_MASK = 1 << 21,
183 GDK_ALL_EVENTS_MASK = 0x3FFFFE
188 GDK_VISIBILITY_UNOBSCURED,
189 GDK_VISIBILITY_PARTIAL,
190 GDK_VISIBILITY_FULLY_OBSCURED
191 } GdkVisibilityState;
199 } GdkScrollDirection;
201 /* Types of enter/leave notifications.
207 * Unknown: An unknown type of enter/leave event occurred.
211 GDK_NOTIFY_ANCESTOR = 0,
212 GDK_NOTIFY_VIRTUAL = 1,
213 GDK_NOTIFY_INFERIOR = 2,
214 GDK_NOTIFY_NONLINEAR = 3,
215 GDK_NOTIFY_NONLINEAR_VIRTUAL = 4,
216 GDK_NOTIFY_UNKNOWN = 5
219 /* Enter/leave event modes.
233 GDK_PROPERTY_NEW_VALUE,
239 GDK_WINDOW_STATE_WITHDRAWN = 1 << 0,
240 GDK_WINDOW_STATE_ICONIFIED = 1 << 1,
241 GDK_WINDOW_STATE_MAXIMIZED = 1 << 2,
242 GDK_WINDOW_STATE_STICKY = 1 << 3,
243 GDK_WINDOW_STATE_FULLSCREEN = 1 << 4,
244 GDK_WINDOW_STATE_ABOVE = 1 << 5,
245 GDK_WINDOW_STATE_BELOW = 1 << 6
250 GDK_SETTING_ACTION_NEW,
251 GDK_SETTING_ACTION_CHANGED,
252 GDK_SETTING_ACTION_DELETED
257 GDK_OWNER_CHANGE_NEW_OWNER,
258 GDK_OWNER_CHANGE_DESTROY,
259 GDK_OWNER_CHANGE_CLOSE
269 struct _GdkEventExpose
276 gint count; /* If non-zero, how many more events follow. */
279 struct _GdkEventNoExpose
286 struct _GdkEventVisibility
291 GdkVisibilityState state;
294 struct _GdkEventMotion
306 gdouble x_root, y_root;
309 struct _GdkEventButton
321 gdouble x_root, y_root;
324 struct _GdkEventScroll
333 GdkScrollDirection direction;
335 gdouble x_root, y_root;
348 guint16 hardware_keycode;
350 guint is_modifier : 1;
353 struct _GdkEventCrossing
358 GdkWindow *subwindow;
364 GdkCrossingMode mode;
365 GdkNotifyType detail;
370 struct _GdkEventFocus
378 struct _GdkEventConfigure
388 struct _GdkEventProperty
398 struct _GdkEventSelection
407 GdkNativeWindow requestor;
410 struct _GdkEventOwnerChange
415 GdkNativeWindow owner;
416 GdkOwnerChange reason;
419 guint32 selection_time;
422 /* This event type will be used pretty rarely. It only is important
423 for XInput aware programs that are drawing their own cursor */
425 struct _GdkEventProximity
434 struct _GdkEventClient
439 GdkAtom message_type;
448 struct _GdkEventSetting
453 GdkSettingAction action;
457 struct _GdkEventWindowState
462 GdkWindowState changed_mask;
463 GdkWindowState new_window_state;
466 struct _GdkEventGrabBroken {
472 GdkWindow *grab_window;
475 /* Event types for DND */
477 struct _GdkEventDND {
481 GdkDragContext *context;
484 gshort x_root, y_root;
491 GdkEventExpose expose;
492 GdkEventNoExpose no_expose;
493 GdkEventVisibility visibility;
494 GdkEventMotion motion;
495 GdkEventButton button;
496 GdkEventScroll scroll;
498 GdkEventCrossing crossing;
499 GdkEventFocus focus_change;
500 GdkEventConfigure configure;
501 GdkEventProperty property;
502 GdkEventSelection selection;
503 GdkEventOwnerChange owner_change;
504 GdkEventProximity proximity;
505 GdkEventClient client;
507 GdkEventWindowState window_state;
508 GdkEventSetting setting;
509 GdkEventGrabBroken grab_broken;
512 GType gdk_event_get_type (void) G_GNUC_CONST;
514 gboolean gdk_events_pending (void);
515 GdkEvent* gdk_event_get (void);
517 GdkEvent* gdk_event_peek (void);
518 GdkEvent* gdk_event_get_graphics_expose (GdkWindow *window);
519 void gdk_event_put (const GdkEvent *event);
521 GdkEvent* gdk_event_new (GdkEventType type);
522 GdkEvent* gdk_event_copy (const GdkEvent *event);
523 void gdk_event_free (GdkEvent *event);
525 guint32 gdk_event_get_time (const GdkEvent *event);
526 gboolean gdk_event_get_state (const GdkEvent *event,
527 GdkModifierType *state);
528 gboolean gdk_event_get_coords (const GdkEvent *event,
531 gboolean gdk_event_get_root_coords (const GdkEvent *event,
534 gboolean gdk_event_get_axis (const GdkEvent *event,
537 void gdk_event_request_motions (const GdkEventMotion *event);
538 void gdk_event_handler_set (GdkEventFunc func,
540 GDestroyNotify notify);
542 void gdk_event_set_screen (GdkEvent *event,
544 GdkScreen *gdk_event_get_screen (const GdkEvent *event);
546 void gdk_set_show_events (gboolean show_events);
547 gboolean gdk_get_show_events (void);
549 #ifndef GDK_MULTIHEAD_SAFE
550 void gdk_add_client_message_filter (GdkAtom message_type,
554 gboolean gdk_setting_get (const gchar *name,
556 #endif /* GDK_MULTIHEAD_SAFE */
560 #endif /* __GDK_EVENTS_H__ */