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