<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="gdk-Windows">
<refmeta>
<refentrytitle role="top_of_page" id="gdk-Windows.top_of_page">Windows</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GDK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Windows</refname>
<refpurpose>Onscreen display areas in the target window system</refpurpose>
</refnamediv>

<refsynopsisdiv id="gdk-Windows.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GdkWindow"/>
<synopsis>

#include &lt;gdk/gdk.h&gt;

struct              <link linkend="GdkWindow-struct">GdkWindow</link>;
enum                <link linkend="GdkWindowType">GdkWindowType</link>;
enum                <link linkend="GdkWindowClass">GdkWindowClass</link>;
enum                <link linkend="GdkWindowHints">GdkWindowHints</link>;
                    <link linkend="GdkGeometry">GdkGeometry</link>;
enum                <link linkend="GdkGravity">GdkGravity</link>;
enum                <link linkend="GdkWindowEdge">GdkWindowEdge</link>;
enum                <link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link>;
                    <link linkend="GdkWindowAttr">GdkWindowAttr</link>;
enum                <link linkend="GdkWindowAttributesType">GdkWindowAttributesType</link>;
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gdk-window-new">gdk_window_new</link>                      (<link linkend="GdkWindow">GdkWindow</link> *parent,
                                                         <link linkend="GdkWindowAttr">GdkWindowAttr</link> *attributes,
                                                         <link linkend="gint">gint</link> attributes_mask);
<link linkend="void">void</link>                <link linkend="gdk-window-destroy">gdk_window_destroy</link>                  (<link linkend="GdkWindow">GdkWindow</link> *window);
#define             <link linkend="gdk-window-ref">gdk_window_ref</link>
#define             <link linkend="gdk-window-unref">gdk_window_unref</link>
<link linkend="GdkWindowType">GdkWindowType</link>       <link linkend="gdk-window-get-window-type">gdk_window_get_window_type</link>          (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gdk-window-at-pointer">gdk_window_at_pointer</link>               (<link linkend="gint">gint</link> *win_x,
                                                         <link linkend="gint">gint</link> *win_y);
<link linkend="void">void</link>                <link linkend="gdk-window-show">gdk_window_show</link>                     (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-show-unraised">gdk_window_show_unraised</link>            (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-hide">gdk_window_hide</link>                     (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-is-visible">gdk_window_is_visible</link>               (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-is-viewable">gdk_window_is_viewable</link>              (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GdkWindowState">GdkWindowState</link>      <link linkend="gdk-window-get-state">gdk_window_get_state</link>                (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-withdraw">gdk_window_withdraw</link>                 (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-iconify">gdk_window_iconify</link>                  (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-deiconify">gdk_window_deiconify</link>                (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-stick">gdk_window_stick</link>                    (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-unstick">gdk_window_unstick</link>                  (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-maximize">gdk_window_maximize</link>                 (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-unmaximize">gdk_window_unmaximize</link>               (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-fullscreen">gdk_window_fullscreen</link>               (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-unfullscreen">gdk_window_unfullscreen</link>             (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-set-keep-above">gdk_window_set_keep_above</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> setting);
<link linkend="void">void</link>                <link linkend="gdk-window-set-keep-below">gdk_window_set_keep_below</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> setting);
<link linkend="void">void</link>                <link linkend="gdk-window-set-opacity">gdk_window_set_opacity</link>              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gdouble">gdouble</link> opacity);
<link linkend="void">void</link>                <link linkend="gdk-window-set-composited">gdk_window_set_composited</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> composited);
<link linkend="void">void</link>                <link linkend="gdk-window-move">gdk_window_move</link>                     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="gdk-window-resize">gdk_window_resize</link>                   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);
<link linkend="void">void</link>                <link linkend="gdk-window-move-resize">gdk_window_move_resize</link>              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);
<link linkend="void">void</link>                <link linkend="gdk-window-scroll">gdk_window_scroll</link>                   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> dx,
                                                         <link linkend="gint">gint</link> dy);
<link linkend="void">void</link>                <link linkend="gdk-window-move-region">gdk_window_move_region</link>              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gint">gint</link> dx,
                                                         <link linkend="gint">gint</link> dy);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-ensure-native">gdk_window_ensure_native</link>            (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-reparent">gdk_window_reparent</link>                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *new_parent,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="gdk-window-clear">gdk_window_clear</link>                    (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-clear-area">gdk_window_clear_area</link>               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);
<link linkend="void">void</link>                <link linkend="gdk-window-clear-area-e">gdk_window_clear_area_e</link>             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);
#define             <link linkend="gdk-window-copy-area">gdk_window_copy_area</link>                (drawable,gc,x,y,source_drawable,source_x,source_y,width,height)
<link linkend="void">void</link>                <link linkend="gdk-window-raise">gdk_window_raise</link>                    (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-lower">gdk_window_lower</link>                    (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-focus">gdk_window_focus</link>                    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="guint32">guint32</link> timestamp);
<link linkend="void">void</link>                <link linkend="gdk-window-register-dnd">gdk_window_register_dnd</link>             (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-begin-resize-drag">gdk_window_begin_resize_drag</link>        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindowEdge">GdkWindowEdge</link> edge,
                                                         <link linkend="gint">gint</link> button,
                                                         <link linkend="gint">gint</link> root_x,
                                                         <link linkend="gint">gint</link> root_y,
                                                         <link linkend="guint32">guint32</link> timestamp);
<link linkend="void">void</link>                <link linkend="gdk-window-begin-move-drag">gdk_window_begin_move_drag</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> button,
                                                         <link linkend="gint">gint</link> root_x,
                                                         <link linkend="gint">gint</link> root_y,
                                                         <link linkend="guint32">guint32</link> timestamp);
<link linkend="void">void</link>                <link linkend="gdk-window-constrain-size">gdk_window_constrain_size</link>           (<link linkend="GdkGeometry">GdkGeometry</link> *geometry,
                                                         <link linkend="guint">guint</link> flags,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height,
                                                         <link linkend="gint">gint</link> *new_width,
                                                         <link linkend="gint">gint</link> *new_height);
<link linkend="void">void</link>                <link linkend="gdk-window-beep">gdk_window_beep</link>                     (<link linkend="GdkWindow">GdkWindow</link> *window);

<link linkend="void">void</link>                <link linkend="gdk-window-begin-paint-rect">gdk_window_begin_paint_rect</link>         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRectangle">GdkRectangle</link> *rectangle);
<link linkend="void">void</link>                <link linkend="gdk-window-begin-paint-region">gdk_window_begin_paint_region</link>       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region);
<link linkend="void">void</link>                <link linkend="gdk-window-end-paint">gdk_window_end_paint</link>                (<link linkend="GdkWindow">GdkWindow</link> *window);

<link linkend="void">void</link>                <link linkend="gdk-window-invalidate-rect">gdk_window_invalidate_rect</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRectangle">GdkRectangle</link> *rect,
                                                         <link linkend="gboolean">gboolean</link> invalidate_children);
<link linkend="void">void</link>                <link linkend="gdk-window-invalidate-region">gdk_window_invalidate_region</link>        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gboolean">gboolean</link> invalidate_children);
<link linkend="void">void</link>                <link linkend="gdk-window-invalidate-maybe-recurse">gdk_window_invalidate_maybe_recurse</link> (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gboolean">gboolean</link> (child_funcGdkWindow *, gpointer) (),
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="GdkRegion">GdkRegion</link> *         <link linkend="gdk-window-get-update-area">gdk_window_get_update_area</link>          (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-freeze-updates">gdk_window_freeze_updates</link>           (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-thaw-updates">gdk_window_thaw_updates</link>             (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-process-all-updates">gdk_window_process_all_updates</link>      (void);
<link linkend="void">void</link>                <link linkend="gdk-window-process-updates">gdk_window_process_updates</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> update_children);
<link linkend="void">void</link>                <link linkend="gdk-window-set-debug-updates">gdk_window_set_debug_updates</link>        (<link linkend="gboolean">gboolean</link> setting);
<link linkend="void">void</link>                <link linkend="gdk-window-get-internal-paint-info">gdk_window_get_internal_paint_info</link>  (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkDrawable">GdkDrawable</link> **real_drawable,
                                                         <link linkend="gint">gint</link> *x_offset,
                                                         <link linkend="gint">gint</link> *y_offset);
<link linkend="void">void</link>                <link linkend="gdk-window-enable-synchronized-configure">gdk_window_enable_synchronized_configure</link>
                                                        (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-configure-finished">gdk_window_configure_finished</link>       (<link linkend="GdkWindow">GdkWindow</link> *window);

<link linkend="void">void</link>                <link linkend="gdk-window-set-user-data">gdk_window_set_user_data</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link>                <link linkend="gdk-window-set-override-redirect">gdk_window_set_override_redirect</link>    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> override_redirect);
<link linkend="void">void</link>                <link linkend="gdk-window-set-accept-focus">gdk_window_set_accept_focus</link>         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> accept_focus);
<link linkend="void">void</link>                <link linkend="gdk-window-set-focus-on-map">gdk_window_set_focus_on_map</link>         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> focus_on_map);
<link linkend="void">void</link>                <link linkend="gdk-window-add-filter">gdk_window_add_filter</link>               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkFilterFunc">GdkFilterFunc</link> function,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>                <link linkend="gdk-window-remove-filter">gdk_window_remove_filter</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkFilterFunc">GdkFilterFunc</link> function,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="GdkFilterReturn">GdkFilterReturn</link>     (<link linkend="GdkFilterFunc">*GdkFilterFunc</link>)                    (<link linkend="GdkXEvent">GdkXEvent</link> *xevent,
                                                         <link linkend="GdkEvent">GdkEvent</link> *event,
                                                         <link linkend="gpointer">gpointer</link> data);
enum                <link linkend="GdkFilterReturn">GdkFilterReturn</link>;
typedef             <link linkend="GdkXEvent">GdkXEvent</link>;
<link linkend="void">void</link>                <link linkend="gdk-window-shape-combine-mask">gdk_window_shape_combine_mask</link>       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="gdk-window-shape-combine-region">gdk_window_shape_combine_region</link>     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *shape_region,
                                                         <link linkend="gint">gint</link> offset_x,
                                                         <link linkend="gint">gint</link> offset_y);
<link linkend="void">void</link>                <link linkend="gdk-window-set-child-shapes">gdk_window_set_child_shapes</link>         (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-merge-child-shapes">gdk_window_merge_child_shapes</link>       (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-input-shape-combine-mask">gdk_window_input_shape_combine_mask</link> (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="gdk-window-input-shape-combine-region">gdk_window_input_shape_combine_region</link>
                                                        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *shape_region,
                                                         <link linkend="gint">gint</link> offset_x,
                                                         <link linkend="gint">gint</link> offset_y);
<link linkend="void">void</link>                <link linkend="gdk-window-set-child-input-shapes">gdk_window_set_child_input_shapes</link>   (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-merge-child-input-shapes">gdk_window_merge_child_input_shapes</link> (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-set-static-gravities">gdk_window_set_static_gravities</link>     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> use_static);
<link linkend="void">void</link>                <link linkend="gdk-window-set-hints">gdk_window_set_hints</link>                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> min_width,
                                                         <link linkend="gint">gint</link> min_height,
                                                         <link linkend="gint">gint</link> max_width,
                                                         <link linkend="gint">gint</link> max_height,
                                                         <link linkend="gint">gint</link> flags);
<link linkend="void">void</link>                <link linkend="gdk-window-set-title">gdk_window_set_title</link>                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *title);
<link linkend="void">void</link>                <link linkend="gdk-window-set-background">gdk_window_set_background</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkColor">GdkColor</link> *color);
<link linkend="void">void</link>                <link linkend="gdk-window-set-back-pixmap">gdk_window_set_back_pixmap</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                                         <link linkend="gboolean">gboolean</link> parent_relative);
#define             <link linkend="GDK-PARENT-RELATIVE--CAPS">GDK_PARENT_RELATIVE</link>
<link linkend="void">void</link>                <link linkend="gdk-window-set-cursor">gdk_window_set_cursor</link>               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkCursor">GdkCursor</link> *cursor);
#define             <link linkend="gdk-window-set-colormap">gdk_window_set_colormap</link>
<link linkend="void">void</link>                <link linkend="gdk-window-get-user-data">gdk_window_get_user_data</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gpointer">gpointer</link> *data);
<link linkend="void">void</link>                <link linkend="gdk-window-get-geometry">gdk_window_get_geometry</link>             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height,
                                                         <link linkend="gint">gint</link> *depth);
<link linkend="void">void</link>                <link linkend="gdk-window-set-geometry-hints">gdk_window_set_geometry_hints</link>       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkGeometry">GdkGeometry</link> *geometry,
                                                         <link linkend="GdkWindowHints">GdkWindowHints</link> geom_mask);
<link linkend="void">void</link>                <link linkend="gdk-window-set-icon-list">gdk_window_set_icon_list</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GList">GList</link> *pixbufs);
<link linkend="void">void</link>                <link linkend="gdk-window-set-modal-hint">gdk_window_set_modal_hint</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> modal);
<link linkend="void">void</link>                <link linkend="gdk-window-set-type-hint">gdk_window_set_type_hint</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link> hint);
<link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link>   <link linkend="gdk-window-get-type-hint">gdk_window_get_type_hint</link>            (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-set-skip-taskbar-hint">gdk_window_set_skip_taskbar_hint</link>    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> skips_taskbar);
<link linkend="void">void</link>                <link linkend="gdk-window-set-skip-pager-hint">gdk_window_set_skip_pager_hint</link>      (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> skips_pager);
<link linkend="void">void</link>                <link linkend="gdk-window-set-urgency-hint">gdk_window_set_urgency_hint</link>         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> urgent);
<link linkend="void">void</link>                <link linkend="gdk-window-get-position">gdk_window_get_position</link>             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);
<link linkend="void">void</link>                <link linkend="gdk-window-get-root-origin">gdk_window_get_root_origin</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);
<link linkend="void">void</link>                <link linkend="gdk-window-get-frame-extents">gdk_window_get_frame_extents</link>        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkRectangle">GdkRectangle</link> *rect);
#define             <link linkend="gdk-window-get-size">gdk_window_get_size</link>
#define             <link linkend="gdk-window-get-visual">gdk_window_get_visual</link>
#define             <link linkend="gdk-window-get-colormap">gdk_window_get_colormap</link>
#define             <link linkend="gdk-window-get-type">gdk_window_get_type</link>
<link linkend="gint">gint</link>                <link linkend="gdk-window-get-origin">gdk_window_get_origin</link>               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-get-deskrelative-origin">gdk_window_get_deskrelative_origin</link>  (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);
<link linkend="void">void</link>                <link linkend="gdk-window-get-root-coords">gdk_window_get_root_coords</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> *root_x,
                                                         <link linkend="gint">gint</link> *root_y);
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gdk-window-get-pointer">gdk_window_get_pointer</link>              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="GdkModifierType">GdkModifierType</link> *mask);
enum                <link linkend="GdkModifierType">GdkModifierType</link>;
<link linkend="GdkWindow">GdkWindow</link> *         <link linkend="gdk-window-get-parent">gdk_window_get_parent</link>               (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GdkWindow">GdkWindow</link> *         <link linkend="gdk-window-get-toplevel">gdk_window_get_toplevel</link>             (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GList">GList</link> *             <link linkend="gdk-window-get-children">gdk_window_get_children</link>             (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GList">GList</link> *             <link linkend="gdk-window-peek-children">gdk_window_peek_children</link>            (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="GdkEventMask">GdkEventMask</link>        <link linkend="gdk-window-get-events">gdk_window_get_events</link>               (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-set-events">gdk_window_set_events</link>               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkEventMask">GdkEventMask</link> event_mask);
<link linkend="void">void</link>                <link linkend="gdk-window-set-icon">gdk_window_set_icon</link>                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *icon_window,
                                                         <link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask);
<link linkend="void">void</link>                <link linkend="gdk-window-set-icon-name">gdk_window_set_icon_name</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link>                <link linkend="gdk-window-set-transient-for">gdk_window_set_transient_for</link>        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *parent);
<link linkend="void">void</link>                <link linkend="gdk-window-set-role">gdk_window_set_role</link>                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *role);
<link linkend="void">void</link>                <link linkend="gdk-window-set-startup-id">gdk_window_set_startup_id</link>           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *startup_id);
<link linkend="void">void</link>                <link linkend="gdk-window-set-group">gdk_window_set_group</link>                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *leader);
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gdk-window-get-group">gdk_window_get_group</link>                (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-set-decorations">gdk_window_set_decorations</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMDecoration">GdkWMDecoration</link> decorations);
<link linkend="gboolean">gboolean</link>            <link linkend="gdk-window-get-decorations">gdk_window_get_decorations</link>          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMDecoration">GdkWMDecoration</link> *decorations);
enum                <link linkend="GdkWMDecoration">GdkWMDecoration</link>;
<link linkend="void">void</link>                <link linkend="gdk-window-set-functions">gdk_window_set_functions</link>            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMFunction">GdkWMFunction</link> functions);
enum                <link linkend="GdkWMFunction">GdkWMFunction</link>;
<link linkend="GList">GList</link> *             <link linkend="gdk-window-get-toplevels">gdk_window_get_toplevels</link>            (void);
<link linkend="GdkWindow">GdkWindow</link> *         <link linkend="gdk-get-default-root-window">gdk_get_default_root_window</link>         (void);

                    <link linkend="GdkPointerHooks">GdkPointerHooks</link>;
<link linkend="GdkPointerHooks">GdkPointerHooks</link> *   <link linkend="gdk-set-pointer-hooks">gdk_set_pointer_hooks</link>               (const <link linkend="GdkPointerHooks">GdkPointerHooks</link> *new_hooks);

