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 @pix:
  63 @Returns: an Xlib <type>Display*</type>.
  64 <!-- # Unused Parameters # -->
  65 @win: a #GdkPixmap.
  66
  67
  68 <!-- ##### MACRO GDK_PIXMAP_XID ##### -->
  69 <para>
  70 Returns the X pixmap belonging to a #GdkPixmap.
  71 </para>
  72
  73 @pix:
  74 @Returns: the Xlib <type>XPixmap</type> of @win.
  75 <!-- # Unused Parameters # -->
  76 @win: a #GdkPixmap.
  77
  78
  79 <!-- ##### MACRO GDK_DISPLAY_XDISPLAY ##### -->
  80 <para>
  81 Returns the display of a #GdkDisplay.
  82 </para>
  83
  84 @display: a #GdkDisplay.
  85
  86
  87 <!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### -->
  88 <para>
  89 Returns the display of a #GdkDrawable.
  90 </para>
  91
  92 @win: a #GdkDrawable.
  93 @Returns: an Xlib <type>Display*</type>.
  94
  95
  96 <!-- ##### MACRO GDK_DRAWABLE_XID ##### -->
  97 <para>
  98 Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
  99 </para>
 100
 101 @win: a #GdkDrawable.
 102 @Returns: the ID of @win's X resource.
 103
 104
 105 <!-- ##### MACRO GDK_IMAGE_XDISPLAY ##### -->
 106 <para>
 107 Returns the display of a #GdkImage.
 108 </para>
 109
 110 @image: a #GdkImage.
 111 @Returns: an Xlib <type>Display*</type>.
 112
 113
 114 <!-- ##### MACRO GDK_IMAGE_XIMAGE ##### -->
 115 <para>
 116 Returns the X image belonging to a #GdkImage.
 117 </para>
 118
 119 @image: a #GdkImage.
 120 @Returns: an <type>XImage*</type>.
 121
 122
 123 <!-- ##### MACRO GDK_GC_XDISPLAY ##### -->
 124 <para>
 125 Returns the display of a #GdkGC.
 126 </para>
 127
 128 @gc: a #GdkGC.
 129 @Returns: an Xlib <type>Display*</type>.
 130
 131
 132 <!-- ##### MACRO GDK_COLORMAP_XDISPLAY ##### -->
 133 <para>
 134 Returns the display of a #GdkColormap.
 135 </para>
 136
 137 @cmap: a #GdkColormap.
 138 @Returns: an Xlib <type>Display*</type>.
 139
 140
 141 <!-- ##### MACRO GDK_COLORMAP_XCOLORMAP ##### -->
 142 <para>
 143 Returns the X colormap belonging to a #GdkColormap.
 144 </para>
 145
 146 @cmap: a #GdkColormap.
 147 @Returns: an Xlib <type>Colormap</type>.
 148
 149
 150 <!-- ##### MACRO GDK_SCREEN_XDISPLAY ##### -->
 151 <para>
 152 Returns the display of a #GdkScreen.
 153 </para>
 154
 155 @screen: a #GdkScreen.
 156 @Returns: an Xlib <type>Display*</type>.
 157
 158
 159 <!-- ##### MACRO GDK_SCREEN_XNUMBER ##### -->
 160 <para>
 161 Returns the index of a #GdkScreen.
 162 </para>
 163
 164 @screen: a #GdkScreen
 165 @Returns: the position of @screen among the screens of
 166   its display.
 167
 168
 169 <!-- ##### MACRO GDK_SCREEN_XSCREEN ##### -->
 170 <para>
 171 Returns the screen of a #GdkScreen.
 172 </para>
 173
 174 @screen: a #GdkScreen
 175 @Returns: an Xlib <type>Screen*</type>.
 176
 177
 178 <!-- ##### MACRO GDK_VISUAL_XVISUAL ##### -->
 179 <para>
 180 Returns the X visual belonging to a #GdkVisual.
 181 </para>
 182
 183 @vis: a #GdkVisual.
 184 @Returns: an Xlib <type>Visual*</type>.
 185
 186
 187 <!-- ##### MACRO GDK_FONT_XDISPLAY ##### -->
 188 <para>
 189 Returns the display of a #GdkFont.
 190 </para>
 191
 192 @font: a #GdkFont.
 193 @Returns: an Xlib <type>Display*</type>.
 194
 195
 196 <!-- ##### MACRO GDK_FONT_XFONT ##### -->
 197 <para>
 198 Returns the X font belonging to a #GdkFont.
 199 </para>
 200
 201 @font: a #GdkFont.
 202 @Returns: an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
 203
 204
 205 <!-- ##### MACRO GDK_CURSOR_XCURSOR ##### -->
 206 <para>
 207 Returns the X cursor belonging to a #GdkCursor.
 208 </para>
 209
 210 @cursor: a #GdkCursor.
 211 @Returns: an Xlib <type>Cursor</type>.
 212
 213
 214 <!-- ##### MACRO GDK_CURSOR_XDISPLAY ##### -->
 215 <para>
 216 Returns the display of a #GdkCursor.
 217 </para>
 218
 219 @cursor: a #GdkCursor.
 220 @Returns: an Xlib <type>Display*</type>.
 221
 222
 223 <!-- ##### MACRO GDK_GC_XGC ##### -->
 224 <para>
 225 Returns the X GC of a #GdkGC.
 226 </para>
 227 <note><para>
 228 Note that the clip origin, clip region and tile/stipple origin fields of the
 229 returned GC may not be in sync with @gc. If you need that,
 230 use GDK_GC_GET_XGC().
 231 </para></note>
 232
 233 @gc: a #GdkGC.
 234 @Returns: an Xlib <type>GC</type>.
 235
 236
 237 <!-- ##### MACRO GDK_GC_GET_XGC ##### -->
 238 <para>
 239 Returns the X GC of a #GdkGC.
 240 </para>
 241
 242 @gc: a #GdkGC.
 243 @Returns: an Xlib <type>GC</type>.
 244
 245
 246 <!-- ##### MACRO GDK_WINDOW_XWINDOW ##### -->
 247 <para>
 248 Another name for GDK_DRAWABLE_XID().
 249 </para>
 250
 251
 252
 253 <!-- ##### FUNCTION gdkx_visual_get ##### -->
 254 <para>
 255 Returns a #GdkVisual corresponding to a X visual.
 256 </para>
 257
 258 @xvisualid: a X visual id.
 259 @Returns: the #GdkVisual.
 260
 261
 262 <!-- ##### FUNCTION gdkx_colormap_get ##### -->
 263 <para>
 264 </para>
 265
 266 @xcolormap: a X colormap.
 267 @Returns: the #GdkColormap.
 268
 269
 270 <!-- ##### FUNCTION gdk_pixmap_foreign_new ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @anid:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION gdk_pixmap_foreign_new_for_display ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @display:
 285 @anid:
 286 @Returns:
 287
 288
 289 <!-- ##### FUNCTION gdk_window_foreign_new ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @anid:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION gdk_window_foreign_new_for_display ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @display:
 304 @anid:
 305 @Returns:
 306
 307
 308 <!-- ##### FUNCTION gdk_xid_table_lookup ##### -->
 309 <para>
 310 Returns the Gdk object associated with the given X id.
 311 </para>
 312
 313 @xid: an X id.
 314 @Returns: the associated Gdk object, which may be a #GdkPixmap,
 315 a #GdkWindow or a #GdkFont.
 316
 317
 318 <!-- ##### FUNCTION gdk_xid_table_lookup_for_display ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @display:
 324 @xid:
 325 @Returns:
 326
 327
 328 <!-- ##### FUNCTION gdk_window_lookup ##### -->
 329 <para>
 330 </para>
 331
 332 @anid:
 333 @Returns:
 334
 335
 336 <!-- ##### FUNCTION gdk_window_lookup_for_display ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @display:
 342 @anid:
 343 @Returns:
 344
 345
 346 <!-- ##### FUNCTION gdk_pixmap_lookup ##### -->
 347 <para>
 348 </para>
 349
 350 @anid:
 351 @Returns:
 352
 353
 354 <!-- ##### FUNCTION gdk_pixmap_lookup_for_display ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @display:
 360 @anid:
 361 @Returns:
 362
 363
 364 <!-- ##### MACRO gdk_font_lookup ##### -->
 365 <para>
 366 Obtains the #GdkFont for the given Xlib font ID, or %NULL if no #GdkFont has
 367 been created for @xid.
 368 </para>
 369
 370 @xid:
 371
 372
 373 <!-- ##### MACRO gdk_font_lookup_for_display ##### -->
 374 <para>
 375 Obtains the #GdkFont for the given Xlib font ID on @display, or %NULL if no
 376 #GdkFont has been created for @xid.
 377 </para>
 378
 379 @display:
 380 @xid:
 381
 382
 383 <!-- ##### FUNCTION gdk_x11_lookup_xdisplay ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @xdisplay:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION gdk_x11_get_server_time ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @window:
 398 @Returns:
 399
 400
 401 <!-- ##### FUNCTION gdk_net_wm_supports ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @property:
 407 @Returns:
 408
 409
 410 <!-- ##### FUNCTION gdk_x11_screen_supports_net_wm_hint ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @screen:
 416 @property:
 417 @Returns:
 418
 419
 420 <!-- ##### FUNCTION gdk_x11_colormap_get_xcolormap ##### -->
 421 <para>
 422 Returns the X colormap belonging to a #GdkColormap.
 423 </para>
 424
 425 @colormap: a #GdkColormap.
 426 @Returns: an Xlib <type>Colormap</type>.
 427
 428
 429 <!-- ##### FUNCTION gdk_x11_colormap_get_xdisplay ##### -->
 430 <para>
 431 Returns the display of a #GdkColormap.
 432 </para>
 433
 434 @colormap: a #GdkColormap.
 435 @Returns: an Xlib <type>Display*</type>.
 436
 437
 438 <!-- ##### FUNCTION gdk_x11_cursor_get_xcursor ##### -->
 439 <para>
 440 Returns the X cursor belonging to a #GdkCursor.
 441 </para>
 442
 443 @cursor: a #GdkCursor.
 444 @Returns:
 445 <!-- # Unused Parameters # -->
 446 @Retursn: an Xlib <type>Cursor</type.
 447
 448
 449 <!-- ##### FUNCTION gdk_x11_cursor_get_xdisplay ##### -->
 450 <para>
 451 Returns the display of a #GdkCursor.
 452 </para>
 453
 454 @cursor: a #GdkCursor.
 455 @Returns: an Xlib <type>Display*</type>.
 456
 457
 458 <!-- ##### FUNCTION gdk_x11_display_get_xdisplay ##### -->
 459 <para>
 460
 461 </para>
 462
 463 @display:
 464 @Returns:
 465
 466
 467 <!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### -->
 468 <para>
 469 Returns the display of a #GdkDrawable.
 470 </para>
 471
 472 @drawable: a #GdkDrawable.
 473 @Returns: an Xlib <type>Display*</type>.
 474
 475
 476 <!-- ##### FUNCTION gdk_x11_drawable_get_xid ##### -->
 477 <para>
 478 Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
 479 </para>
 480
 481 @drawable: a #GdkDrawable.
 482 @Returns: the ID of @win's X resource.
 483
 484
 485 <!-- ##### FUNCTION gdk_x11_font_get_name ##### -->
 486 <para>
 487
 488 </para>
 489
 490 @font:
 491 @Returns:
 492
 493
 494 <!-- ##### FUNCTION gdk_x11_font_get_xdisplay ##### -->
 495 <para>
 496 Returns the display of a #GdkFont.
 497 </para>
 498
 499 @font: a #GdkFont.
 500 @Returns: an Xlib <type>Display*</type>.
 501
 502
 503 <!-- ##### FUNCTION gdk_x11_font_get_xfont ##### -->
 504 <para>
 505 Returns the X font belonging to a #GdkFont.
 506 </para>
 507
 508 @font: a #GdkFont.
 509 @Returns: an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
 510
 511
 512 <!-- ##### FUNCTION gdk_x11_gc_get_xdisplay ##### -->
 513 <para>
 514 Returns the display of a #GdkGC.
 515 </para>
 516
 517 @gc: a #GdkGC.
 518 @Returns: an Xlib <type>Display*</type>.
 519
 520
 521 <!-- ##### FUNCTION gdk_x11_gc_get_xgc ##### -->
 522 <para>
 523 Returns the X GC of a #GdkGC.
 524 </para>
 525
 526 @gc: a #GdkGC.
 527 @Returns: an Xlib <type>GC</type>.
 528
 529
 530 <!-- ##### FUNCTION gdk_x11_get_default_root_xwindow ##### -->
 531 <para>
 532 Gets the root window of the default screen
 533 (see gdk_x11_get_default_screen()).
 534 </para>
 535
 536 @Returns: an Xlib <type>Window</type>.
 537
 538
 539 <!-- ##### FUNCTION gdk_x11_get_default_screen ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @Returns:
 545
 546
 547 <!-- ##### FUNCTION gdk_x11_get_default_xdisplay ##### -->
 548 <para>
 549 Gets the default GTK+ display.
 550 </para>
 551
 552 @Returns: the Xlib <type>Display*</type> for the display
 553   specified in the <option>--display</option> command line option
 554   or the <envar>DISPLAY</envar> environment variable.
 555
 556
 557 <!-- ##### FUNCTION gdk_x11_grab_server ##### -->
 558 <para>
 559 Call <function>XGrabServer()</function> on the default display.
 560 To ungrab the server again, use gdk_x11_ungrab_server().
 561 </para>
 562 <para>
 563 gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
 564 </para>
 565
 566
 567
 568 <!-- ##### FUNCTION gdk_x11_image_get_xdisplay ##### -->
 569 <para>
 570 Returns the display of a #GdkImage.
 571 </para>
 572
 573 @image:
 574 @Returns: an Xlib <type>Display*</type>.
 575 <!-- # Unused Parameters # -->
 576 @drawable: a #GdkImage.
 577
 578
 579 <!-- ##### FUNCTION gdk_x11_image_get_ximage ##### -->
 580 <para>
 581 Returns the X image belonging to a #GdkImage.
 582 </para>
 583
 584 @image: a #GdkImage.
 585 @Returns: an <type>XImage*</type>.
 586
 587
 588 <!-- ##### FUNCTION gdk_x11_screen_get_screen_number ##### -->
 589 <para>
 590
 591 </para>
 592
 593 @screen:
 594 @Returns:
 595
 596
 597 <!-- ##### FUNCTION gdk_x11_screen_get_xscreen ##### -->
 598 <para>
 599
 600 </para>
 601
 602 @screen:
 603 @Returns:
 604
 605
 606 <!-- ##### FUNCTION gdk_x11_ungrab_server ##### -->
 607 <para>
 608 Ungrab the default display after it has been grabbed with
 609 gdk_x11_grab_server().
 610 </para>
 611
 612
 613
 614 <!-- ##### FUNCTION gdk_x11_visual_get_xvisual ##### -->
 615 <para>
 616 Returns the X visual belonging to a #GdkVisual.
 617 </para>
 618
 619 @visual: a #GdkVisual.
 620 @Returns: an Xlib <type>Visual*</type>.
 621
 622
 623 <!-- ##### FUNCTION gdk_x11_atom_to_xatom ##### -->
 624 <para>
 625
 626 </para>
 627
 628 @atom:
 629 @Returns:
 630
 631
 632 <!-- ##### FUNCTION gdk_x11_atom_to_xatom_for_display ##### -->
 633 <para>
 634
 635 </para>
 636
 637 @display:
 638 @atom:
 639 @Returns:
 640 <!-- # Unused Parameters # -->
 641 @virtual_atom:
 642
 643
 644 <!-- ##### FUNCTION gdk_x11_xatom_to_atom ##### -->
 645 <para>
 646
 647 </para>
 648
 649 @xatom:
 650 @Returns:
 651
 652
 653 <!-- ##### FUNCTION gdk_x11_xatom_to_atom_for_display ##### -->
 654 <para>
 655
 656 </para>
 657
 658 @display:
 659 @xatom:
 660 @Returns:
 661
 662
 663 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name ##### -->
 664 <para>
 665
 666 </para>
 667
 668 @atom_name:
 669 @Returns:
 670
 671
 672 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name_for_display ##### -->
 673 <para>
 674
 675 </para>
 676
 677 @display:
 678 @atom_name:
 679 @Returns:
 680
 681
 682 <!-- ##### FUNCTION gdk_x11_get_xatom_name ##### -->
 683 <para>
 684
 685 </para>
 686
 687 @xatom:
 688 @Returns:
 689
 690
 691 <!-- ##### FUNCTION gdk_x11_get_xatom_name_for_display ##### -->
 692 <para>
 693
 694 </para>
 695
 696 @display:
 697 @xatom:
 698 @Returns:
 699
 700