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 X backend-specific functions
   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
 256 </para>
 257
 258 @xvisualid:
 259 @Returns:
 260
 261
 262 <!-- ##### FUNCTION gdkx_colormap_get ##### -->
 263 <para>
 264 </para>
 265
 266 @xcolormap:
 267 @Returns:
 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
 311 </para>
 312
 313 @xid:
 314 @Returns:
 315
 316
 317 <!-- ##### FUNCTION gdk_xid_table_lookup_for_display ##### -->
 318 <para>
 319
 320 </para>
 321
 322 @display:
 323 @xid:
 324 @Returns:
 325
 326
 327 <!-- ##### FUNCTION gdk_window_lookup ##### -->
 328 <para>
 329 </para>
 330
 331 @anid:
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION gdk_window_lookup_for_display ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @display:
 341 @anid:
 342 @Returns:
 343
 344
 345 <!-- ##### FUNCTION gdk_pixmap_lookup ##### -->
 346 <para>
 347 </para>
 348
 349 @anid:
 350 @Returns:
 351
 352
 353 <!-- ##### FUNCTION gdk_pixmap_lookup_for_display ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @display:
 359 @anid:
 360 @Returns:
 361
 362
 363 <!-- ##### MACRO gdk_font_lookup ##### -->
 364 <para>
 365 Obtains the #GdkFont for the given Xlib font ID, or %NULL if no #GdkFont has
 366 been created for @xid.
 367 </para>
 368
 369 @xid:
 370
 371
 372 <!-- ##### MACRO gdk_font_lookup_for_display ##### -->
 373 <para>
 374 Obtains the #GdkFont for the given Xlib font ID on @display, or %NULL if no
 375 #GdkFont has been created for @xid.
 376 </para>
 377
 378 @display:
 379 @xid:
 380
 381
 382 <!-- ##### FUNCTION gdk_x11_lookup_xdisplay ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @xdisplay:
 388 @Returns:
 389
 390
 391 <!-- ##### FUNCTION gdk_x11_get_server_time ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @window:
 397 @Returns:
 398
 399
 400 <!-- ##### FUNCTION gdk_net_wm_supports ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @property:
 406 @Returns:
 407
 408
 409 <!-- ##### FUNCTION gdk_x11_screen_supports_net_wm_hint ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @screen:
 415 @property:
 416 @Returns:
 417
 418
 419 <!-- ##### FUNCTION gdk_x11_screen_get_window_manager_name ##### -->
 420 <para>
 421
 422 </para>
 423
 424 @screen:
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gdk_x11_screen_lookup_visual ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @screen:
 434 @xvisualid:
 435 @Returns:
 436
 437
 438 <!-- ##### FUNCTION gdk_x11_colormap_foreign_new ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @visual:
 444 @xcolormap:
 445 @Returns:
 446
 447
 448 <!-- ##### FUNCTION gdk_x11_colormap_get_xcolormap ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @colormap:
 454 @Returns:
 455
 456
 457 <!-- ##### FUNCTION gdk_x11_colormap_get_xdisplay ##### -->
 458 <para>
 459
 460 </para>
 461
 462 @colormap:
 463 @Returns:
 464
 465
 466 <!-- ##### FUNCTION gdk_x11_cursor_get_xcursor ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @cursor:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gdk_x11_cursor_get_xdisplay ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @cursor:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gdk_x11_display_get_xdisplay ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @display:
 490 @Returns:
 491
 492
 493 <!-- ##### FUNCTION gdk_x11_display_grab ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @display:
 499
 500
 501 <!-- ##### FUNCTION gdk_x11_display_ungrab ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @display:
 507
 508
 509 <!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @drawable:
 515 @Returns:
 516
 517
 518 <!-- ##### FUNCTION gdk_x11_drawable_get_xid ##### -->
 519 <para>
 520
 521 </para>
 522
 523 @drawable:
 524 @Returns:
 525
 526
 527 <!-- ##### FUNCTION gdk_x11_font_get_name ##### -->
 528 <para>
 529
 530 </para>
 531
 532 @font:
 533 @Returns:
 534
 535
 536 <!-- ##### FUNCTION gdk_x11_font_get_xdisplay ##### -->
 537 <para>
 538
 539 </para>
 540
 541 @font:
 542 @Returns:
 543
 544
 545 <!-- ##### FUNCTION gdk_x11_font_get_xfont ##### -->
 546 <para>
 547
 548 </para>
 549
 550 @font:
 551 @Returns:
 552
 553
 554 <!-- ##### FUNCTION gdk_x11_gc_get_xdisplay ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @gc:
 560 @Returns:
 561
 562
 563 <!-- ##### FUNCTION gdk_x11_gc_get_xgc ##### -->
 564 <para>
 565
 566 </para>
 567
 568 @gc:
 569 @Returns:
 570
 571
 572 <!-- ##### FUNCTION gdk_x11_get_default_root_xwindow ##### -->
 573 <para>
 574
 575 </para>
 576
 577 @Returns:
 578
 579
 580 <!-- ##### FUNCTION gdk_x11_get_default_screen ##### -->
 581 <para>
 582
 583 </para>
 584
 585 @Returns:
 586
 587
 588 <!-- ##### FUNCTION gdk_x11_get_default_xdisplay ##### -->
 589 <para>
 590
 591 </para>
 592
 593 @Returns:
 594
 595
 596 <!-- ##### FUNCTION gdk_x11_grab_server ##### -->
 597 <para>
 598
 599 </para>
 600
 601
 602
 603 <!-- ##### FUNCTION gdk_x11_image_get_xdisplay ##### -->
 604 <para>
 605
 606 </para>
 607
 608 @image:
 609 @Returns:
 610
 611
 612 <!-- ##### FUNCTION gdk_x11_image_get_ximage ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @image:
 618 @Returns:
 619
 620
 621 <!-- ##### FUNCTION gdk_x11_screen_get_screen_number ##### -->
 622 <para>
 623
 624 </para>
 625
 626 @screen:
 627 @Returns:
 628
 629
 630 <!-- ##### FUNCTION gdk_x11_screen_get_xscreen ##### -->
 631 <para>
 632
 633 </para>
 634
 635 @screen:
 636 @Returns:
 637
 638
 639 <!-- ##### FUNCTION gdk_x11_ungrab_server ##### -->
 640 <para>
 641
 642 </para>
 643
 644
 645
 646 <!-- ##### FUNCTION gdk_x11_visual_get_xvisual ##### -->
 647 <para>
 648
 649 </para>
 650
 651 @visual:
 652 @Returns:
 653
 654
 655 <!-- ##### FUNCTION gdk_x11_atom_to_xatom ##### -->
 656 <para>
 657
 658 </para>
 659
 660 @atom:
 661 @Returns:
 662
 663
 664 <!-- ##### FUNCTION gdk_x11_atom_to_xatom_for_display ##### -->
 665 <para>
 666
 667 </para>
 668
 669 @display:
 670 @atom:
 671 @Returns:
 672
 673
 674 <!-- ##### FUNCTION gdk_x11_xatom_to_atom ##### -->
 675 <para>
 676
 677 </para>
 678
 679 @xatom:
 680 @Returns:
 681
 682
 683 <!-- ##### FUNCTION gdk_x11_xatom_to_atom_for_display ##### -->
 684 <para>
 685
 686 </para>
 687
 688 @display:
 689 @xatom:
 690 @Returns:
 691
 692
 693 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name ##### -->
 694 <para>
 695
 696 </para>
 697
 698 @atom_name:
 699 @Returns:
 700
 701
 702 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name_for_display ##### -->
 703 <para>
 704
 705 </para>
 706
 707 @display:
 708 @atom_name:
 709 @Returns:
 710
 711
 712 <!-- ##### FUNCTION gdk_x11_get_xatom_name ##### -->
 713 <para>
 714
 715 </para>
 716
 717 @xatom:
 718 @Returns:
 719
 720
 721 <!-- ##### FUNCTION gdk_x11_get_xatom_name_for_display ##### -->
 722 <para>
 723
 724 </para>
 725
 726 @display:
 727 @xatom:
 728 @Returns:
 729
 730