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

   1 <!-- ##### SECTION Title ##### -->
   2 X Window System Interaction
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### MACRO GDK_ROOT_WINDOW ##### -->
  18 <para>
  19 Obtains the Xlib window id of the root window of the current screen.
  20 </para>
  21
  22
  23
  24 <!-- ##### MACRO GDK_ROOT_PARENT ##### -->
  25 <para>
  26 Obtains the Xlib window id of the root window of the default screen.
  27 </para>
  28
  29
  30
  31 <!-- ##### MACRO GDK_DISPLAY ##### -->
  32 <para>
  33 The current display.
  34 </para>
  35
  36 @Returns: an Xlib <type>Display*</type>.
  37
  38
  39 <!-- ##### MACRO GDK_WINDOW_XDISPLAY ##### -->
  40 <para>
  41 Returns the display of a #GdkWindow.
  42 </para>
  43
  44 @win: a #GdkWindow.
  45 @Returns: an Xlib <type>Display*</type>.
  46
  47
  48 <!-- ##### MACRO GDK_WINDOW_XID ##### -->
  49 <para>
  50 Returns the X window belonging to a #GdkWindow.
  51 </para>
  52
  53 @win: a #GdkWindow.
  54 @Returns: the Xlib <type>Window</type> of @win.
  55
  56
  57 <!-- ##### MACRO GDK_PIXMAP_XDISPLAY ##### -->
  58 <para>
  59 Returns the display of a #GdkPixmap.
  60 </para>
  61
  62 @win: a #GdkPixmap.
  63 @Returns: an Xlib <type>Display*</type>.
  64
  65
  66 <!-- ##### MACRO GDK_PIXMAP_XID ##### -->
  67 <para>
  68 Returns the X pixmap belonging to a #GdkPixmap.
  69 </para>
  70
  71 @win: a #GdkPixmap.
  72 @Returns: the Xlib <type>XPixmap</type> of @win.
  73
  74
  75 <!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### -->
  76 <para>
  77 Returns the display of a #GdkDrawable.
  78 </para>
  79
  80 @win: a #GdkDrawable.
  81 @Returns: an Xlib <type>Display*</type>.
  82
  83
  84 <!-- ##### MACRO GDK_DRAWABLE_XID ##### -->
  85 <para>
  86 Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
  87 </para>
  88
  89 @win: a #GdkDrawable.
  90 @Returns: the ID of @win's X resource.
  91
  92
  93 <!-- ##### MACRO GDK_IMAGE_XDISPLAY ##### -->
  94 <para>
  95 Returns the display of a #GdkImage.
  96 </para>
  97
  98 @image: a #GdkImage.
  99 @Returns: an Xlib <type>Display*</type>.
 100
 101
 102 <!-- ##### MACRO GDK_IMAGE_XIMAGE ##### -->
 103 <para>
 104 Returns the X image belonging to a #GdkImage.
 105 </para>
 106
 107 @image: a #GdkImage.
 108 @Returns: an <type>XImage*</type>.
 109
 110
 111 <!-- ##### MACRO GDK_GC_XDISPLAY ##### -->
 112 <para>
 113 Returns the display of a #GdkGC.
 114 </para>
 115
 116 @gc: a #GdkGC.
 117 @Returns: an Xlib <type>Display*</type>.
 118
 119
 120 <!-- ##### MACRO GDK_COLORMAP_XDISPLAY ##### -->
 121 <para>
 122 Returns the display of a #GdkColormap.
 123 </para>
 124
 125 @cmap: a #GdkColormap.
 126 @Returns: an Xlib <type>Display*</type>.
 127
 128
 129 <!-- ##### MACRO GDK_COLORMAP_XCOLORMAP ##### -->
 130 <para>
 131 Returns the X colormap belonging to a #GdkColormap.
 132 </para>
 133
 134 @cmap: a #GdkColormap.
 135 @Returns: an Xlib <type>Colormap</type>.
 136
 137
 138 <!-- ##### MACRO GDK_VISUAL_XVISUAL ##### -->
 139 <para>
 140 Returns the X visual belonging to a #GdkVisual.
 141 </para>
 142
 143 @vis: a #GdkVisual.
 144 @Returns: an Xlib <type>Visual*</type>.
 145
 146
 147 <!-- ##### MACRO GDK_FONT_XDISPLAY ##### -->
 148 <para>
 149 Returns the display of a #GdkFont.
 150 </para>
 151
 152 @font: a #GdkFont.
 153 @Returns: an Xlib <type>Display*</type>.
 154
 155
 156 <!-- ##### MACRO GDK_FONT_XFONT ##### -->
 157 <para>
 158 Returns the X font belonging to a #GdkFont.
 159 </para>
 160
 161 @font: a #GdkFont.
 162 @Returns: an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
 163
 164
 165 <!-- ##### MACRO GDK_CURSOR_XCURSOR ##### -->
 166 <para>
 167 Returns the X cursor belonging to a #GdkCursor.
 168 </para>
 169
 170 @cursor: a #GdkCursor.
 171 @Returns: an Xlib <type>Cursor</type>.
 172
 173
 174 <!-- ##### MACRO GDK_CURSOR_XDISPLAY ##### -->
 175 <para>
 176 Returns the display of a #GdkCursor.
 177 </para>
 178
 179 @cursor: a #GdkCursor.
 180 @Returns: an Xlib <type>Display*</type>.
 181
 182
 183 <!-- ##### MACRO GDK_GC_XGC ##### -->
 184 <para>
 185 Returns the X GC of a #GdkGC.
 186 </para>
 187 <note><para>
 188 Note that the clip origin, clip region and tile/stipple origin fields of the
 189 returned GC may not be in sync with @gc. If you need that,
 190 use GDK_GC_GET_XGC().
 191 </para></note>
 192
 193 @gc: a #GdkGC.
 194 @Returns: an Xlib <type>GC</type>.
 195
 196
 197 <!-- ##### MACRO GDK_GC_GET_XGC ##### -->
 198 <para>
 199 Returns the X GC of a #GdkGC.
 200 </para>
 201
 202 @gc: a #GdkGC.
 203 @Returns: an Xlib <type>GC</type>.
 204
 205
 206 <!-- ##### MACRO GDK_WINDOW_XWINDOW ##### -->
 207 <para>
 208 Another name for GDK_DRAWABLE_XID().
 209 </para>
 210
 211
 212
 213 <!-- ##### FUNCTION gdkx_visual_get ##### -->
 214 <para>
 215 Returns a #GdkVisual corresponding to a X visual.
 216 </para>
 217
 218 @xvisualid: a X visual id.
 219 @Returns: the #GdkVisual.
 220
 221
 222 <!-- ##### FUNCTION gdkx_colormap_get ##### -->
 223 <para>
 224 Returns a #GdkColormap corresponding to a X colormap.
 225 </para>
 226
 227 @xcolormap: a X colormap.
 228 @Returns: the #GdkColormap.
 229
 230
 231 <!-- ##### FUNCTION gdk_pixmap_foreign_new ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @anid:
 237 @Returns:
 238
 239
 240 <!-- ##### FUNCTION gdk_window_foreign_new ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @anid:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION gdk_xid_table_lookup ##### -->
 250 <para>
 251 Returns the Gdk object associated with the given X id.
 252 </para>
 253
 254 @xid: an X id.
 255 @Returns: the associated Gdk object, which may be a #GdkPixmap,
 256 a #GdkWindow or a #GdkFont.
 257
 258
 259 <!-- ##### FUNCTION gdk_window_lookup ##### -->
 260 <para>
 261 Obtains the #GdkWindow for the given Xlib window ID, or %NULL if no #GdkWindow has
 262 been created for @xid.
 263 </para>
 264
 265 @anid:
 266 @Returns:
 267 <!-- # Unused Parameters # -->
 268 @xid: Xlib window ID
 269
 270
 271 <!-- ##### FUNCTION gdk_pixmap_lookup ##### -->
 272 <para>
 273 Obtains the #GdkPixmap for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
 274 been created for @xid.
 275 </para>
 276
 277 @anid:
 278 @Returns:
 279 <!-- # Unused Parameters # -->
 280 @xid: Xlib pixmap ID
 281
 282
 283 <!-- ##### MACRO gdk_font_lookup ##### -->
 284 <para>
 285 Obtains the #GdkFont for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
 286 been created for @xid.
 287 </para>
 288
 289 @xid:
 290
 291
 292 <!-- ##### FUNCTION gdk_x11_get_server_time ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @window:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION gdk_net_wm_supports ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @property:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION gdk_x11_colormap_get_xcolormap ##### -->
 311 <para>
 312 Returns the X colormap belonging to a #GdkColormap.
 313 </para>
 314
 315 @colormap: a #GdkColormap.
 316 @Returns: an Xlib <type>Colormap</type>.
 317
 318
 319 <!-- ##### FUNCTION gdk_x11_colormap_get_xdisplay ##### -->
 320 <para>
 321 Returns the display of a #GdkColormap.
 322 </para>
 323
 324 @colormap: a #GdkColormap.
 325 @Returns: an Xlib <type>Display*</type>.
 326
 327
 328 <!-- ##### FUNCTION gdk_x11_cursor_get_xcursor ##### -->
 329 <para>
 330 Returns the X cursor belonging to a #GdkCursor.
 331 </para>
 332
 333 @cursor: a #GdkCursor.
 334 @Returns:
 335 <!-- # Unused Parameters # -->
 336 @Retursn: an Xlib <type>Cursor</type.
 337
 338
 339 <!-- ##### FUNCTION gdk_x11_cursor_get_xdisplay ##### -->
 340 <para>
 341 Returns the display of a #GdkCursor.
 342 </para>
 343
 344 @cursor: a #GdkCursor.
 345 @Returns: an Xlib <type>Display*</type>.
 346
 347
 348 <!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### -->
 349 <para>
 350 Returns the display of a #GdkDrawable.
 351 </para>
 352
 353 @drawable: a #GdkDrawable.
 354 @Returns: an Xlib <type>Display*</type>.
 355
 356
 357 <!-- ##### FUNCTION gdk_x11_drawable_get_xid ##### -->
 358 <para>
 359 Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
 360 </para>
 361
 362 @drawable: a #GdkDrawable.
 363 @Returns: the ID of @win's X resource.
 364
 365
 366 <!-- ##### FUNCTION gdk_x11_font_get_name ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @font:
 372 @Returns:
 373
 374
 375 <!-- ##### FUNCTION gdk_x11_font_get_xdisplay ##### -->
 376 <para>
 377 Returns the display of a #GdkFont.
 378 </para>
 379
 380 @font: a #GdkFont.
 381 @Returns: an Xlib <type>Display*</type>.
 382
 383
 384 <!-- ##### FUNCTION gdk_x11_font_get_xfont ##### -->
 385 <para>
 386 Returns the X font belonging to a #GdkFont.
 387 </para>
 388
 389 @font: a #GdkFont.
 390 @Returns: an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
 391
 392
 393 <!-- ##### FUNCTION gdk_x11_gc_get_xdisplay ##### -->
 394 <para>
 395 Returns the display of a #GdkGC.
 396 </para>
 397
 398 @gc: a #GdkGC.
 399 @Returns: an Xlib <type>Display*</type>.
 400
 401
 402 <!-- ##### FUNCTION gdk_x11_gc_get_xgc ##### -->
 403 <para>
 404 Returns the X GC of a #GdkGC.
 405 </para>
 406
 407 @gc: a #GdkGC.
 408 @Returns: an Xlib <type>GC</type>.
 409
 410
 411 <!-- ##### FUNCTION gdk_x11_get_default_root_xwindow ##### -->
 412 <para>
 413 Gets the root window of the default screen
 414 (see gdk_x11_get_default_screen()).
 415 </para>
 416
 417 @Returns: an Xlib <type>Window</type>.
 418
 419
 420 <!-- ##### FUNCTION gdk_x11_get_default_screen ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gdk_x11_get_default_xdisplay ##### -->
 429 <para>
 430 Gets the default GTK+ display.
 431 </para>
 432
 433 @Returns: the Xlib <type>Display*</type> for the display
 434   specified in the <option>--display</option> command line option
 435   or the <envar>DISPLAY</envar> environment variable.
 436
 437
 438 <!-- ##### FUNCTION gdk_x11_grab_server ##### -->
 439 <para>
 440 Call <function>XGrabServer()</function> on the default display.
 441 To ungrab the server again, use gdk_x11_ungrab_server().
 442 </para>
 443 <para>
 444 gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
 445 </para>
 446
 447
 448
 449 <!-- ##### FUNCTION gdk_x11_image_get_xdisplay ##### -->
 450 <para>
 451 Returns the display of a #GdkImage.
 452 </para>
 453
 454 @image:
 455 @Returns: an Xlib <type>Display*</type>.
 456 <!-- # Unused Parameters # -->
 457 @drawable: a #GdkImage.
 458
 459
 460 <!-- ##### FUNCTION gdk_x11_image_get_ximage ##### -->
 461 <para>
 462 Returns the X image belonging to a #GdkImage.
 463 </para>
 464
 465 @image: a #GdkImage.
 466 @Returns: an <type>XImage*</type>.
 467
 468
 469 <!-- ##### FUNCTION gdk_x11_ungrab_server ##### -->
 470 <para>
 471 Ungrab the default display after it has been grabbed with
 472 gdk_x11_grab_server().
 473 </para>
 474
 475
 476
 477 <!-- ##### FUNCTION gdk_x11_visual_get_xvisual ##### -->
 478 <para>
 479 Returns the X visual belonging to a #GdkVisual.
 480 </para>
 481
 482 @visual: a #GdkVisual.
 483 @Returns: an Xlib <type>Visual*</type>.
 484
 485
 486 <!-- ##### FUNCTION gdk_x11_atom_to_xatom ##### -->
 487 <para>
 488
 489 </para>
 490
 491 @atom:
 492 @Returns:
 493
 494
 495 <!-- ##### FUNCTION gdk_x11_xatom_to_atom ##### -->
 496 <para>
 497
 498 </para>
 499
 500 @xatom:
 501 @Returns:
 502
 503
 504 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name ##### -->
 505 <para>
 506
 507 </para>
 508
 509 @atom_name:
 510 @Returns:
 511
 512
 513 <!-- ##### FUNCTION gdk_x11_get_xatom_name ##### -->
 514 <para>
 515
 516 </para>
 517
 518 @xatom:
 519 @Returns:
 520
 521