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

   1 <!-- ##### SECTION Title ##### -->
   2 Windows
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Onscreen display areas in the target window system
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GdkWindow is a rectangular region on the screen. It's a low-level object,
  10 used to implement high-level objects such as #GtkWidget and #GtkWindow on the
  11 GTK+ level. A #GtkWindow is a toplevel window, the thing a user might think of
  12 as a "window" with a titlebar and so on; a #GtkWindow may contain many #GdkWindow.
  13 For example, each #GtkButton has a #GdkWindow associated with it.
  14 </para>
  15 <refsect2 id="COMPOSITED-WINDOWS"><title>Composited Windows</title>
  16 <para>
  17 Normally, the windowing system takes care of rendering the contents of a child
  18 window onto its parent window. This mechanism can be intercepted by calling
  19 gdk_window_set_composited() on the child window. For a
  20 <firstterm>composited</firstterm> window it is the responsibility of the
  21 application to render the window contents at the right spot.
  22 </para>
  23 <example id="composited-window-example"><title>Composited windows</title>
  24 <programlisting><![CDATA[
  25 #include <gtk/gtk.h>
  26
  27 /* The expose event handler for the event box.
  28  *
  29  * This function simply draws a transparency onto a widget on the area
  30  * for which it receives expose events.  This is intended to give the
  31  * event box a "transparent" background.
  32  *
  33  * In order for this to work properly, the widget must have an RGBA
  34  * colourmap.  The widget should also be set as app-paintable since it
  35  * doesn't make sense for GTK+ to draw a background if we are drawing it
  36  * (and because GTK+ might actually replace our transparency with its
  37  * default background colour).
  38  */
  39 static gboolean
  40 transparent_expose (GtkWidget      *widget,
  41                     GdkEventExpose *event)
  42 {
  43   cairo_t *cr;
  44
  45   cr = gdk_cairo_create (widget->window);
  46   cairo_set_operator (cr, CAIRO_OPERATOR_CLEAR);
  47   gdk_cairo_region (cr, event->region);
  48   cairo_fill (cr);
  49   cairo_destroy (cr);
  50
  51   return FALSE;
  52 }
  53
  54 /* The expose event handler for the window.
  55  *
  56  * This function performs the actual compositing of the event box onto
  57  * the already-existing background of the window at 50% normal opacity.
  58  *
  59  * In this case we do not want app-paintable to be set on the widget
  60  * since we want it to draw its own (red) background. Because of this,
  61  * however, we must ensure that we use g_signal_connect_after so that
  62  * this handler is called after the red has been drawn. If it was
  63  * called before then GTK would just blindly paint over our work.
  64  *
  65  * Note: if the child window has children, then you need a cairo 1.6
  66  * feature to make this work correctly.
  67  */
  68 static gboolean
  69 window_expose_event (GtkWidget      *widget,
  70                      GdkEventExpose *event)
  71 {
  72   GdkRegion *region;
  73   GtkWidget *child;
  74   cairo_t *cr;
  75
  76   /* get our child (in this case, the event box) */
  77   child = gtk_bin_get_child (GTK_BIN (widget));
  78
  79   /* create a cairo context to draw to the window */
  80   cr = gdk_cairo_create (widget->window);
  81
  82   /* the source data is the (composited) event box */
  83   gdk_cairo_set_source_pixmap (cr, child->window,
  84                                child->allocation.x,
  85                                child->allocation.y);
  86
  87   /* draw no more than our expose event intersects our child */
  88   region = gdk_region_rectangle (&child->allocation);
  89   gdk_region_intersect (region, event->region);
  90   gdk_cairo_region (cr, region);
  91   cairo_clip (cr);
  92
  93   /* composite, with a 50% opacity */
  94   cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
  95   cairo_paint_with_alpha (cr, 0.5);
  96
  97   /* we're done */
  98   cairo_destroy (cr);
  99
 100   return FALSE;
 101 }
 102
 103 int
 104 main (int argc, char **argv)
 105 {
 106   GtkWidget *window, *event, *button;
 107   GdkScreen *screen;
 108   GdkColormap *rgba;
 109   GdkColor red;
 110
 111   gtk_init (&argc, &argv);
 112
 113   /* Make the widgets */
 114   button = gtk_button_new_with_label ("A Button");
 115   event = gtk_event_box_new ();
 116   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
 117
 118   /* Put a red background on the window */
 119   gdk_color_parse ("red", &red);
 120   gtk_widget_modify_bg (window, GTK_STATE_NORMAL, &red);
 121
 122   /* Set the colourmap for the event box.
 123    * Must be done before the event box is realised.
 124    */
 125   screen = gtk_widget_get_screen (event);
 126   rgba = gdk_screen_get_rgba_colormap (screen);
 127   gtk_widget_set_colormap (event, rgba);
 128
 129   /* Set our event box to have a fully-transparent background
 130    * drawn on it. Currently there is no way to simply tell GTK+
 131    * that "transparency" is the background colour for a widget.
 132    */
 133   gtk_widget_set_app_paintable (GTK_WIDGET (event), TRUE);
 134   g_signal_connect (event, "expose-event",
 135                     G_CALLBACK (transparent_expose), NULL);
 136
 137   /* Put them inside one another */
 138   gtk_container_set_border_width (GTK_CONTAINER (window), 10);
 139   gtk_container_add (GTK_CONTAINER (window), event);
 140   gtk_container_add (GTK_CONTAINER (event), button);
 141
 142   /* Realise and show everything */
 143   gtk_widget_show_all (window);
 144
 145   /* Set the event box GdkWindow to be composited.
 146    * Obviously must be performed after event box is realised.
 147    */
 148   gdk_window_set_composited (event->window, TRUE);
 149
 150   /* Set up the compositing handler.
 151    * Note that we do _after_ so that the normal (red) background is drawn
 152    * by gtk before our compositing occurs.
 153    */
 154   g_signal_connect_after (window, "expose-event",
 155                           G_CALLBACK (window_expose_event), NULL);
 156
 157   gtk_main ();
 158
 159   return 0;
 160 }
 161 ]]>
 162 </programlisting></example>
 163 <para>
 164 In the example <xref linkend="composited-window-example"/>, a button is
 165 placed inside of an event box inside of a window. The event box is
 166 set as composited and therefore is no longer automatically drawn to
 167 the screen.
 168 </para>
 169 <para>
 170 When the contents of the event box change, an expose event is
 171 generated on its parent window (which, in this case, belongs to
 172 the toplevel #GtkWindow). The expose handler for this widget is
 173 responsible for merging the changes back on the screen in the way
 174 that it wishes.
 175 </para>
 176 <para>
 177 In our case, we merge the contents with a 50% transparency. We
 178 also set the background colour of the window to red. The effect is
 179 that the background shows through the button.
 180 </para>
 181 </refsect2>
 182 <refsect2 id="OFFSCREEN-WINDOWS"><title>Offscreen Windows</title>
 183 <para>
 184 Offscreen windows are more general than composited windows, since they
 185 allow not only to modify the rendering of the child window onto its parent,
 186 but also to apply coordinate transformations.
 187 </para>
 188 <para>
 189 To integrate an offscreen window into a window hierarchy, one has to call
 190 gdk_offscreen_window_set_embedder() and handle a number of signals. The
 191 #GdkWindow::pick-embedded-child signal on the embedder window is used to
 192 select an offscreen child at given coordinates, and the #GdkWindow::to-embedder
 193 and #GdkWindow::from-embedder signals on the offscreen window are used to
 194 translate coordinates between the embedder and the offscreen window.
 195 </para>
 196
 197 <para>
 198 For rendering an offscreen window onto its embedder, the contents of the
 199 offscreen window are available as a pixmap, via
 200 gdk_offscreen_window_get_pixmap().
 201 </para>
 202 </refsect2>
 203
 204 <!-- ##### SECTION See_Also ##### -->
 205 <para>
 206
 207 </para>
 208
 209 <!-- ##### SECTION Stability_Level ##### -->
 210
 211
 212 <!-- ##### SECTION Image ##### -->
 213
 214
 215 <!-- ##### STRUCT GdkWindow ##### -->
 216 <para>
 217 An opaque structure representing an onscreen drawable.
 218 Pointers to structures of type #GdkPixmap, #GdkBitmap,
 219 and #GdkWindow, can often be used interchangeably.
 220 The type #GdkDrawable refers generically to any of
 221 these types.
 222 </para>
 223
 224
 225 <!-- ##### SIGNAL GdkWindow::from-embedder ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @gdkwindow: the object which received the signal.
 231 @arg1:
 232 @arg2:
 233 @arg3:
 234 @arg4:
 235
 236 <!-- ##### SIGNAL GdkWindow::pick-embedded-child ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @gdkwindow: the object which received the signal.
 242 @arg1:
 243 @arg2:
 244 @Returns:
 245
 246 <!-- ##### SIGNAL GdkWindow::to-embedder ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @gdkwindow: the object which received the signal.
 252 @arg1:
 253 @arg2:
 254 @arg3:
 255 @arg4:
 256
 257 <!-- ##### ARG GdkWindow:cursor ##### -->
 258 <para>
 259
 260 </para>
 261
 262 <!-- ##### ENUM GdkWindowType ##### -->
 263 <para>
 264 Describes the kind of window.
 265 </para>
 266
 267 @GDK_WINDOW_ROOT: root window; this window has no parent, covers the entire screen, and is created by the window system
 268 @GDK_WINDOW_TOPLEVEL: toplevel window (used to implement #GtkWindow)
 269 @GDK_WINDOW_CHILD: child window (used to implement e.g. #GtkEntry)
 270 @GDK_WINDOW_DIALOG: useless/deprecated compatibility type
 271 @GDK_WINDOW_TEMP: override redirect temporary window (used to implement #GtkMenu)
 272 @GDK_WINDOW_FOREIGN: foreign window (see gdk_window_foreign_new())
 273 @GDK_WINDOW_OFFSCREEN: offscreen window (see <xref linkend="OFFSCREEN-WINDOWS"/>). Since 2.18
 274
 275 <!-- ##### ENUM GdkWindowClass ##### -->
 276 <para>
 277 @GDK_INPUT_OUTPUT windows are the standard kind of window you might expect.
 278 @GDK_INPUT_ONLY windows are invisible; they are used to trap events, but
 279 you can't draw on them.
 280 </para>
 281
 282 @GDK_INPUT_OUTPUT: window for graphics and events
 283 @GDK_INPUT_ONLY: window for events only
 284
 285 <!-- ##### ENUM GdkWindowHints ##### -->
 286 <para>
 287 Used to indicate which fields of a #GdkGeometry struct should be paid attention
 288 to. Also, the presence/absence of @GDK_HINT_POS, @GDK_HINT_USER_POS, and
 289 @GDK_HINT_USER_SIZE is significant, though they don't directly refer to
 290 #GdkGeometry fields.  @GDK_HINT_USER_POS will be set automatically by #GtkWindow
 291 if you call gtk_window_move(). @GDK_HINT_USER_POS and @GDK_HINT_USER_SIZE
 292 should be set if the user specified a size/position using a --geometry
 293 command-line argument; gtk_window_parse_geometry() automatically sets these
 294 flags.
 295 </para>
 296
 297 @GDK_HINT_POS: indicates that the program has positioned the window
 298 @GDK_HINT_MIN_SIZE: min size fields are set
 299 @GDK_HINT_MAX_SIZE: max size fields are set
 300 @GDK_HINT_BASE_SIZE: base size fields are set
 301 @GDK_HINT_ASPECT: aspect ratio fields are set
 302 @GDK_HINT_RESIZE_INC: resize increment fields are set
 303 @GDK_HINT_WIN_GRAVITY: window gravity field is set
 304 @GDK_HINT_USER_POS: indicates that the window's position was explicitly set by the user
 305 @GDK_HINT_USER_SIZE: indicates that the window's size was explicitly set by the user
 306
 307 <!-- ##### STRUCT GdkGeometry ##### -->
 308 <para>
 309 The #GdkGeometry struct gives the window manager information about
 310 a window's geometry constraints. Normally you would set these on
 311 the GTK+ level using gtk_window_set_geometry_hints(). #GtkWindow
 312 then sets the hints on the #GdkWindow it creates.
 313 </para>
 314
 315 <para>
 316 gdk_window_set_geometry_hints() expects the hints to be fully valid already and
 317 simply passes them to the window manager; in contrast,
 318 gtk_window_set_geometry_hints() performs some interpretation. For example,
 319 #GtkWindow will apply the hints to the geometry widget instead of the toplevel
 320 window, if you set a geometry widget. Also, the
 321 @min_width/@min_height/@max_width/@max_height fields may be set to -1, and
 322 #GtkWindow will substitute the size request of the window or geometry widget. If
 323 the minimum size hint is not provided, #GtkWindow will use its requisition as
 324 the minimum size.  If the minimum size is provided and a geometry widget is set,
 325 #GtkWindow will take the minimum size as the minimum size of the geometry widget
 326 rather than the entire window. The base size is treated similarly.
 327 </para>
 328
 329 <para>
 330 The canonical use-case for gtk_window_set_geometry_hints() is to get a terminal
 331 widget to resize properly. Here, the terminal text area should be the geometry
 332 widget; #GtkWindow will then automatically set the base size to the size of
 333 other widgets in the terminal window, such as the menubar and scrollbar.  Then,
 334 the @width_inc and @height_inc fields should be set to the size of one character
 335 in the terminal. Finally, the base size should be set to the size of one
 336 character. The net effect is that the minimum size of the terminal
 337 will have a 1x1 character terminal area, and only terminal sizes on
 338 the "character grid" will be allowed.
 339 </para>
 340
 341 <para>
 342 Here's an example of how the terminal example would be implemented, assuming
 343 a terminal area widget called "terminal" and a toplevel window "toplevel":
 344 <informalexample><programlisting>
 345         GdkGeometry hints;
 346
 347         hints.base_width = terminal->char_width;
 348         hints.base_height = terminal->char_height;
 349         hints.min_width = terminal->char_width;
 350         hints.min_height = terminal->char_height;
 351         hints.width_inc = terminal->char_width;
 352         hints.height_inc = terminal->char_height;
 353
 354         gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
 355                                        GTK_WIDGET (terminal),
 356                                        &amp;hints,
 357                                        GDK_HINT_RESIZE_INC |
 358                                        GDK_HINT_MIN_SIZE |
 359                                        GDK_HINT_BASE_SIZE);
 360 </programlisting></informalexample>
 361 </para>
 362
 363 <para>
 364 The other useful fields are the @min_aspect and @max_aspect fields; these
 365 contain a width/height ratio as a floating point number. If a geometry widget is
 366 set, the aspect applies to the geometry widget rather than the entire window.
 367 The most common use of these hints is probably to set @min_aspect and
 368 @max_aspect to the same value, thus forcing the window to keep a constant aspect
 369 ratio.
 370 </para>
 371
 372 @min_width: minimum width of window (or -1 to use requisition, with #GtkWindow only)
 373 @min_height: minimum height of window (or -1 to use requisition, with #GtkWindow only)
 374 @max_width: maximum width of window (or -1 to use requisition, with #GtkWindow only)
 375 @max_height: maximum height of window (or -1 to use requisition, with #GtkWindow only)
 376 @base_width: allowed window widths are @base_width + @width_inc * N where N is any integer (-1 allowed with #GtkWindow)
 377 @base_height: allowed window widths are @base_height + @height_inc * N where N is any integer (-1 allowed with #GtkWindow)
 378 @width_inc: width resize increment
 379 @height_inc: height resize increment
 380 @min_aspect: minimum width/height ratio
 381 @max_aspect: maximum width/height ratio
 382 @win_gravity: window gravity, see gtk_window_set_gravity()
 383
 384 <!-- ##### ENUM GdkGravity ##### -->
 385 <para>
 386 Defines the reference point of a window and the meaning of coordinates
 387 passed to gtk_window_move(). See gtk_window_move() and the "implementation
 388 notes" section of the
 389 <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
 390 Window Manager Hints</ulink> specification for more details.
 391 </para>
 392
 393 @GDK_GRAVITY_NORTH_WEST: the reference point is at the top left corner.
 394 @GDK_GRAVITY_NORTH: the reference point is in the middle of the top edge.
 395 @GDK_GRAVITY_NORTH_EAST: the reference point is at the top right corner.
 396 @GDK_GRAVITY_WEST: the reference point is at the middle of the left edge.
 397 @GDK_GRAVITY_CENTER: the reference point is at the center of the window.
 398 @GDK_GRAVITY_EAST: the reference point is at the middle of the right edge.
 399 @GDK_GRAVITY_SOUTH_WEST: the reference point is at the lower left corner.
 400 @GDK_GRAVITY_SOUTH: the reference point is at the middle of the lower edge.
 401 @GDK_GRAVITY_SOUTH_EAST: the reference point is at the lower right corner.
 402 @GDK_GRAVITY_STATIC: the reference point is at the top left corner of the
 403    window itself, ignoring window manager decorations.
 404
 405 <!-- ##### ENUM GdkWindowEdge ##### -->
 406 <para>
 407 Determines a window edge or corner.
 408 </para>
 409
 410 @GDK_WINDOW_EDGE_NORTH_WEST: the top left corner.
 411 @GDK_WINDOW_EDGE_NORTH: the top edge.
 412 @GDK_WINDOW_EDGE_NORTH_EAST: the top right corner.
 413 @GDK_WINDOW_EDGE_WEST: the left edge.
 414 @GDK_WINDOW_EDGE_EAST: the right edge.
 415 @GDK_WINDOW_EDGE_SOUTH_WEST: the lower left corner.
 416 @GDK_WINDOW_EDGE_SOUTH: the lower edge.
 417 @GDK_WINDOW_EDGE_SOUTH_EAST: the lower right corner.
 418
 419 <!-- ##### ENUM GdkWindowTypeHint ##### -->
 420 <para>
 421 These are hints for the window manager that indicate what type of function
 422 the window has. The window manager can use this when determining decoration
 423 and behaviour of the window. The hint must be set before mapping the window.
 424 </para>
 425 <para>
 426 See the
 427 <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
 428 Window Manager Hints</ulink> specification for more details about
 429 window types.
 430 </para>
 431
 432 @GDK_WINDOW_TYPE_HINT_NORMAL: Normal toplevel window.
 433 @GDK_WINDOW_TYPE_HINT_DIALOG: Dialog window.
 434 @GDK_WINDOW_TYPE_HINT_MENU: Window used to implement a menu; GTK+ uses
 435   this hint only for torn-off menus, see #GtkTearoffMenuItem.
 436 @GDK_WINDOW_TYPE_HINT_TOOLBAR: Window used to implement toolbars.
 437 @GDK_WINDOW_TYPE_HINT_SPLASHSCREEN: Window used to display a splash
 438   screen during application startup.
 439 @GDK_WINDOW_TYPE_HINT_UTILITY: Utility windows which are not detached
 440   toolbars or dialogs.
 441 @GDK_WINDOW_TYPE_HINT_DOCK: Used for creating dock or panel windows.
 442 @GDK_WINDOW_TYPE_HINT_DESKTOP: Used for creating the desktop background
 443 window.
 444 @GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU: A menu that belongs to a menubar.
 445 @GDK_WINDOW_TYPE_HINT_POPUP_MENU: A menu that does not belong to a menubar,
 446   e.g. a context menu.
 447 @GDK_WINDOW_TYPE_HINT_TOOLTIP: A tooltip.
 448 @GDK_WINDOW_TYPE_HINT_NOTIFICATION: A notification - typically a "bubble"
 449   that belongs to a status icon.
 450 @GDK_WINDOW_TYPE_HINT_COMBO: A popup from a combo box.
 451 @GDK_WINDOW_TYPE_HINT_DND: A window that is used to implement a DND cursor.
 452
 453 <!-- ##### STRUCT GdkWindowAttr ##### -->
 454 <para>
 455 Attributes to use for a newly-created window.
 456 </para>
 457
 458 @title: title of the window (for toplevel windows)
 459 @event_mask: event mask (see gdk_window_set_events())
 460 @x: X coordinate relative to parent window (see gdk_window_move())
 461 @y: Y coordinate relative to parent window (see gdk_window_move())
 462 @width: width of window
 463 @height: height of window
 464 @wclass: #GDK_INPUT_OUTPUT (normal window) or #GDK_INPUT_ONLY (invisible window that receives events)
 465 @visual: #GdkVisual for window
 466 @colormap: #GdkColormap for window
 467 @window_type: type of window
 468 @cursor: cursor for the window (see gdk_window_set_cursor())
 469 @wmclass_name: don't use (see gtk_window_set_wmclass())
 470 @wmclass_class: don't use (see gtk_window_set_wmclass())
 471 @override_redirect: %TRUE to bypass the window manager
 472 @type_hint: a hint of the function of the window
 473
 474 <!-- ##### ENUM GdkWindowAttributesType ##### -->
 475 <para>
 476 Used to indicate which fields in the #GdkWindowAttr struct should be
 477 honored. For example, if you filled in the "cursor" and "x" fields of
 478 #GdkWindowAttr, pass "@GDK_WA_X | @GDK_WA_CURSOR" to gdk_window_new().  Fields
 479 in #GdkWindowAttr not covered by a bit in this enum are required; for example,
 480 the @width/@height, @wclass, and @window_type fields are required, they have no
 481 corresponding flag in #GdkWindowAttributesType.
 482 </para>
 483
 484 @GDK_WA_TITLE: Honor the title field
 485 @GDK_WA_X: Honor the X coordinate field
 486 @GDK_WA_Y: Honor the Y coordinate field
 487 @GDK_WA_CURSOR: Honor the cursor field
 488 @GDK_WA_COLORMAP: Honor the colormap field
 489 @GDK_WA_VISUAL: Honor the visual field
 490 @GDK_WA_WMCLASS: Honor the wmclass_class and wmclass_name fields
 491 @GDK_WA_NOREDIR: Honor the override_redirect field
 492 @GDK_WA_TYPE_HINT: Honor the type_hint field
 493
 494 <!-- ##### FUNCTION gdk_window_new ##### -->
 495 <para>
 496
 497 </para>
 498
 499 @parent:
 500 @attributes:
 501 @attributes_mask:
 502 @Returns:
 503
 504
 505 <!-- ##### FUNCTION gdk_window_destroy ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @window:
 511
 512
 513 <!-- ##### MACRO gdk_window_ref ##### -->
 514 <para>
 515 Deprecated equivalent of g_object_ref()
 516 </para>
 517
 518 @Returns: the window
 519
 520
 521 <!-- ##### MACRO gdk_window_unref ##### -->
 522 <para>
 523 Deprecated equivalent of g_object_unref()
 524 </para>
 525
 526
 527
 528 <!-- ##### FUNCTION gdk_window_get_window_type ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @window:
 534 @Returns:
 535
 536
 537 <!-- ##### FUNCTION gdk_window_at_pointer ##### -->
 538 <para>
 539
 540 </para>
 541
 542 @win_x:
 543 @win_y:
 544 @Returns:
 545
 546
 547 <!-- ##### FUNCTION gdk_window_show ##### -->
 548 <para>
 549
 550 </para>
 551
 552 @window:
 553
 554
 555 <!-- ##### FUNCTION gdk_window_show_unraised ##### -->
 556 <para>
 557
 558 </para>
 559
 560 @window:
 561
 562
 563 <!-- ##### FUNCTION gdk_window_hide ##### -->
 564 <para>
 565
 566 </para>
 567
 568 @window:
 569
 570
 571 <!-- ##### FUNCTION gdk_window_is_destroyed ##### -->
 572 <para>
 573
 574 </para>
 575
 576 @window:
 577 @Returns:
 578
 579
 580 <!-- ##### FUNCTION gdk_window_is_visible ##### -->
 581 <para>
 582
 583 </para>
 584
 585 @window:
 586 @Returns:
 587
 588
 589 <!-- ##### FUNCTION gdk_window_is_viewable ##### -->
 590 <para>
 591
 592 </para>
 593
 594 @window:
 595 @Returns:
 596
 597
 598 <!-- ##### FUNCTION gdk_window_get_state ##### -->
 599 <para>
 600
 601 </para>
 602
 603 @window:
 604 @Returns:
 605
 606
 607 <!-- ##### FUNCTION gdk_window_withdraw ##### -->
 608 <para>
 609
 610 </para>
 611
 612 @window:
 613
 614
 615 <!-- ##### FUNCTION gdk_window_iconify ##### -->
 616 <para>
 617
 618 </para>
 619
 620 @window:
 621
 622
 623 <!-- ##### FUNCTION gdk_window_deiconify ##### -->
 624 <para>
 625
 626 </para>
 627
 628 @window:
 629
 630
 631 <!-- ##### FUNCTION gdk_window_stick ##### -->
 632 <para>
 633
 634 </para>
 635
 636 @window:
 637
 638
 639 <!-- ##### FUNCTION gdk_window_unstick ##### -->
 640 <para>
 641
 642 </para>
 643
 644 @window:
 645
 646
 647 <!-- ##### FUNCTION gdk_window_maximize ##### -->
 648 <para>
 649
 650 </para>
 651
 652 @window:
 653
 654
 655 <!-- ##### FUNCTION gdk_window_unmaximize ##### -->
 656 <para>
 657
 658 </para>
 659
 660 @window:
 661
 662
 663 <!-- ##### FUNCTION gdk_window_fullscreen ##### -->
 664 <para>
 665
 666 </para>
 667
 668 @window:
 669
 670
 671 <!-- ##### FUNCTION gdk_window_unfullscreen ##### -->
 672 <para>
 673
 674 </para>
 675
 676 @window:
 677
 678
 679 <!-- ##### FUNCTION gdk_window_set_keep_above ##### -->
 680 <para>
 681
 682 </para>
 683
 684 @window:
 685 @setting:
 686
 687
 688 <!-- ##### FUNCTION gdk_window_set_keep_below ##### -->
 689 <para>
 690
 691 </para>
 692
 693 @window:
 694 @setting:
 695
 696
 697 <!-- ##### FUNCTION gdk_window_set_opacity ##### -->
 698 <para>
 699
 700 </para>
 701
 702 @window:
 703 @opacity:
 704
 705
 706 <!-- ##### FUNCTION gdk_window_set_composited ##### -->
 707 <para>
 708
 709 </para>
 710
 711 @window:
 712 @composited:
 713
 714
 715 <!-- ##### FUNCTION gdk_window_move ##### -->
 716 <para>
 717
 718 </para>
 719
 720 @window:
 721 @x:
 722 @y:
 723
 724
 725 <!-- ##### FUNCTION gdk_window_resize ##### -->
 726 <para>
 727
 728 </para>
 729
 730 @window:
 731 @width:
 732 @height:
 733
 734
 735 <!-- ##### FUNCTION gdk_window_move_resize ##### -->
 736 <para>
 737
 738 </para>
 739
 740 @window:
 741 @x:
 742 @y:
 743 @width:
 744 @height:
 745
 746
 747 <!-- ##### FUNCTION gdk_window_scroll ##### -->
 748 <para>
 749
 750 </para>
 751
 752 @window:
 753 @dx:
 754 @dy:
 755
 756
 757 <!-- ##### FUNCTION gdk_window_move_region ##### -->
 758 <para>
 759
 760 </para>
 761
 762 @window:
 763 @region:
 764 @dx:
 765 @dy:
 766
 767
 768 <!-- ##### FUNCTION gdk_window_flush ##### -->
 769 <para>
 770
 771 </para>
 772
 773 @window:
 774
 775
 776 <!-- ##### FUNCTION gdk_window_ensure_native ##### -->
 777 <para>
 778
 779 </para>
 780
 781 @window:
 782 @Returns:
 783
 784
 785 <!-- ##### FUNCTION gdk_window_reparent ##### -->
 786 <para>
 787
 788 </para>
 789
 790 @window:
 791 @new_parent:
 792 @x:
 793 @y:
 794
 795
 796 <!-- ##### FUNCTION gdk_window_clear ##### -->
 797 <para>
 798
 799 </para>
 800
 801 @window:
 802
 803
 804 <!-- ##### FUNCTION gdk_window_clear_area ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @window:
 810 @x:
 811 @y:
 812 @width:
 813 @height:
 814
 815
 816 <!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
 817 <para>
 818
 819 </para>
 820
 821 @window:
 822 @x:
 823 @y:
 824 @width:
 825 @height:
 826
 827
 828 <!-- ##### MACRO gdk_window_copy_area ##### -->
 829 <para>
 830 Deprecated equivalent to gdk_draw_drawable(), see that function for docs
 831 </para>
 832
 833 @drawable: a #GdkDrawable
 834 @gc: a #GdkGC sharing the drawable's visual and colormap
 835 @x: X position in @drawable where the rectangle should be drawn
 836 @y: Y position in @drawable where the rectangle should be drawn
 837 @source_drawable: the source #GdkDrawable, which may be the same as @drawable
 838 @source_x: X position in @src of rectangle to draw
 839 @source_y: Y position in @src of rectangle to draw
 840 @width: width of rectangle to draw, or -1 for entire @src width
 841 @height: height of rectangle to draw, or -1 for entire @src height
 842 <!-- # Unused Parameters # -->
 843 @drawable: a #GdkDrawable
 844 @xdest: X position in @drawable where the rectangle should be drawn
 845 @ydest: Y position in @drawable where the rectangle should be drawn
 846
 847
 848 <!-- ##### FUNCTION gdk_window_raise ##### -->
 849 <para>
 850
 851 </para>
 852
 853 @window:
 854
 855
 856 <!-- ##### FUNCTION gdk_window_lower ##### -->
 857 <para>
 858
 859 </para>
 860
 861 @window:
 862
 863
 864 <!-- ##### FUNCTION gdk_window_restack ##### -->
 865 <para>
 866
 867 </para>
 868
 869 @window:
 870 @sibling:
 871 @above:
 872
 873
 874 <!-- ##### FUNCTION gdk_window_focus ##### -->
 875 <para>
 876
 877 </para>
 878
 879 @window:
 880 @timestamp:
 881
 882
 883 <!-- ##### FUNCTION gdk_window_register_dnd ##### -->
 884 <para>
 885 Registers a window as a potential drop destination.
 886 </para>
 887
 888 @window: a #GdkWindow.
 889
 890
 891 <!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
 892 <para>
 893
 894 </para>
 895
 896 @window:
 897 @edge:
 898 @button:
 899 @root_x:
 900 @root_y:
 901 @timestamp:
 902
 903
 904 <!-- ##### FUNCTION gdk_window_begin_move_drag ##### -->
 905 <para>
 906
 907 </para>
 908
 909 @window:
 910 @button:
 911 @root_x:
 912 @root_y:
 913 @timestamp:
 914
 915
 916 <!-- ##### FUNCTION gdk_window_constrain_size ##### -->
 917 <para>
 918
 919 </para>
 920
 921 @geometry:
 922 @flags:
 923 @width:
 924 @height:
 925 @new_width:
 926 @new_height:
 927
 928
 929 <!-- ##### FUNCTION gdk_window_beep ##### -->
 930 <para>
 931
 932 </para>
 933
 934 @window:
 935
 936
 937 <!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
 938 <para>
 939
 940 </para>
 941
 942 @window:
 943 @rectangle:
 944
 945
 946 <!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
 947 <para>
 948
 949 </para>
 950
 951 @window:
 952 @region:
 953
 954
 955 <!-- ##### FUNCTION gdk_window_end_paint ##### -->
 956 <para>
 957
 958 </para>
 959
 960 @window:
 961
 962
 963 <!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
 964 <para>
 965
 966 </para>
 967
 968 @window:
 969 @rect:
 970 @invalidate_children:
 971
 972
 973 <!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
 974 <para>
 975
 976 </para>
 977
 978 @window:
 979 @region:
 980 @invalidate_children:
 981
 982
 983 <!-- ##### FUNCTION gdk_window_invalidate_maybe_recurse ##### -->
 984 <para>
 985
 986 </para>
 987
 988 @window:
 989 @region:
 990 @GdkWindow *, gpointer:
 991 @user_data:
 992
 993
 994 <!-- ##### FUNCTION gdk_window_get_update_area ##### -->
 995 <para>
 996
 997 </para>
 998
 999 @window:
1000 @Returns:
1001
1002
1003 <!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
1004 <para>
1005
1006 </para>
1007
1008 @window:
1009
1010
1011 <!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
1012 <para>
1013
1014 </para>
1015
1016 @window:
1017
1018
1019 <!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
1020 <para>
1021
1022 </para>
1023
1024 @void:
1025
1026
1027 <!-- ##### FUNCTION gdk_window_process_updates ##### -->
1028 <para>
1029
1030 </para>
1031
1032 @window:
1033 @update_children:
1034
1035
1036 <!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
1037 <para>
1038
1039 </para>
1040
1041 @setting:
1042
1043
1044 <!-- ##### FUNCTION gdk_window_get_internal_paint_info ##### -->
1045 <para>
1046
1047 </para>
1048
1049 @window:
1050 @real_drawable:
1051 @x_offset:
1052 @y_offset:
1053
1054
1055 <!-- ##### FUNCTION gdk_window_enable_synchronized_configure ##### -->
1056 <para>
1057
1058 </para>
1059
1060 @window:
1061
1062
1063 <!-- ##### FUNCTION gdk_window_configure_finished ##### -->
1064 <para>
1065
1066 </para>
1067
1068 @window:
1069
1070
1071 <!-- ##### FUNCTION gdk_window_set_user_data ##### -->
1072 <para>
1073
1074 </para>
1075
1076 @window:
1077 @user_data:
1078
1079
1080 <!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
1081 <para>
1082
1083 </para>
1084
1085 @window:
1086 @override_redirect:
1087
1088
1089 <!-- ##### FUNCTION gdk_window_set_accept_focus ##### -->
1090 <para>
1091
1092 </para>
1093
1094 @window:
1095 @accept_focus:
1096
1097
1098 <!-- ##### FUNCTION gdk_window_set_focus_on_map ##### -->
1099 <para>
1100
1101 </para>
1102
1103 @window:
1104 @focus_on_map:
1105
1106
1107 <!-- ##### FUNCTION gdk_window_add_filter ##### -->
1108 <para>
1109
1110 </para>
1111
1112 @window:
1113 @function:
1114 @data:
1115
1116
1117 <!-- ##### FUNCTION gdk_window_remove_filter ##### -->
1118 <para>
1119
1120 </para>
1121
1122 @window:
1123 @function:
1124 @data:
1125
1126
1127 <!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
1128 <para>
1129 Specifies the type of function used to filter native events before they are
1130 converted to GDK events.
1131 </para>
1132
1133 <para>
1134 When a filter is called, @event is unpopulated, except for
1135 <literal>event-&gt;window</literal>. The filter may translate the native
1136 event to a GDK event and store the result in @event, or handle it without
1137 translation. If the filter translates the event and processing should
1138 continue, it should return <literal>GDK_FILTER_TRANSLATE</literal>.
1139 </para>
1140
1141 @xevent: the native event to filter.
1142 @event: the GDK event to which the X event will be translated.
1143 @data: user data set when the filter was installed.
1144 @Returns: a #GdkFilterReturn value.
1145
1146
1147 <!-- ##### ENUM GdkFilterReturn ##### -->
1148 <para>
1149 Specifies the result of applying a #GdkFilterFunc to a native event.
1150 </para>
1151
1152 @GDK_FILTER_CONTINUE: event not handled, continue processing.
1153 @GDK_FILTER_TRANSLATE: native event translated into a GDK event and stored
1154                        in the <literal>event</literal> structure that was passed in.
1155 @GDK_FILTER_REMOVE: event handled, terminate processing.
1156
1157 <!-- ##### TYPEDEF GdkXEvent ##### -->
1158 <para>
1159 Used to represent native events (<type>XEvent</type>s for the X11
1160 backend, <type>MSG</type>s for Win32).
1161 </para>
1162
1163
1164 <!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
1165 <para>
1166
1167 </para>
1168
1169 @window:
1170 @mask:
1171 @x:
1172 @y:
1173
1174
1175 <!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
1176 <para>
1177
1178 </para>
1179
1180 @window:
1181 @shape_region:
1182 @offset_x:
1183 @offset_y:
1184
1185
1186 <!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
1187 <para>
1188
1189 </para>
1190
1191 @window:
1192
1193
1194 <!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
1195 <para>
1196
1197 </para>
1198
1199 @window:
1200
1201
1202 <!-- ##### FUNCTION gdk_window_input_shape_combine_mask ##### -->
1203 <para>
1204
1205 </para>
1206
1207 @window:
1208 @mask:
1209 @x:
1210 @y:
1211
1212
1213 <!-- ##### FUNCTION gdk_window_input_shape_combine_region ##### -->
1214 <para>
1215
1216 </para>
1217
1218 @window:
1219 @shape_region:
1220 @offset_x:
1221 @offset_y:
1222
1223
1224 <!-- ##### FUNCTION gdk_window_set_child_input_shapes ##### -->
1225 <para>
1226
1227 </para>
1228
1229 @window:
1230
1231
1232 <!-- ##### FUNCTION gdk_window_merge_child_input_shapes ##### -->
1233 <para>
1234
1235 </para>
1236
1237 @window:
1238
1239
1240 <!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
1241 <para>
1242
1243 </para>
1244
1245 @window:
1246 @use_static:
1247 @Returns:
1248
1249
1250 <!-- ##### FUNCTION gdk_window_set_hints ##### -->
1251 <para>
1252
1253 </para>
1254
1255 @window:
1256 @x:
1257 @y:
1258 @min_width:
1259 @min_height:
1260 @max_width:
1261 @max_height:
1262 @flags:
1263
1264
1265 <!-- ##### FUNCTION gdk_window_set_title ##### -->
1266 <para>
1267
1268 </para>
1269
1270 @window:
1271 @title:
1272
1273
1274 <!-- ##### FUNCTION gdk_window_set_background ##### -->
1275 <para>
1276
1277 </para>
1278
1279 @window:
1280 @color:
1281
1282
1283 <!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
1284 <para>
1285
1286 </para>
1287
1288 @window:
1289 @pixmap:
1290 @parent_relative:
1291
1292
1293 <!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
1294 <para>
1295 A special value for <literal>GdkPixmap*</literal> variables, indicating
1296 that the background pixmap for a window should be inherited from the parent
1297 window.
1298 </para>
1299
1300
1301
1302 <!-- ##### FUNCTION gdk_window_set_cursor ##### -->
1303 <para>
1304
1305 </para>
1306
1307 @window:
1308 @cursor:
1309
1310
1311 <!-- ##### FUNCTION gdk_window_get_cursor ##### -->
1312 <para>
1313
1314 </para>
1315
1316 @window:
1317 @Returns:
1318
1319
1320 <!-- ##### MACRO gdk_window_set_colormap ##### -->
1321 <para>
1322 Deprecated equivalent to gdk_drawable_set_colormap()
1323 </para>
1324
1325
1326
1327 <!-- ##### FUNCTION gdk_window_get_user_data ##### -->
1328 <para>
1329
1330 </para>
1331
1332 @window:
1333 @data:
1334
1335
1336 <!-- ##### FUNCTION gdk_window_get_geometry ##### -->
1337 <para>
1338
1339 </para>
1340
1341 @window:
1342 @x:
1343 @y:
1344 @width:
1345 @height:
1346 @depth:
1347
1348
1349 <!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
1350 <para>
1351
1352 </para>
1353
1354 @window:
1355 @geometry:
1356 @geom_mask:
1357
1358
1359 <!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
1360 <para>
1361
1362 </para>
1363
1364 @window:
1365 @pixbufs:
1366
1367
1368 <!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
1369 <para>
1370
1371 </para>
1372
1373 @window:
1374 @modal:
1375
1376
1377 <!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
1378 <para>
1379
1380 </para>
1381
1382 @window:
1383 @hint:
1384
1385
1386 <!-- ##### FUNCTION gdk_window_get_type_hint ##### -->
1387 <para>
1388
1389 </para>
1390
1391 @window:
1392 @Returns:
1393
1394
1395 <!-- ##### FUNCTION gdk_window_set_skip_taskbar_hint ##### -->
1396 <para>
1397
1398 </para>
1399
1400 @window:
1401 @skips_taskbar:
1402
1403
1404 <!-- ##### FUNCTION gdk_window_set_skip_pager_hint ##### -->
1405 <para>
1406
1407 </para>
1408
1409 @window:
1410 @skips_pager:
1411
1412
1413 <!-- ##### FUNCTION gdk_window_set_urgency_hint ##### -->
1414 <para>
1415
1416 </para>
1417
1418 @window:
1419 @urgent:
1420
1421
1422 <!-- ##### FUNCTION gdk_window_get_position ##### -->
1423 <para>
1424
1425 </para>
1426
1427 @window:
1428 @x:
1429 @y:
1430
1431
1432 <!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
1433 <para>
1434
1435 </para>
1436
1437 @window:
1438 @x:
1439 @y:
1440
1441
1442 <!-- ##### FUNCTION gdk_window_get_frame_extents ##### -->
1443 <para>
1444
1445 </para>
1446
1447 @window:
1448 @rect:
1449
1450
1451 <!-- ##### MACRO gdk_window_get_size ##### -->
1452 <para>
1453 Deprecated equivalent of gdk_drawable_get_size().
1454 </para>
1455
1456
1457
1458 <!-- ##### MACRO gdk_window_get_visual ##### -->
1459 <para>
1460 Deprecated equivalent of gdk_drawable_get_visual().
1461 </para>
1462
1463 @Returns: the #GdkVisual of the window
1464
1465
1466 <!-- ##### MACRO gdk_window_get_colormap ##### -->
1467 <para>
1468 Deprecated equivalent of gdk_drawable_get_colormap().
1469 </para>
1470
1471 @Returns: colormap for the window
1472
1473
1474 <!-- ##### MACRO gdk_window_get_type ##### -->
1475 <para>
1476 Deprecated equivalent of gdk_drawable_get_type().
1477 </para>
1478
1479 @Returns: type of drawable
1480
1481
1482 <!-- ##### FUNCTION gdk_window_get_origin ##### -->
1483 <para>
1484
1485 </para>
1486
1487 @window:
1488 @x:
1489 @y:
1490 @Returns:
1491
1492
1493 <!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
1494 <para>
1495
1496 </para>
1497
1498 @window:
1499 @x:
1500 @y:
1501 @Returns:
1502
1503
1504 <!-- ##### FUNCTION gdk_window_get_root_coords ##### -->
1505 <para>
1506
1507 </para>
1508
1509 @window:
1510 @x:
1511 @y:
1512 @root_x:
1513 @root_y:
1514
1515
1516 <!-- ##### FUNCTION gdk_window_get_pointer ##### -->
1517 <para>
1518
1519 </para>
1520
1521 @window:
1522 @x:
1523 @y:
1524 @mask:
1525 @Returns:
1526
1527
1528 <!-- ##### ENUM GdkModifierType ##### -->
1529 <para>
1530 A set of bit-flags to indicate the state of modifier keys and mouse buttons
1531 in various event types. Typical modifier keys are Shift, Control, Meta, Super,
1532 Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
1533 </para>
1534 <para>
1535 Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
1536 </para>
1537 <para>
1538 Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
1539 to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK, %GDK_HYPER_MASK
1540 or %GDK_META_MASK in the state field of key events.
1541 </para>
1542
1543 @GDK_SHIFT_MASK: the Shift key.
1544 @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
1545   X server this may either be CapsLock or ShiftLock).
1546 @GDK_CONTROL_MASK: the Control key.
1547 @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
1548   mapping of the X server which key is interpreted as this modifier, but
1549   normally it is the Alt key).
1550 @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
1551   mapping of the X server which key is interpreted as this modifier).
1552 @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
1553   mapping of the X server which key is interpreted as this modifier).
1554 @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
1555   mapping of the X server which key is interpreted as this modifier).
1556 @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
1557   mapping of the X server which key is interpreted as this modifier).
1558 @GDK_BUTTON1_MASK: the first mouse button.
1559 @GDK_BUTTON2_MASK: the second mouse button.
1560 @GDK_BUTTON3_MASK: the third mouse button.
1561 @GDK_BUTTON4_MASK: the fourth mouse button.
1562 @GDK_BUTTON5_MASK: the fifth mouse button.
1563 @GDK_SUPER_MASK: the Super modifier. Since 2.10
1564 @GDK_HYPER_MASK: the Hyper modifier. Since 2.10
1565 @GDK_META_MASK: the Meta modifier. Since 2.10
1566 @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
1567   between (keyval, modifiers) pairs from key press and release events.
1568 @GDK_MODIFIER_MASK: a mask covering all modifier types.
1569
1570 <!-- ##### FUNCTION gdk_window_get_parent ##### -->
1571 <para>
1572
1573 </para>
1574
1575 @window:
1576 @Returns:
1577
1578
1579 <!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
1580 <para>
1581
1582 </para>
1583
1584 @window:
1585 @Returns:
1586
1587
1588 <!-- ##### FUNCTION gdk_window_get_children ##### -->
1589 <para>
1590
1591 </para>
1592
1593 @window:
1594 @Returns:
1595
1596
1597 <!-- ##### FUNCTION gdk_window_peek_children ##### -->
1598 <para>
1599
1600 </para>
1601
1602 @window:
1603 @Returns:
1604
1605
1606 <!-- ##### FUNCTION gdk_window_get_events ##### -->
1607 <para>
1608
1609 </para>
1610
1611 @window:
1612 @Returns:
1613
1614
1615 <!-- ##### FUNCTION gdk_window_set_events ##### -->
1616 <para>
1617
1618 </para>
1619
1620 @window:
1621 @event_mask:
1622
1623
1624 <!-- ##### FUNCTION gdk_window_set_icon ##### -->
1625 <para>
1626
1627 </para>
1628
1629 @window:
1630 @icon_window:
1631 @pixmap:
1632 @mask:
1633
1634
1635 <!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
1636 <para>
1637
1638 </para>
1639
1640 @window:
1641 @name:
1642
1643
1644 <!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
1645 <para>
1646
1647 </para>
1648
1649 @window:
1650 @parent:
1651
1652
1653 <!-- ##### FUNCTION gdk_window_set_role ##### -->
1654 <para>
1655
1656 </para>
1657
1658 @window:
1659 @role:
1660
1661
1662 <!-- ##### FUNCTION gdk_window_set_startup_id ##### -->
1663 <para>
1664
1665 </para>
1666
1667 @window:
1668 @startup_id:
1669
1670
1671 <!-- ##### FUNCTION gdk_window_set_group ##### -->
1672 <para>
1673
1674 </para>
1675
1676 @window:
1677 @leader:
1678
1679
1680 <!-- ##### FUNCTION gdk_window_get_group ##### -->
1681 <para>
1682
1683 </para>
1684
1685 @window:
1686 @Returns:
1687
1688
1689 <!-- ##### FUNCTION gdk_window_set_decorations ##### -->
1690 <para>
1691
1692 </para>
1693
1694 @window:
1695 @decorations:
1696
1697
1698 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
1699 <para>
1700
1701 </para>
1702
1703 @window: The window to get the decorations from
1704 @decorations: The window decorations will be written here
1705 @Returns: %TRUE if the window has decorations set, %FALSE otherwise.
1706
1707
1708 <!-- ##### ENUM GdkWMDecoration ##### -->
1709 <para>
1710 These are hints originally defined by the Motif toolkit.
1711 The window manager can use them when determining how to decorate
1712 the window. The hint must be set before mapping the window.
1713 </para>
1714
1715 @GDK_DECOR_ALL: all decorations should be applied.
1716 @GDK_DECOR_BORDER: a frame should be drawn around the window.
1717 @GDK_DECOR_RESIZEH: the frame should have resize handles.
1718 @GDK_DECOR_TITLE: a titlebar should be placed above the window.
1719 @GDK_DECOR_MENU: a button for opening a menu should be included.
1720 @GDK_DECOR_MINIMIZE: a minimize button should be included.
1721 @GDK_DECOR_MAXIMIZE: a maximize button should be included.
1722
1723 <!-- ##### FUNCTION gdk_window_set_functions ##### -->
1724 <para>
1725
1726 </para>
1727
1728 @window:
1729 @functions:
1730
1731
1732 <!-- ##### ENUM GdkWMFunction ##### -->
1733 <para>
1734 These are hints originally defined by the Motif toolkit.
1735 The window manager can use them when determining the functions
1736 to offer for the window.
1737 The hint must be set before mapping the window.
1738 </para>
1739
1740 @GDK_FUNC_ALL: all functions should be offered.
1741 @GDK_FUNC_RESIZE: the window should be resizable.
1742 @GDK_FUNC_MOVE: the window should be movable.
1743 @GDK_FUNC_MINIMIZE: the window should be minimizable.
1744 @GDK_FUNC_MAXIMIZE: the window should be maximizable.
1745 @GDK_FUNC_CLOSE: the window should be closable.
1746
1747 <!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
1748 <para>
1749
1750 </para>
1751
1752 @void:
1753 @Returns:
1754
1755
1756 <!-- ##### FUNCTION gdk_get_default_root_window ##### -->
1757 <para>
1758
1759 </para>
1760
1761 @void:
1762 @Returns:
1763
1764
1765 <!-- ##### STRUCT GdkPointerHooks ##### -->
1766 <para>
1767 A table of pointers to functions for getting quantities related to
1768 the current pointer position. GDK has one global table of this type,
1769 which can be set using gdk_set_pointer_hooks().
1770 </para>
1771 <para>
1772 This is only useful for such low-level tools as an event recorder.
1773 Applications should never have any reason to use this facility
1774 </para>
1775
1776 @get_pointer: Obtains the current pointer position and modifier state.
1777   The position is given in coordinates relative to the window containing
1778   the pointer, which is returned in @window.
1779 @window_at_pointer: Obtains the window underneath the mouse pointer,
1780   returning the location of that window in @win_x, @win_y. Returns %NULL
1781   if the window under the mouse pointer is not known to GDK (for example,
1782   belongs to another application).
1783
1784 <!-- ##### FUNCTION gdk_set_pointer_hooks ##### -->
1785 <para>
1786
1787 </para>
1788
1789 @new_hooks:
1790 @Returns:
1791
1792
1793 <!-- ##### FUNCTION gdk_offscreen_window_get_pixmap ##### -->
1794 <para>
1795
1796 </para>
1797
1798 @window:
1799 @Returns:
1800
1801
1802 <!-- ##### FUNCTION gdk_offscreen_window_set_embedder ##### -->
1803 <para>
1804
1805 </para>
1806
1807 @window:
1808 @embedder:
1809
1810
1811 <!-- ##### FUNCTION gdk_offscreen_window_get_embedder ##### -->
1812 <para>
1813
1814 </para>
1815
1816 @window:
1817 @Returns:
1818
1819
1820 <!-- ##### FUNCTION gdk_window_geometry_changed ##### -->
1821 <para>
1822
1823 </para>
1824
1825 @window:
1826
1827
1828 <!-- ##### FUNCTION gdk_window_redirect_to_drawable ##### -->
1829 <para>
1830
1831 </para>
1832
1833 @window:
1834 @drawable:
1835 @src_x:
1836 @src_y:
1837 @dest_x:
1838 @dest_y:
1839 @width:
1840 @height:
1841
1842
1843 <!-- ##### FUNCTION gdk_window_remove_redirection ##### -->
1844 <para>
1845
1846 </para>
1847
1848 @window:
1849
1850
1851 <!--
1852 Local variables:
1853 mode: sgml
1854 sgml-parent-document: ("../gdk-docs.sgml" "book" "refsect2" "")
1855 End:
1856 -->
1857
1858