1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 Functions for handling events from the window system
7 <!-- ##### SECTION Long_Description ##### -->
9 This section describes functions dealing with events from the window system.
12 In GTK+ applications the events are handled automatically in
13 gtk_main_do_event() and passed on to the appropriate widgets, so these
14 functions are rarely needed. Though some of the fields in the
15 <link linkend="gdk-Event-Structures">Event Structures</link> are useful.
18 <!-- ##### SECTION See_Also ##### -->
22 <term><link linkend="gdk-Event-Structures">Event Structures</link></term>
24 The structs used for each type of event.
30 <!-- ##### SECTION Stability_Level ##### -->
33 <!-- ##### ENUM GdkEventType ##### -->
35 Specifies the type of the event.
38 Do not confuse these events with the signals that GTK+ widgets emit.
39 Although many of these events result in corresponding signals being emitted,
40 the events are often transformed or filtered along the way.
43 @GDK_NOTHING: a special code to indicate a null event.
44 @GDK_DELETE: the window manager has requested that the toplevel window be
45 hidden or destroyed, usually when the user clicks on a special icon in the
47 @GDK_DESTROY: the window has been destroyed.
48 @GDK_EXPOSE: all or part of the window has become visible and needs to be
50 @GDK_MOTION_NOTIFY: the pointer (usually a mouse) has moved.
51 @GDK_BUTTON_PRESS: a mouse button has been pressed.
52 @GDK_2BUTTON_PRESS: a mouse button has been double-clicked (clicked twice
53 within a short period of time). Note that each click also generates a
54 %GDK_BUTTON_PRESS event.
55 @GDK_3BUTTON_PRESS: a mouse button has been clicked 3 times in a short period
56 of time. Note that each click also generates a %GDK_BUTTON_PRESS event.
57 @GDK_BUTTON_RELEASE: a mouse button has been released.
58 @GDK_KEY_PRESS: a key has been pressed.
59 @GDK_KEY_RELEASE: a key has been released.
60 @GDK_ENTER_NOTIFY: the pointer has entered the window.
61 @GDK_LEAVE_NOTIFY: the pointer has left the window.
62 @GDK_FOCUS_CHANGE: the keyboard focus has entered or left the window.
63 @GDK_CONFIGURE: the size, position or stacking order of the window has changed.
64 Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows.
65 @GDK_MAP: the window has been mapped.
66 @GDK_UNMAP: the window has been unmapped.
67 @GDK_PROPERTY_NOTIFY: a property on the window has been changed or deleted.
68 @GDK_SELECTION_CLEAR: the application has lost ownership of a selection.
69 @GDK_SELECTION_REQUEST: another application has requested a selection.
70 @GDK_SELECTION_NOTIFY: a selection has been received.
71 @GDK_PROXIMITY_IN: an input device has moved into contact with a sensing
72 surface (e.g. a touchscreen or graphics tablet).
73 @GDK_PROXIMITY_OUT: an input device has moved out of contact with a sensing
75 @GDK_DRAG_ENTER: the mouse has entered the window while a drag is in progress.
76 @GDK_DRAG_LEAVE: the mouse has left the window while a drag is in progress.
77 @GDK_DRAG_MOTION: the mouse has moved in the window while a drag is in
79 @GDK_DRAG_STATUS: the status of the drag operation initiated by the window
81 @GDK_DROP_START: a drop operation onto the window has started.
82 @GDK_DROP_FINISHED: the drop operation initiated by the window has completed.
83 @GDK_CLIENT_EVENT: a message has been received from another application.
84 @GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
85 @GDK_NO_EXPOSE: indicates that the source region was completely available
86 when parts of a drawable were copied. This is not very useful.
87 @GDK_SCROLL: the scroll wheel was turned
88 @GDK_WINDOW_STATE: the state of a window has changed. See #GdkWindowState
89 for the possible window states
90 @GDK_SETTING: a setting has been modified.
91 @GDK_OWNER_CHANGE: the owner of a selection has changed. This event type
93 @GDK_GRAB_BROKEN: a pointer or keyboard grab was broken. This event type
95 @GDK_DAMAGE: the content of the window has been changed. This event type
98 <!-- ##### ENUM GdkEventMask ##### -->
100 A set of bit-flags to indicate which events a window is to receive.
101 Most of these masks map onto one or more of the #GdkEventType event types
105 %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
106 number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
107 event is received each time the mouse moves. However, if the application
108 spends a lot of time processing the event (updating the display, for example),
109 it can lag behind the position of the mouse. When using
110 %GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent,
111 some of which are marked as a hint (the is_hint member is %TRUE).
112 To receive more motion events after a motion hint event, the application
113 needs to asks for more, by calling gdk_event_request_motions().
116 @GDK_EXPOSURE_MASK: receive expose events
117 @GDK_POINTER_MOTION_MASK: receive all pointer motion events
118 @GDK_POINTER_MOTION_HINT_MASK: see the explanation above
119 @GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed
120 @GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed
121 @GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed
122 @GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed
123 @GDK_BUTTON_PRESS_MASK: receive button press events
124 @GDK_BUTTON_RELEASE_MASK: receive button release events
125 @GDK_KEY_PRESS_MASK: receive key press events
126 @GDK_KEY_RELEASE_MASK: receive key release events
127 @GDK_ENTER_NOTIFY_MASK: receive window enter events
128 @GDK_LEAVE_NOTIFY_MASK: receive window leave events
129 @GDK_FOCUS_CHANGE_MASK: receive focus change events
130 @GDK_STRUCTURE_MASK: receive events about window configuration change
131 @GDK_PROPERTY_CHANGE_MASK: receive property change events
132 @GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events
133 @GDK_PROXIMITY_IN_MASK: receive proximity in events
134 @GDK_PROXIMITY_OUT_MASK: receive proximity out events
135 @GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of
137 @GDK_SCROLL_MASK: receive scroll events
138 @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
140 <!-- ##### MACRO GDK_CURRENT_TIME ##### -->
142 Represents the current time, and can be used anywhere a time is expected.
147 <!-- ##### MACRO GDK_PRIORITY_EVENTS ##### -->
149 This is the priority that events from the X server are given in the
150 <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
155 <!-- ##### MACRO GDK_PRIORITY_REDRAW ##### -->
157 This is the priority that the idle handler processing window updates
158 is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
163 <!-- ##### FUNCTION gdk_events_pending ##### -->
170 <!-- ##### FUNCTION gdk_event_peek ##### -->
177 <!-- ##### FUNCTION gdk_event_get ##### -->
184 <!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
192 <!-- ##### FUNCTION gdk_event_put ##### -->
199 <!-- ##### FUNCTION gdk_event_new ##### -->
208 <!-- ##### FUNCTION gdk_event_copy ##### -->
216 <!-- ##### FUNCTION gdk_event_free ##### -->
223 <!-- ##### FUNCTION gdk_event_get_time ##### -->
231 <!-- ##### FUNCTION gdk_event_get_state ##### -->
241 <!-- ##### FUNCTION gdk_event_get_axis ##### -->
252 <!-- ##### FUNCTION gdk_event_get_coords ##### -->
263 <!-- ##### FUNCTION gdk_event_get_root_coords ##### -->
274 <!-- ##### FUNCTION gdk_event_request_motions ##### -->
282 <!-- ##### FUNCTION gdk_event_handler_set ##### -->
291 <!-- ##### USER_FUNCTION GdkEventFunc ##### -->
293 Specifies the type of function passed to gdk_event_handler_set() to handle
297 @event: the #GdkEvent to process.
298 @data: user data set when the event handler was installed with
299 gdk_event_handler_set().
302 <!-- ##### FUNCTION gdk_event_send_client_message ##### -->
311 <!-- ##### FUNCTION gdk_event_send_client_message_for_display ##### -->
322 <!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
329 <!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
338 <!-- ##### FUNCTION gdk_get_show_events ##### -->
345 <!-- ##### FUNCTION gdk_set_show_events ##### -->
352 <!-- ##### FUNCTION gdk_event_set_screen ##### -->
361 <!-- ##### FUNCTION gdk_event_get_screen ##### -->
370 <!-- ##### FUNCTION gdk_setting_get ##### -->