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 <!-- ##### SECTION Stability_Level ##### -->
  31
  32
  33 <!-- ##### ENUM GdkEventType ##### -->
  34 <para>
  35 Specifies the type of the event.
  36 </para>
  37 <para>
  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.
  41 </para>
  42
  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
  46 title bar.
  47 @GDK_DESTROY: the window has been destroyed.
  48 @GDK_EXPOSE: all or part of the window has become visible and needs to be
  49 redrawn.
  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
  74 surface.
  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
  78 progress.
  79 @GDK_DRAG_STATUS: the status of the drag operation initiated by the window
  80 has changed.
  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
  92   was added in 2.6
  93
  94 <!-- ##### ENUM GdkEventMask ##### -->
  95 <para>
  96 A set of bit-flags to indicate which events a window is to receive.
  97 Most of these masks map onto one or more of the #GdkEventType event types
  98 above.
  99 </para>
 100 <para>
 101 %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
 102 number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
 103 event is received each time the mouse moves. However, if the application
 104 spends a lot of time processing the event (updating the display, for example),
 105 it can easily lag behind the position of the mouse. When using the
 106 %GDK_POINTER_MOTION_HINT_MASK the server will only send a single %GDK_MOTION_NOTIFY
 107 event (which is marked as a hint) until the application asks for more, by calling
 108 gdk_window_get_pointer().
 109 </para>
 110
 111 @GDK_EXPOSURE_MASK:
 112 @GDK_POINTER_MOTION_MASK:
 113 @GDK_POINTER_MOTION_HINT_MASK:
 114 @GDK_BUTTON_MOTION_MASK:
 115 @GDK_BUTTON1_MOTION_MASK:
 116 @GDK_BUTTON2_MOTION_MASK:
 117 @GDK_BUTTON3_MOTION_MASK:
 118 @GDK_BUTTON_PRESS_MASK:
 119 @GDK_BUTTON_RELEASE_MASK:
 120 @GDK_KEY_PRESS_MASK:
 121 @GDK_KEY_RELEASE_MASK:
 122 @GDK_ENTER_NOTIFY_MASK:
 123 @GDK_LEAVE_NOTIFY_MASK:
 124 @GDK_FOCUS_CHANGE_MASK:
 125 @GDK_STRUCTURE_MASK:
 126 @GDK_PROPERTY_CHANGE_MASK:
 127 @GDK_VISIBILITY_NOTIFY_MASK:
 128 @GDK_PROXIMITY_IN_MASK:
 129 @GDK_PROXIMITY_OUT_MASK:
 130 @GDK_SUBSTRUCTURE_MASK:
 131 @GDK_SCROLL_MASK:
 132 @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
 133
 134 <!-- ##### MACRO GDK_CURRENT_TIME ##### -->
 135 <para>
 136 Represents the current time, and can be used anywhere a time is expected.
 137 </para>
 138
 139
 140
 141 <!-- ##### MACRO GDK_PRIORITY_EVENTS ##### -->
 142 <para>
 143 This is the priority that events from the X server are given in the
 144 <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 145 </para>
 146
 147
 148
 149 <!-- ##### MACRO GDK_PRIORITY_REDRAW ##### -->
 150 <para>
 151 This is the priority that the idle handler processing window updates
 152 is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 153 </para>
 154
 155
 156
 157 <!-- ##### FUNCTION gdk_events_pending ##### -->
 158 <para>
 159 </para>
 160
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gdk_event_peek ##### -->
 165 <para>
 166 </para>
 167
 168 @Returns:
 169
 170
 171 <!-- ##### FUNCTION gdk_event_get ##### -->
 172 <para>
 173 </para>
 174
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
 179 <para>
 180 </para>
 181
 182 @window:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION gdk_event_put ##### -->
 187 <para>
 188 </para>
 189
 190 @event:
 191
 192
 193 <!-- ##### FUNCTION gdk_event_new ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @type:
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION gdk_event_copy ##### -->
 203 <para>
 204 </para>
 205
 206 @event:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gdk_event_free ##### -->
 211 <para>
 212 </para>
 213
 214 @event: a #GdkEvent.
 215
 216
 217 <!-- ##### FUNCTION gdk_event_get_time ##### -->
 218 <para>
 219 </para>
 220
 221 @event:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION gdk_event_get_state ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @event:
 231 @state:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION gdk_event_get_axis ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @event:
 241 @axis_use:
 242 @value:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gdk_event_get_coords ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @event:
 252 @x_win:
 253 @y_win:
 254 @Returns:
 255
 256
 257 <!-- ##### FUNCTION gdk_event_get_root_coords ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @event:
 263 @x_root:
 264 @y_root:
 265 @Returns:
 266
 267
 268 <!-- ##### FUNCTION gdk_event_handler_set ##### -->
 269 <para>
 270 </para>
 271
 272 @func:
 273 @data:
 274 @notify:
 275
 276
 277 <!-- ##### USER_FUNCTION GdkEventFunc ##### -->
 278 <para>
 279 Specifies the type of function passed to gdk_event_handler_set() to handle
 280 all GDK events.
 281 </para>
 282
 283 @event: the #GdkEvent to process.
 284 @data: user data set when the event handler was installed with
 285 gdk_event_handler_set().
 286
 287
 288 <!-- ##### FUNCTION gdk_event_send_client_message ##### -->
 289 <para>
 290 </para>
 291
 292 @event:
 293 @winid:
 294 @Returns:
 295 <!-- # Unused Parameters # -->
 296 @xid:
 297
 298
 299 <!-- ##### FUNCTION gdk_event_send_client_message_for_display ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @display:
 305 @event:
 306 @winid:
 307 @Returns:
 308 <!-- # Unused Parameters # -->
 309 @xid:
 310
 311
 312 <!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
 313 <para>
 314 </para>
 315
 316 @event:
 317
 318
 319 <!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
 320 <para>
 321 </para>
 322
 323 @message_type:
 324 @func:
 325 @data:
 326
 327
 328 <!-- ##### FUNCTION gdk_get_show_events ##### -->
 329 <para>
 330 </para>
 331
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION gdk_set_show_events ##### -->
 336 <para>
 337 </para>
 338
 339 @show_events:
 340
 341
 342 <!-- ##### FUNCTION gdk_event_set_screen ##### -->
 343 <para>
 344
 345 </para>
 346
 347 @event:
 348 @screen:
 349
 350
 351 <!-- ##### FUNCTION gdk_event_get_screen ##### -->
 352 <para>
 353
 354 </para>
 355
 356 @event:
 357 @Returns:
 358
 359
 360 <!-- ##### FUNCTION gdk_setting_get ##### -->
 361 <para>
 362 </para>
 363
 364 @name:
 365 @value:
 366 @Returns:
 367
 368