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

   1 <!-- ##### SECTION Title ##### -->
   2 Windows
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 onscreen display areas in the target window system
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 A #GdkWindow is a rectangular region on the screen. It's a low-level object,
  11 used to implement high-level objects such as #GtkWidget and #GtkWindow on the
  12 GTK+ level. A #GtkWindow is a toplevel window, the thing a user might think of
  13 as a "window" with a titlebar and so on; a #GtkWindow may contain many #GdkWindow.
  14 For example, each #GtkButton has a #GdkWindow associated with it.
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### STRUCT GdkWindow ##### -->
  23 <para>
  24 An opaque structure representing an onscreen drawable.
  25 Pointers to structures of type #GdkPixmap, #GdkBitmap,
  26 and #GdkWindow, can often be used interchangeably.
  27 The type #GdkDrawable refers generically to any of
  28 these types.
  29 </para>
  30
  31
  32 <!-- ##### ENUM GdkWindowType ##### -->
  33 <para>
  34 Describes the kind of window.
  35 </para>
  36
  37 @GDK_WINDOW_ROOT: root window; this window has no parent, covers the entire screen, and is created by the window system
  38 @GDK_WINDOW_TOPLEVEL: toplevel window (used to implement #GtkWindow)
  39 @GDK_WINDOW_CHILD: child window (used to implement e.g. #GtkButton)
  40 @GDK_WINDOW_DIALOG: useless/deprecated compatibility type
  41 @GDK_WINDOW_TEMP: override redirect temporary window (used to implement #GtkMenu)
  42 @GDK_WINDOW_FOREIGN: foreign window (see gdk_window_foreign_new())
  43
  44 <!-- ##### ENUM GdkWindowClass ##### -->
  45 <para>
  46 @GDK_INPUT_OUTPUT windows are the standard kind of window you might expect.
  47 @GDK_INPUT_ONLY windows are invisible; they are used to trap events, but
  48 you can't draw on them.
  49 </para>
  50
  51 @GDK_INPUT_OUTPUT: window for graphics and events
  52 @GDK_INPUT_ONLY: window for events only
  53
  54 <!-- ##### ENUM GdkWindowHints ##### -->
  55 <para>
  56 Used to indicate which fields of a #GdkGeometry struct should be paid attention
  57 to. Also, the presence/absence of @GDK_HINT_POS, @GDK_HINT_USER_POS, and
  58 @GDK_HINT_USER_SIZE is significant, though they don't directly refer to
  59 #GdkGeometry fields.  @GDK_HINT_USER_POS will be set automatically by #GtkWindow
  60 if you call gtk_window_move(). @GDK_HINT_USER_POS and @GDK_HINT_USER_SIZE
  61 should be set if the user specified a size/position using a --geometry
  62 command-line argument; gtk_window_parse_geometry() automatically sets these
  63 flags.
  64 </para>
  65
  66 @GDK_HINT_POS: indicates that the program has positioned the window
  67 @GDK_HINT_MIN_SIZE: min size fields are set
  68 @GDK_HINT_MAX_SIZE: max size fields are set
  69 @GDK_HINT_BASE_SIZE: base size fields are set
  70 @GDK_HINT_ASPECT: aspect ratio fields are set
  71 @GDK_HINT_RESIZE_INC: resize increment fields are set
  72 @GDK_HINT_WIN_GRAVITY: window gravity field is set
  73 @GDK_HINT_USER_POS: indicates that the window's position was explicitly set by the user
  74 @GDK_HINT_USER_SIZE: indicates that the window's size was explicitly set by the user
  75
  76 <!-- ##### STRUCT GdkGeometry ##### -->
  77 <para>
  78 The #GdkGeometry struct gives the window manager information about
  79 a window's geometry constraints. Normally you would set these on
  80 the GTK+ level using gtk_window_set_geometry_hints(). #GtkWindow
  81 then sets the hints on the #GdkWindow it creates.
  82 </para>
  83
  84 <para>
  85 gdk_window_set_geometry_hints() expects the hints to be fully valid already and
  86 simply passes them to the window manager; in contrast,
  87 gtk_window_set_geometry_hints() performs some interpretation. For example,
  88 #GtkWindow will apply the hints to the geometry widget instead of the toplevel
  89 window, if you set a geometry widget. Also, the
  90 @min_width/@min_height/@max_width/@max_height fields may be set to -1, and
  91 #GtkWindow will substitute the size request of the window or geometry widget. If
  92 the minimum size hint is not provided, #GtkWindow will use its requisition as
  93 the minimum size.  If the minimum size is provided and a geometry widget is set,
  94 #GtkWindow will take the minimum size as the minimum size of the geometry widget
  95 rather than the entire window. The base size is treated similarly.
  96 </para>
  97
  98 <para>
  99 The canonical use-case for gtk_window_set_geometry_hints() is to get a terminal
 100 widget to resize properly. Here, the terminal text area should be the geometry
 101 widget; #GtkWindow will then automatically set the base size to the size of
 102 other widgets in the terminal window, such as the menubar and scrollbar.  Then,
 103 the @width_inc and @height_inc fields should be set to the size of one character
 104 in the terminal. Finally, the base size should be set to the size of one
 105 character. The net effect is that the minimum size of the terminal
 106 will have a 1x1 character terminal area, and only terminal sizes on
 107 the "character grid" will be allowed.
 108 </para>
 109
 110 <para>
 111 Here's an example of how the terminal example would be implemented, assuming
 112 a terminal area widget called "terminal" and a toplevel window "toplevel":
 113 <informalexample><programlisting>
 114         GdkGeometry hints;
 115
 116         hints.base_width = terminal->char_width;
 117         hints.base_height = terminal->char_height;
 118         hints.min_width = terminal->char_width;
 119         hints.min_height = terminal->char_height;
 120         hints.width_inc = terminal->char_width;
 121         hints.height_inc = terminal->char_height;
 122
 123         gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
 124                                        GTK_WIDGET (terminal),
 125                                        &amp;hints,
 126                                        GDK_HINT_RESIZE_INC |
 127                                        GDK_HINT_MIN_SIZE |
 128                                        GDK_HINT_BASE_SIZE);
 129 </programlisting></informalexample>
 130 </para>
 131
 132 <para>
 133 The other useful fields are the @min_aspect and @max_aspect fields; these
 134 contain a width/height ratio as a floating point number. If a geometry widget is
 135 set, the aspect applies to the geometry widget rather than the entire window.
 136 The most common use of these hints is probably to set @min_aspect and
 137 @max_aspect to the same value, thus forcing the window to keep a constant aspect
 138 ratio.
 139 </para>
 140
 141 @min_width: minimum width of window (or -1 to use requisition, with #GtkWindow only)
 142 @min_height minimum height of window (or -1 to use requisition, with #GtkWindow only)
 143 @min_height:
 144 @max_width: maximum width of window (or -1 to use requisition, with #GtkWindow only)
 145 @max_height: maximum height of window (or -1 to use requisition, with #GtkWindow only)
 146 @base_width: allowed window widths are @base_width + @width_inc * N where N is any integer (-1 allowed with #GtkWindow)
 147 @base_height: allowed window widths are @base_height + @height_inc * N where N is any integer (-1 allowed with #GtkWindow)
 148 @width_inc: width resize increment
 149 @height_inc: height resize increment
 150 @min_aspect: minimum width/height ratio
 151 @max_aspect: maximum width/height ratio
 152 @win_gravity: window gravity, see gtk_window_set_gravity()
 153
 154 <!-- ##### ENUM GdkGravity ##### -->
 155 <para>
 156 Defines the reference point of a window and the meaning of coordinates
 157 passed to gtk_window_move(). See gtk_window_move() and the "implementation
 158 notes" section of the
 159 <ulink url="http://www.freedesktop.org/standards/wm-spec.html">extended
 160 window manager hints</ulink> specification for more details.
 161 </para>
 162
 163 @GDK_GRAVITY_NORTH_WEST: the reference point is at the top left corner.
 164 @GDK_GRAVITY_NORTH: the reference point is in the middle of the top edge.
 165 @GDK_GRAVITY_NORTH_EAST: the reference point is at the top right corner.
 166 @GDK_GRAVITY_WEST: the reference point is at the middle of the left edge.
 167 @GDK_GRAVITY_CENTER: the reference point is at the center of the window.
 168 @GDK_GRAVITY_EAST: the reference point is at the middle of the right edge.
 169 @GDK_GRAVITY_SOUTH_WEST: the reference point is at the lower left corner.
 170 @GDK_GRAVITY_SOUTH: the reference point is at the middle of the lower edge.
 171 @GDK_GRAVITY_SOUTH_EAST: the reference point is at the lower right corner.
 172 @GDK_GRAVITY_STATIC: the reference point is at the top left corner of the
 173    window itself, ignoring window manager decorations.
 174
 175 <!-- ##### ENUM GdkWindowEdge ##### -->
 176 <para>
 177 Determines a window edge or corner.
 178 </para>
 179
 180 @GDK_WINDOW_EDGE_NORTH_WEST: the top left corner.
 181 @GDK_WINDOW_EDGE_NORTH: the top edge.
 182 @GDK_WINDOW_EDGE_NORTH_EAST: the top right corner.
 183 @GDK_WINDOW_EDGE_WEST: the left edge.
 184 @GDK_WINDOW_EDGE_EAST: the right edge.
 185 @GDK_WINDOW_EDGE_SOUTH_WEST: the lower left corner.
 186 @GDK_WINDOW_EDGE_SOUTH: the lower edge.
 187 @GDK_WINDOW_EDGE_SOUTH_EAST: the lower right corner.
 188
 189 <!-- ##### ENUM GdkWindowTypeHint ##### -->
 190 <para>
 191 These are hints for the window manager that indicate what type of function
 192 the window has. The window manager can use this when determining decoration
 193 and behaviour of the window. The hint must be set before mapping the window.
 194 </para>
 195
 196 @GDK_WINDOW_TYPE_HINT_NORMAL: Normal toplevel window.
 197 @GDK_WINDOW_TYPE_HINT_DIALOG: Dialog window.
 198 @GDK_WINDOW_TYPE_HINT_MENU: Window used to implement a menu.
 199 @GDK_WINDOW_TYPE_HINT_TOOLBAR: Window used to implement toolbars.
 200
 201 <!-- ##### STRUCT GdkWindowAttr ##### -->
 202 <para>
 203 Attributes to use for a newly-created window.
 204 </para>
 205
 206 @title: title of the window (for toplevel windows)
 207 @event_mask: event mask (see gdk_window_set_events())
 208 @x: X coordinate relative to parent window (see gdk_window_move())
 209 @y: Y coordinate relative to parent window (see gdk_window_move())
 210 @width: width of window
 211 @height: height of window
 212 @wclass: #GDK_INPUT_OUTPUT (normal window) or #GDK_INPUT_ONLY (invisible window that receives events)
 213 @visual: #GdkVisual for window
 214 @colormap: #GdkColormap for window
 215 @window_type: type of window
 216 @cursor: cursor for the window (see gdk_window_set_cursor())
 217 @wmclass_name: don't use (see gtk_window_set_wmclass())
 218 @wmclass_class: don't use (see gtk_window_set_wmclass())
 219 @override_redirect: %TRUE to bypass the window manager
 220
 221 <!-- ##### ENUM GdkWindowAttributesType ##### -->
 222 <para>
 223 Used to indicate which fields in the #GdkWindowAttr struct should be
 224 honored. For example, if you filled in the "cursor" and "x" fields of
 225 #GdkWindowAttr, pass "@GDK_WA_X | @GDK_WA_CURSOR" to gdk_window_new().  Fields
 226 in #GdkWindowAttr not covered by a bit in this enum are required; for example,
 227 the @width/@height, @wclass, and @window_type fields are required, they have no
 228 corresponding flag in #GdkWindowAttributesType.
 229 </para>
 230
 231 @GDK_WA_TITLE: Honor the title field
 232 @GDK_WA_X: Honor the X coordinate field
 233 @GDK_WA_Y: Honor the Y coordinate field
 234 @GDK_WA_CURSOR: Honor the cursor field
 235 @GDK_WA_COLORMAP: Honor the colormap field
 236 @GDK_WA_VISUAL: Honor the visual field
 237 @GDK_WA_WMCLASS: Honor the wmclass_class and wmclass_name fields
 238 @GDK_WA_NOREDIR: Honor the override_redirect field
 239
 240 <!-- ##### FUNCTION gdk_window_new ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @parent:
 246 @attributes:
 247 @attributes_mask:
 248 @Returns:
 249
 250
 251 <!-- ##### FUNCTION gdk_window_destroy ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @window:
 257
 258
 259 <!-- ##### MACRO gdk_window_ref ##### -->
 260 <para>
 261 Deprecated equivalent of g_object_ref()
 262 </para>
 263
 264 @Returns:
 265
 266
 267 <!-- ##### MACRO gdk_window_unref ##### -->
 268 <para>
 269 Deprecated equivalent of g_object_unref()
 270 </para>
 271
 272
 273
 274 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @window:
 280 @Returns:
 281
 282
 283 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @win_x:
 289 @win_y:
 290 @Returns:
 291
 292
 293 <!-- ##### FUNCTION gdk_window_show ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @window:
 299
 300
 301 <!-- ##### FUNCTION gdk_window_show_unraised ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @window:
 307
 308
 309 <!-- ##### FUNCTION gdk_window_hide ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @window:
 315
 316
 317 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
 318 <para>
 319
 320 </para>
 321
 322 @window:
 323 @Returns:
 324
 325
 326 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @window:
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION gdk_window_get_state ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @window:
 341 @Returns:
 342
 343
 344 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @window:
 350
 351
 352 <!-- ##### FUNCTION gdk_window_iconify ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @window:
 358
 359
 360 <!-- ##### FUNCTION gdk_window_deiconify ##### -->
 361 <para>
 362
 363 </para>
 364
 365 @window:
 366
 367
 368 <!-- ##### FUNCTION gdk_window_stick ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @window:
 374
 375
 376 <!-- ##### FUNCTION gdk_window_unstick ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @window:
 382
 383
 384 <!-- ##### FUNCTION gdk_window_maximize ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @window:
 390
 391
 392 <!-- ##### FUNCTION gdk_window_unmaximize ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @window:
 398
 399
 400 <!-- ##### FUNCTION gdk_window_move ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @window:
 406 @x:
 407 @y:
 408
 409
 410 <!-- ##### FUNCTION gdk_window_resize ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @window:
 416 @width:
 417 @height:
 418
 419
 420 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @window:
 426 @x:
 427 @y:
 428 @width:
 429 @height:
 430
 431
 432 <!-- ##### FUNCTION gdk_window_scroll ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @window:
 438 @dx:
 439 @dy:
 440
 441
 442 <!-- ##### FUNCTION gdk_window_reparent ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @window:
 448 @new_parent:
 449 @x:
 450 @y:
 451
 452
 453 <!-- ##### FUNCTION gdk_window_clear ##### -->
 454 <para>
 455
 456 </para>
 457
 458 @window:
 459
 460
 461 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
 462 <para>
 463
 464 </para>
 465
 466 @window:
 467 @x:
 468 @y:
 469 @width:
 470 @height:
 471
 472
 473 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
 474 <para>
 475
 476 </para>
 477
 478 @window:
 479 @x:
 480 @y:
 481 @width:
 482 @height:
 483
 484
 485 <!-- ##### MACRO gdk_window_copy_area ##### -->
 486 <para>
 487 Deprecated equivalent to gdk_draw_drawable(), see that function for docs
 488 </para>
 489
 490 @drawable:
 491 @gc:
 492 @x:
 493 @y:
 494 @source_drawable:
 495 @source_x:
 496 @source_y:
 497 @width:
 498 @height:
 499
 500
 501 <!-- ##### FUNCTION gdk_window_raise ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @window:
 507
 508
 509 <!-- ##### FUNCTION gdk_window_lower ##### -->
 510 <para>
 511
 512 </para>
 513
 514 @window:
 515
 516
 517 <!-- ##### FUNCTION gdk_window_focus ##### -->
 518 <para>
 519
 520 </para>
 521
 522 @window:
 523 @timestamp:
 524
 525
 526 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
 527 <para>
 528 Registers a window as a potential drop destination.
 529 </para>
 530
 531 @window: a #GdkWindow.
 532
 533
 534 <!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @window:
 540 @edge:
 541 @button:
 542 @root_x:
 543 @root_y:
 544 @timestamp:
 545
 546
 547 <!-- ##### FUNCTION gdk_window_begin_move_drag ##### -->
 548 <para>
 549
 550 </para>
 551
 552 @window:
 553 @button:
 554 @root_x:
 555 @root_y:
 556 @timestamp:
 557
 558
 559 <!-- ##### FUNCTION gdk_window_constrain_size ##### -->
 560 <para>
 561
 562 </para>
 563
 564 @geometry:
 565 @flags:
 566 @width:
 567 @height:
 568 @new_width:
 569 @new_height:
 570
 571
 572 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
 573 <para>
 574
 575 </para>
 576
 577 @window:
 578 @rectangle:
 579
 580
 581 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @window:
 587 @region:
 588
 589
 590 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
 591 <para>
 592
 593 </para>
 594
 595 @window:
 596
 597
 598 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
 599 <para>
 600
 601 </para>
 602
 603 @window:
 604 @rect:
 605 @invalidate_children:
 606
 607
 608 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
 609 <para>
 610
 611 </para>
 612
 613 @window:
 614 @region:
 615 @invalidate_children:
 616
 617
 618 <!-- ##### FUNCTION gdk_window_invalidate_maybe_recurse ##### -->
 619 <para>
 620
 621 </para>
 622
 623 @window:
 624 @region:
 625 @child_func:
 626 @user_data:
 627
 628
 629 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
 630 <para>
 631
 632 </para>
 633
 634 @window:
 635 @Returns:
 636
 637
 638 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
 639 <para>
 640
 641 </para>
 642
 643 @window:
 644
 645
 646 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
 647 <para>
 648
 649 </para>
 650
 651 @window:
 652
 653
 654 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
 655 <para>
 656
 657 </para>
 658
 659
 660
 661 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
 662 <para>
 663
 664 </para>
 665
 666 @window:
 667 @update_children:
 668
 669
 670 <!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
 671 <para>
 672
 673 </para>
 674
 675 @setting:
 676
 677
 678 <!-- ##### FUNCTION gdk_window_get_internal_paint_info ##### -->
 679 <para>
 680
 681 </para>
 682
 683 @window:
 684 @real_drawable:
 685 @x_offset:
 686 @y_offset:
 687
 688
 689 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
 690 <para>
 691
 692 </para>
 693
 694 @window:
 695 @user_data:
 696
 697
 698 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
 699 <para>
 700
 701 </para>
 702
 703 @window:
 704 @override_redirect:
 705
 706
 707 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
 708 <para>
 709
 710 </para>
 711
 712 @window:
 713 @function:
 714 @data:
 715
 716
 717 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
 718 <para>
 719
 720 </para>
 721
 722 @window:
 723 @function:
 724 @data:
 725
 726
 727 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
 728 <para>
 729 Specifies the type of function used to filter native events before they are
 730 converted to GDK events. A filter may translate the native event to a GDK
 731 event or handle it without translation.
 732 </para>
 733
 734 @xevent: the native event to filter.
 735 @event: the GDK event to which the X event will be translated.
 736 @data: user data set when the filter was installed.
 737 @Returns: a #GdkFilterReturn value.
 738
 739
 740 <!-- ##### ENUM GdkFilterReturn ##### -->
 741 <para>
 742 Specifies the result of applying a #GdkFilterFunc to a native event.
 743 </para>
 744
 745 @GDK_FILTER_CONTINUE: event not handled, continue processing.
 746 @GDK_FILTER_TRANSLATE: translated event stored.
 747 @GDK_FILTER_REMOVE: event handled, terminate processing.
 748
 749 <!-- ##### TYPEDEF GdkXEvent ##### -->
 750 <para>
 751 Used to represent native events (<type>XEvent</type>s for the X11
 752 backend, <type>MSG</type>s for Win32).
 753 </para>
 754
 755
 756 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
 757 <para>
 758
 759 </para>
 760
 761 @window:
 762 @mask:
 763 @x:
 764 @y:
 765
 766
 767 <!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
 768 <para>
 769
 770 </para>
 771
 772 @window:
 773 @shape_region:
 774 @offset_x:
 775 @offset_y:
 776
 777
 778 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
 779 <para>
 780
 781 </para>
 782
 783 @window:
 784
 785
 786 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
 787 <para>
 788
 789 </para>
 790
 791 @window:
 792
 793
 794 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
 795 <para>
 796
 797 </para>
 798
 799 @window:
 800 @use_static:
 801 @Returns:
 802
 803
 804 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @window:
 810 @x:
 811 @y:
 812 @min_width:
 813 @min_height:
 814 @max_width:
 815 @max_height:
 816 @flags:
 817
 818
 819 <!-- ##### FUNCTION gdk_window_set_title ##### -->
 820 <para>
 821
 822 </para>
 823
 824 @window:
 825 @title:
 826
 827
 828 <!-- ##### FUNCTION gdk_window_set_background ##### -->
 829 <para>
 830
 831 </para>
 832
 833 @window:
 834 @color:
 835
 836
 837 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
 838 <para>
 839
 840 </para>
 841
 842 @window:
 843 @pixmap:
 844 @parent_relative:
 845
 846
 847 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
 848 <para>
 849 A special value for <literal>GdkPixmap*</literal> variables, indicating
 850 that the background pixmap for a window should be inherited from the parent
 851 window.
 852 </para>
 853
 854
 855
 856 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
 857 <para>
 858
 859 </para>
 860
 861 @window:
 862 @cursor:
 863
 864
 865 <!-- ##### MACRO gdk_window_set_colormap ##### -->
 866 <para>
 867 Deprecated equivalent to gdk_drawable_set_colormap()
 868 </para>
 869
 870
 871
 872 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
 873 <para>
 874
 875 </para>
 876
 877 @window:
 878 @data:
 879
 880
 881 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
 882 <para>
 883
 884 </para>
 885
 886 @window:
 887 @x:
 888 @y:
 889 @width:
 890 @height:
 891 @depth:
 892
 893
 894 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
 895 <para>
 896
 897 </para>
 898
 899 @window:
 900 @geometry:
 901 @geom_mask:
 902
 903
 904 <!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
 905 <para>
 906
 907 </para>
 908
 909 @window:
 910 @pixbufs:
 911
 912
 913 <!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
 914 <para>
 915
 916 </para>
 917
 918 @window:
 919 @modal:
 920
 921
 922 <!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
 923 <para>
 924
 925 </para>
 926
 927 @window:
 928 @hint:
 929
 930
 931 <!-- ##### FUNCTION gdk_window_get_position ##### -->
 932 <para>
 933
 934 </para>
 935
 936 @window:
 937 @x:
 938 @y:
 939
 940
 941 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
 942 <para>
 943
 944 </para>
 945
 946 @window:
 947 @x:
 948 @y:
 949
 950
 951 <!-- ##### FUNCTION gdk_window_get_frame_extents ##### -->
 952 <para>
 953
 954 </para>
 955
 956 @window:
 957 @rect:
 958
 959
 960 <!-- ##### MACRO gdk_window_get_size ##### -->
 961 <para>
 962 Deprecated equivalent of gdk_drawable_get_size().
 963 </para>
 964
 965
 966
 967 <!-- ##### MACRO gdk_window_get_visual ##### -->
 968 <para>
 969 Deprecated equivalent of gdk_drawable_get_visual().
 970 </para>
 971
 972 @Returns:
 973
 974
 975 <!-- ##### MACRO gdk_window_get_colormap ##### -->
 976 <para>
 977 Deprecated equivalent of gdk_drawable_get_colormap().
 978 </para>
 979
 980 @Returns: colormap for the window
 981
 982
 983 <!-- ##### MACRO gdk_window_get_type ##### -->
 984 <para>
 985 Deprecated equivalent of gdk_drawable_get_type().
 986 </para>
 987
 988 @Returns: type of drawable
 989
 990
 991 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
 992 <para>
 993
 994 </para>
 995
 996 @window:
 997 @x:
 998 @y:
 999 @Returns:
1000
1001
1002 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
1003 <para>
1004
1005 </para>
1006
1007 @window:
1008 @x:
1009 @y:
1010 @Returns:
1011
1012
1013 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
1014 <para>
1015
1016 </para>
1017
1018 @window:
1019 @x:
1020 @y:
1021 @mask:
1022 @Returns:
1023
1024
1025 <!-- ##### ENUM GdkModifierType ##### -->
1026 <para>
1027 A set of bit-flags to indicate the state of modifier keys and mouse buttons
1028 in various event types. Typical modifier keys are Shift, Control, Meta, Super,
1029 Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
1030 </para>
1031 <para>
1032 Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
1033 </para>
1034
1035 @GDK_SHIFT_MASK: the Shift key.
1036 @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
1037   X server this may either be CapsLock or ShiftLock).
1038 @GDK_CONTROL_MASK: the Control key.
1039 @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
1040   mapping of the X server which key is interpreted as this modifier, but
1041   normally it is the Alt key).
1042 @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
1043   mapping of the X server which key is interpreted as this modifier).
1044 @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
1045   mapping of the X server which key is interpreted as this modifier).
1046 @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
1047   mapping of the X server which key is interpreted as this modifier).
1048 @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
1049   mapping of the X server which key is interpreted as this modifier).
1050 @GDK_BUTTON1_MASK: the first mouse button.
1051 @GDK_BUTTON2_MASK: the second mouse button.
1052 @GDK_BUTTON3_MASK: the third mouse button.
1053 @GDK_BUTTON4_MASK: the fourth mouse button.
1054 @GDK_BUTTON5_MASK: the fifth mouse button.
1055 @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
1056   between (keyval, modifiers) pairs from key press and release events.
1057 @GDK_MODIFIER_MASK:
1058
1059 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
1060 <para>
1061
1062 </para>
1063
1064 @window:
1065 @Returns:
1066
1067
1068 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
1069 <para>
1070
1071 </para>
1072
1073 @window:
1074 @Returns:
1075
1076
1077 <!-- ##### FUNCTION gdk_window_get_children ##### -->
1078 <para>
1079
1080 </para>
1081
1082 @window:
1083 @Returns:
1084
1085
1086 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
1087 <para>
1088
1089 </para>
1090
1091 @window:
1092 @Returns:
1093
1094
1095 <!-- ##### FUNCTION gdk_window_get_events ##### -->
1096 <para>
1097
1098 </para>
1099
1100 @window:
1101 @Returns:
1102
1103
1104 <!-- ##### FUNCTION gdk_window_set_events ##### -->
1105 <para>
1106
1107 </para>
1108
1109 @window:
1110 @event_mask:
1111
1112
1113 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
1114 <para>
1115
1116 </para>
1117
1118 @window:
1119 @icon_window:
1120 @pixmap:
1121 @mask:
1122
1123
1124 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
1125 <para>
1126
1127 </para>
1128
1129 @window:
1130 @name:
1131
1132
1133 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
1134 <para>
1135
1136 </para>
1137
1138 @window:
1139 @parent:
1140
1141
1142 <!-- ##### FUNCTION gdk_window_set_role ##### -->
1143 <para>
1144
1145 </para>
1146
1147 @window:
1148 @role:
1149
1150
1151 <!-- ##### FUNCTION gdk_window_set_group ##### -->
1152 <para>
1153
1154 </para>
1155
1156 @window:
1157 @leader:
1158
1159
1160 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
1161 <para>
1162
1163 </para>
1164
1165 @window:
1166 @decorations:
1167
1168
1169 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
1170 <para>
1171
1172 </para>
1173
1174 @window: The window to get the decorations from
1175 @decorations: The window decorations will be written here
1176 @Returns: %TRUE if the window has decorations set, %FALSE otherwise.
1177
1178
1179 <!-- ##### ENUM GdkWMDecoration ##### -->
1180 <para>
1181 These are hints originally defined by the Motif toolkit.
1182 The window manager can use them when determining how to decorate
1183 the window. The hint must be set before mapping the window.
1184 </para>
1185
1186 @GDK_DECOR_ALL: all decorations should be applied.
1187 @GDK_DECOR_BORDER: a frame should be drawn around the window.
1188 @GDK_DECOR_RESIZEH: the frame should have resize handles.
1189 @GDK_DECOR_TITLE: a titlebar should be placed above the window.
1190 @GDK_DECOR_MENU: a button for opening a menu should be included.
1191 @GDK_DECOR_MINIMIZE: a minimize button should be included.
1192 @GDK_DECOR_MAXIMIZE: a maximize button should be included.
1193
1194 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
1195 <para>
1196
1197 </para>
1198
1199 @window:
1200 @functions:
1201
1202
1203 <!-- ##### ENUM GdkWMFunction ##### -->
1204 <para>
1205 These are hints originally defined by the Motif toolkit.
1206 The window manager can use them when determining the functions
1207 to offer for the window.
1208 The hint must be set before mapping the window.
1209 </para>
1210
1211 @GDK_FUNC_ALL: all functions should be offered.
1212 @GDK_FUNC_RESIZE: the window should be resizable.
1213 @GDK_FUNC_MOVE: the window should be movable.
1214 @GDK_FUNC_MINIMIZE: the window should be minimizable.
1215 @GDK_FUNC_MAXIMIZE: the window should be maximizable.
1216 @GDK_FUNC_CLOSE: the window should be closable.
1217
1218 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
1219 <para>
1220
1221 </para>
1222
1223 @Returns:
1224
1225
1226 <!-- ##### FUNCTION gdk_get_default_root_window ##### -->
1227 <para>
1228
1229 </para>
1230
1231 @Returns:
1232
1233
1234 <!-- ##### STRUCT GdkPointerHooks ##### -->
1235 <para>
1236 A table of pointers to functions for getting quantities related to
1237 the current pointer position. GDK has one global table of this type,
1238 which can be set using gdk_set_pointer_hooks().
1239 </para>
1240 <para>
1241 This is only useful for such low-level tools as an event recorder.
1242 Applications should never have any reason to use this facility
1243 </para>
1244
1245 @get_pointer: Obtains the current pointer position and modifier state.
1246   The position is given in coordinates relative to the window containing
1247   the pointer, which is returned in @window.
1248 @window_at_pointer: Obtains the window underneath the mouse pointer,
1249   returning the location of that window in @win_x, @win_y. Returns %NULL
1250   if the window under the mouse pointer is not known to GDK (for example,
1251   belongs to another application).
1252
1253 <!-- ##### FUNCTION gdk_set_pointer_hooks ##### -->
1254 <para>
1255
1256 </para>
1257
1258 @new_hooks:
1259 @Returns:
1260
1261