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