Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/events.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Events
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 functions for handling events from the window system.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This section describes functions dealing with events from the window system.
  10 </para>
  11 <para>
  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.
  16 </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19 <para>
  20 <variablelist>
  21 <varlistentry>
  22 <term><link linkend="gdk-Event-Structures">Event Structures</link></term>
  23 <listitem><para>
  24 The structs used for each type of event.
  25 </para></listitem>
  26 </varlistentry>
  27 </variablelist>
  28 </para>
  29
  30 <!-- ##### ENUM GdkEventType ##### -->
  31 <para>
  32 Specifies the type of the event.
  33 </para>
  34 <para>
  35 Do not confuse these events with the signals that GTK+ widgets emit.
  36 Although many of these events result in corresponding signals being emitted,
  37 the events are often transformed or filtered along the way.
  38 </para>
  39
  40 @GDK_NOTHING: a special code to indicate a null event.
  41 @GDK_DELETE: the window manager has requested that the toplevel window be
  42 hidden or destroyed, usually when the user clicks on a special icon in the
  43 title bar.
  44 @GDK_DESTROY: the window has been destroyed.
  45 @GDK_EXPOSE: all or part of the window has become visible and needs to be
  46 redrawn.
  47 @GDK_MOTION_NOTIFY: the pointer (usually a mouse) has moved.
  48 @GDK_BUTTON_PRESS: a mouse button has been pressed.
  49 @GDK_2BUTTON_PRESS: a mouse button has been double-clicked (clicked twice
  50 within a short period of time). Note that each click also generates a
  51 %GDK_BUTTON_PRESS event.
  52 @GDK_3BUTTON_PRESS: a mouse button has been clicked 3 times in a short period
  53 of time. Note that each click also generates a %GDK_BUTTON_PRESS event.
  54 @GDK_BUTTON_RELEASE: a mouse button has been released.
  55 @GDK_KEY_PRESS: a key has been pressed.
  56 @GDK_KEY_RELEASE: a key has been released.
  57 @GDK_ENTER_NOTIFY: the pointer has entered the window.
  58 @GDK_LEAVE_NOTIFY: the pointer has left the window.
  59 @GDK_FOCUS_CHANGE: the keyboard focus has entered or left the window.
  60 @GDK_CONFIGURE: the size, position or stacking order of the window has changed.
  61 Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows.
  62 @GDK_MAP: the window has been mapped.
  63 @GDK_UNMAP: the window has been unmapped.
  64 @GDK_PROPERTY_NOTIFY: a property on the window has been changed or deleted.
  65 @GDK_SELECTION_CLEAR: the application has lost ownership of a selection.
  66 @GDK_SELECTION_REQUEST: another application has requested a selection.
  67 @GDK_SELECTION_NOTIFY: a selection has been received.
  68 @GDK_PROXIMITY_IN: an input device has moved into contact with a sensing
  69 surface (e.g. a touchscreen or graphics tablet).
  70 @GDK_PROXIMITY_OUT: an input device has moved out of contact with a sensing
  71 surface.
  72 @GDK_DRAG_ENTER: the mouse has entered the window while a drag is in progress.
  73 @GDK_DRAG_LEAVE: the mouse has left the window while a drag is in progress.
  74 @GDK_DRAG_MOTION: the mouse has moved in the window while a drag is in
  75 progress.
  76 @GDK_DRAG_STATUS: the status of the drag operation initiated by the window
  77 has changed.
  78 @GDK_DROP_START: a drop operation onto the window has started.
  79 @GDK_DROP_FINISHED: the drop operation initiated by the window has completed.
  80 @GDK_CLIENT_EVENT: a message has been received from another application.
  81 @GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
  82 @GDK_NO_EXPOSE: indicates that the source region was completely available
  83 when parts of a drawable were copied. This is not very useful.
  84
  85 <!-- ##### ENUM GdkEventMask ##### -->
  86 <para>
  87 A set of bit-flags to indicate which events a window is to receive.
  88 Most of these masks map onto one or more of the #GdkEventType event types
  89 above.
  90 </para>
  91 <para>
  92 %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
  93 number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
  94 event is received each time the mouse moves. However, if the application
  95 spends a lot of time processing the event (updating the display, for example),
  96 it can easily lag behind the position of the mouse. When using the
  97 %GDK_POINTER_MOTION_HINT_MASK the server will only send %GDK_MOTION_NOTIFY
  98 events when the application asks for them, by calling gdk_window_get_pointer().
  99 </para>
 100
 101 @GDK_EXPOSURE_MASK:
 102 @GDK_POINTER_MOTION_MASK:
 103 @GDK_POINTER_MOTION_HINT_MASK:
 104 @GDK_BUTTON_MOTION_MASK:
 105 @GDK_BUTTON1_MOTION_MASK:
 106 @GDK_BUTTON2_MOTION_MASK:
 107 @GDK_BUTTON3_MOTION_MASK:
 108 @GDK_BUTTON_PRESS_MASK:
 109 @GDK_BUTTON_RELEASE_MASK:
 110 @GDK_KEY_PRESS_MASK:
 111 @GDK_KEY_RELEASE_MASK:
 112 @GDK_ENTER_NOTIFY_MASK:
 113 @GDK_LEAVE_NOTIFY_MASK:
 114 @GDK_FOCUS_CHANGE_MASK:
 115 @GDK_STRUCTURE_MASK:
 116 @GDK_PROPERTY_CHANGE_MASK:
 117 @GDK_VISIBILITY_NOTIFY_MASK:
 118 @GDK_PROXIMITY_IN_MASK:
 119 @GDK_PROXIMITY_OUT_MASK:
 120 @GDK_SUBSTRUCTURE_MASK:
 121 @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
 122
 123 <!-- ##### MACRO GDK_CURRENT_TIME ##### -->
 124 <para>
 125 Represents the current time, and can be used anywhere a time is expected.
 126 </para>
 127
 128
 129
 130 <!-- ##### MACRO GDK_PRIORITY_EVENTS ##### -->
 131 <para>
 132 This is the priority that events from the X server are given in the
 133 <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 134 </para>
 135
 136
 137
 138 <!-- ##### FUNCTION gdk_events_pending ##### -->
 139 <para>
 140 Checks if any events are waiting to be processed.
 141 </para>
 142
 143 @Returns: TRUE if any events are pending.
 144
 145
 146 <!-- ##### FUNCTION gdk_event_peek ##### -->
 147 <para>
 148 Gets a copy of the first #GdkEvent in the event queue.
 149 (Note that this function will not get more events from the X server.
 150 It only checks the events that have already been moved to the GDK event queue.)
 151 </para>
 152
 153 @Returns: a copy of the first #GdkEvent on the event queue, or NULL if no
 154 events are in the queue. The returned #GdkEvent should be freed with
 155 gdk_event_free().
 156
 157
 158 <!-- ##### FUNCTION gdk_event_get ##### -->
 159 <para>
 160 Gets the next #GdkEvent to be processed, fetching events from the X server if
 161 necessary.
 162 </para>
 163
 164 @Returns: the next #GdkEvent to be processed, or NULL if no events are pending.
 165 The returned #GdkEvent should be freed with gdk_event_free().
 166
 167
 168 <!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
 169 <para>
 170 Waits for a GraphicsExpose or NoExpose event from the X server.
 171 This is used in the #GtkText and #GtkCList widgets in GTK+ to make sure any
 172 GraphicsExpose events are handled before the widget is scrolled.
 173 </para>
 174
 175 @window: the #GdkWindow to wait for the events for.
 176 @Returns: a #GdkEventExpose if a GraphicsExpose was received, or NULL if a
 177 NoExpose event was received.
 178
 179
 180 <!-- ##### FUNCTION gdk_event_put ##### -->
 181 <para>
 182 Appends a copy of the given event onto the front of the event queue.
 183 </para>
 184
 185 @event: a #GdkEvent.
 186
 187
 188 <!-- ##### FUNCTION gdk_event_copy ##### -->
 189 <para>
 190 Copies a #GdkEvent, copying or incrementing the reference count of the
 191 resources associated with it (e.g. #GdkWindow's and strings).
 192 </para>
 193
 194 @event: a #GdkEvent.
 195 @Returns: a copy of @event. The returned #GdkEvent should be freed with
 196 gdk_event_free().
 197
 198
 199 <!-- ##### FUNCTION gdk_event_free ##### -->
 200 <para>
 201 Frees a #GdkEvent, freeing or decrementing any resources associated with it.
 202 Note that this function should only be called with events returned from
 203 gdk_event_peek(), gdk_event_get(), gdk_event_get_graphics_expose() and
 204 gdk_event_copy().
 205 </para>
 206
 207 @event: a #GdkEvent.
 208
 209
 210 <!-- ##### FUNCTION gdk_event_get_time ##### -->
 211 <para>
 212 Gets the timestamp from a #GdkEvent.
 213 </para>
 214
 215 @event: a #GdkEvent.
 216 @Returns: the timestamp from @event, or #GDK_CURRENT_TIME if the event has
 217 no timestamp.
 218
 219
 220 <!-- ##### FUNCTION gdk_event_handler_set ##### -->
 221 <para>
 222 Sets the function to call to handle all events from GDK.
 223 </para>
 224 <para>
 225 Note that GTK+ uses this to install its own event handler, so it is probably
 226 not useful for GTK+ applications.
 227 </para>
 228
 229 @func: the function to call to handle events from GDK.
 230 @data: user data to pass to the function.
 231 @notify: the function to call when the handler function is removed, i.e. when
 232 gdk_event_handler_set() is called with another event handler.
 233
 234
 235 <!-- ##### USER_FUNCTION GdkEventFunc ##### -->
 236 <para>
 237 Specifies the type of function passed to gdk_event_handler_set() to handle
 238 all GDK events.
 239 </para>
 240
 241 @event: the #GdkEvent to process.
 242 @data: user data set when the event handler was installed with
 243 gdk_event_handler_set().
 244
 245
 246 <!-- ##### FUNCTION gdk_event_send_client_message ##### -->
 247 <para>
 248 Sends an X ClientMessage event to a given window.
 249 </para>
 250 <para>
 251 This could be used for communicating between different applications,
 252 though the amount of data is limited to 20 bytes.
 253 </para>
 254
 255 @event: the #GdkEvent to send, which should be a #GdkEventClient.
 256 @xid: the window to send the X ClientMessage event to.
 257 @Returns: non-zero on success.
 258
 259
 260 <!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
 261 <para>
 262 Sends an X ClientMessage event to all toplevel windows.
 263 </para>
 264 <para>
 265 Toplevel windows are determined by checking for the WM_STATE property, as
 266 described in the Inter-Client Communication Conventions Manual (ICCCM).
 267 If no windows are found with the WM_STATE property set, the message is sent
 268 to all children of the root window.
 269 </para>
 270
 271 @event: the #GdkEvent to send, which should be a #GdkEventClient.
 272
 273
 274 <!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
 275 <para>
 276 Adds a filter to be called when X ClientMessage events are received.
 277 </para>
 278
 279 @message_type: the type of ClientMessage events to receive. This will be
 280 checked against the <structfield>message_type</structfield> field of the
 281 XClientMessage event struct.
 282 @func: the function to call to process the event.
 283 @data: user data to pass to @func.
 284
 285
 286 <!-- ##### FUNCTION gdk_get_show_events ##### -->
 287 <para>
 288 Returns non-zero if event debugging output is enabled.
 289 </para>
 290
 291 @Returns: non-zero if event debugging output is enabled.
 292
 293
 294 <!-- ##### FUNCTION gdk_set_show_events ##### -->
 295 <para>
 296 Sets whether event debugging information is output.
 297 Note that GTK+ must be compiled with debugging enabled, i.e. using the
 298 '--enable-debug' configure option.
 299 </para>
 300
 301 @show_events: TRUE to output event debugging information.
 302
 303