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