<link linkend="GdkPixmap">GdkPixmap</link> *         <link linkend="gdk-offscreen-window-get-pixmap">gdk_offscreen_window_get_pixmap</link>     (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-offscreen-window-set-embedder">gdk_offscreen_window_set_embedder</link>   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *embedder);
<link linkend="GdkWindow">GdkWindow</link> *         <link linkend="gdk-offscreen-window-get-embedder">gdk_offscreen_window_get_embedder</link>   (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-geometry-changed">gdk_window_geometry_changed</link>         (<link linkend="GdkWindow">GdkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="gdk-window-redirect-to-drawable">gdk_window_redirect_to_drawable</link>     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkDrawable">GdkDrawable</link> *drawable,
                                                         <link linkend="gint">gint</link> src_x,
                                                         <link linkend="gint">gint</link> src_y,
                                                         <link linkend="gint">gint</link> dest_x,
                                                         <link linkend="gint">gint</link> dest_y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);
<link linkend="void">void</link>                <link linkend="gdk-window-remove-redirection">gdk_window_remove_redirection</link>       (<link linkend="GdkWindow">GdkWindow</link> *window);
</synopsis>
</refsynopsisdiv>

<refsect1 id="gdk-Windows.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GdkDrawable">GdkDrawable</link>
         +----GdkWindow
</synopsis>
</refsect1>





<refsect1 id="gdk-Windows.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GdkWindow--cursor">cursor</link>&quot;                   <link linkend="gpointer">gpointer</link>              : Read / Write
</synopsis>
</refsect1>

<refsect1 id="gdk-Windows.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GdkWindow-from-embedder">from-embedder</link>&quot;                                  : Run Last
  &quot;<link linkend="GdkWindow-pick-embedded-child">pick-embedded-child</link>&quot;                            : Run Last
  &quot;<link linkend="GdkWindow-to-embedder">to-embedder</link>&quot;                                    : Run Last
</synopsis>
</refsect1>


<refsect1 id="gdk-Windows.description" role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="GdkWindow"><type>GdkWindow</type></link> is a rectangular region on the screen. It's a low-level object,
used to implement high-level objects such as <link linkend="GtkWidget"><type>GtkWidget</type></link> and <link linkend="GtkWindow"><type>GtkWindow</type></link> on the
GTK+ level. A <link linkend="GtkWindow"><type>GtkWindow</type></link> is a toplevel window, the thing a user might think of
as a "window" with a titlebar and so on; a <link linkend="GtkWindow"><type>GtkWindow</type></link> may contain many <link linkend="GdkWindow"><type>GdkWindow</type></link>.
For example, each <link linkend="GtkButton"><type>GtkButton</type></link> has a <link linkend="GdkWindow"><type>GdkWindow</type></link> associated with it.
</para>
<example id="composited-window-example"><title>Composited windows</title>
<programlisting><![CDATA[
#include <gtk/gtk.h>
/* The expose event handler for the event box.
 *
 * This function simply draws a transparency onto a widget on the area
 * for which it receives expose events.  This is intended to give the
 * event box a "transparent" background.
 *
 * In order for this to work properly, the widget must have an RGBA
 * colourmap.  The widget should also be set as app-paintable since it
 * doesn't make sense for GTK+ to draw a background if we are drawing it
 * (and because GTK+ might actually replace our transparency with its
 * default background colour).
 */
static gboolean
transparent_expose (GtkWidget      *widget,
                    GdkEventExpose *event)
{
  cairo_t *cr;
  cr = gdk_cairo_create (widget->window);
  cairo_set_operator (cr, CAIRO_OPERATOR_CLEAR);
  gdk_cairo_region (cr, event->region);
  cairo_fill (cr);
  cairo_destroy (cr);
  return FALSE;
}
/* The expose event handler for the window.
 *
 * This function performs the actual compositing of the event box onto
 * the already-existing background of the window at 50% normal opacity.
 *
 * In this case we do not want app-paintable to be set on the widget
 * since we want it to draw its own (red) background. Because of this,
 * however, we must ensure that we use g_signal_connect_after so that
 * this handler is called after the red has been drawn. If it was
 * called before then GTK would just blindly paint over our work.
 *
 * Note: if the child window has children, then you need a cairo 1.16
 * feature to make this work correctly.
 */
static gboolean
window_expose_event (GtkWidget      *widget,
                     GdkEventExpose *event)
{
  GdkRegion *region;
  GtkWidget *child;
  cairo_t *cr;
  /* get our child (in this case, the event box) */
  child = gtk_bin_get_child (GTK_BIN (widget));
  /* create a cairo context to draw to the window */
  cr = gdk_cairo_create (widget->window);
  /* the source data is the (composited) event box */
  gdk_cairo_set_source_pixmap (cr, child->window,
                               child->allocation.x,
                               child->allocation.y);
  /* draw no more than our expose event intersects our child */
  region = gdk_region_rectangle (&child->allocation);
  gdk_region_intersect (region, event->region);
  gdk_cairo_region (cr, region);
  cairo_clip (cr);
  /* composite, with a 50% opacity */
  cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
  cairo_paint_with_alpha (cr, 0.5);
  /* we're done */
  cairo_destroy (cr);
  return FALSE;
}
int
main (int argc, char **argv)
{
  GtkWidget *window, *event, *button;
  GdkScreen *screen;
  GdkColormap *rgba;
  GdkColor red;
  gtk_init (&argc, &argv);
  /* Make the widgets */
  button = gtk_button_new_with_label ("A Button");
  event = gtk_event_box_new ();
  window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  /* Put a red background on the window */
  gdk_color_parse ("red", &red);
  gtk_widget_modify_bg (window, GTK_STATE_NORMAL, &red);
  /* Set the colourmap for the event box.
   * Must be done before the event box is realised.
   */
  screen = gtk_widget_get_screen (event);
  rgba = gdk_screen_get_rgba_colormap (screen);
  gtk_widget_set_colormap (event, rgba);
  /* Set our event box to have a fully-transparent background
   * drawn on it. Currently there is no way to simply tell GTK+
   * that "transparency" is the background colour for a widget.
   */
  gtk_widget_set_app_paintable (GTK_WIDGET (event), TRUE);
  g_signal_connect (event, "expose-event",
                    G_CALLBACK (transparent_expose), NULL);
  /* Put them inside one another */
  gtk_container_set_border_width (GTK_CONTAINER (window), 10);
  gtk_container_add (GTK_CONTAINER (window), event);
  gtk_container_add (GTK_CONTAINER (event), button);
  /* Realise and show everything */
  gtk_widget_show_all (window);
  /* Set the event box GdkWindow to be composited.
   * Obviously must be performed after event box is realised.
   */
  gdk_window_set_composited (event->window, TRUE);
  /* Set up the compositing handler.
   * Note that we do _after_ so that the normal (red) background is drawn
   * by gtk before our compositing occurs.
   */
  g_signal_connect_after (window, "expose-event",
                          G_CALLBACK (window_expose_event), NULL);
  gtk_main ();
  return 0;
}
]]>
</programlisting></example>
<para>
In the example <xref linkend="composited-window-example"/>, a button is
placed inside of an event box inside of a window. The event box is
set as composited and therefore is no longer automatically drawn to
the screen.
</para>
<para>
When the contents of the event box change, an expose event is
generated on its parent window (which, in this case, belongs to
the toplevel <link linkend="GtkWindow"><type>GtkWindow</type></link>). The expose handler for this widget is
responsible for merging the changes back on the screen in the way
that it wishes.
</para>
<para>
In our case, we merge the contents with a 50% transparency. We
also set the background colour of the window to red. The effect is
that the background shows through the button.
</para>
</refsect1>

<refsect1 id="gdk-Windows.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GdkWindow-struct" role="struct">
<title>struct GdkWindow</title>
<indexterm zone="GdkWindow-struct"><primary sortas="Window">GdkWindow</primary></indexterm><programlisting>struct GdkWindow;</programlisting>
<para>
An opaque structure representing an onscreen drawable.
Pointers to structures of type <link linkend="GdkPixmap"><type>GdkPixmap</type></link>, <link linkend="GdkBitmap"><type>GdkBitmap</type></link>,
and <link linkend="GdkWindow"><type>GdkWindow</type></link>, can often be used interchangeably.
The type <link linkend="GdkDrawable"><type>GdkDrawable</type></link> refers generically to any of
these types.
</para></refsect2>
<refsect2 id="GdkWindowType" role="enum">
<title>enum GdkWindowType</title>
<indexterm zone="GdkWindowType"><primary sortas="WindowType">GdkWindowType</primary></indexterm><programlisting>typedef enum
{
  GDK_WINDOW_ROOT,
  GDK_WINDOW_TOPLEVEL,
  GDK_WINDOW_CHILD,
  GDK_WINDOW_DIALOG,
  GDK_WINDOW_TEMP,
  GDK_WINDOW_FOREIGN,
  GDK_WINDOW_OFFSCREEN
} GdkWindowType;
</programlisting>
<para>
Describes the kind of window.
</para><variablelist role="enum">
<varlistentry id="GDK-WINDOW-ROOT--CAPS" role="constant">
<term><literal>GDK_WINDOW_ROOT</literal></term>
<listitem><simpara>root window; this window has no parent, covers the entire screen, and is created by the window system
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TOPLEVEL--CAPS" role="constant">
<term><literal>GDK_WINDOW_TOPLEVEL</literal></term>
<listitem><simpara>toplevel window (used to implement <link linkend="GtkWindow"><type>GtkWindow</type></link>)
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-CHILD--CAPS" role="constant">
<term><literal>GDK_WINDOW_CHILD</literal></term>
<listitem><simpara>child window (used to implement e.g. <link linkend="GtkEntry"><type>GtkEntry</type></link>)
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-DIALOG--CAPS" role="constant">
<term><literal>GDK_WINDOW_DIALOG</literal></term>
<listitem><simpara>useless/deprecated compatibility type
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TEMP--CAPS" role="constant">
<term><literal>GDK_WINDOW_TEMP</literal></term>
<listitem><simpara>override redirect temporary window (used to implement <link linkend="GtkMenu"><type>GtkMenu</type></link>)
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-FOREIGN--CAPS" role="constant">
<term><literal>GDK_WINDOW_FOREIGN</literal></term>
<listitem><simpara>foreign window (see <link linkend="gdk-window-foreign-new"><function>gdk_window_foreign_new()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-OFFSCREEN--CAPS" role="constant">
<term><literal>GDK_WINDOW_OFFSCREEN</literal></term>
<listitem><simpara>offscreen window. Since 2.18
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowClass" role="enum">
<title>enum GdkWindowClass</title>
<indexterm zone="GdkWindowClass"><primary sortas="WindowClass">GdkWindowClass</primary></indexterm><programlisting>typedef enum
{
  GDK_INPUT_OUTPUT,
  GDK_INPUT_ONLY
} GdkWindowClass;
</programlisting>
<para>
<parameter>GDK_INPUT_OUTPUT</parameter> windows are the standard kind of window you might expect.
<parameter>GDK_INPUT_ONLY</parameter> windows are invisible; they are used to trap events, but
you can't draw on them.
</para><variablelist role="enum">
<varlistentry id="GDK-INPUT-OUTPUT--CAPS" role="constant">
<term><literal>GDK_INPUT_OUTPUT</literal></term>
<listitem><simpara>window for graphics and events
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-INPUT-ONLY--CAPS" role="constant">
<term><literal>GDK_INPUT_ONLY</literal></term>
<listitem><simpara>window for events only
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowHints" role="enum">
<title>enum GdkWindowHints</title>
<indexterm zone="GdkWindowHints"><primary sortas="WindowHints">GdkWindowHints</primary></indexterm><programlisting>typedef enum
{
  GDK_HINT_POS	       = 1 &lt;&lt; 0,
  GDK_HINT_MIN_SIZE    = 1 &lt;&lt; 1,
  GDK_HINT_MAX_SIZE    = 1 &lt;&lt; 2,
  GDK_HINT_BASE_SIZE   = 1 &lt;&lt; 3,
  GDK_HINT_ASPECT      = 1 &lt;&lt; 4,
  GDK_HINT_RESIZE_INC  = 1 &lt;&lt; 5,
  GDK_HINT_WIN_GRAVITY = 1 &lt;&lt; 6,
  GDK_HINT_USER_POS    = 1 &lt;&lt; 7,
  GDK_HINT_USER_SIZE   = 1 &lt;&lt; 8
} GdkWindowHints;
</programlisting>
<para>
Used to indicate which fields of a <link linkend="GdkGeometry"><type>GdkGeometry</type></link> struct should be paid attention
to. Also, the presence/absence of <parameter>GDK_HINT_POS</parameter>, <parameter>GDK_HINT_USER_POS</parameter>, and
<parameter>GDK_HINT_USER_SIZE</parameter> is significant, though they don't directly refer to
<link linkend="GdkGeometry"><type>GdkGeometry</type></link> fields.  <parameter>GDK_HINT_USER_POS</parameter> will be set automatically by <link linkend="GtkWindow"><type>GtkWindow</type></link>
if you call <link linkend="gtk-window-move"><function>gtk_window_move()</function></link>. <parameter>GDK_HINT_USER_POS</parameter> and <parameter>GDK_HINT_USER_SIZE</parameter>
should be set if the user specified a size/position using a --geometry
command-line argument; <link linkend="gtk-window-parse-geometry"><function>gtk_window_parse_geometry()</function></link> automatically sets these
flags.
</para><variablelist role="enum">
<varlistentry id="GDK-HINT-POS--CAPS" role="constant">
<term><literal>GDK_HINT_POS</literal></term>
<listitem><simpara>indicates that the program has positioned the window
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-MIN-SIZE--CAPS" role="constant">
<term><literal>GDK_HINT_MIN_SIZE</literal></term>
<listitem><simpara>min size fields are set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-MAX-SIZE--CAPS" role="constant">
<term><literal>GDK_HINT_MAX_SIZE</literal></term>
<listitem><simpara>max size fields are set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-BASE-SIZE--CAPS" role="constant">
<term><literal>GDK_HINT_BASE_SIZE</literal></term>
<listitem><simpara>base size fields are set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-ASPECT--CAPS" role="constant">
<term><literal>GDK_HINT_ASPECT</literal></term>
<listitem><simpara>aspect ratio fields are set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-RESIZE-INC--CAPS" role="constant">
<term><literal>GDK_HINT_RESIZE_INC</literal></term>
<listitem><simpara>resize increment fields are set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-WIN-GRAVITY--CAPS" role="constant">
<term><literal>GDK_HINT_WIN_GRAVITY</literal></term>
<listitem><simpara>window gravity field is set
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-USER-POS--CAPS" role="constant">
<term><literal>GDK_HINT_USER_POS</literal></term>
<listitem><simpara>indicates that the window's position was explicitly set by the user
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HINT-USER-SIZE--CAPS" role="constant">
<term><literal>GDK_HINT_USER_SIZE</literal></term>
<listitem><simpara>indicates that the window's size was explicitly set by the user
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkGeometry" role="struct">
<title>GdkGeometry</title>
<indexterm zone="GdkGeometry"><primary sortas="Geometry">GdkGeometry</primary></indexterm><programlisting>typedef struct {
  gint min_width;
  gint min_height;
  gint max_width;
  gint max_height;
  gint base_width;
  gint base_height;
  gint width_inc;
  gint height_inc;
  gdouble min_aspect;
  gdouble max_aspect;
  GdkGravity win_gravity;
} GdkGeometry;
</programlisting>
<para>
The <link linkend="GdkGeometry"><type>GdkGeometry</type></link> struct gives the window manager information about
a window's geometry constraints. Normally you would set these on
the GTK+ level using <link linkend="gtk-window-set-geometry-hints"><function>gtk_window_set_geometry_hints()</function></link>. <link linkend="GtkWindow"><type>GtkWindow</type></link>
then sets the hints on the <link linkend="GdkWindow"><type>GdkWindow</type></link> it creates.
</para>
<para>
<link linkend="gdk-window-set-geometry-hints"><function>gdk_window_set_geometry_hints()</function></link> expects the hints to be fully valid already and
simply passes them to the window manager; in contrast,
<link linkend="gtk-window-set-geometry-hints"><function>gtk_window_set_geometry_hints()</function></link> performs some interpretation. For example,
<link linkend="GtkWindow"><type>GtkWindow</type></link> will apply the hints to the geometry widget instead of the toplevel
window, if you set a geometry widget. Also, the
<parameter>min_width</parameter>/<parameter>min_height</parameter>/<parameter>max_width</parameter>/<parameter>max_height</parameter> fields may be set to -1, and
<link linkend="GtkWindow"><type>GtkWindow</type></link> will substitute the size request of the window or geometry widget. If
the minimum size hint is not provided, <link linkend="GtkWindow"><type>GtkWindow</type></link> will use its requisition as
the minimum size.  If the minimum size is provided and a geometry widget is set,
<link linkend="GtkWindow"><type>GtkWindow</type></link> will take the minimum size as the minimum size of the geometry widget
rather than the entire window. The base size is treated similarly.
</para>
<para>
The canonical use-case for <link linkend="gtk-window-set-geometry-hints"><function>gtk_window_set_geometry_hints()</function></link> is to get a terminal
widget to resize properly. Here, the terminal text area should be the geometry
widget; <link linkend="GtkWindow"><type>GtkWindow</type></link> will then automatically set the base size to the size of
other widgets in the terminal window, such as the menubar and scrollbar.  Then,
the <parameter>width_inc</parameter> and <parameter>height_inc</parameter> fields should be set to the size of one character
in the terminal. Finally, the base size should be set to the size of one
character. The net effect is that the minimum size of the terminal
will have a 1x1 character terminal area, and only terminal sizes on
the "character grid" will be allowed.
</para>
<para>
Here's an example of how the terminal example would be implemented, assuming
a terminal area widget called "terminal" and a toplevel window "toplevel":
<informalexample><programlisting>
	GdkGeometry hints;
	hints.base_width = terminal->char_width;
        hints.base_height = terminal->char_height;
        hints.min_width = terminal->char_width;
        hints.min_height = terminal->char_height;
        hints.width_inc = terminal->char_width;
        hints.height_inc = terminal->char_height;
	gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
				       GTK_WIDGET (terminal),
 				       &amp;hints,
				       GDK_HINT_RESIZE_INC |
                                       GDK_HINT_MIN_SIZE |
                                       GDK_HINT_BASE_SIZE);
</programlisting></informalexample>
</para>
<para>
The other useful fields are the <parameter>min_aspect</parameter> and <parameter>max_aspect</parameter> fields; these
contain a width/height ratio as a floating point number. If a geometry widget is
set, the aspect applies to the geometry widget rather than the entire window.
The most common use of these hints is probably to set <parameter>min_aspect</parameter> and
<parameter>max_aspect</parameter> to the same value, thus forcing the window to keep a constant aspect
ratio.
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>min_width</structfield>;</term>
<listitem><simpara>minimum width of window (or -1 to use requisition, with <link linkend="GtkWindow"><type>GtkWindow</type></link> only)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>min_height</structfield>;</term>
<listitem><simpara>minimum height of window (or -1 to use requisition, with <link linkend="GtkWindow"><type>GtkWindow</type></link> only)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>max_width</structfield>;</term>
<listitem><simpara>maximum width of window (or -1 to use requisition, with <link linkend="GtkWindow"><type>GtkWindow</type></link> only)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>max_height</structfield>;</term>
<listitem><simpara>maximum height of window (or -1 to use requisition, with <link linkend="GtkWindow"><type>GtkWindow</type></link> only)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>base_width</structfield>;</term>
<listitem><simpara>allowed window widths are <parameter>base_width</parameter> + <parameter>width_inc</parameter> * N where N is any integer (-1 allowed with <link linkend="GtkWindow"><type>GtkWindow</type></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>base_height</structfield>;</term>
<listitem><simpara>allowed window widths are <parameter>base_height</parameter> + <parameter>height_inc</parameter> * N where N is any integer (-1 allowed with <link linkend="GtkWindow"><type>GtkWindow</type></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>width_inc</structfield>;</term>
<listitem><simpara>width resize increment
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>height_inc</structfield>;</term>
<listitem><simpara>height resize increment
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gdouble">gdouble</link>&#160;<structfield>min_aspect</structfield>;</term>
<listitem><simpara>minimum width/height ratio
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gdouble">gdouble</link>&#160;<structfield>max_aspect</structfield>;</term>
<listitem><simpara>maximum width/height ratio
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkGravity">GdkGravity</link>&#160;<structfield>win_gravity</structfield>;</term>
<listitem><simpara>window gravity, see <link linkend="gtk-window-set-gravity"><function>gtk_window_set_gravity()</function></link>
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkGravity" role="enum">
<title>enum GdkGravity</title>
<indexterm zone="GdkGravity"><primary sortas="Gravity">GdkGravity</primary></indexterm><programlisting>typedef enum
{
  GDK_GRAVITY_NORTH_WEST = 1,
  GDK_GRAVITY_NORTH,
  GDK_GRAVITY_NORTH_EAST,
  GDK_GRAVITY_WEST,
  GDK_GRAVITY_CENTER,
  GDK_GRAVITY_EAST,
  GDK_GRAVITY_SOUTH_WEST,
  GDK_GRAVITY_SOUTH,
  GDK_GRAVITY_SOUTH_EAST,
  GDK_GRAVITY_STATIC
} GdkGravity;
</programlisting>
<para>
Defines the reference point of a window and the meaning of coordinates
passed to <link linkend="gtk-window-move"><function>gtk_window_move()</function></link>. See <link linkend="gtk-window-move"><function>gtk_window_move()</function></link> and the "implementation
notes" section of the
<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
Window Manager Hints</ulink> specification for more details.
</para><variablelist role="enum">
<varlistentry id="GDK-GRAVITY-NORTH-WEST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_NORTH_WEST</literal></term>
<listitem><simpara>the reference point is at the top left corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-NORTH--CAPS" role="constant">
<term><literal>GDK_GRAVITY_NORTH</literal></term>
<listitem><simpara>the reference point is in the middle of the top edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-NORTH-EAST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_NORTH_EAST</literal></term>
<listitem><simpara>the reference point is at the top right corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-WEST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_WEST</literal></term>
<listitem><simpara>the reference point is at the middle of the left edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-CENTER--CAPS" role="constant">
<term><literal>GDK_GRAVITY_CENTER</literal></term>
<listitem><simpara>the reference point is at the center of the window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-EAST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_EAST</literal></term>
<listitem><simpara>the reference point is at the middle of the right edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-SOUTH-WEST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_SOUTH_WEST</literal></term>
<listitem><simpara>the reference point is at the lower left corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-SOUTH--CAPS" role="constant">
<term><literal>GDK_GRAVITY_SOUTH</literal></term>
<listitem><simpara>the reference point is at the middle of the lower edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-SOUTH-EAST--CAPS" role="constant">
<term><literal>GDK_GRAVITY_SOUTH_EAST</literal></term>
<listitem><simpara>the reference point is at the lower right corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-GRAVITY-STATIC--CAPS" role="constant">
<term><literal>GDK_GRAVITY_STATIC</literal></term>
<listitem><simpara>the reference point is at the top left corner of the 
   window itself, ignoring window manager decorations.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowEdge" role="enum">
<title>enum GdkWindowEdge</title>
<indexterm zone="GdkWindowEdge"><primary sortas="WindowEdge">GdkWindowEdge</primary></indexterm><programlisting>typedef enum
{
  GDK_WINDOW_EDGE_NORTH_WEST,
  GDK_WINDOW_EDGE_NORTH,
  GDK_WINDOW_EDGE_NORTH_EAST,
  GDK_WINDOW_EDGE_WEST,
  GDK_WINDOW_EDGE_EAST,
  GDK_WINDOW_EDGE_SOUTH_WEST,
  GDK_WINDOW_EDGE_SOUTH,
  GDK_WINDOW_EDGE_SOUTH_EAST  
} GdkWindowEdge;
</programlisting>
<para>
Determines a window edge or corner.
</para><variablelist role="enum">
<varlistentry id="GDK-WINDOW-EDGE-NORTH-WEST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_NORTH_WEST</literal></term>
<listitem><simpara>the top left corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-NORTH--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_NORTH</literal></term>
<listitem><simpara>the top edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-NORTH-EAST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_NORTH_EAST</literal></term>
<listitem><simpara>the top right corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-WEST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_WEST</literal></term>
<listitem><simpara>the left edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-EAST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_EAST</literal></term>
<listitem><simpara>the right edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-SOUTH-WEST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_SOUTH_WEST</literal></term>
<listitem><simpara>the lower left corner.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-SOUTH--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_SOUTH</literal></term>
<listitem><simpara>the lower edge.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-EDGE-SOUTH-EAST--CAPS" role="constant">
<term><literal>GDK_WINDOW_EDGE_SOUTH_EAST</literal></term>
<listitem><simpara>the lower right corner.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowTypeHint" role="enum">
<title>enum GdkWindowTypeHint</title>
<indexterm zone="GdkWindowTypeHint"><primary sortas="WindowTypeHint">GdkWindowTypeHint</primary></indexterm><programlisting>typedef enum
{
  GDK_WINDOW_TYPE_HINT_NORMAL,
  GDK_WINDOW_TYPE_HINT_DIALOG,
  GDK_WINDOW_TYPE_HINT_MENU,		/* Torn off menu */
  GDK_WINDOW_TYPE_HINT_TOOLBAR,
  GDK_WINDOW_TYPE_HINT_SPLASHSCREEN,
  GDK_WINDOW_TYPE_HINT_UTILITY,
  GDK_WINDOW_TYPE_HINT_DOCK,
  GDK_WINDOW_TYPE_HINT_DESKTOP,
  GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU,	/* A drop down menu (from a menubar) */
  GDK_WINDOW_TYPE_HINT_POPUP_MENU,	/* A popup menu (from right-click) */
  GDK_WINDOW_TYPE_HINT_TOOLTIP,
  GDK_WINDOW_TYPE_HINT_NOTIFICATION,
  GDK_WINDOW_TYPE_HINT_COMBO,
  GDK_WINDOW_TYPE_HINT_DND
} GdkWindowTypeHint;
</programlisting>
<para>
These are hints for the window manager that indicate what type of function
the window has. The window manager can use this when determining decoration
and behaviour of the window. The hint must be set before mapping the window.
</para>
<para>
See the
<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
Window Manager Hints</ulink> specification for more details about
window types.
</para><variablelist role="enum">
<varlistentry id="GDK-WINDOW-TYPE-HINT-NORMAL--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_NORMAL</literal></term>
<listitem><simpara>Normal toplevel window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-DIALOG--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_DIALOG</literal></term>
<listitem><simpara>Dialog window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-MENU--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_MENU</literal></term>
<listitem><simpara>Window used to implement a menu; GTK+ uses 
  this hint only for torn-off menus, see <link linkend="GtkTearoffMenuItem"><type>GtkTearoffMenuItem</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-TOOLBAR--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_TOOLBAR</literal></term>
<listitem><simpara>Window used to implement toolbars.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-SPLASHSCREEN--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_SPLASHSCREEN</literal></term>
<listitem><simpara>Window used to display a splash 
  screen during application startup.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-UTILITY--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_UTILITY</literal></term>
<listitem><simpara>Utility windows which are not detached 
  toolbars or dialogs.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-DOCK--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_DOCK</literal></term>
<listitem><simpara>Used for creating dock or panel windows.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-DESKTOP--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_DESKTOP</literal></term>
<listitem><simpara>Used for creating the desktop background 
window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-DROPDOWN-MENU--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU</literal></term>
<listitem><simpara>A menu that belongs to a menubar.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-POPUP-MENU--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_POPUP_MENU</literal></term>
<listitem><simpara>A menu that does not belong to a menubar, 
  e.g. a context menu.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-TOOLTIP--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_TOOLTIP</literal></term>
<listitem><simpara>A tooltip.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-NOTIFICATION--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_NOTIFICATION</literal></term>
<listitem><simpara>A notification - typically a "bubble" 
  that belongs to a status icon.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-COMBO--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_COMBO</literal></term>
<listitem><simpara>A popup from a combo box.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WINDOW-TYPE-HINT-DND--CAPS" role="constant">
<term><literal>GDK_WINDOW_TYPE_HINT_DND</literal></term>
<listitem><simpara>A window that is used to implement a DND cursor.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowAttr" role="struct">
<title>GdkWindowAttr</title>
<indexterm zone="GdkWindowAttr"><primary sortas="WindowAttr">GdkWindowAttr</primary></indexterm><programlisting>typedef struct {
  gchar *title;
  gint event_mask;
  gint x, y;
  gint width;
  gint height;
  GdkWindowClass wclass;
  GdkVisual *visual;
  GdkColormap *colormap;
  GdkWindowType window_type;
  GdkCursor *cursor;
  gchar *wmclass_name;
  gchar *wmclass_class;
  gboolean override_redirect;
  GdkWindowTypeHint type_hint;
} GdkWindowAttr;
</programlisting>
<para>
Attributes to use for a newly-created window.
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gchar">gchar</link>&#160;*<structfield>title</structfield>;</term>
<listitem><simpara>title of the window (for toplevel windows)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>event_mask</structfield>;</term>
<listitem><simpara>event mask (see <link linkend="gdk-window-set-events"><function>gdk_window_set_events()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>x</structfield>;</term>
<listitem><simpara>X coordinate relative to parent window (see <link linkend="gdk-window-move"><function>gdk_window_move()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>y</structfield>;</term>
<listitem><simpara>Y coordinate relative to parent window (see <link linkend="gdk-window-move"><function>gdk_window_move()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>width</structfield>;</term>
<listitem><simpara>width of window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&#160;<structfield>height</structfield>;</term>
<listitem><simpara>height of window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkWindowClass">GdkWindowClass</link>&#160;<structfield>wclass</structfield>;</term>
<listitem><simpara>#GDK_INPUT_OUTPUT (normal window) or <link linkend="GDK-INPUT-ONLY--CAPS"><type>GDK_INPUT_ONLY</type></link> (invisible window that receives events)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkVisual">GdkVisual</link>&#160;*<structfield>visual</structfield>;</term>
<listitem><simpara>#GdkVisual for window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkColormap">GdkColormap</link>&#160;*<structfield>colormap</structfield>;</term>
<listitem><simpara>#GdkColormap for window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkWindowType">GdkWindowType</link>&#160;<structfield>window_type</structfield>;</term>
<listitem><simpara>type of window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkCursor">GdkCursor</link>&#160;*<structfield>cursor</structfield>;</term>
<listitem><simpara>cursor for the window (see <link linkend="gdk-window-set-cursor"><function>gdk_window_set_cursor()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link>&#160;*<structfield>wmclass_name</structfield>;</term>
<listitem><simpara>don't use (see <link linkend="gtk-window-set-wmclass"><function>gtk_window_set_wmclass()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link>&#160;*<structfield>wmclass_class</structfield>;</term>
<listitem><simpara>don't use (see <link linkend="gtk-window-set-wmclass"><function>gtk_window_set_wmclass()</function></link>)
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gboolean">gboolean</link>&#160;<structfield>override_redirect</structfield>;</term>
<listitem><simpara>%TRUE to bypass the window manager
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link>&#160;<structfield>type_hint</structfield>;</term>
<listitem><simpara>a hint of the function of the window
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWindowAttributesType" role="enum">
<title>enum GdkWindowAttributesType</title>
<indexterm zone="GdkWindowAttributesType"><primary sortas="WindowAttributesType">GdkWindowAttributesType</primary></indexterm><programlisting>typedef enum
{
  GDK_WA_TITLE	   = 1 &lt;&lt; 1,
  GDK_WA_X	   = 1 &lt;&lt; 2,
  GDK_WA_Y	   = 1 &lt;&lt; 3,
  GDK_WA_CURSOR	   = 1 &lt;&lt; 4,
  GDK_WA_COLORMAP  = 1 &lt;&lt; 5,
  GDK_WA_VISUAL	   = 1 &lt;&lt; 6,
  GDK_WA_WMCLASS   = 1 &lt;&lt; 7,
  GDK_WA_NOREDIR   = 1 &lt;&lt; 8,
  GDK_WA_TYPE_HINT = 1 &lt;&lt; 9
} GdkWindowAttributesType;
</programlisting>
<para>
Used to indicate which fields in the <link linkend="GdkWindowAttr"><type>GdkWindowAttr</type></link> struct should be
honored. For example, if you filled in the "cursor" and "x" fields of
<link linkend="GdkWindowAttr"><type>GdkWindowAttr</type></link>, pass "<parameter>GDK_WA_X</parameter> | <parameter>GDK_WA_CURSOR</parameter>" to <link linkend="gdk-window-new"><function>gdk_window_new()</function></link>.  Fields
in <link linkend="GdkWindowAttr"><type>GdkWindowAttr</type></link> not covered by a bit in this enum are required; for example,
the <parameter>width</parameter>/<parameter>height</parameter>, <parameter>wclass</parameter>, and <parameter>window_type</parameter> fields are required, they have no
corresponding flag in <link linkend="GdkWindowAttributesType"><type>GdkWindowAttributesType</type></link>.
</para><variablelist role="enum">
<varlistentry id="GDK-WA-TITLE--CAPS" role="constant">
<term><literal>GDK_WA_TITLE</literal></term>
<listitem><simpara>Honor the title field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-X--CAPS" role="constant">
<term><literal>GDK_WA_X</literal></term>
<listitem><simpara>Honor the X coordinate field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-Y--CAPS" role="constant">
<term><literal>GDK_WA_Y</literal></term>
<listitem><simpara>Honor the Y coordinate field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-CURSOR--CAPS" role="constant">
<term><literal>GDK_WA_CURSOR</literal></term>
<listitem><simpara>Honor the cursor field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-COLORMAP--CAPS" role="constant">
<term><literal>GDK_WA_COLORMAP</literal></term>
<listitem><simpara>Honor the colormap field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-VISUAL--CAPS" role="constant">
<term><literal>GDK_WA_VISUAL</literal></term>
<listitem><simpara>Honor the visual field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-WMCLASS--CAPS" role="constant">
<term><literal>GDK_WA_WMCLASS</literal></term>
<listitem><simpara>Honor the wmclass_class and wmclass_name fields
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-NOREDIR--CAPS" role="constant">
<term><literal>GDK_WA_NOREDIR</literal></term>
<listitem><simpara>Honor the override_redirect field
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-WA-TYPE-HINT--CAPS" role="constant">
<term><literal>GDK_WA_TYPE_HINT</literal></term>
<listitem><simpara>Honor the type_hint field
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-new" role="function">
<title>gdk_window_new ()</title>
<indexterm zone="gdk-window-new"><primary sortas="window_new">gdk_window_new</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gdk_window_new                      (<link linkend="GdkWindow">GdkWindow</link> *parent,
                                                         <link linkend="GdkWindowAttr">GdkWindowAttr</link> *attributes,
                                                         <link linkend="gint">gint</link> attributes_mask);</programlisting>
<para>
Creates a new <link linkend="GdkWindow"><type>GdkWindow</type></link> using the attributes from
<parameter>attributes</parameter>. See <link linkend="GdkWindowAttr"><type>GdkWindowAttr</type></link> and <link linkend="GdkWindowAttributesType"><type>GdkWindowAttributesType</type></link> for
more details.  Note: to use this on displays other than the default
display, <parameter>parent</parameter> must be specified.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to create the window as a child of
  the default root window for the default display.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attributes</parameter>&#160;:</term>
<listitem><simpara> attributes of the new window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attributes_mask</parameter>&#160;:</term>
<listitem><simpara> mask indicating which fields in <parameter>attributes</parameter> are valid
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-destroy" role="function">
<title>gdk_window_destroy ()</title>
<indexterm zone="gdk-window-destroy"><primary sortas="window_destroy">gdk_window_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_destroy                  (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Destroys the window system resources associated with <parameter>window</parameter> and decrements <parameter>window</parameter>'s
reference count. The window system resources for all children of <parameter>window</parameter> are also
destroyed, but the children's reference counts are not decremented.
</para>
<para>
Note that a window will not be destroyed automatically when its reference count
reaches zero. You must call this function yourself before that happens.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-ref" role="macro" condition="deprecated:">
<title>gdk_window_ref</title>
<indexterm zone="gdk-window-ref" role="deprecated"><primary sortas="window_ref">gdk_window_ref</primary></indexterm><programlisting>#define gdk_window_ref                 gdk_drawable_ref
</programlisting>
<warning><para><literal>gdk_window_ref</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="g-object-ref"><function>g_object_ref()</function></link>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-unref" role="macro" condition="deprecated:">
<title>gdk_window_unref</title>
<indexterm zone="gdk-window-unref" role="deprecated"><primary sortas="window_unref">gdk_window_unref</primary></indexterm><programlisting>#define gdk_window_unref               gdk_drawable_unref
</programlisting>
<warning><para><literal>gdk_window_unref</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="g-object-unref"><function>g_object_unref()</function></link>
</para></refsect2>
<refsect2 id="gdk-window-get-window-type" role="function">
<title>gdk_window_get_window_type ()</title>
<indexterm zone="gdk-window-get-window-type"><primary sortas="window_get_window_type">gdk_window_get_window_type</primary></indexterm><programlisting><link linkend="GdkWindowType">GdkWindowType</link>       gdk_window_get_window_type          (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the type of the window. See <link linkend="GdkWindowType"><type>GdkWindowType</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> type of window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-at-pointer" role="function">
<title>gdk_window_at_pointer ()</title>
<indexterm zone="gdk-window-at-pointer"><primary sortas="window_at_pointer">gdk_window_at_pointer</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gdk_window_at_pointer               (<link linkend="gint">gint</link> *win_x,
                                                         <link linkend="gint">gint</link> *win_y);</programlisting>
<para>
Obtains the window underneath the mouse pointer, returning the
location of that window in <parameter>win_x</parameter>, <parameter>win_y</parameter>. Returns <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the
window under the mouse pointer is not known to GDK (if the window
belongs to another application and a <link linkend="GdkWindow"><type>GdkWindow</type></link> hasn't been created
for it with <link linkend="gdk-window-foreign-new"><function>gdk_window_foreign_new()</function></link>)
</para>
<para>
NOTE: For multihead-aware widgets or applications use
<link linkend="gdk-display-get-window-at-pointer"><function>gdk_display_get_window_at_pointer()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>win_x</parameter>&#160;:</term>
<listitem><simpara> return location for origin of the window under the pointer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>win_y</parameter>&#160;:</term>
<listitem><simpara> return location for origin of the window under the pointer
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> window under the mouse pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-show" role="function">
<title>gdk_window_show ()</title>
<indexterm zone="gdk-window-show"><primary sortas="window_show">gdk_window_show</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_show                     (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Like <link linkend="gdk-window-show-unraised"><function>gdk_window_show_unraised()</function></link>, but also raises the window to the
top of the window stack (moves the window to the front of the
Z-order).
</para>
<para>
This function maps a window so it's visible onscreen. Its opposite
is <link linkend="gdk-window-hide"><function>gdk_window_hide()</function></link>.
</para>
<para>
When implementing a <link linkend="GtkWidget"><type>GtkWidget</type></link>, you should call this function on the widget's
<link linkend="GdkWindow"><type>GdkWindow</type></link> as part of the "map" method.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-show-unraised" role="function">
<title>gdk_window_show_unraised ()</title>
<indexterm zone="gdk-window-show-unraised"><primary sortas="window_show_unraised">gdk_window_show_unraised</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_show_unraised            (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Shows a <link linkend="GdkWindow"><type>GdkWindow</type></link> onscreen, but does not modify its stacking
order. In contrast, <link linkend="gdk-window-show"><function>gdk_window_show()</function></link> will raise the window
to the top of the window stack.
</para>
<para>
On the X11 platform, in Xlib terms, this function calls
<link linkend="XMapWindow"><function>XMapWindow()</function></link> (it also updates some internal GDK state, which means
that you can't really use <link linkend="XMapWindow"><function>XMapWindow()</function></link> directly on a GDK window).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-hide" role="function">
<title>gdk_window_hide ()</title>
<indexterm zone="gdk-window-hide"><primary sortas="window_hide">gdk_window_hide</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_hide                     (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
For toplevel windows, withdraws them, so they will no longer be
known to the window manager; for all windows, unmaps them, so
they won't be displayed. Normally done automatically as
part of <link linkend="gtk-widget-hide"><function>gtk_widget_hide()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-is-visible" role="function">
<title>gdk_window_is_visible ()</title>
<indexterm zone="gdk-window-is-visible"><primary sortas="window_is_visible">gdk_window_is_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_is_visible               (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Checks whether the window has been mapped (with <link linkend="gdk-window-show"><function>gdk_window_show()</function></link> or
<link linkend="gdk-window-show-unraised"><function>gdk_window_show_unraised()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window is mapped
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-is-viewable" role="function">
<title>gdk_window_is_viewable ()</title>
<indexterm zone="gdk-window-is-viewable"><primary sortas="window_is_viewable">gdk_window_is_viewable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_is_viewable              (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Check if the window and all ancestors of the window are
mapped. (This is not necessarily "viewable" in the X sense, since
we only check as far as we have GDK window parents, not to the root
window.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window is viewable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-state" role="function">
<title>gdk_window_get_state ()</title>
<indexterm zone="gdk-window-get-state"><primary sortas="window_get_state">gdk_window_get_state</primary></indexterm><programlisting><link linkend="GdkWindowState">GdkWindowState</link>      gdk_window_get_state                (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the bitwise OR of the currently active window state flags,
from the <link linkend="GdkWindowState"><type>GdkWindowState</type></link> enumeration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> window state bitfield
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-withdraw" role="function">
<title>gdk_window_withdraw ()</title>
<indexterm zone="gdk-window-withdraw"><primary sortas="window_withdraw">gdk_window_withdraw</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_withdraw                 (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Withdraws a window (unmaps it and asks the window manager to forget about it).
This function is not really useful as <link linkend="gdk-window-hide"><function>gdk_window_hide()</function></link> automatically
withdraws toplevel windows before hiding them.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-iconify" role="function">
<title>gdk_window_iconify ()</title>
<indexterm zone="gdk-window-iconify"><primary sortas="window_iconify">gdk_window_iconify</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_iconify                  (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Asks to iconify (minimize) <parameter>window</parameter>. The window manager may choose
to ignore the request, but normally will honor it. Using
<link linkend="gtk-window-iconify"><function>gtk_window_iconify()</function></link> is preferred, if you have a <link linkend="GtkWindow"><type>GtkWindow</type></link> widget.
</para>
<para>
This function only makes sense when <parameter>window</parameter> is a toplevel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-deiconify" role="function">
<title>gdk_window_deiconify ()</title>
<indexterm zone="gdk-window-deiconify"><primary sortas="window_deiconify">gdk_window_deiconify</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_deiconify                (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Attempt to deiconify (unminimize) <parameter>window</parameter>. On X11 the window manager may
choose to ignore the request to deiconify. When using GTK+,
use <link linkend="gtk-window-deiconify"><function>gtk_window_deiconify()</function></link> instead of the <link linkend="GdkWindow"><type>GdkWindow</type></link> variant. Or better yet,
you probably want to use <link linkend="gtk-window-present"><function>gtk_window_present()</function></link>, which raises the window, focuses it,
unminimizes it, and puts it on the current desktop.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-stick" role="function">
<title>gdk_window_stick ()</title>
<indexterm zone="gdk-window-stick"><primary sortas="window_stick">gdk_window_stick</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_stick                    (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
"Pins" a window such that it's on all workspaces and does not scroll
with viewports, for window managers that have scrollable viewports.
(When using <link linkend="GtkWindow"><type>GtkWindow</type></link>, <link linkend="gtk-window-stick"><function>gtk_window_stick()</function></link> may be more useful.)
</para>
<para>
On the X11 platform, this function depends on window manager
support, so may have no effect with many window managers. However,
GDK will do the best it can to convince the window manager to stick
the window. For window managers that don't support this operation,
there's nothing you can do to force it to happen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-unstick" role="function">
<title>gdk_window_unstick ()</title>
<indexterm zone="gdk-window-unstick"><primary sortas="window_unstick">gdk_window_unstick</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_unstick                  (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Reverse operation for <link linkend="gdk-window-stick"><function>gdk_window_stick()</function></link>; see <link linkend="gdk-window-stick"><function>gdk_window_stick()</function></link>,
and <link linkend="gtk-window-unstick"><function>gtk_window_unstick()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-maximize" role="function">
<title>gdk_window_maximize ()</title>
<indexterm zone="gdk-window-maximize"><primary sortas="window_maximize">gdk_window_maximize</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_maximize                 (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Maximizes the window. If the window was already maximized, then
this function does nothing.
</para>
<para>
On X11, asks the window manager to maximize <parameter>window</parameter>, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
"maximized"; so you can't rely on the maximization actually
happening. But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.
</para>
<para>
On Windows, reliably maximizes the window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-unmaximize" role="function">
<title>gdk_window_unmaximize ()</title>
<indexterm zone="gdk-window-unmaximize"><primary sortas="window_unmaximize">gdk_window_unmaximize</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_unmaximize               (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Unmaximizes the window. If the window wasn't maximized, then this
function does nothing.
</para>
<para>
On X11, asks the window manager to unmaximize <parameter>window</parameter>, if the
window manager supports this operation. Not all window managers
support this, and some deliberately ignore it or don't have a
concept of "maximized"; so you can't rely on the unmaximization
actually happening. But it will happen with most standard window
managers, and GDK makes a best effort to get it to happen.
</para>
<para>
On Windows, reliably unmaximizes the window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-fullscreen" role="function" condition="since:2.2">
<title>gdk_window_fullscreen ()</title>
<indexterm zone="gdk-window-fullscreen" role="2.2"><primary sortas="window_fullscreen">gdk_window_fullscreen</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_fullscreen               (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Moves the window into fullscreen mode. This means the
window covers the entire screen and is above any panels
or task bars.
</para>
<para>
If the window was already fullscreen, then this function does nothing.
</para>
<para>
On X11, asks the window manager to put <parameter>window</parameter> in a fullscreen
state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or
don't have a concept of "fullscreen"; so you can't rely on the
fullscreenification actually happening. But it will happen with
most standard window managers, and GDK makes a best effort to get
it to happen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2</para></refsect2>
<refsect2 id="gdk-window-unfullscreen" role="function" condition="since:2.2">
<title>gdk_window_unfullscreen ()</title>
<indexterm zone="gdk-window-unfullscreen" role="2.2"><primary sortas="window_unfullscreen">gdk_window_unfullscreen</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_unfullscreen             (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Moves the window out of fullscreen mode. If the window was not
fullscreen, does nothing.
</para>
<para>
On X11, asks the window manager to move <parameter>window</parameter> out of the fullscreen
state, if the window manager supports this operation. Not all
window managers support this, and some deliberately ignore it or
don't have a concept of "fullscreen"; so you can't rely on the
unfullscreenification actually happening. But it will happen with
most standard window managers, and GDK makes a best effort to get
it to happen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2</para></refsect2>
<refsect2 id="gdk-window-set-keep-above" role="function" condition="since:2.4">
<title>gdk_window_set_keep_above ()</title>
<indexterm zone="gdk-window-set-keep-above" role="2.4"><primary sortas="window_set_keep_above">gdk_window_set_keep_above</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_keep_above           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
<para>
Set if <parameter>window</parameter> must be kept above other windows. If the
window was already above, then this function does nothing.
</para>
<para>
On X11, asks the window manager to keep <parameter>window</parameter> above, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
"keep above"; so you can't rely on the window being kept above.
But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
<listitem><simpara> whether to keep <parameter>window</parameter> above other windows
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gdk-window-set-keep-below" role="function" condition="since:2.4">
<title>gdk_window_set_keep_below ()</title>
<indexterm zone="gdk-window-set-keep-below" role="2.4"><primary sortas="window_set_keep_below">gdk_window_set_keep_below</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_keep_below           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
<para>
Set if <parameter>window</parameter> must be kept below other windows. If the
window was already below, then this function does nothing.
</para>
<para>
On X11, asks the window manager to keep <parameter>window</parameter> below, if the window
manager supports this operation. Not all window managers support
this, and some deliberately ignore it or don't have a concept of
"keep below"; so you can't rely on the window being kept below.
But it will happen with most standard window managers,
and GDK makes a best effort to get it to happen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
<listitem><simpara> whether to keep <parameter>window</parameter> below other windows
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gdk-window-set-opacity" role="function" condition="since:2.12">
<title>gdk_window_set_opacity ()</title>
<indexterm zone="gdk-window-set-opacity" role="2.12"><primary sortas="window_set_opacity">gdk_window_set_opacity</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_opacity              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gdouble">gdouble</link> opacity);</programlisting>
<para>
Request the windowing system to make <parameter>window</parameter> partially transparent,
with opacity 0 being fully transparent and 1 fully opaque. (Values
of the opacity parameter are clamped to the [0,1] range.) 
</para>
<para>
On X11, this works only on X screens with a compositing manager 
running.
</para>
<para>
For setting up per-pixel alpha, see <link linkend="gdk-screen-get-rgba-colormap"><function>gdk_screen_get_rgba_colormap()</function></link>.
For making non-toplevel windows translucent, see 
<link linkend="gdk-window-set-composited"><function>gdk_window_set_composited()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a top-level <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
<listitem><simpara> opacity
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gdk-window-set-composited" role="function" condition="since:2.12">
<title>gdk_window_set_composited ()</title>
<indexterm zone="gdk-window-set-composited" role="2.12"><primary sortas="window_set_composited">gdk_window_set_composited</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_composited           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> composited);</programlisting>
<para>
Sets a <link linkend="GdkWindow"><type>GdkWindow</type></link> as composited, or unsets it. Composited
windows do not automatically have their contents drawn to
the screen. Drawing is redirected to an offscreen buffer
and an expose event is emitted on the parent of the composited
window. It is the responsibility of the parent's expose handler
to manually merge the off-screen content onto the screen in
whatever way it sees fit. See <xref linkend="composited-window-example"/>
for an example.
</para>
<para>
It only makes sense for child windows to be composited; see
<link linkend="gdk-window-set-opacity"><function>gdk_window_set_opacity()</function></link> if you need translucent toplevel
windows.
</para>
<para>
An additional effect of this call is that the area of this
window is no longer clipped from regions marked for
invalidation on its parent. Draws done on the parent
window are also no longer clipped by the child.
</para>
<para>
This call is only supported on some systems (currently,
only X11 with new enough Xcomposite and Xdamage extensions).
You must call <link linkend="gdk-display-supports-composite"><function>gdk_display_supports_composite()</function></link> to check if
setting a window as composited is supported before
attempting to do so.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>composited</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to set the window as composited
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gdk-window-move" role="function">
<title>gdk_window_move ()</title>
<indexterm zone="gdk-window-move"><primary sortas="window_move">gdk_window_move</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_move                     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Repositions a window relative to its parent window.
For toplevel windows, window managers may ignore or modify the move;
you should probably use <link linkend="gtk-window-move"><function>gtk_window_move()</function></link> on a <link linkend="GtkWindow"><type>GtkWindow</type></link> widget
anyway, instead of using GDK functions. For child windows,
the move will reliably succeed.
</para>
<para>
If you're also planning to resize the window, use <link linkend="gdk-window-move-resize"><function>gdk_window_move_resize()</function></link>
to both move and resize simultaneously, for a nicer visual effect.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X coordinate relative to window's parent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y coordinate relative to window's parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-resize" role="function">
<title>gdk_window_resize ()</title>
<indexterm zone="gdk-window-resize"><primary sortas="window_resize">gdk_window_resize</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_resize                   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Resizes <parameter>window</parameter>; for toplevel windows, asks the window manager to resize
the window. The window manager may not allow the resize. When using GTK+,
use <link linkend="gtk-window-resize"><function>gtk_window_resize()</function></link> instead of this low-level GDK function.
</para>
<para>
Windows may not be resized below 1x1.
</para>
<para>
If you're also planning to move the window, use <link linkend="gdk-window-move-resize"><function>gdk_window_move_resize()</function></link>
to both move and resize simultaneously, for a nicer visual effect.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> new width of the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> new height of the window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-move-resize" role="function">
<title>gdk_window_move_resize ()</title>
<indexterm zone="gdk-window-move-resize"><primary sortas="window_move_resize">gdk_window_move_resize</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_move_resize              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Equivalent to calling <link linkend="gdk-window-move"><function>gdk_window_move()</function></link> and <link linkend="gdk-window-resize"><function>gdk_window_resize()</function></link>,
except that both operations are performed at once, avoiding strange
visual effects. (i.e. the user may be able to see the window first
move, then resize, if you don't use <link linkend="gdk-window-move-resize"><function>gdk_window_move_resize()</function></link>.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> new X position relative to window's parent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> new Y position relative to window's parent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> new width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> new height
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-scroll" role="function">
<title>gdk_window_scroll ()</title>
<indexterm zone="gdk-window-scroll"><primary sortas="window_scroll">gdk_window_scroll</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_scroll                   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> dx,
                                                         <link linkend="gint">gint</link> dy);</programlisting>
<para>
Scroll the contents of its window, both pixels and children, by
the given amount. Portions of the window that the scroll operation
brings in from offscreen areas are invalidated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dx</parameter>&#160;:</term>
<listitem><simpara> Amount to scroll in the X direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dy</parameter>&#160;:</term>
<listitem><simpara> Amount to scroll in the Y direction
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-move-region" role="function" condition="since:2.8">
<title>gdk_window_move_region ()</title>
<indexterm zone="gdk-window-move-region" role="2.8"><primary sortas="window_move_region">gdk_window_move_region</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_move_region              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gint">gint</link> dx,
                                                         <link linkend="gint">gint</link> dy);</programlisting>
<para>
Move the part of <parameter>window</parameter> indicated by <parameter>region</parameter> by <parameter>dy</parameter> pixels in the Y 
direction and <parameter>dx</parameter> pixels in the X direction. The portions of <parameter>region</parameter> 
that not covered by the new position of <parameter>region</parameter> are invalidated.
</para>
<para>
Child windows are not moved.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>region</parameter>&#160;:</term>
<listitem><simpara> The <link linkend="GdkRegion"><type>GdkRegion</type></link> to move
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dx</parameter>&#160;:</term>
<listitem><simpara> Amount to move in the X direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dy</parameter>&#160;:</term>
<listitem><simpara> Amount to move in the Y direction
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.8</para></refsect2>
<refsect2 id="gdk-window-ensure-native" role="function" condition="since:2.18">
<title>gdk_window_ensure_native ()</title>
<indexterm zone="gdk-window-ensure-native" role="2.18"><primary sortas="window_ensure_native">gdk_window_ensure_native</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_ensure_native            (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Tries to ensure that there is a window-system native window for this
GdkWindow. This may fail in some situations, returning <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.
</para>
<para>
Offscreen window and children of them can never have native windows.
</para>
<para>
Some backends may not support native child windows.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window has a native window, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gdk-window-reparent" role="function">
<title>gdk_window_reparent ()</title>
<indexterm zone="gdk-window-reparent"><primary sortas="window_reparent">gdk_window_reparent</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_reparent                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *new_parent,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Reparents <parameter>window</parameter> into the given <parameter>new_parent</parameter>. The window being
reparented will be unmapped as a side effect.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_parent</parameter>&#160;:</term>
<listitem><simpara> new parent to move <parameter>window</parameter> into
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X location inside the new parent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y location inside the new parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-clear" role="function">
<title>gdk_window_clear ()</title>
<indexterm zone="gdk-window-clear"><primary sortas="window_clear">gdk_window_clear</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_clear                    (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Clears an entire <parameter>window</parameter> to the background color or background pixmap.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-clear-area" role="function">
<title>gdk_window_clear_area ()</title>
<indexterm zone="gdk-window-clear-area"><primary sortas="window_clear_area">gdk_window_clear_area</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_clear_area               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Clears an area of <parameter>window</parameter> to the background color or background pixmap.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> x coordinate of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> y coordinate of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> width of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> height of rectangle to clear
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-clear-area-e" role="function">
<title>gdk_window_clear_area_e ()</title>
<indexterm zone="gdk-window-clear-area-e"><primary sortas="window_clear_area_e">gdk_window_clear_area_e</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_clear_area_e             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Like <link linkend="gdk-window-clear-area"><function>gdk_window_clear_area()</function></link>, but also generates an expose event for
the cleared area.
</para>
<para>
This function has a stupid name because it dates back to the mists
time, pre-GDK-1.0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> x coordinate of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> y coordinate of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> width of rectangle to clear
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> height of rectangle to clear
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-copy-area" role="macro" condition="deprecated:">
<title>gdk_window_copy_area()</title>
<indexterm zone="gdk-window-copy-area" role="deprecated"><primary sortas="window_copy_area">gdk_window_copy_area</primary></indexterm><programlisting>#define             gdk_window_copy_area(drawable,gc,x,y,source_drawable,source_x,source_y,width,height)</programlisting>
<warning><para><literal>gdk_window_copy_area</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent to <link linkend="gdk-draw-drawable"><function>gdk_draw_drawable()</function></link>, see that function for docs
</para><variablelist role="params">
<varlistentry><term><parameter>drawable</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GdkDrawable"><type>GdkDrawable</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gc</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GdkGC"><type>GdkGC</type></link> sharing the drawable's visual and colormap
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara>X position in <parameter>drawable</parameter> where the rectangle should be drawn
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara>Y position in <parameter>drawable</parameter> where the rectangle should be drawn
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source_drawable</parameter>&#160;:</term>
<listitem><simpara>the source <link linkend="GdkDrawable"><type>GdkDrawable</type></link>, which may be the same as <parameter>drawable</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source_x</parameter>&#160;:</term>
<listitem><simpara>X position in <parameter>src</parameter> of rectangle to draw
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source_y</parameter>&#160;:</term>
<listitem><simpara>Y position in <parameter>src</parameter> of rectangle to draw
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara>width of rectangle to draw, or -1 for entire <parameter>src</parameter> width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara>height of rectangle to draw, or -1 for entire <parameter>src</parameter> height
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-raise" role="function">
<title>gdk_window_raise ()</title>
<indexterm zone="gdk-window-raise"><primary sortas="window_raise">gdk_window_raise</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_raise                    (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Raises <parameter>window</parameter> to the top of the Z-order (stacking order), so that
other windows with the same parent window appear below <parameter>window</parameter>.
This is true whether or not the windows are visible.
</para>
<para>
If <parameter>window</parameter> is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, <link linkend="gdk-window-raise"><function>gdk_window_raise()</function></link> only
requests the restack, does not guarantee it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-lower" role="function">
<title>gdk_window_lower ()</title>
<indexterm zone="gdk-window-lower"><primary sortas="window_lower">gdk_window_lower</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_lower                    (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Lowers <parameter>window</parameter> to the bottom of the Z-order (stacking order), so that
other windows with the same parent window appear above <parameter>window</parameter>.
This is true whether or not the other windows are visible.
</para>
<para>
If <parameter>window</parameter> is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, <link linkend="gdk-window-lower"><function>gdk_window_lower()</function></link> only
requests the restack, does not guarantee it.
</para>
<para>
Note that <link linkend="gdk-window-show"><function>gdk_window_show()</function></link> raises the window again, so don't call this
function before <link linkend="gdk-window-show"><function>gdk_window_show()</function></link>. (Try <link linkend="gdk-window-show-unraised"><function>gdk_window_show_unraised()</function></link>.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-focus" role="function">
<title>gdk_window_focus ()</title>
<indexterm zone="gdk-window-focus"><primary sortas="window_focus">gdk_window_focus</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_focus                    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="guint32">guint32</link> timestamp);</programlisting>
<para>
Sets keyboard focus to <parameter>window</parameter>. In most cases, <link linkend="gtk-window-present"><function>gtk_window_present()</function></link> 
should be used on a <link linkend="GtkWindow"><type>GtkWindow</type></link>, rather than calling this function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timestamp</parameter>&#160;:</term>
<listitem><simpara> timestamp of the event triggering the window focus
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-register-dnd" role="function">
<title>gdk_window_register_dnd ()</title>
<indexterm zone="gdk-window-register-dnd"><primary sortas="window_register_dnd">gdk_window_register_dnd</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_register_dnd             (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Registers a window as a potential drop destination.
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="GdkWindow"><type>GdkWindow</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-begin-resize-drag" role="function">
<title>gdk_window_begin_resize_drag ()</title>
<indexterm zone="gdk-window-begin-resize-drag"><primary sortas="window_begin_resize_drag">gdk_window_begin_resize_drag</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_begin_resize_drag        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindowEdge">GdkWindowEdge</link> edge,
                                                         <link linkend="gint">gint</link> button,
                                                         <link linkend="gint">gint</link> root_x,
                                                         <link linkend="gint">gint</link> root_y,
                                                         <link linkend="guint32">guint32</link> timestamp);</programlisting>
<para>
Begins a window resize operation (for a toplevel window).
You might use this function to implement a "window resize grip," for
example; in fact <link linkend="GtkStatusbar"><type>GtkStatusbar</type></link> uses it. The function works best
with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a 
fallback implementation for other window managers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>edge</parameter>&#160;:</term>
<listitem><simpara> the edge or corner from which the drag is started
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button</parameter>&#160;:</term>
<listitem><simpara> the button being used to drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_x</parameter>&#160;:</term>
<listitem><simpara> root window X coordinate of mouse click that began the drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_y</parameter>&#160;:</term>
<listitem><simpara> root window Y coordinate of mouse click that began the drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timestamp</parameter>&#160;:</term>
<listitem><simpara> timestamp of mouse click that began the drag (use <link linkend="gdk-event-get-time"><function>gdk_event_get_time()</function></link>)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-begin-move-drag" role="function">
<title>gdk_window_begin_move_drag ()</title>
<indexterm zone="gdk-window-begin-move-drag"><primary sortas="window_begin_move_drag">gdk_window_begin_move_drag</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_begin_move_drag          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> button,
                                                         <link linkend="gint">gint</link> root_x,
                                                         <link linkend="gint">gint</link> root_y,
                                                         <link linkend="guint32">guint32</link> timestamp);</programlisting>
<para>
Begins a window move operation (for a toplevel window).  You might
use this function to implement a "window move grip," for
example. The function works best with window managers that support
the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended 
Window Manager Hints</ulink>, but has a fallback implementation for
other window managers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button</parameter>&#160;:</term>
<listitem><simpara> the button being used to drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_x</parameter>&#160;:</term>
<listitem><simpara> root window X coordinate of mouse click that began the drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_y</parameter>&#160;:</term>
<listitem><simpara> root window Y coordinate of mouse click that began the drag
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timestamp</parameter>&#160;:</term>
<listitem><simpara> timestamp of mouse click that began the drag
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-constrain-size" role="function">
<title>gdk_window_constrain_size ()</title>
<indexterm zone="gdk-window-constrain-size"><primary sortas="window_constrain_size">gdk_window_constrain_size</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_constrain_size           (<link linkend="GdkGeometry">GdkGeometry</link> *geometry,
                                                         <link linkend="guint">guint</link> flags,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height,
                                                         <link linkend="gint">gint</link> *new_width,
                                                         <link linkend="gint">gint</link> *new_height);</programlisting>
<para>
Constrains a desired width and height according to a
set of geometry hints (such as minimum and maximum size).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>geometry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkGeometry"><type>GdkGeometry</type></link> structure
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
<listitem><simpara> a mask indicating what portions of <parameter>geometry</parameter> are set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> desired width of window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> desired height of the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_width</parameter>&#160;:</term>
<listitem><simpara> location to store resulting width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_height</parameter>&#160;:</term>
<listitem><simpara> location to store resulting height
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-beep" role="function" condition="since:2.12">
<title>gdk_window_beep ()</title>
<indexterm zone="gdk-window-beep" role="2.12"><primary sortas="window_beep">gdk_window_beep</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_beep                     (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Emits a short beep associated to <parameter>window</parameter> in the appropriate
display, if supported. Otherwise, emits a short beep on
the display just as <link linkend="gdk-display-beep"><function>gdk_display_beep()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gdk-window-begin-paint-rect" role="function">
<title>gdk_window_begin_paint_rect ()</title>
<indexterm zone="gdk-window-begin-paint-rect"><primary sortas="window_begin_paint_rect">gdk_window_begin_paint_rect</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_begin_paint_rect         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRectangle">GdkRectangle</link> *rectangle);</programlisting>
<para>
A convenience wrapper around <link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> which
creates a rectangular region for you. See
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
<listitem><simpara> rectangle you intend to draw to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-begin-paint-region" role="function">
<title>gdk_window_begin_paint_region ()</title>
<indexterm zone="gdk-window-begin-paint-region"><primary sortas="window_begin_paint_region">gdk_window_begin_paint_region</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_begin_paint_region       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region);</programlisting>
<para>
Indicates that you are beginning the process of redrawing <parameter>region</parameter>.
A backing store (offscreen buffer) large enough to contain <parameter>region</parameter>
will be created. The backing store will be initialized with the
background color or background pixmap for <parameter>window</parameter>. Then, all
drawing operations performed on <parameter>window</parameter> will be diverted to the
backing store.  When you call <link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link>, the backing
store will be copied to <parameter>window</parameter>, making it visible onscreen. Only
the part of <parameter>window</parameter> contained in <parameter>region</parameter> will be modified; that is,
drawing operations are clipped to <parameter>region</parameter>.
</para>
<para>
The net result of all this is to remove flicker, because the user
sees the finished product appear all at once when you call
<link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link>. If you draw to <parameter>window</parameter> directly without
calling <link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link>, the user may see flicker
as individual drawing operations are performed in sequence.  The
clipping and background-initializing features of
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> are conveniences for the
programmer, so you can avoid doing that work yourself.
</para>
<para>
When using GTK+, the widget system automatically places calls to
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> and <link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link> around
emissions of the expose_event signal. That is, if you're writing an
expose event handler, you can assume that the exposed area in
<link linkend="GdkEventExpose"><type>GdkEventExpose</type></link> has already been cleared to the window background,
is already set as the clip region, and already has a backing store.
Therefore in most cases, application code need not call
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link>. (You can disable the automatic
calls around expose events on a widget-by-widget basis by calling
<link linkend="gtk-widget-set-double-buffered"><function>gtk_widget_set_double_buffered()</function></link>.)
</para>
<para>
If you call this function multiple times before calling the
matching <link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link>, the backing stores are pushed onto
a stack. <link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link> copies the topmost backing store
onscreen, subtracts the topmost region from all other regions in
the stack, and pops the stack. All drawing operations affect only
the topmost backing store in the stack. One matching call to
<link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link> is required for each call to
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>region</parameter>&#160;:</term>
<listitem><simpara> region you intend to draw to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-end-paint" role="function">
<title>gdk_window_end_paint ()</title>
<indexterm zone="gdk-window-end-paint"><primary sortas="window_end_paint">gdk_window_end_paint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_end_paint                (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Indicates that the backing store created by the most recent call to
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> should be copied onscreen and
deleted, leaving the next-most-recent backing store or no backing
store at all as the active paint region. See
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> for full details. It is an error to
call this function without a matching
<link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> first.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-invalidate-rect" role="function">
<title>gdk_window_invalidate_rect ()</title>
<indexterm zone="gdk-window-invalidate-rect"><primary sortas="window_invalidate_rect">gdk_window_invalidate_rect</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_invalidate_rect          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRectangle">GdkRectangle</link> *rect,
                                                         <link linkend="gboolean">gboolean</link> invalidate_children);</programlisting>
<para>
A convenience wrapper around <link linkend="gdk-window-invalidate-region"><function>gdk_window_invalidate_region()</function></link> which
invalidates a rectangular region. See
<link linkend="gdk-window-invalidate-region"><function>gdk_window_invalidate_region()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rect</parameter>&#160;:</term>
<listitem><simpara> rectangle to invalidate or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to invalidate the whole
     window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>invalidate_children</parameter>&#160;:</term>
<listitem><simpara> whether to also invalidate child windows
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-invalidate-region" role="function">
<title>gdk_window_invalidate_region ()</title>
<indexterm zone="gdk-window-invalidate-region"><primary sortas="window_invalidate_region">gdk_window_invalidate_region</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_invalidate_region        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gboolean">gboolean</link> invalidate_children);</programlisting>
<para>
Adds <parameter>region</parameter> to the update area for <parameter>window</parameter>. The update area is the
region that needs to be redrawn, or "dirty region." The call
<link linkend="gdk-window-process-updates"><function>gdk_window_process_updates()</function></link> sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of <parameter>window</parameter> in
response to those expose events.
</para>
<para>
GDK will call <link linkend="gdk-window-process-all-updates"><function>gdk_window_process_all_updates()</function></link> on your behalf
whenever your program returns to the main loop and becomes idle, so
normally there's no need to do that manually, you just need to
invalidate regions that you know should be redrawn.
</para>
<para>
The <parameter>invalidate_children</parameter> parameter controls whether the region of
each child window that intersects <parameter>region</parameter> will also be invalidated.
If <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, then the update area for child windows will remain
unaffected. See gdk_window_invalidate_maybe_recurse if you need
fine grained control over which children are invalidated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>region</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkRegion"><type>GdkRegion</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>invalidate_children</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to also invalidate child windows
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-invalidate-maybe-recurse" role="function">
<title>gdk_window_invalidate_maybe_recurse ()</title>
<indexterm zone="gdk-window-invalidate-maybe-recurse"><primary sortas="window_invalidate_maybe_recurse">gdk_window_invalidate_maybe_recurse</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_invalidate_maybe_recurse (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *region,
                                                         <link linkend="gboolean">gboolean</link> (child_funcGdkWindow *, gpointer) (),
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Adds <parameter>region</parameter> to the update area for <parameter>window</parameter>. The update area is the
region that needs to be redrawn, or "dirty region." The call
<link linkend="gdk-window-process-updates"><function>gdk_window_process_updates()</function></link> sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of <parameter>window</parameter> in
response to those expose events.
</para>
<para>
GDK will call <link linkend="gdk-window-process-all-updates"><function>gdk_window_process_all_updates()</function></link> on your behalf
whenever your program returns to the main loop and becomes idle, so
normally there's no need to do that manually, you just need to
invalidate regions that you know should be redrawn.
</para>
<para>
The <parameter>child_func</parameter> parameter controls whether the region of
each child window that intersects <parameter>region</parameter> will also be invalidated.
Only children for which <parameter>child_func</parameter> returns TRUE will have the area
invalidated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>region</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkRegion"><type>GdkRegion</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child_func</parameter>&#160;:</term>
<listitem><simpara> function to use to decide if to recurse to a child,
             <link linkend="NULL--CAPS"><literal>NULL</literal></link> means never recurse.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara> data passed to <parameter>child_func</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-update-area" role="function">
<title>gdk_window_get_update_area ()</title>
<indexterm zone="gdk-window-get-update-area"><primary sortas="window_get_update_area">gdk_window_get_update_area</primary></indexterm><programlisting><link linkend="GdkRegion">GdkRegion</link> *         gdk_window_get_update_area          (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Transfers ownership of the update area from <parameter>window</parameter> to the caller
of the function. That is, after calling this function, <parameter>window</parameter> will
no longer have an invalid/dirty region; the update area is removed
from <parameter>window</parameter> and handed to you. If a window has no update area,
<link linkend="gdk-window-get-update-area"><function>gdk_window_get_update_area()</function></link> returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>. You are responsible for
calling <link linkend="gdk-region-destroy"><function>gdk_region_destroy()</function></link> on the returned region if it's non-<link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the update area for <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-freeze-updates" role="function">
<title>gdk_window_freeze_updates ()</title>
<indexterm zone="gdk-window-freeze-updates"><primary sortas="window_freeze_updates">gdk_window_freeze_updates</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_freeze_updates           (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Temporarily freezes a window such that it won't receive expose
events.  The window will begin receiving expose events again when
<link linkend="gdk-window-thaw-updates"><function>gdk_window_thaw_updates()</function></link> is called. If <link linkend="gdk-window-freeze-updates"><function>gdk_window_freeze_updates()</function></link>
has been called more than once, <link linkend="gdk-window-thaw-updates"><function>gdk_window_thaw_updates()</function></link> must be called
an equal number of times to begin processing exposes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-thaw-updates" role="function">
<title>gdk_window_thaw_updates ()</title>
<indexterm zone="gdk-window-thaw-updates"><primary sortas="window_thaw_updates">gdk_window_thaw_updates</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_thaw_updates             (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Thaws a window frozen with <link linkend="gdk-window-freeze-updates"><function>gdk_window_freeze_updates()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-process-all-updates" role="function">
<title>gdk_window_process_all_updates ()</title>
<indexterm zone="gdk-window-process-all-updates"><primary sortas="window_process_all_updates">gdk_window_process_all_updates</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_process_all_updates      (void);</programlisting>
<para>
Calls <link linkend="gdk-window-process-updates"><function>gdk_window_process_updates()</function></link> for all windows (see <link linkend="GdkWindow"><type>GdkWindow</type></link>)
in the application.</para>
<para>
</para></refsect2>
<refsect2 id="gdk-window-process-updates" role="function">
<title>gdk_window_process_updates ()</title>
<indexterm zone="gdk-window-process-updates"><primary sortas="window_process_updates">gdk_window_process_updates</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_process_updates          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> update_children);</programlisting>
<para>
Sends one or more expose events to <parameter>window</parameter>. The areas in each
expose event will cover the entire update area for the window (see
<link linkend="gdk-window-invalidate-region"><function>gdk_window_invalidate_region()</function></link> for details). Normally GDK calls
<link linkend="gdk-window-process-all-updates"><function>gdk_window_process_all_updates()</function></link> on your behalf, so there's no
need to call this function unless you want to force expose events
to be delivered immediately and synchronously (vs. the usual
case, where GDK delivers them in an idle handler). Occasionally
this is useful to produce nicer scrolling behavior, for example.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>update_children</parameter>&#160;:</term>
<listitem><simpara> whether to also process updates for child windows
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-debug-updates" role="function">
<title>gdk_window_set_debug_updates ()</title>
<indexterm zone="gdk-window-set-debug-updates"><primary sortas="window_set_debug_updates">gdk_window_set_debug_updates</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_debug_updates        (<link linkend="gboolean">gboolean</link> setting);</programlisting>
<para>
With update debugging enabled, calls to
<link linkend="gdk-window-invalidate-region"><function>gdk_window_invalidate_region()</function></link> clear the invalidated region of the
screen to a noticeable color, and GDK pauses for a short time
before sending exposes to windows during
<link linkend="gdk-window-process-updates"><function>gdk_window_process_updates()</function></link>.  The net effect is that you can see
the invalid region for each window and watch redraws as they
occur. This allows you to diagnose inefficiencies in your application.
</para>
<para>
In essence, because the GDK rendering model prevents all flicker,
if you are redrawing the same region 400 times you may never
notice, aside from noticing a speed problem. Enabling update
debugging causes GTK to flicker slowly and noticeably, so you can
see exactly what's being redrawn when, in what order.
</para>
<para>
The --gtk-debug=updates command line option passed to GTK+ programs
enables this debug option at application startup time. That's
usually more useful than calling <link linkend="gdk-window-set-debug-updates"><function>gdk_window_set_debug_updates()</function></link>
yourself, though you might want to use this function to enable
updates sometime after application startup time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to turn on update debugging
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-internal-paint-info" role="function">
<title>gdk_window_get_internal_paint_info ()</title>
<indexterm zone="gdk-window-get-internal-paint-info"><primary sortas="window_get_internal_paint_info">gdk_window_get_internal_paint_info</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_internal_paint_info  (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkDrawable">GdkDrawable</link> **real_drawable,
                                                         <link linkend="gint">gint</link> *x_offset,
                                                         <link linkend="gint">gint</link> *y_offset);</programlisting>
<para>
If you bypass the GDK layer and use windowing system primitives to
draw directly onto a <link linkend="GdkWindow"><type>GdkWindow</type></link>, then you need to deal with two
details: there may be an offset between GDK coordinates and windowing
system coordinates, and GDK may have redirected drawing to a offscreen
pixmap as the result of a <link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> calls.
This function allows retrieving the information you need to compensate
for these effects.
</para>
<para>
This function exposes details of the GDK implementation, and is thus
likely to change in future releases of GDK.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>real_drawable</parameter>&#160;:</term>
<listitem><simpara> location to store the drawable to which drawing should be
           done.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x_offset</parameter>&#160;:</term>
<listitem><simpara> location to store the X offset between coordinates in <parameter>window</parameter>,
           and the underlying window system primitive coordinates for
           *<parameter>real_drawable</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y_offset</parameter>&#160;:</term>
<listitem><simpara> location to store the Y offset between coordinates in <parameter>window</parameter>,
           and the underlying window system primitive coordinates for
           *<parameter>real_drawable</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-enable-synchronized-configure" role="function" condition="since:2.6">
<title>gdk_window_enable_synchronized_configure ()</title>
<indexterm zone="gdk-window-enable-synchronized-configure" role="2.6"><primary sortas="window_enable_synchronized_configure">gdk_window_enable_synchronized_configure</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_enable_synchronized_configure
                                                        (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Indicates that the application will cooperate with the window
system in synchronizing the window repaint with the window
manager during resizing operations. After an application calls
this function, it must call <link linkend="gdk-window-configure-finished"><function>gdk_window_configure_finished()</function></link> every
time it has finished all processing associated with a set of
Configure events. Toplevel GTK+ windows automatically use this
protocol.
</para>
<para>
On X, calling this function makes <parameter>window</parameter> participate in the
_NET_WM_SYNC_REQUEST window manager protocol.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6</para></refsect2>
<refsect2 id="gdk-window-configure-finished" role="function" condition="since:2.6">
<title>gdk_window_configure_finished ()</title>
<indexterm zone="gdk-window-configure-finished" role="2.6"><primary sortas="window_configure_finished">gdk_window_configure_finished</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_configure_finished       (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Signal to the window system that the application has finished
handling Configure events it has received. Window Managers can
use this to better synchronize the frame repaint with the
application. GTK+ applications will automatically call this
function when appropriate.
</para>
<para>
This function can only be called if <link linkend="gdk-window-enable-synchronized-configure"><function>gdk_window_enable_synchronized_configure()</function></link>
was called previously.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6</para></refsect2>
<refsect2 id="gdk-window-set-user-data" role="function">
<title>gdk_window_set_user_data ()</title>
<indexterm zone="gdk-window-set-user-data"><primary sortas="window_set_user_data">gdk_window_set_user_data</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_user_data            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
For most purposes this function is deprecated in favor of
<link linkend="g-object-set-data"><function>g_object_set_data()</function></link>. However, for historical reasons GTK+ stores
the <link linkend="GtkWidget"><type>GtkWidget</type></link> that owns a <link linkend="GdkWindow"><type>GdkWindow</type></link> as user data on the
<link linkend="GdkWindow"><type>GdkWindow</type></link>. So, custom widget implementations should use
this function for that. If GTK+ receives an event for a <link linkend="GdkWindow"><type>GdkWindow</type></link>,
and the user data for the window is non-<link linkend="NULL--CAPS"><literal>NULL</literal></link>, GTK+ will assume the
user data is a <link linkend="GtkWidget"><type>GtkWidget</type></link>, and forward the event to that widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara> user data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-override-redirect" role="function">
<title>gdk_window_set_override_redirect ()</title>
<indexterm zone="gdk-window-set-override-redirect"><primary sortas="window_set_override_redirect">gdk_window_set_override_redirect</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_override_redirect    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> override_redirect);</programlisting>
<para>
An override redirect window is not under the control of the window manager.
This means it won't have a titlebar, won't be minimizable, etc. - it will
be entirely under the control of the application. The window manager
can't see the override redirect window at all.
</para>
<para>
Override redirect should only be used for short-lived temporary
windows, such as popup menus. <link linkend="GtkMenu"><type>GtkMenu</type></link> uses an override redirect
window in its implementation, for example.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>override_redirect</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if window should be override redirect
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-accept-focus" role="function" condition="since:2.4">
<title>gdk_window_set_accept_focus ()</title>
<indexterm zone="gdk-window-set-accept-focus" role="2.4"><primary sortas="window_set_accept_focus">gdk_window_set_accept_focus</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_accept_focus         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> accept_focus);</programlisting>
<para>
Setting <parameter>accept_focus</parameter> to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> hints the desktop environment that the
window doesn't want to receive input focus. 
</para>
<para>
On X, it is the responsibility of the window manager to interpret this 
hint. ICCCM-compliant window manager usually respect it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>accept_focus</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window should receive input focus
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gdk-window-set-focus-on-map" role="function" condition="since:2.6">
<title>gdk_window_set_focus_on_map ()</title>
<indexterm zone="gdk-window-set-focus-on-map" role="2.6"><primary sortas="window_set_focus_on_map">gdk_window_set_focus_on_map</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_focus_on_map         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> focus_on_map);</programlisting>
<para>
Setting <parameter>focus_on_map</parameter> to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> hints the desktop environment that the
window doesn't want to receive input focus when it is mapped.  
focus_on_map should be turned off for windows that aren't triggered
interactively (such as popups from network activity).
</para>
<para>
On X, it is the responsibility of the window manager to interpret
this hint. Window managers following the freedesktop.org window
manager extension specification should respect it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>focus_on_map</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window should receive input focus when mapped
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6</para></refsect2>
<refsect2 id="gdk-window-add-filter" role="function">
<title>gdk_window_add_filter ()</title>
<indexterm zone="gdk-window-add-filter"><primary sortas="window_add_filter">gdk_window_add_filter</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_add_filter               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkFilterFunc">GdkFilterFunc</link> function,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Adds an event filter to <parameter>window</parameter>, allowing you to intercept events
before they reach GDK. This is a low-level operation and makes it
easy to break GDK and/or GTK+, so you have to know what you're
doing. Pass <link linkend="NULL--CAPS"><literal>NULL</literal></link> for <parameter>window</parameter> to get all events for all windows,
instead of events for a specific window.
</para>
<para>
See <link linkend="gdk-display-add-client-message-filter"><function>gdk_display_add_client_message_filter()</function></link> if you are interested
in X ClientMessage events.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>function</parameter>&#160;:</term>
<listitem><simpara> filter callback
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara> data to pass to filter callback
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-remove-filter" role="function">
<title>gdk_window_remove_filter ()</title>
<indexterm zone="gdk-window-remove-filter"><primary sortas="window_remove_filter">gdk_window_remove_filter</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_remove_filter            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkFilterFunc">GdkFilterFunc</link> function,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Remove a filter previously added with <link linkend="gdk-window-add-filter"><function>gdk_window_add_filter()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>function</parameter>&#160;:</term>
<listitem><simpara> previously-added filter function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara> user data for previously-added filter function
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkFilterFunc" role="function">
<title>GdkFilterFunc ()</title>
<indexterm zone="GdkFilterFunc"><primary sortas="FilterFunc">GdkFilterFunc</primary></indexterm><programlisting><link linkend="GdkFilterReturn">GdkFilterReturn</link>     (*GdkFilterFunc)                    (<link linkend="GdkXEvent">GdkXEvent</link> *xevent,
                                                         <link linkend="GdkEvent">GdkEvent</link> *event,
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Specifies the type of function used to filter native events before they are
converted to GDK events.
</para>
<para>
When a filter is called, <parameter>event</parameter> is unpopulated, except for
<literal>event-&gt;window</literal>. The filter may translate the native
event to a GDK event and store the result in <parameter>event</parameter>, or handle it without
translation. If the filter translates the event and processing should
continue, it should return <literal>GDK_FILTER_TRANSLATE</literal>.
</para><variablelist role="params">
<varlistentry><term><parameter>xevent</parameter>&#160;:</term>
<listitem><simpara>the native event to filter.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event</parameter>&#160;:</term>
<listitem><simpara>the GDK event to which the X event will be translated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>user data set when the filter was installed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a <link linkend="GdkFilterReturn"><type>GdkFilterReturn</type></link> value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkFilterReturn" role="enum">
<title>enum GdkFilterReturn</title>
<indexterm zone="GdkFilterReturn"><primary sortas="FilterReturn">GdkFilterReturn</primary></indexterm><programlisting>typedef enum {
  GDK_FILTER_CONTINUE,	  /* Event not handled, continue processesing */
  GDK_FILTER_TRANSLATE,	  /* Native event translated into a GDK event and
                             stored in the "event" structure that was
                             passed in */
  GDK_FILTER_REMOVE	  /* Terminate processing, removing event */
} GdkFilterReturn;
</programlisting>
<para>
Specifies the result of applying a <link linkend="GdkFilterFunc"><type>GdkFilterFunc</type></link> to a native event.
</para><variablelist role="enum">
<varlistentry id="GDK-FILTER-CONTINUE--CAPS" role="constant">
<term><literal>GDK_FILTER_CONTINUE</literal></term>
<listitem><simpara>event not handled, continue processing.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FILTER-TRANSLATE--CAPS" role="constant">
<term><literal>GDK_FILTER_TRANSLATE</literal></term>
<listitem><simpara>native event translated into a GDK event and stored
                       in the <literal>event</literal> structure that was passed in.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FILTER-REMOVE--CAPS" role="constant">
<term><literal>GDK_FILTER_REMOVE</literal></term>
<listitem><simpara>event handled, terminate processing.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkXEvent" role="typedef">
<title>GdkXEvent</title>
<indexterm zone="GdkXEvent"><primary sortas="XEvent">GdkXEvent</primary></indexterm><programlisting>typedef void GdkXEvent;	  /* Can be cast to window system specific
</programlisting>
<para>
Used to represent native events (<type>XEvent</type>s for the X11
backend, <type>MSG</type>s for Win32).
</para></refsect2>
<refsect2 id="gdk-window-shape-combine-mask" role="function">
<title>gdk_window_shape_combine_mask ()</title>
<indexterm zone="gdk-window-shape-combine-mask"><primary sortas="window_shape_combine_mask">gdk_window_shape_combine_mask</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_shape_combine_mask       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Applies a shape mask to <parameter>window</parameter>. Pixels in <parameter>window</parameter> corresponding to
set bits in the <parameter>mask</parameter> will be visible; pixels in <parameter>window</parameter>
corresponding to unset bits in the <parameter>mask</parameter> will be transparent. This
gives a non-rectangular window.
</para>
<para>
If <parameter>mask</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the shape mask will be unset, and the <parameter>x</parameter>/<parameter>y</parameter>
parameters are not used.
</para>
<para>
On the X11 platform, this uses an X server extension which is
widely available on most common platforms, but not available on
very old X servers, and occasionally the implementation will be
buggy. On servers without the shape extension, this function
will do nothing.
</para>
<para>
This function works on both toplevel and child windows.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara> shape mask
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-shape-combine-region" role="function">
<title>gdk_window_shape_combine_region ()</title>
<indexterm zone="gdk-window-shape-combine-region"><primary sortas="window_shape_combine_region">gdk_window_shape_combine_region</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_shape_combine_region     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *shape_region,
                                                         <link linkend="gint">gint</link> offset_x,
                                                         <link linkend="gint">gint</link> offset_y);</programlisting>
<para>
Makes pixels in <parameter>window</parameter> outside <parameter>shape_region</parameter> be transparent,
so that the window may be nonrectangular. See also
<link linkend="gdk-window-shape-combine-mask"><function>gdk_window_shape_combine_mask()</function></link> to use a bitmap as the mask.
</para>
<para>
If <parameter>shape_region</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the shape will be unset, so the whole
window will be opaque again. <parameter>offset_x</parameter> and <parameter>offset_y</parameter> are ignored
if <parameter>shape_region</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</para>
<para>
On the X11 platform, this uses an X server extension which is
widely available on most common platforms, but not available on
very old X servers, and occasionally the implementation will be
buggy. On servers without the shape extension, this function
will do nothing.
</para>
<para>
This function works on both toplevel and child windows.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shape_region</parameter>&#160;:</term>
<listitem><simpara> region of window to be non-transparent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_x</parameter>&#160;:</term>
<listitem><simpara> X position of <parameter>shape_region</parameter> in <parameter>window</parameter> coordinates
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_y</parameter>&#160;:</term>
<listitem><simpara> Y position of <parameter>shape_region</parameter> in <parameter>window</parameter> coordinates
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-child-shapes" role="function">
<title>gdk_window_set_child_shapes ()</title>
<indexterm zone="gdk-window-set-child-shapes"><primary sortas="window_set_child_shapes">gdk_window_set_child_shapes</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_child_shapes         (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Sets the shape mask of <parameter>window</parameter> to the union of shape masks
for all children of <parameter>window</parameter>, ignoring the shape mask of <parameter>window</parameter>
itself. Contrast with <link linkend="gdk-window-merge-child-shapes"><function>gdk_window_merge_child_shapes()</function></link> which includes
the shape mask of <parameter>window</parameter> in the masks to be merged.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-merge-child-shapes" role="function">
<title>gdk_window_merge_child_shapes ()</title>
<indexterm zone="gdk-window-merge-child-shapes"><primary sortas="window_merge_child_shapes">gdk_window_merge_child_shapes</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_merge_child_shapes       (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Merges the shape masks for any child windows into the
shape mask for <parameter>window</parameter>. i.e. the union of all masks
for <parameter>window</parameter> and its children will become the new mask
for <parameter>window</parameter>. See <link linkend="gdk-window-shape-combine-mask"><function>gdk_window_shape_combine_mask()</function></link>.
</para>
<para>
This function is distinct from <link linkend="gdk-window-set-child-shapes"><function>gdk_window_set_child_shapes()</function></link>
because it includes <parameter>window</parameter>'s shape mask in the set of shapes to
be merged.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-input-shape-combine-mask" role="function" condition="since:2.10">
<title>gdk_window_input_shape_combine_mask ()</title>
<indexterm zone="gdk-window-input-shape-combine-mask" role="2.10"><primary sortas="window_input_shape_combine_mask">gdk_window_input_shape_combine_mask</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_input_shape_combine_mask (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Like <link linkend="gdk-window-shape-combine-mask"><function>gdk_window_shape_combine_mask()</function></link>, but the shape applies
only to event handling. Mouse events which happen while
the pointer position corresponds to an unset bit in the
mask will be passed on the window below <parameter>window</parameter>.
</para>
<para>
An input shape is typically used with RGBA windows.
The alpha channel of the window defines which pixels are
invisible and allows for nicely antialiased borders,
and the input shape controls where the window is
"clickable".
</para>
<para>
On the X11 platform, this requires version 1.1 of the
shape extension.
</para>
<para>
On the Win32 platform, this functionality is not present and the
function does nothing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara> shape mask, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X position of shape mask with respect to <parameter>window</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y position of shape mask with respect to <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gdk-window-input-shape-combine-region" role="function" condition="since:2.10">
<title>gdk_window_input_shape_combine_region ()</title>
<indexterm zone="gdk-window-input-shape-combine-region" role="2.10"><primary sortas="window_input_shape_combine_region">gdk_window_input_shape_combine_region</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_input_shape_combine_region
                                                        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkRegion">GdkRegion</link> *shape_region,
                                                         <link linkend="gint">gint</link> offset_x,
                                                         <link linkend="gint">gint</link> offset_y);</programlisting>
<para>
Like <link linkend="gdk-window-shape-combine-region"><function>gdk_window_shape_combine_region()</function></link>, but the shape applies
only to event handling. Mouse events which happen while
the pointer position corresponds to an unset bit in the
mask will be passed on the window below <parameter>window</parameter>.
</para>
<para>
An input shape is typically used with RGBA windows.
The alpha channel of the window defines which pixels are
invisible and allows for nicely antialiased borders,
and the input shape controls where the window is
"clickable".
</para>
<para>
On the X11 platform, this requires version 1.1 of the
shape extension.
</para>
<para>
On the Win32 platform, this functionality is not present and the
function does nothing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shape_region</parameter>&#160;:</term>
<listitem><simpara> region of window to be non-transparent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_x</parameter>&#160;:</term>
<listitem><simpara> X position of <parameter>shape_region</parameter> in <parameter>window</parameter> coordinates
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_y</parameter>&#160;:</term>
<listitem><simpara> Y position of <parameter>shape_region</parameter> in <parameter>window</parameter> coordinates
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gdk-window-set-child-input-shapes" role="function" condition="since:2.10">
<title>gdk_window_set_child_input_shapes ()</title>
<indexterm zone="gdk-window-set-child-input-shapes" role="2.10"><primary sortas="window_set_child_input_shapes">gdk_window_set_child_input_shapes</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_child_input_shapes   (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Sets the input shape mask of <parameter>window</parameter> to the union of input shape masks
for all children of <parameter>window</parameter>, ignoring the input shape mask of <parameter>window</parameter>
itself. Contrast with <link linkend="gdk-window-merge-child-input-shapes"><function>gdk_window_merge_child_input_shapes()</function></link> which includes
the input shape mask of <parameter>window</parameter> in the masks to be merged.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gdk-window-merge-child-input-shapes" role="function" condition="since:2.10">
<title>gdk_window_merge_child_input_shapes ()</title>
<indexterm zone="gdk-window-merge-child-input-shapes" role="2.10"><primary sortas="window_merge_child_input_shapes">gdk_window_merge_child_input_shapes</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_merge_child_input_shapes (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Merges the input shape masks for any child windows into the
input shape mask for <parameter>window</parameter>. i.e. the union of all input masks
for <parameter>window</parameter> and its children will become the new input mask
for <parameter>window</parameter>. See <link linkend="gdk-window-input-shape-combine-mask"><function>gdk_window_input_shape_combine_mask()</function></link>.
</para>
<para>
This function is distinct from <link linkend="gdk-window-set-child-input-shapes"><function>gdk_window_set_child_input_shapes()</function></link>
because it includes <parameter>window</parameter>'s input shape mask in the set of
shapes to be merged.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gdk-window-set-static-gravities" role="function">
<title>gdk_window_set_static_gravities ()</title>
<indexterm zone="gdk-window-set-static-gravities"><primary sortas="window_set_static_gravities">gdk_window_set_static_gravities</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_set_static_gravities     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> use_static);</programlisting>
<para>
Set the bit gravity of the given window to static, and flag it so
all children get static subwindow gravity. This is used if you are
implementing scary features that involve deep knowledge of the
windowing system. Don't worry about it unless you have to.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>use_static</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to turn on static gravity
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the server supports static gravity
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-hints" role="function" condition="deprecated:">
<title>gdk_window_set_hints ()</title>
<indexterm zone="gdk-window-set-hints" role="deprecated"><primary sortas="window_set_hints">gdk_window_set_hints</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_hints                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> min_width,
                                                         <link linkend="gint">gint</link> min_height,
                                                         <link linkend="gint">gint</link> max_width,
                                                         <link linkend="gint">gint</link> max_height,
                                                         <link linkend="gint">gint</link> flags);</programlisting>
<warning><para><literal>gdk_window_set_hints</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This function is broken and useless and you should ignore it.
If using GTK+, use functions such as <link linkend="gtk-window-resize"><function>gtk_window_resize()</function></link>, <link linkend="gtk-window-set-size-request"><function>gtk_window_set_size_request()</function></link>,
<link linkend="gtk-window-move"><function>gtk_window_move()</function></link>, <link linkend="gtk-window-parse-geometry"><function>gtk_window_parse_geometry()</function></link>, and <link linkend="gtk-window-set-geometry-hints"><function>gtk_window_set_geometry_hints()</function></link>,
depending on what you're trying to do.
</para>
<para>
If using GDK directly, use <link linkend="gdk-window-set-geometry-hints"><function>gdk_window_set_geometry_hints()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> ignored field, does not matter
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> ignored field, does not matter
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_width</parameter>&#160;:</term>
<listitem><simpara> minimum width hint
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_height</parameter>&#160;:</term>
<listitem><simpara> minimum height hint
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_width</parameter>&#160;:</term>
<listitem><simpara> max width hint
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_height</parameter>&#160;:</term>
<listitem><simpara> max height hint
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
<listitem><simpara> logical OR of GDK_HINT_POS, GDK_HINT_MIN_SIZE, and/or GDK_HINT_MAX_SIZE
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-title" role="function">
<title>gdk_window_set_title ()</title>
<indexterm zone="gdk-window-set-title"><primary sortas="window_set_title">gdk_window_set_title</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_title                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *title);</programlisting>
<para>
Sets the title of a toplevel window, to be displayed in the titlebar.
If you haven't explicitly set the icon name for the window
(using <link linkend="gdk-window-set-icon-name"><function>gdk_window_set_icon_name()</function></link>), the icon name will be set to
<parameter>title</parameter> as well. <parameter>title</parameter> must be in UTF-8 encoding (as with all
user-readable strings in GDK/GTK+). <parameter>title</parameter> may not be <link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter>&#160;:</term>
<listitem><simpara> title of <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-background" role="function">
<title>gdk_window_set_background ()</title>
<indexterm zone="gdk-window-set-background"><primary sortas="window_set_background">gdk_window_set_background</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_background           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkColor">GdkColor</link> *color);</programlisting>
<para>
Sets the background color of <parameter>window</parameter>. (However, when using GTK+,
set the background of a widget with <link linkend="gtk-widget-modify-bg"><function>gtk_widget_modify_bg()</function></link> - if
you're an application - or <link linkend="gtk-style-set-background"><function>gtk_style_set_background()</function></link> - if you're
implementing a custom widget.)
</para>
<para>
The <parameter>color</parameter> must be allocated; <link linkend="gdk-rgb-find-color"><function>gdk_rgb_find_color()</function></link> is the best way
to allocate a color.
</para>
<para>
See also <link linkend="gdk-window-set-back-pixmap"><function>gdk_window_set_back_pixmap()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter>&#160;:</term>
<listitem><simpara> an allocated <link linkend="GdkColor"><type>GdkColor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-back-pixmap" role="function">
<title>gdk_window_set_back_pixmap ()</title>
<indexterm zone="gdk-window-set-back-pixmap"><primary sortas="window_set_back_pixmap">gdk_window_set_back_pixmap</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_back_pixmap          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                                         <link linkend="gboolean">gboolean</link> parent_relative);</programlisting>
<para>
Sets the background pixmap of <parameter>window</parameter>. May also be used to set a
background of "None" on <parameter>window</parameter>, by setting a background pixmap
of <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</para>
<para>
A background pixmap will be tiled, positioning the first tile at
the origin of <parameter>window</parameter>, or if <parameter>parent_relative</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the tiling
will be done based on the origin of the parent window (useful to
align tiles in a parent with tiles in a child).
</para>
<para>
A background pixmap of <link linkend="NULL--CAPS"><literal>NULL</literal></link> means that the window will have no
background.  A window with no background will never have its
background filled by the windowing system, instead the window will
contain whatever pixels were already in the corresponding area of
the display.
</para>
<para>
The windowing system will normally fill a window with its background
when the window is obscured then exposed, and when you call
<link linkend="gdk-window-clear"><function>gdk_window_clear()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkPixmap"><type>GdkPixmap</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent_relative</parameter>&#160;:</term>
<listitem><simpara> whether the tiling origin is at the origin of
  <parameter>window</parameter>'s parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GDK-PARENT-RELATIVE--CAPS" role="macro">
<title>GDK_PARENT_RELATIVE</title>
<indexterm zone="GDK-PARENT-RELATIVE--CAPS"><primary sortas="PARENT_RELATIVE">GDK_PARENT_RELATIVE</primary></indexterm><programlisting>#define GDK_PARENT_RELATIVE  1L
</programlisting>
<para>
A special value for <literal>GdkPixmap*</literal> variables, indicating
that the background pixmap for a window should be inherited from the parent
window.
</para></refsect2>
<refsect2 id="gdk-window-set-cursor" role="function">
<title>gdk_window_set_cursor ()</title>
<indexterm zone="gdk-window-set-cursor"><primary sortas="window_set_cursor">gdk_window_set_cursor</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_cursor               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkCursor">GdkCursor</link> *cursor);</programlisting>
<para>
Sets the mouse pointer for a <link linkend="GdkWindow"><type>GdkWindow</type></link>. Use <link linkend="gdk-cursor-new-for-display"><function>gdk_cursor_new_for_display()</function></link>
or <link linkend="gdk-cursor-new-from-pixmap"><function>gdk_cursor_new_from_pixmap()</function></link> to create the cursor. To make the cursor
invisible, use <link linkend="GDK-BLANK-CURSOR--CAPS"><literal>GDK_BLANK_CURSOR</literal></link>. Passing <link linkend="NULL--CAPS"><literal>NULL</literal></link> for the <parameter>cursor</parameter> argument
to <link linkend="gdk-window-set-cursor"><function>gdk_window_set_cursor()</function></link> means that <parameter>window</parameter> will use the cursor of its
parent window. Most windows should use this default.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cursor</parameter>&#160;:</term>
<listitem><simpara> a cursor
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-colormap" role="macro" condition="deprecated:">
<title>gdk_window_set_colormap</title>
<indexterm zone="gdk-window-set-colormap" role="deprecated"><primary sortas="window_set_colormap">gdk_window_set_colormap</primary></indexterm><programlisting>#define gdk_window_set_colormap        gdk_drawable_set_colormap
</programlisting>
<warning><para><literal>gdk_window_set_colormap</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent to <link linkend="gdk-drawable-set-colormap"><function>gdk_drawable_set_colormap()</function></link>
</para></refsect2>
<refsect2 id="gdk-window-get-user-data" role="function">
<title>gdk_window_get_user_data ()</title>
<indexterm zone="gdk-window-get-user-data"><primary sortas="window_get_user_data">gdk_window_get_user_data</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_user_data            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gpointer">gpointer</link> *data);</programlisting>
<para>
Retrieves the user data for <parameter>window</parameter>, which is normally the widget
that <parameter>window</parameter> belongs to. See <link linkend="gdk-window-set-user-data"><function>gdk_window_set_user_data()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara> return location for user data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-geometry" role="function">
<title>gdk_window_get_geometry ()</title>
<indexterm zone="gdk-window-get-geometry"><primary sortas="window_get_geometry">gdk_window_get_geometry</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_geometry             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height,
                                                         <link linkend="gint">gint</link> *depth);</programlisting>
<para>
Any of the return location arguments to this function may be <link linkend="NULL--CAPS"><literal>NULL</literal></link>,
if you aren't interested in getting the value of that field.
</para>
<para>
The X and Y coordinates returned are relative to the parent window
of <parameter>window</parameter>, which for toplevels usually means relative to the
window decorations (titlebar, etc.) rather than relative to the
root window (screen-size background window).
</para>
<para>
On the X11 platform, the geometry is obtained from the X server,
so reflects the latest position of <parameter>window</parameter>; this may be out-of-sync
with the position of <parameter>window</parameter> delivered in the most-recently-processed
<link linkend="GdkEventConfigure"><type>GdkEventConfigure</type></link>. <link linkend="gdk-window-get-position"><function>gdk_window_get_position()</function></link> in contrast gets the
position from the most recent configure event.
</para>
<para>
<note>
If <parameter>window</parameter> is not a toplevel, it is <emphasis>much</emphasis> better
to call <link linkend="gdk-window-get-position"><function>gdk_window_get_position()</function></link> and <link linkend="gdk-drawable-get-size"><function>gdk_drawable_get_size()</function></link> instead,
because it avoids the roundtrip to the X server and because
<link linkend="gdk-drawable-get-size"><function>gdk_drawable_get_size()</function></link> supports the full 32-bit coordinate space,
whereas <link linkend="gdk-window-get-geometry"><function>gdk_window_get_geometry()</function></link> is restricted to the 16-bit
coordinates of X11.
</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> return location for X coordinate of window (relative to its parent)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> return location for Y coordinate of window (relative to its parent)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> return location for width of window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> return location for height of window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter>&#160;:</term>
<listitem><simpara> return location for bit depth of window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-geometry-hints" role="function">
<title>gdk_window_set_geometry_hints ()</title>
<indexterm zone="gdk-window-set-geometry-hints"><primary sortas="window_set_geometry_hints">gdk_window_set_geometry_hints</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_geometry_hints       (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="GdkGeometry">GdkGeometry</link> *geometry,
                                                         <link linkend="GdkWindowHints">GdkWindowHints</link> geom_mask);</programlisting>
<para>
Sets the geometry hints for <parameter>window</parameter>. Hints flagged in <parameter>geom_mask</parameter>
are set, hints not flagged in <parameter>geom_mask</parameter> are unset.
To unset all hints, use a <parameter>geom_mask</parameter> of 0 and a <parameter>geometry</parameter> of <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</para>
<para>
This function provides hints to the windowing system about
acceptable sizes for a toplevel window. The purpose of 
this is to constrain user resizing, but the windowing system
will typically  (but is not required to) also constrain the
current size of the window to the provided values and
constrain programatic resizing via <link linkend="gdk-window-resize"><function>gdk_window_resize()</function></link> or
<link linkend="gdk-window-move-resize"><function>gdk_window_move_resize()</function></link>.
</para>
<para>
Note that on X11, this effect has no effect on windows
of type <link linkend="GDK-WINDOW-TEMP--CAPS"><literal>GDK_WINDOW_TEMP</literal></link> or windows where override redirect
has been turned on via <link linkend="gdk-window-set-override-redirect"><function>gdk_window_set_override_redirect()</function></link>
since these windows are not resizable by the user.
</para>
<para>
Since you can't count on the windowing system doing the
constraints for programmatic resizes, you should generally
call <link linkend="gdk-window-constrain-size"><function>gdk_window_constrain_size()</function></link> yourself to determine
appropriate sizes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>geometry</parameter>&#160;:</term>
<listitem><simpara> geometry hints
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>geom_mask</parameter>&#160;:</term>
<listitem><simpara> bitmask indicating fields of <parameter>geometry</parameter> to pay attention to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-icon-list" role="function">
<title>gdk_window_set_icon_list ()</title>
<indexterm zone="gdk-window-set-icon-list"><primary sortas="window_set_icon_list">gdk_window_set_icon_list</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_icon_list            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GList">GList</link> *pixbufs);</programlisting>
<para>
Sets a list of icons for the window. One of these will be used
to represent the window when it has been iconified. The icon is
usually shown in an icon box or some sort of task bar. Which icon
size is shown depends on the window manager. The window manager
can scale the icon  but setting several size icons can give better
image quality since the window manager may only need to scale the
icon by a small amount or not at all.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> The <link linkend="GdkWindow"><type>GdkWindow</type></link> toplevel window to set the icon of.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbufs</parameter>&#160;:</term>
<listitem><simpara> A list of pixbufs, of different sizes.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-modal-hint" role="function">
<title>gdk_window_set_modal_hint ()</title>
<indexterm zone="gdk-window-set-modal-hint"><primary sortas="window_set_modal_hint">gdk_window_set_modal_hint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_modal_hint           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> modal);</programlisting>
<para>
The application can use this hint to tell the window manager
that a certain window has modal behaviour. The window manager
can use this information to handle modal windows in a special
way.
</para>
<para>
You should only use this on windows for which you have
previously called <link linkend="gdk-window-set-transient-for"><function>gdk_window_set_transient_for()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> A toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>modal</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window is modal, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-type-hint" role="function">
<title>gdk_window_set_type_hint ()</title>
<indexterm zone="gdk-window-set-type-hint"><primary sortas="window_set_type_hint">gdk_window_set_type_hint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_type_hint            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link> hint);</programlisting>
<para>
The application can use this call to provide a hint to the window
manager about the functionality of a window. The window manager
can use this information when determining the decoration and behaviour
of the window.
</para>
<para>
The hint must be set before the window is mapped.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> A toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hint</parameter>&#160;:</term>
<listitem><simpara> A hint of the function this window will have
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-type-hint" role="function" condition="since:2.10">
<title>gdk_window_get_type_hint ()</title>
<indexterm zone="gdk-window-get-type-hint" role="2.10"><primary sortas="window_get_type_hint">gdk_window_get_type_hint</primary></indexterm><programlisting><link linkend="GdkWindowTypeHint">GdkWindowTypeHint</link>   gdk_window_get_type_hint            (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
This function returns the type hint set for a window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> A toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The type hint set for <parameter>window</parameter>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gdk-window-set-skip-taskbar-hint" role="function" condition="since:2.2">
<title>gdk_window_set_skip_taskbar_hint ()</title>
<indexterm zone="gdk-window-set-skip-taskbar-hint" role="2.2"><primary sortas="window_set_skip_taskbar_hint">gdk_window_set_skip_taskbar_hint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_skip_taskbar_hint    (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> skips_taskbar);</programlisting>
<para>
Toggles whether a window should appear in a task list or window
list. If a window's semantic type as specified with
<link linkend="gdk-window-set-type-hint"><function>gdk_window_set_type_hint()</function></link> already fully describes the window, this
function should <emphasis>not</emphasis> be called in addition, 
instead you should allow the window to be treated according to 
standard policy for its semantic type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>skips_taskbar</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to skip the taskbar
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2</para></refsect2>
<refsect2 id="gdk-window-set-skip-pager-hint" role="function" condition="since:2.2">
<title>gdk_window_set_skip_pager_hint ()</title>
<indexterm zone="gdk-window-set-skip-pager-hint" role="2.2"><primary sortas="window_set_skip_pager_hint">gdk_window_set_skip_pager_hint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_skip_pager_hint      (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> skips_pager);</programlisting>
<para>
Toggles whether a window should appear in a pager (workspace
switcher, or other desktop utility program that displays a small
thumbnail representation of the windows on the desktop). If a
window's semantic type as specified with <link linkend="gdk-window-set-type-hint"><function>gdk_window_set_type_hint()</function></link>
already fully describes the window, this function should 
<emphasis>not</emphasis> be called in addition, instead you should 
allow the window to be treated according to standard policy for 
its semantic type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>skips_pager</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to skip the pager
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2</para></refsect2>
<refsect2 id="gdk-window-set-urgency-hint" role="function" condition="since:2.8">
<title>gdk_window_set_urgency_hint ()</title>
<indexterm zone="gdk-window-set-urgency-hint" role="2.8"><primary sortas="window_set_urgency_hint">gdk_window_set_urgency_hint</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_urgency_hint         (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gboolean">gboolean</link> urgent);</programlisting>
<para>
Toggles whether a window needs the user's
urgent attention.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>urgent</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the window is urgent
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.8</para></refsect2>
<refsect2 id="gdk-window-get-position" role="function">
<title>gdk_window_get_position ()</title>
<indexterm zone="gdk-window-get-position"><primary sortas="window_get_position">gdk_window_get_position</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_position             (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);</programlisting>
<para>
Obtains the position of the window as reported in the
most-recently-processed <link linkend="GdkEventConfigure"><type>GdkEventConfigure</type></link>. Contrast with
<link linkend="gdk-window-get-geometry"><function>gdk_window_get_geometry()</function></link> which queries the X server for the
current window position, regardless of which events have been
received or processed.
</para>
<para>
The position coordinates are relative to the window's parent window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X coordinate of window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y coordinate of window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-root-origin" role="function">
<title>gdk_window_get_root_origin ()</title>
<indexterm zone="gdk-window-get-root-origin"><primary sortas="window_get_root_origin">gdk_window_get_root_origin</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_root_origin          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);</programlisting>
<para>
Obtains the top-left corner of the window manager frame in root
window coordinates.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> return location for X position of window frame
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> return location for Y position of window frame
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-frame-extents" role="function">
<title>gdk_window_get_frame_extents ()</title>
<indexterm zone="gdk-window-get-frame-extents"><primary sortas="window_get_frame_extents">gdk_window_get_frame_extents</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_frame_extents        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkRectangle">GdkRectangle</link> *rect);</programlisting>
<para>
Obtains the bounding box of the window, including window manager
titlebar/borders if any. The frame position is given in root window
coordinates. To get the position of the window itself (rather than
the frame) in root window coordinates, use <link linkend="gdk-window-get-origin"><function>gdk_window_get_origin()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rect</parameter>&#160;:</term>
<listitem><simpara> rectangle to fill with bounding box of the window frame
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-size" role="macro" condition="deprecated:">
<title>gdk_window_get_size</title>
<indexterm zone="gdk-window-get-size" role="deprecated"><primary sortas="window_get_size">gdk_window_get_size</primary></indexterm><programlisting>#define gdk_window_get_size            gdk_drawable_get_size
</programlisting>
<warning><para><literal>gdk_window_get_size</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="gdk-drawable-get-size"><function>gdk_drawable_get_size()</function></link>.
</para></refsect2>
<refsect2 id="gdk-window-get-visual" role="macro" condition="deprecated:">
<title>gdk_window_get_visual</title>
<indexterm zone="gdk-window-get-visual" role="deprecated"><primary sortas="window_get_visual">gdk_window_get_visual</primary></indexterm><programlisting>#define gdk_window_get_visual          gdk_drawable_get_visual
</programlisting>
<warning><para><literal>gdk_window_get_visual</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="gdk-drawable-get-visual"><function>gdk_drawable_get_visual()</function></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the <link linkend="GdkVisual"><type>GdkVisual</type></link> of the window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-colormap" role="macro" condition="deprecated:">
<title>gdk_window_get_colormap</title>
<indexterm zone="gdk-window-get-colormap" role="deprecated"><primary sortas="window_get_colormap">gdk_window_get_colormap</primary></indexterm><programlisting>#define gdk_window_get_colormap        gdk_drawable_get_colormap
</programlisting>
<warning><para><literal>gdk_window_get_colormap</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="gdk-drawable-get-colormap"><function>gdk_drawable_get_colormap()</function></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>colormap for the window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-type" role="macro" condition="deprecated:">
<title>gdk_window_get_type</title>
<indexterm zone="gdk-window-get-type" role="deprecated"><primary sortas="window_get_type">gdk_window_get_type</primary></indexterm><programlisting>#define gdk_window_get_type            gdk_window_get_window_type
</programlisting>
<warning><para><literal>gdk_window_get_type</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated equivalent of <link linkend="gdk-drawable-get-type"><function>gdk_drawable_get_type()</function></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>type of drawable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-origin" role="function">
<title>gdk_window_get_origin ()</title>
<indexterm zone="gdk-window-get-origin"><primary sortas="window_get_origin">gdk_window_get_origin</primary></indexterm><programlisting><link linkend="gint">gint</link>                gdk_window_get_origin               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);</programlisting>
<para>
Obtains the position of a window in root window coordinates.
(Compare with <link linkend="gdk-window-get-position"><function>gdk_window_get_position()</function></link> and
<link linkend="gdk-window-get-geometry"><function>gdk_window_get_geometry()</function></link> which return the position of a window
relative to its parent window.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> return location for X coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> return location for Y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> not meaningful, ignore
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-deskrelative-origin" role="function" condition="deprecated:">
<title>gdk_window_get_deskrelative_origin ()</title>
<indexterm zone="gdk-window-get-deskrelative-origin" role="deprecated"><primary sortas="window_get_deskrelative_origin">gdk_window_get_deskrelative_origin</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_get_deskrelative_origin  (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);</programlisting>
<warning><para><literal>gdk_window_get_deskrelative_origin</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This gets the origin of a <link linkend="GdkWindow"><type>GdkWindow</type></link> relative to
an Enlightenment-window-manager desktop. As long as you don't
assume that the user's desktop/workspace covers the entire
root window (i.e. you don't assume that the desktop begins
at root window coordinate 0,0) this function is not necessary.
It's deprecated for that reason.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> return location for X coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> return location for Y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> not meaningful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-root-coords" role="function">
<title>gdk_window_get_root_coords ()</title>
<indexterm zone="gdk-window-get-root-coords"><primary sortas="window_get_root_coords">gdk_window_get_root_coords</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_get_root_coords          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="gint">gint</link> *root_x,
                                                         <link linkend="gint">gint</link> *root_y);</programlisting>
<para>
Obtains the position of a window position in root
window coordinates. This is similar to
<link linkend="gdk-window-get-origin"><function>gdk_window_get_origin()</function></link> but allows you go pass
in any position in the window, not just the origin.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> X coordinate in window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> Y coordinate in window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_x</parameter>&#160;:</term>
<listitem><simpara> return location for X coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_y</parameter>&#160;:</term>
<listitem><simpara> return location for Y coordinate
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-pointer" role="function">
<title>gdk_window_get_pointer ()</title>
<indexterm zone="gdk-window-get-pointer"><primary sortas="window_get_pointer">gdk_window_get_pointer</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gdk_window_get_pointer              (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="GdkModifierType">GdkModifierType</link> *mask);</programlisting>
<para>
Obtains the current pointer position and modifier state.
The position is given in coordinates relative to the upper left
corner of <parameter>window</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> return location for X coordinate of pointer or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to not
     return the X coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> return location for Y coordinate of pointer or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to not
     return the Y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara> return location for modifier mask or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to not return the
     modifier mask
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the window containing the pointer (as with
<link linkend="gdk-window-at-pointer"><function>gdk_window_at_pointer()</function></link>), or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the window containing the
pointer isn't known to GDK
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkModifierType" role="enum">
<title>enum GdkModifierType</title>
<indexterm zone="GdkModifierType"><primary sortas="ModifierType">GdkModifierType</primary></indexterm><programlisting>typedef enum
{
  GDK_SHIFT_MASK    = 1 &lt;&lt; 0,
  GDK_LOCK_MASK	    = 1 &lt;&lt; 1,
  GDK_CONTROL_MASK  = 1 &lt;&lt; 2,
  GDK_MOD1_MASK	    = 1 &lt;&lt; 3,
  GDK_MOD2_MASK	    = 1 &lt;&lt; 4,
  GDK_MOD3_MASK	    = 1 &lt;&lt; 5,
  GDK_MOD4_MASK	    = 1 &lt;&lt; 6,
  GDK_MOD5_MASK	    = 1 &lt;&lt; 7,
  GDK_BUTTON1_MASK  = 1 &lt;&lt; 8,
  GDK_BUTTON2_MASK  = 1 &lt;&lt; 9,
  GDK_BUTTON3_MASK  = 1 &lt;&lt; 10,
  GDK_BUTTON4_MASK  = 1 &lt;&lt; 11,
  GDK_BUTTON5_MASK  = 1 &lt;&lt; 12,

  /* The next few modifiers are used by XKB, so we skip to the end.
   * Bits 15 - 25 are currently unused. Bit 29 is used internally.
   */
  
  GDK_SUPER_MASK    = 1 &lt;&lt; 26,
  GDK_HYPER_MASK    = 1 &lt;&lt; 27,
  GDK_META_MASK     = 1 &lt;&lt; 28,
  
  GDK_RELEASE_MASK  = 1 &lt;&lt; 30,

  GDK_MODIFIER_MASK = 0x5c001fff
} GdkModifierType;
</programlisting>
<para>
A set of bit-flags to indicate the state of modifier keys and mouse buttons
in various event types. Typical modifier keys are Shift, Control, Meta, Super,
Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
</para>
<para>
Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
</para>
<para>
Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
to Mod2 - Mod5, and indicates this by setting <link linkend="GDK-SUPER-MASK--CAPS"><literal>GDK_SUPER_MASK</literal></link>, <link linkend="GDK-HYPER-MASK--CAPS"><literal>GDK_HYPER_MASK</literal></link>
or <link linkend="GDK-META-MASK--CAPS"><literal>GDK_META_MASK</literal></link> in the state field of key events.
</para><variablelist role="enum">
<varlistentry id="GDK-SHIFT-MASK--CAPS" role="constant">
<term><literal>GDK_SHIFT_MASK</literal></term>
<listitem><simpara>the Shift key.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-LOCK-MASK--CAPS" role="constant">
<term><literal>GDK_LOCK_MASK</literal></term>
<listitem><simpara>a Lock key (depending on the modifier mapping of the 
  X server this may either be CapsLock or ShiftLock).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-CONTROL-MASK--CAPS" role="constant">
<term><literal>GDK_CONTROL_MASK</literal></term>
<listitem><simpara>the Control key.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MOD1-MASK--CAPS" role="constant">
<term><literal>GDK_MOD1_MASK</literal></term>
<listitem><simpara>the fourth modifier key (it depends on the modifier 
  mapping of the X server which key is interpreted as this modifier, but
  normally it is the Alt key).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MOD2-MASK--CAPS" role="constant">
<term><literal>GDK_MOD2_MASK</literal></term>
<listitem><simpara>the fifth modifier key (it depends on the modifier 
  mapping of the X server which key is interpreted as this modifier).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MOD3-MASK--CAPS" role="constant">
<term><literal>GDK_MOD3_MASK</literal></term>
<listitem><simpara>the sixth modifier key (it depends on the modifier 
  mapping of the X server which key is interpreted as this modifier).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MOD4-MASK--CAPS" role="constant">
<term><literal>GDK_MOD4_MASK</literal></term>
<listitem><simpara>the seventh modifier key (it depends on the modifier 
  mapping of the X server which key is interpreted as this modifier).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MOD5-MASK--CAPS" role="constant">
<term><literal>GDK_MOD5_MASK</literal></term>
<listitem><simpara>the eighth modifier key (it depends on the modifier 
  mapping of the X server which key is interpreted as this modifier).
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-BUTTON1-MASK--CAPS" role="constant">
<term><literal>GDK_BUTTON1_MASK</literal></term>
<listitem><simpara>the first mouse button.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-BUTTON2-MASK--CAPS" role="constant">
<term><literal>GDK_BUTTON2_MASK</literal></term>
<listitem><simpara>the second mouse button.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-BUTTON3-MASK--CAPS" role="constant">
<term><literal>GDK_BUTTON3_MASK</literal></term>
<listitem><simpara>the third mouse button.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-BUTTON4-MASK--CAPS" role="constant">
<term><literal>GDK_BUTTON4_MASK</literal></term>
<listitem><simpara>the fourth mouse button.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-BUTTON5-MASK--CAPS" role="constant">
<term><literal>GDK_BUTTON5_MASK</literal></term>
<listitem><simpara>the fifth mouse button.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-SUPER-MASK--CAPS" role="constant">
<term><literal>GDK_SUPER_MASK</literal></term>
<listitem><simpara>the Super modifier. Since 2.10
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-HYPER-MASK--CAPS" role="constant">
<term><literal>GDK_HYPER_MASK</literal></term>
<listitem><simpara>the Hyper modifier. Since 2.10
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-META-MASK--CAPS" role="constant">
<term><literal>GDK_META_MASK</literal></term>
<listitem><simpara>the Meta modifier. Since 2.10
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-RELEASE-MASK--CAPS" role="constant">
<term><literal>GDK_RELEASE_MASK</literal></term>
<listitem><simpara>not used in GDK itself. GTK+ uses it to differentiate 
  between (keyval, modifiers) pairs from key press and release events.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-MODIFIER-MASK--CAPS" role="constant">
<term><literal>GDK_MODIFIER_MASK</literal></term>
<listitem><simpara>a mask covering all modifier types.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-parent" role="function">
<title>gdk_window_get_parent ()</title>
<indexterm zone="gdk-window-get-parent"><primary sortas="window_get_parent">gdk_window_get_parent</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link> *         gdk_window_get_parent               (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Obtains the parent of <parameter>window</parameter>, as known to GDK. Does not query the
X server; thus this returns the parent as passed to <link linkend="gdk-window-new"><function>gdk_window_new()</function></link>,
not the actual parent. This should never matter unless you're using
Xlib calls mixed with GDK calls on the X11 platform. It may also
matter for toplevel windows, because the window manager may choose
to reparent them.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> parent of <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-toplevel" role="function">
<title>gdk_window_get_toplevel ()</title>
<indexterm zone="gdk-window-get-toplevel"><primary sortas="window_get_toplevel">gdk_window_get_toplevel</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link> *         gdk_window_get_toplevel             (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the toplevel window that's an ancestor of <parameter>window</parameter>.
</para>
<para>
Any window type but <link linkend="GDK-WINDOW-CHILD--CAPS"><literal>GDK_WINDOW_CHILD</literal></link> is considered a
toplevel window, as is a <link linkend="GDK-WINDOW-CHILD--CAPS"><literal>GDK_WINDOW_CHILD</literal></link> window that
has a root window as parent.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the toplevel window containing <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-children" role="function">
<title>gdk_window_get_children ()</title>
<indexterm zone="gdk-window-get-children"><primary sortas="window_get_children">gdk_window_get_children</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gdk_window_get_children             (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the list of children of <parameter>window</parameter> known to GDK.
This function only returns children created via GDK,
so for example it's useless when used with the root window;
it only returns windows an application created itself.
</para>
<para>
The returned list must be freed, but the elements in the
list need not be.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> list of child windows inside <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-peek-children" role="function">
<title>gdk_window_peek_children ()</title>
<indexterm zone="gdk-window-peek-children"><primary sortas="window_peek_children">gdk_window_peek_children</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gdk_window_peek_children            (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Like <link linkend="gdk-window-get-children"><function>gdk_window_get_children()</function></link>, but does not copy the list of
children, so the list does not need to be freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a reference to the list of child windows in <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-events" role="function">
<title>gdk_window_get_events ()</title>
<indexterm zone="gdk-window-get-events"><primary sortas="window_get_events">gdk_window_get_events</primary></indexterm><programlisting><link linkend="GdkEventMask">GdkEventMask</link>        gdk_window_get_events               (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the event mask for <parameter>window</parameter>. See <link linkend="gdk-window-set-events"><function>gdk_window_set_events()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> event mask for <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-events" role="function">
<title>gdk_window_set_events ()</title>
<indexterm zone="gdk-window-set-events"><primary sortas="window_set_events">gdk_window_set_events</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_events               (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkEventMask">GdkEventMask</link> event_mask);</programlisting>
<para>
The event mask for a window determines which events will be reported
for that window. For example, an event mask including <link linkend="GDK-BUTTON-PRESS-MASK--CAPS"><type>GDK_BUTTON_PRESS_MASK</type></link>
means the window should report button press events. The event mask
is the bitwise OR of values from the <link linkend="GdkEventMask"><type>GdkEventMask</type></link> enumeration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event_mask</parameter>&#160;:</term>
<listitem><simpara> event mask for <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-icon" role="function">
<title>gdk_window_set_icon ()</title>
<indexterm zone="gdk-window-set-icon"><primary sortas="window_set_icon">gdk_window_set_icon</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_icon                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *icon_window,
                                                         <link linkend="GdkPixmap">GdkPixmap</link> *pixmap,
                                                         <link linkend="GdkBitmap">GdkBitmap</link> *mask);</programlisting>
<para>
Sets the icon of <parameter>window</parameter> as a pixmap or window. If using GTK+, investigate
<link linkend="gtk-window-set-default-icon-list"><function>gtk_window_set_default_icon_list()</function></link> first, and then <link linkend="gtk-window-set-icon-list"><function>gtk_window_set_icon_list()</function></link>
and <link linkend="gtk-window-set-icon"><function>gtk_window_set_icon()</function></link>. If those don't meet your needs, look at
<link linkend="gdk-window-set-icon-list"><function>gdk_window_set_icon_list()</function></link>. Only if all those are too high-level do you
want to fall back to <link linkend="gdk-window-set-icon"><function>gdk_window_set_icon()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link> to use for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to unset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkPixmap"><type>GdkPixmap</type></link> to use as the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to unset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
<listitem><simpara> a 1-bit pixmap (<link linkend="GdkBitmap"><type>GdkBitmap</type></link>) to use as mask for <parameter>pixmap</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to have none
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-icon-name" role="function">
<title>gdk_window_set_icon_name ()</title>
<indexterm zone="gdk-window-set-icon-name"><primary sortas="window_set_icon_name">gdk_window_set_icon_name</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_icon_name            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Windows may have a name used while minimized, distinct from the
name they display in their titlebar. Most of the time this is a bad
idea from a user interface standpoint. But you can set such a name
with this function, if you like.
</para>
<para>
After calling this with a non-<link linkend="NULL--CAPS"><literal>NULL</literal></link> <parameter>name</parameter>, calls to <link linkend="gdk-window-set-title"><function>gdk_window_set_title()</function></link>
will not update the icon title.
</para>
<para>
Using <link linkend="NULL--CAPS"><literal>NULL</literal></link> for <parameter>name</parameter> unsets the icon title; further calls to
<link linkend="gdk-window-set-title"><function>gdk_window_set_title()</function></link> will again update the icon title as well.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&#160;:</term>
<listitem><simpara> name of window while iconified (minimized)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-transient-for" role="function">
<title>gdk_window_set_transient_for ()</title>
<indexterm zone="gdk-window-set-transient-for"><primary sortas="window_set_transient_for">gdk_window_set_transient_for</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_transient_for        (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *parent);</programlisting>
<para>
Indicates to the window manager that <parameter>window</parameter> is a transient dialog
associated with the application window <parameter>parent</parameter>. This allows the
window manager to do things like center <parameter>window</parameter> on <parameter>parent</parameter> and
keep <parameter>window</parameter> above <parameter>parent</parameter>.
</para>
<para>
See <link linkend="gtk-window-set-transient-for"><function>gtk_window_set_transient_for()</function></link> if you're using <link linkend="GtkWindow"><type>GtkWindow</type></link> or
<link linkend="GtkDialog"><type>GtkDialog</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
<listitem><simpara> another toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-role" role="function">
<title>gdk_window_set_role ()</title>
<indexterm zone="gdk-window-set-role"><primary sortas="window_set_role">gdk_window_set_role</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_role                 (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *role);</programlisting>
<para>
When using GTK+, typically you should use <link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link> instead
of this low-level function.
</para>
<para>
The window manager and session manager use a window's role to
distinguish it from other kinds of window in the same application.
When an application is restarted after being saved in a previous
session, all windows with the same title and role are treated as
interchangeable.  So if you have two windows with the same title
that should be distinguished for session management purposes, you
should set the role on those windows. It doesn't matter what string
you use for the role, as long as you have a different role for each
non-interchangeable kind of window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>role</parameter>&#160;:</term>
<listitem><simpara> a string indicating its role
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-startup-id" role="function" condition="since:2.12">
<title>gdk_window_set_startup_id ()</title>
<indexterm zone="gdk-window-set-startup-id" role="2.12"><primary sortas="window_set_startup_id">gdk_window_set_startup_id</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_startup_id           (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         const <link linkend="gchar">gchar</link> *startup_id);</programlisting>
<para>
When using GTK+, typically you should use <link linkend="gtk-window-set-startup-id"><function>gtk_window_set_startup_id()</function></link>
instead of this low-level function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>startup_id</parameter>&#160;:</term>
<listitem><simpara> a string with startup-notification identifier
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gdk-window-set-group" role="function">
<title>gdk_window_set_group ()</title>
<indexterm zone="gdk-window-set-group"><primary sortas="window_set_group">gdk_window_set_group</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_group                (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *leader);</programlisting>
<para>
Sets the group leader window for <parameter>window</parameter>. By default,
GDK sets the group leader for all toplevel windows
to a global window implicitly created by GDK. With this function
you can override this default.
</para>
<para>
The group leader window allows the window manager to distinguish
all windows that belong to a single application. It may for example
allow users to minimize/unminimize all windows belonging to an
application at once. You should only set a non-default group window
if your application pretends to be multiple applications.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>leader</parameter>&#160;:</term>
<listitem><simpara> group leader window, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to restore the default group leader window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-group" role="function" condition="since:2.4">
<title>gdk_window_get_group ()</title>
<indexterm zone="gdk-window-get-group" role="2.4"><primary sortas="window_get_group">gdk_window_get_group</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gdk_window_get_group                (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Returns the group leader window for <parameter>window</parameter>. See <link linkend="gdk-window-set-group"><function>gdk_window_set_group()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the group leader window for <parameter>window</parameter>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gdk-window-set-decorations" role="function">
<title>gdk_window_set_decorations ()</title>
<indexterm zone="gdk-window-set-decorations"><primary sortas="window_set_decorations">gdk_window_set_decorations</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_decorations          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMDecoration">GdkWMDecoration</link> decorations);</programlisting>
<para>
"Decorations" are the features the window manager adds to a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>.
This function sets the traditional Motif window manager hints that tell the
window manager which decorations you would like your window to have.
Usually you should use <link linkend="gtk-window-set-decorated"><function>gtk_window_set_decorated()</function></link> on a <link linkend="GtkWindow"><type>GtkWindow</type></link> instead of
using the GDK function directly.
</para>
<para>
The <parameter>decorations</parameter> argument is the logical OR of the fields in
the <link linkend="GdkWMDecoration"><type>GdkWMDecoration</type></link> enumeration. If <link linkend="GDK-DECOR-ALL--CAPS"><type>GDK_DECOR_ALL</type></link> is included in the
mask, the other bits indicate which decorations should be turned off.
If <link linkend="GDK-DECOR-ALL--CAPS"><type>GDK_DECOR_ALL</type></link> is not included, then the other bits indicate
which decorations should be turned on.
</para>
<para>
Most window managers honor a decorations hint of 0 to disable all decorations,
but very few honor all possible combinations of bits.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>decorations</parameter>&#160;:</term>
<listitem><simpara> decoration hint mask
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-decorations" role="function">
<title>gdk_window_get_decorations ()</title>
<indexterm zone="gdk-window-get-decorations"><primary sortas="window_get_decorations">gdk_window_get_decorations</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gdk_window_get_decorations          (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMDecoration">GdkWMDecoration</link> *decorations);</programlisting>
<para>
Returns the decorations set on the GdkWindow with <link linkend="gdk-window-set-decorations"><type>gdk_window_set_decorations</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> The toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link> to get the decorations from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>decorations</parameter>&#160;:</term>
<listitem><simpara> The window decorations will be written here
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the window has decorations set, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWMDecoration" role="enum">
<title>enum GdkWMDecoration</title>
<indexterm zone="GdkWMDecoration"><primary sortas="WMDecoration">GdkWMDecoration</primary></indexterm><programlisting>typedef enum
{
  GDK_DECOR_ALL		= 1 &lt;&lt; 0,
  GDK_DECOR_BORDER	= 1 &lt;&lt; 1,
  GDK_DECOR_RESIZEH	= 1 &lt;&lt; 2,
  GDK_DECOR_TITLE	= 1 &lt;&lt; 3,
  GDK_DECOR_MENU	= 1 &lt;&lt; 4,
  GDK_DECOR_MINIMIZE	= 1 &lt;&lt; 5,
  GDK_DECOR_MAXIMIZE	= 1 &lt;&lt; 6
} GdkWMDecoration;
</programlisting>
<para>
These are hints originally defined by the Motif toolkit.
The window manager can use them when determining how to decorate
the window. The hint must be set before mapping the window.
</para><variablelist role="enum">
<varlistentry id="GDK-DECOR-ALL--CAPS" role="constant">
<term><literal>GDK_DECOR_ALL</literal></term>
<listitem><simpara>all decorations should be applied.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-BORDER--CAPS" role="constant">
<term><literal>GDK_DECOR_BORDER</literal></term>
<listitem><simpara>a frame should be drawn around the window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-RESIZEH--CAPS" role="constant">
<term><literal>GDK_DECOR_RESIZEH</literal></term>
<listitem><simpara>the frame should have resize handles.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-TITLE--CAPS" role="constant">
<term><literal>GDK_DECOR_TITLE</literal></term>
<listitem><simpara>a titlebar should be placed above the window.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-MENU--CAPS" role="constant">
<term><literal>GDK_DECOR_MENU</literal></term>
<listitem><simpara>a button for opening a menu should be included.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-MINIMIZE--CAPS" role="constant">
<term><literal>GDK_DECOR_MINIMIZE</literal></term>
<listitem><simpara>a minimize button should be included.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-DECOR-MAXIMIZE--CAPS" role="constant">
<term><literal>GDK_DECOR_MAXIMIZE</literal></term>
<listitem><simpara>a maximize button should be included.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-set-functions" role="function">
<title>gdk_window_set_functions ()</title>
<indexterm zone="gdk-window-set-functions"><primary sortas="window_set_functions">gdk_window_set_functions</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_set_functions            (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWMFunction">GdkWMFunction</link> functions);</programlisting>
<para>
Sets hints about the window management functions to make available
via buttons on the window frame.
</para>
<para>
On the X backend, this function sets the traditional Motif window 
manager hint for this purpose. However, few window managers do
anything reliable or interesting with this hint. Many ignore it
entirely.
</para>
<para>
The <parameter>functions</parameter> argument is the logical OR of values from the
<link linkend="GdkWMFunction"><type>GdkWMFunction</type></link> enumeration. If the bitmask includes <link linkend="GDK-FUNC-ALL--CAPS"><type>GDK_FUNC_ALL</type></link>,
then the other bits indicate which functions to disable; if
it doesn't include <link linkend="GDK-FUNC-ALL--CAPS"><type>GDK_FUNC_ALL</type></link>, it indicates which functions to
enable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a toplevel <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>functions</parameter>&#160;:</term>
<listitem><simpara> bitmask of operations to allow on <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkWMFunction" role="enum">
<title>enum GdkWMFunction</title>
<indexterm zone="GdkWMFunction"><primary sortas="WMFunction">GdkWMFunction</primary></indexterm><programlisting>typedef enum
{
  GDK_FUNC_ALL		= 1 &lt;&lt; 0,
  GDK_FUNC_RESIZE	= 1 &lt;&lt; 1,
  GDK_FUNC_MOVE		= 1 &lt;&lt; 2,
  GDK_FUNC_MINIMIZE	= 1 &lt;&lt; 3,
  GDK_FUNC_MAXIMIZE	= 1 &lt;&lt; 4,
  GDK_FUNC_CLOSE	= 1 &lt;&lt; 5
} GdkWMFunction;
</programlisting>
<para>
These are hints originally defined by the Motif toolkit.
The window manager can use them when determining the functions
to offer for the window.
The hint must be set before mapping the window.
</para><variablelist role="enum">
<varlistentry id="GDK-FUNC-ALL--CAPS" role="constant">
<term><literal>GDK_FUNC_ALL</literal></term>
<listitem><simpara>all functions should be offered.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FUNC-RESIZE--CAPS" role="constant">
<term><literal>GDK_FUNC_RESIZE</literal></term>
<listitem><simpara>the window should be resizable.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FUNC-MOVE--CAPS" role="constant">
<term><literal>GDK_FUNC_MOVE</literal></term>
<listitem><simpara>the window should be movable.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FUNC-MINIMIZE--CAPS" role="constant">
<term><literal>GDK_FUNC_MINIMIZE</literal></term>
<listitem><simpara>the window should be minimizable.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FUNC-MAXIMIZE--CAPS" role="constant">
<term><literal>GDK_FUNC_MAXIMIZE</literal></term>
<listitem><simpara>the window should be maximizable.
</simpara></listitem>
</varlistentry>
<varlistentry id="GDK-FUNC-CLOSE--CAPS" role="constant">
<term><literal>GDK_FUNC_CLOSE</literal></term>
<listitem><simpara>the window should be closable.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-window-get-toplevels" role="function" condition="deprecated:2.16: Use gdk_screen_get_toplevel_windows() instead.">
<title>gdk_window_get_toplevels ()</title>
<indexterm zone="gdk-window-get-toplevels" role="deprecated"><primary sortas="window_get_toplevels">gdk_window_get_toplevels</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gdk_window_get_toplevels            (void);</programlisting>
<warning><para><literal>gdk_window_get_toplevels</literal> has been deprecated since version 2.16 and should not be used in newly-written code. Use <link linkend="gdk-screen-get-toplevel-windows"><function>gdk_screen_get_toplevel_windows()</function></link> instead.</para></warning>
<para>
Obtains a list of all toplevel windows known to GDK on the default
screen (see <link linkend="gdk-screen-get-toplevel-windows"><function>gdk_screen_get_toplevel_windows()</function></link>).
A toplevel window is a child of the root window (see
<link linkend="gdk-get-default-root-window"><function>gdk_get_default_root_window()</function></link>).
</para>
<para>
The returned list should be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>, but
its elements need not be freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> list of toplevel windows, free with <link linkend="g-list-free"><function>g_list_free()</function></link>

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-get-default-root-window" role="function">
<title>gdk_get_default_root_window ()</title>
<indexterm zone="gdk-get-default-root-window"><primary sortas="get_default_root_window">gdk_get_default_root_window</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link> *         gdk_get_default_root_window         (void);</programlisting>
<para>
Obtains the root window (parent all other windows are inside)
for the default display and screen.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the default root window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdkPointerHooks" role="struct">
<title>GdkPointerHooks</title>
<indexterm zone="GdkPointerHooks"><primary sortas="PointerHooks">GdkPointerHooks</primary></indexterm><programlisting>typedef struct {
  GdkWindow* (*get_pointer)       (GdkWindow	   *window,
			           gint	           *x,
			           gint   	   *y,
			           GdkModifierType *mask);
  GdkWindow* (*window_at_pointer) (GdkScreen       *screen, /* unused */
                                   gint            *win_x,
                                   gint            *win_y);
} GdkPointerHooks;
</programlisting>
<para>
A table of pointers to functions for getting quantities related to
the current pointer position. GDK has one global table of this type,
which can be set using <link linkend="gdk-set-pointer-hooks"><function>gdk_set_pointer_hooks()</function></link>.
</para>
<para>
This is only useful for such low-level tools as an event recorder.
Applications should never have any reason to use this facility
</para><variablelist role="struct">
<varlistentry>
<term><structfield>get_pointer</structfield>&#160;()</term>
<listitem><simpara>Obtains the current pointer position and modifier state.
  The position is given in coordinates relative to the window containing
  the pointer, which is returned in <parameter>window</parameter>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>window_at_pointer</structfield>&#160;()</term>
<listitem><simpara>Obtains the window underneath the mouse pointer, 
  returning the location of that window in <parameter>win_x</parameter>, <parameter>win_y</parameter>. Returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
  if the window under the mouse pointer is not known to GDK (for example,
  belongs to another application).
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-set-pointer-hooks" role="function">
<title>gdk_set_pointer_hooks ()</title>
<indexterm zone="gdk-set-pointer-hooks"><primary sortas="set_pointer_hooks">gdk_set_pointer_hooks</primary></indexterm><programlisting><link linkend="GdkPointerHooks">GdkPointerHooks</link> *   gdk_set_pointer_hooks               (const <link linkend="GdkPointerHooks">GdkPointerHooks</link> *new_hooks);</programlisting>
<para>
This function allows for hooking into the operation
of getting the current location of the pointer. This
is only useful for such low-level tools as an
event recorder. Applications should never have any
reason to use this facility.
</para>
<para>
This function is not multihead safe. For multihead operation,
see <link linkend="gdk-display-set-pointer-hooks"><function>gdk_display_set_pointer_hooks()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>new_hooks</parameter>&#160;:</term>
<listitem><simpara> a table of pointers to functions for getting
  quantities related to the current pointer position,
  or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to restore the default table.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the previous pointer hook table
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-offscreen-window-get-pixmap" role="function">
<title>gdk_offscreen_window_get_pixmap ()</title>
<indexterm zone="gdk-offscreen-window-get-pixmap"><primary sortas="offscreen_window_get_pixmap">gdk_offscreen_window_get_pixmap</primary></indexterm><programlisting><link linkend="GdkPixmap">GdkPixmap</link> *         gdk_offscreen_window_get_pixmap     (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the offscreen pixmap that an offscreen window renders into.
If you need to keep this around over window resizes, you need to
add a reference to it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The offscreen pixmap, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if not offscreen
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gdk-offscreen-window-set-embedder" role="function" condition="since:2.18">
<title>gdk_offscreen_window_set_embedder ()</title>
<indexterm zone="gdk-offscreen-window-set-embedder" role="2.18"><primary sortas="offscreen_window_set_embedder">gdk_offscreen_window_set_embedder</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_offscreen_window_set_embedder   (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkWindow">GdkWindow</link> *embedder);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>embedder</parameter>&#160;:</term>
<listitem><simpara> the <link linkend="GdkWindow"><type>GdkWindow</type></link> that <parameter>window</parameter> gets embedded in
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gdk-offscreen-window-get-embedder" role="function" condition="since:2.18">
<title>gdk_offscreen_window_get_embedder ()</title>
<indexterm zone="gdk-offscreen-window-get-embedder" role="2.18"><primary sortas="offscreen_window_get_embedder">gdk_offscreen_window_get_embedder</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link> *         gdk_offscreen_window_get_embedder   (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Gets the window that <parameter>window</parameter> is embedded in.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the embedding <link linkend="GdkWindow"><type>GdkWindow</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>window</parameter> is not an
    embedded offscreen window

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gdk-window-geometry-changed" role="function" condition="since:2.18">
<title>gdk_window_geometry_changed ()</title>
<indexterm zone="gdk-window-geometry-changed" role="2.18"><primary sortas="window_geometry_changed">gdk_window_geometry_changed</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_geometry_changed         (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gdk-window-redirect-to-drawable" role="function" condition="since:2.14">
<title>gdk_window_redirect_to_drawable ()</title>
<indexterm zone="gdk-window-redirect-to-drawable" role="2.14"><primary sortas="window_redirect_to_drawable">gdk_window_redirect_to_drawable</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_redirect_to_drawable     (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                         <link linkend="GdkDrawable">GdkDrawable</link> *drawable,
                                                         <link linkend="gint">gint</link> src_x,
                                                         <link linkend="gint">gint</link> src_y,
                                                         <link linkend="gint">gint</link> dest_x,
                                                         <link linkend="gint">gint</link> dest_y,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Redirects drawing into <parameter>window</parameter> so that drawing to the
window in the rectangle specified by <parameter>src_x</parameter>, <parameter>src_y</parameter>,
<parameter>width</parameter> and <parameter>height</parameter> is also drawn into <parameter>drawable</parameter> at
<parameter>dest_x</parameter>, <parameter>dest_y</parameter>.
</para>
<para>
Only drawing between <link linkend="gdk-window-begin-paint-region"><function>gdk_window_begin_paint_region()</function></link> or
<link linkend="gdk-window-begin-paint-rect"><function>gdk_window_begin_paint_rect()</function></link> and <link linkend="gdk-window-end-paint"><function>gdk_window_end_paint()</function></link> is
redirected.
</para>
<para>
Redirection is active until <link linkend="gdk-window-remove-redirection"><function>gdk_window_remove_redirection()</function></link>
is called.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkDrawable"><type>GdkDrawable</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_x</parameter>&#160;:</term>
<listitem><simpara> x position in <parameter>window</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src_y</parameter>&#160;:</term>
<listitem><simpara> y position in <parameter>window</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_x</parameter>&#160;:</term>
<listitem><simpara> x position in <parameter>drawable</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_y</parameter>&#160;:</term>
<listitem><simpara> y position in <parameter>drawable</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara> width of redirection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara> height of redirection
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>
<refsect2 id="gdk-window-remove-redirection" role="function" condition="since:2.14">
<title>gdk_window_remove_redirection ()</title>
<indexterm zone="gdk-window-remove-redirection" role="2.14"><primary sortas="window_remove_redirection">gdk_window_remove_redirection</primary></indexterm><programlisting><link linkend="void">void</link>                gdk_window_remove_redirection       (<link linkend="GdkWindow">GdkWindow</link> *window);</programlisting>
<para>
Removes any active redirection started by
<link linkend="gdk-window-redirect-to-drawable"><function>gdk_window_redirect_to_drawable()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GdkWindow"><type>GdkWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>

</refsect1>
<refsect1 id="gdk-Windows.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GdkWindow--cursor" role="property"><title>The <literal>&quot;cursor&quot;</literal> property</title>
<indexterm zone="GdkWindow--cursor"><primary sortas="Window:cursor">GdkWindow:cursor</primary></indexterm><programlisting>  &quot;cursor&quot;                   <link linkend="gpointer">gpointer</link>              : Read / Write</programlisting>
<para>Cursor.</para></refsect2>
</refsect1>

<refsect1 id="gdk-Windows.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GdkWindow-from-embedder" role="signal"><title>The <literal>&quot;from-embedder&quot;</literal> signal</title>
<indexterm zone="GdkWindow-from-embedder" role="2.18"><primary sortas="Window::from-embedder">GdkWindow::from-embedder</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                        <link linkend="gdouble">gdouble</link>    embedder-x,
                                                        <link linkend="gdouble">gdouble</link>    embedder-y,
                                                        <link linkend="gpointer">gpointer</link>   offscreen-x,
                                                        <link linkend="gpointer">gpointer</link>   offscreen-y,
                                                        <link linkend="gpointer">gpointer</link>   user_data)        : Run Last</programlisting>
<para>
The ::from-embedder signal is emitted to translate coordinates
in the embedder of an offscreen window to the offscreen window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> the offscreen window on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>embedder-x</parameter>&#160;:</term>
<listitem><simpara> x coordinate in the embedder window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>embedder-y</parameter>&#160;:</term>
<listitem><simpara> y coordinate in the embedder window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offscreen-x</parameter>&#160;:</term>
<listitem><simpara> return location for the x coordinate in the offscreen window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offscreen-y</parameter>&#160;:</term>
<listitem><simpara> return location for the y coordinate in the offscreen window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist><para>Since 2.18</para></refsect2><refsect2 id="GdkWindow-pick-embedded-child" role="signal"><title>The <literal>&quot;pick-embedded-child&quot;</literal> signal</title>
<indexterm zone="GdkWindow-pick-embedded-child" role="2.18"><primary sortas="Window::pick-embedded-child">GdkWindow::pick-embedded-child</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          user_function                      (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                        <link linkend="gdouble">gdouble</link>    x,
                                                        <link linkend="gdouble">gdouble</link>    y,
                                                        <link linkend="gpointer">gpointer</link>   user_data)      : Run Last</programlisting>
<para>
The ::pick-embedded-child signal is emitted to find an embedded
child at the given position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> the window on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> x coordinate in the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> y coordinate in the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the GdkWindow of the embedded child at <parameter>x</parameter>, <parameter>y</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since 2.18</para></refsect2><refsect2 id="GdkWindow-to-embedder" role="signal"><title>The <literal>&quot;to-embedder&quot;</literal> signal</title>
<indexterm zone="GdkWindow-to-embedder" role="2.18"><primary sortas="Window::to-embedder">GdkWindow::to-embedder</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GdkWindow">GdkWindow</link> *window,
                                                        <link linkend="gdouble">gdouble</link>    offscreen-x,
                                                        <link linkend="gdouble">gdouble</link>    offscreen-y,
                                                        <link linkend="gpointer">gpointer</link>   embedder-x,
                                                        <link linkend="gpointer">gpointer</link>   embedder-y,
                                                        <link linkend="gpointer">gpointer</link>   user_data)        : Run Last</programlisting>
<para>
The ::to-embedder signal is emitted to translate coordinates
in an offscreen window to its embedder.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara> the offscreen window on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offscreen-x</parameter>&#160;:</term>
<listitem><simpara> x coordinate in the offscreen window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offscreen-y</parameter>&#160;:</term>
<listitem><simpara> y coordinate in the offscreen window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>embedder-x</parameter>&#160;:</term>
<listitem><simpara> return location for the x coordinate in the embedder window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>embedder-y</parameter>&#160;:</term>
<listitem><simpara> return location for the y coordinate in the embedder window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist><para>Since 2.18</para></refsect2>
</refsect1>



</refentry>
