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

   1 <!-- ##### SECTION Title ##### -->
   2 GdkDisplay
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GdkDisplay objects purpose are two fold:
  10 <itemizedlist>
  11 <listitem><para>To grab/ungrab keyboard focus and mouse pointer</para></listitem>
  12 <listitem><para>To manage and provide information about the #GdkScreen(s)
  13                 available for this #GdkDisplay
  14           </para></listitem>
  15 </itemizedlist>
  16 </para>
  17 <para>
  18   #GdkDisplay objects are the GDK representation of the X Display which can be
  19   described as <emphasis>a workstation consisting of a keyboard a pointing
  20   device (such as a mouse) and one or more screens</emphasis>.
  21   It is used to open and keep track of various #GdkScreen objects currently
  22   instanciated by the application. It is also used to grab and release the keyboard
  23   and the mouse pointer.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28
  29 </para>
  30
  31 <!-- ##### SECTION Stability_Level ##### -->
  32
  33
  34 <!-- ##### STRUCT GdkDisplay ##### -->
  35 <para>
  36 The <structname>GdkDisplay</structname> struct is the GDK representation
  37 of an X display. All its fields are private and should not be accessed directly.
  38 </para>
  39
  40 @Since: 2.2
  41
  42 <!-- ##### SIGNAL GdkDisplay::closed ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @gdkdisplay: the object which received the signal.
  48 @arg1:
  49
  50 <!-- ##### FUNCTION gdk_display_open ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @display_name:
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION gdk_display_get_default ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION gdk_display_get_name ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @display:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION gdk_display_get_n_screens ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @display:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION gdk_display_get_screen ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @display:
  91 @screen_num:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gdk_display_get_default_screen ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @display:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION gdk_display_pointer_ungrab ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @display:
 110 @time_:
 111
 112
 113 <!-- ##### FUNCTION gdk_display_keyboard_ungrab ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @display:
 119 @time_:
 120
 121
 122 <!-- ##### FUNCTION gdk_display_pointer_is_grabbed ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @display:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gdk_display_beep ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @display:
 137
 138
 139 <!-- ##### FUNCTION gdk_display_sync ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @display:
 145
 146
 147 <!-- ##### FUNCTION gdk_display_flush ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @display:
 153
 154
 155 <!-- ##### FUNCTION gdk_display_close ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @display:
 161
 162
 163 <!-- ##### FUNCTION gdk_display_list_devices ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @display:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION gdk_display_get_event ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @display:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gdk_display_peek_event ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @display:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION gdk_display_put_event ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @display:
 196 @event:
 197
 198
 199 <!-- ##### FUNCTION gdk_display_add_client_message_filter ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @display:
 205 @message_type:
 206 @func:
 207 @data:
 208
 209
 210 <!-- ##### FUNCTION gdk_display_set_double_click_time ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @display:
 216 @msec:
 217
 218
 219 <!-- ##### FUNCTION gdk_display_set_double_click_distance ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @display:
 225 @distance:
 226
 227
 228 <!-- ##### FUNCTION gdk_display_get_pointer ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @display:
 234 @screen:
 235 @x:
 236 @y:
 237 @mask:
 238
 239
 240 <!-- ##### FUNCTION gdk_display_get_window_at_pointer ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @display:
 246 @win_x:
 247 @win_y:
 248 @Returns:
 249
 250
 251 <!-- ##### STRUCT GdkDisplayPointerHooks ##### -->
 252 <para>
 253 A table of pointers to functions for getting quantities related to
 254 the current pointer position. Each #GdkDisplay has a table of this type,
 255 which can be set using gdk_display_set_pointer_hooks().
 256 </para>
 257 <para>
 258 This is only useful for such low-level tools as an event recorder.
 259 Applications should never have any reason to use this facility
 260 </para>
 261
 262 @get_pointer: Obtains the current pointer position and modifier state.
 263   The position is given in coordinates relative to the window containing
 264   the pointer, which is returned in @window.
 265 @window_get_pointer: Obtains the window underneath the mouse pointer.
 266   Current pointer position and modifier state are returned in @x, @y and
 267   @mask. The position is given in coordinates relative to @window.
 268 @window_at_pointer: Obtains the window underneath the mouse pointer,
 269   returning the location of that window in @win_x, @win_y. Returns %NULL
 270   if the window under the mouse pointer is not known to GDK (for example,
 271   belongs to another application).
 272 @Since: 2.2
 273
 274 <!-- ##### FUNCTION gdk_display_set_pointer_hooks ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @display:
 280 @new_hooks:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION gdk_display_warp_pointer ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @display:
 290 @screen:
 291 @x:
 292 @y:
 293
 294
 295 <!-- ##### FUNCTION gdk_display_supports_cursor_color ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @display:
 301 @Returns:
 302
 303
 304 <!-- ##### FUNCTION gdk_display_supports_cursor_alpha ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @display:
 310 @Returns:
 311
 312
 313 <!-- ##### FUNCTION gdk_display_get_default_cursor_size ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @display:
 319 @Returns:
 320
 321
 322 <!-- ##### FUNCTION gdk_display_get_maximal_cursor_size ##### -->
 323 <para>
 324
 325 </para>
 326
 327 @display:
 328 @width:
 329 @height:
 330
 331
 332 <!-- ##### FUNCTION gdk_display_get_default_group ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @display:
 338 @Returns:
 339
 340
 341 <!-- ##### FUNCTION gdk_display_supports_selection_notification ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @display:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gdk_display_request_selection_notification ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @display:
 356 @selection:
 357 @Returns:
 358
 359
 360 <!-- ##### FUNCTION gdk_display_supports_clipboard_persistence ##### -->
 361 <para>
 362
 363 </para>
 364
 365 @display:
 366 @Returns:
 367
 368
 369 <!-- ##### FUNCTION gdk_display_store_clipboard ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @display:
 375 @clipboard_window:
 376 @time_:
 377 @targets:
 378 @n_targets:
 379
 380
 381 <!-- ##### FUNCTION gdk_display_supports_shapes ##### -->
 382 <para>
 383
 384 </para>
 385
 386 @display:
 387 @Returns:
 388
 389
 390 <!-- ##### FUNCTION gdk_display_supports_input_shapes ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @display:
 396 @Returns:
 397
 398