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