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