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

   1 <!-- ##### SECTION Title ##### -->
   2 Windows
   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 <!-- ##### STRUCT GdkWindowAttr ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @title:
  23 @event_mask:
  24 @x:
  25 @y:
  26 @width:
  27 @height:
  28 @wclass:
  29 @visual:
  30 @colormap:
  31 @window_type:
  32 @cursor:
  33 @wmclass_name:
  34 @wmclass_class:
  35 @override_redirect:
  36
  37 <!-- ##### STRUCT GdkWindow ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @user_data:
  43
  44 <!-- ##### ENUM GdkWindowType ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @GDK_WINDOW_ROOT:
  50 @GDK_WINDOW_TOPLEVEL:
  51 @GDK_WINDOW_CHILD:
  52 @GDK_WINDOW_DIALOG:
  53 @GDK_WINDOW_TEMP:
  54 @GDK_WINDOW_FOREIGN:
  55
  56 <!-- ##### ENUM GdkWindowClass ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @GDK_INPUT_OUTPUT:
  62 @GDK_INPUT_ONLY:
  63
  64 <!-- ##### ENUM GdkWindowAttributesType ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @GDK_WA_TITLE:
  70 @GDK_WA_X:
  71 @GDK_WA_Y:
  72 @GDK_WA_CURSOR:
  73 @GDK_WA_COLORMAP:
  74 @GDK_WA_VISUAL:
  75 @GDK_WA_WMCLASS:
  76 @GDK_WA_NOREDIR:
  77
  78 <!-- ##### ENUM GdkWindowHints ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @GDK_HINT_POS:
  84 @GDK_HINT_MIN_SIZE:
  85 @GDK_HINT_MAX_SIZE:
  86 @GDK_HINT_BASE_SIZE:
  87 @GDK_HINT_ASPECT:
  88 @GDK_HINT_RESIZE_INC:
  89
  90 <!-- ##### STRUCT GdkGeometry ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @min_width:
  96 @min_height:
  97 @max_width:
  98 @max_height:
  99 @base_width:
 100 @base_height:
 101 @width_inc:
 102 @height_inc:
 103 @min_aspect:
 104 @max_aspect:
 105
 106 <!-- ##### FUNCTION gdk_window_new ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @parent:
 112 @attributes:
 113 @attributes_mask:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION gdk_window_destroy ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @window:
 123
 124
 125 <!-- ##### MACRO gdk_window_ref ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @Returns:
 131 <!-- # Unused Parameters # -->
 132 @window:
 133
 134
 135 <!-- ##### MACRO gdk_window_unref ##### -->
 136 <para>
 137
 138 </para>
 139
 140 <!-- # Unused Parameters # -->
 141 @window:
 142
 143
 144 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @window:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @win_x:
 159 @win_y:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gdk_window_show ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @window:
 169
 170
 171 <!-- ##### FUNCTION gdk_window_hide ##### -->
 172 <para>
 173
 174 </para>
 175
 176 @window:
 177
 178
 179 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @window:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @window:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @window:
 203
 204
 205 <!-- ##### FUNCTION gdk_window_move ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @window:
 211 @x:
 212 @y:
 213
 214
 215 <!-- ##### FUNCTION gdk_window_resize ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @window:
 221 @width:
 222 @height:
 223
 224
 225 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @window:
 231 @x:
 232 @y:
 233 @width:
 234 @height:
 235
 236
 237 <!-- ##### FUNCTION gdk_window_scroll ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @window:
 243 @dx:
 244 @dy:
 245
 246
 247 <!-- ##### FUNCTION gdk_window_reparent ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @window:
 253 @new_parent:
 254 @x:
 255 @y:
 256
 257
 258 <!-- ##### FUNCTION gdk_window_clear ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @window:
 264
 265
 266 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @window:
 272 @x:
 273 @y:
 274 @width:
 275 @height:
 276
 277
 278 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @window:
 284 @x:
 285 @y:
 286 @width:
 287 @height:
 288
 289
 290 <!-- ##### MACRO gdk_window_copy_area ##### -->
 291 <para>
 292
 293 </para>
 294
 295 @drawable:
 296 @gc:
 297 @x:
 298 @y:
 299 @source_drawable:
 300 @source_x:
 301 @source_y:
 302 @width:
 303 @height:
 304 <!-- # Unused Parameters # -->
 305 @window:
 306 @source_window:
 307
 308
 309 <!-- ##### FUNCTION gdk_window_raise ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @window:
 315
 316
 317 <!-- ##### FUNCTION gdk_window_lower ##### -->
 318 <para>
 319
 320 </para>
 321
 322 @window:
 323
 324
 325 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @window:
 331
 332
 333 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @window:
 339 @rectangle:
 340
 341
 342 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
 343 <para>
 344
 345 </para>
 346
 347 @window:
 348 @region:
 349
 350
 351 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
 352 <para>
 353
 354 </para>
 355
 356 @window:
 357
 358
 359 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @window:
 365 @rect:
 366 @invalidate_children:
 367
 368
 369 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @window:
 375 @region:
 376 @invalidate_children:
 377
 378
 379 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @window:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @window:
 394
 395
 396 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @window:
 402
 403
 404 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
 405 <para>
 406
 407 </para>
 408
 409
 410
 411 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @window:
 417 @update_children:
 418
 419
 420 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @window:
 426 @user_data:
 427
 428
 429 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @window:
 435 @override_redirect:
 436
 437
 438 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @window:
 444 @function:
 445 @data:
 446
 447
 448 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @window:
 454 @function:
 455 @data:
 456
 457
 458 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
 459 <para>
 460
 461 </para>
 462
 463 @xevent:
 464 @event:
 465 @data:
 466 @Returns:
 467
 468
 469 <!-- ##### ENUM GdkFilterReturn ##### -->
 470 <para>
 471
 472 </para>
 473
 474 @GDK_FILTER_CONTINUE:
 475 @GDK_FILTER_TRANSLATE:
 476 @GDK_FILTER_REMOVE:
 477
 478 <!-- ##### TYPEDEF GdkXEvent ##### -->
 479 <para>
 480
 481 </para>
 482
 483
 484 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @window:
 490 @shape_mask:
 491 @offset_x:
 492 @offset_y:
 493
 494
 495 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
 496 <para>
 497
 498 </para>
 499
 500 @window:
 501
 502
 503 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
 504 <para>
 505
 506 </para>
 507
 508 @window:
 509
 510
 511 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
 512 <para>
 513
 514 </para>
 515
 516 @window:
 517 @use_static:
 518 @Returns:
 519
 520
 521 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
 522 <para>
 523
 524 </para>
 525
 526 @window:
 527 @x:
 528 @y:
 529 @min_width:
 530 @min_height:
 531 @max_width:
 532 @max_height:
 533 @flags:
 534
 535
 536 <!-- ##### FUNCTION gdk_window_set_title ##### -->
 537 <para>
 538
 539 </para>
 540
 541 @window:
 542 @title:
 543
 544
 545 <!-- ##### FUNCTION gdk_window_set_background ##### -->
 546 <para>
 547
 548 </para>
 549
 550 @window:
 551 @color:
 552
 553
 554 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @window:
 560 @pixmap:
 561 @parent_relative:
 562
 563
 564 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
 565 <para>
 566
 567 </para>
 568
 569
 570
 571 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
 572 <para>
 573
 574 </para>
 575
 576 @window:
 577 @cursor:
 578
 579
 580 <!-- ##### MACRO gdk_window_set_colormap ##### -->
 581 <para>
 582
 583 </para>
 584
 585 <!-- # Unused Parameters # -->
 586 @window:
 587 @colormap:
 588
 589
 590 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
 591 <para>
 592
 593 </para>
 594
 595 @window:
 596 @data:
 597
 598
 599 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
 600 <para>
 601
 602 </para>
 603
 604 @window:
 605 @x:
 606 @y:
 607 @width:
 608 @height:
 609 @depth:
 610
 611
 612 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @window:
 618 @geometry:
 619 @flags:
 620
 621
 622 <!-- ##### FUNCTION gdk_window_get_position ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @window:
 628 @x:
 629 @y:
 630
 631
 632 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
 633 <para>
 634
 635 </para>
 636
 637 @window:
 638 @x:
 639 @y:
 640
 641
 642 <!-- ##### MACRO gdk_window_get_size ##### -->
 643 <para>
 644
 645 </para>
 646
 647 <!-- # Unused Parameters # -->
 648 @window:
 649 @width:
 650 @height:
 651
 652
 653 <!-- ##### MACRO gdk_window_get_visual ##### -->
 654 <para>
 655
 656 </para>
 657
 658 @Returns:
 659 <!-- # Unused Parameters # -->
 660 @window:
 661
 662
 663 <!-- ##### MACRO gdk_window_get_colormap ##### -->
 664 <para>
 665
 666 </para>
 667
 668 @Returns:
 669 <!-- # Unused Parameters # -->
 670 @window:
 671
 672
 673 <!-- ##### MACRO gdk_window_get_type ##### -->
 674 <para>
 675
 676 </para>
 677
 678 @Returns:
 679 <!-- # Unused Parameters # -->
 680 @window:
 681
 682
 683 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
 684 <para>
 685
 686 </para>
 687
 688 @window:
 689 @x:
 690 @y:
 691 @Returns:
 692
 693
 694 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
 695 <para>
 696
 697 </para>
 698
 699 @window:
 700 @x:
 701 @y:
 702 @Returns:
 703
 704
 705 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
 706 <para>
 707
 708 </para>
 709
 710 @window:
 711 @x:
 712 @y:
 713 @mask:
 714 @Returns:
 715
 716
 717 <!-- ##### ENUM GdkModifierType ##### -->
 718 <para>
 719
 720 </para>
 721
 722 @GDK_SHIFT_MASK:
 723 @GDK_LOCK_MASK:
 724 @GDK_CONTROL_MASK:
 725 @GDK_MOD1_MASK:
 726 @GDK_MOD2_MASK:
 727 @GDK_MOD3_MASK:
 728 @GDK_MOD4_MASK:
 729 @GDK_MOD5_MASK:
 730 @GDK_BUTTON1_MASK:
 731 @GDK_BUTTON2_MASK:
 732 @GDK_BUTTON3_MASK:
 733 @GDK_BUTTON4_MASK:
 734 @GDK_BUTTON5_MASK:
 735 @GDK_RELEASE_MASK:
 736 @GDK_MODIFIER_MASK:
 737
 738 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
 739 <para>
 740
 741 </para>
 742
 743 @window:
 744 @Returns:
 745
 746
 747 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
 748 <para>
 749
 750 </para>
 751
 752 @window:
 753 @Returns:
 754
 755
 756 <!-- ##### FUNCTION gdk_window_get_children ##### -->
 757 <para>
 758
 759 </para>
 760
 761 @window:
 762 @Returns:
 763
 764
 765 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
 766 <para>
 767
 768 </para>
 769
 770 @window:
 771 @Returns:
 772
 773
 774 <!-- ##### FUNCTION gdk_window_get_events ##### -->
 775 <para>
 776
 777 </para>
 778
 779 @window:
 780 @Returns:
 781
 782
 783 <!-- ##### FUNCTION gdk_window_set_events ##### -->
 784 <para>
 785
 786 </para>
 787
 788 @window:
 789 @event_mask:
 790
 791
 792 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
 793 <para>
 794
 795 </para>
 796
 797 @window:
 798 @icon_window:
 799 @pixmap:
 800 @mask:
 801
 802
 803 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
 804 <para>
 805
 806 </para>
 807
 808 @window:
 809 @name:
 810
 811
 812 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
 813 <para>
 814
 815 </para>
 816
 817 @window:
 818 @leader:
 819
 820
 821 <!-- ##### FUNCTION gdk_window_set_role ##### -->
 822 <para>
 823
 824 </para>
 825
 826 @window:
 827 @role:
 828
 829
 830 <!-- ##### FUNCTION gdk_window_set_group ##### -->
 831 <para>
 832
 833 </para>
 834
 835 @window:
 836 @leader:
 837
 838
 839 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
 840 <para>
 841
 842 </para>
 843
 844 @window:
 845 @decorations:
 846
 847
 848 <!-- ##### ENUM GdkWMDecoration ##### -->
 849 <para>
 850
 851 </para>
 852
 853 @GDK_DECOR_ALL:
 854 @GDK_DECOR_BORDER:
 855 @GDK_DECOR_RESIZEH:
 856 @GDK_DECOR_TITLE:
 857 @GDK_DECOR_MENU:
 858 @GDK_DECOR_MINIMIZE:
 859 @GDK_DECOR_MAXIMIZE:
 860
 861 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
 862 <para>
 863
 864 </para>
 865
 866 @window:
 867 @functions:
 868
 869
 870 <!-- ##### ENUM GdkWMFunction ##### -->
 871 <para>
 872
 873 </para>
 874
 875 @GDK_FUNC_ALL:
 876 @GDK_FUNC_RESIZE:
 877 @GDK_FUNC_MOVE:
 878 @GDK_FUNC_MINIMIZE:
 879 @GDK_FUNC_MAXIMIZE:
 880 @GDK_FUNC_CLOSE:
 881
 882 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
 883 <para>
 884
 885 </para>
 886
 887 @Returns:
 888
 889