Create a new Gdk.Window

Parameters:

Object properties

Create a new Gdk.Window

Parameters:

Gdk.Window parent

a GdkWindow, or NULL to create the window as a child of the default root window for the default display.

Gdk.WindowAttr attributes Required (not null)

attributes of the new window

gint32 attributes_mask Required (not null)

mask indicating which fields in attributes are valid

Returns:

Gdk.Window the new GdkWindow

Obtains the window underneath the mouse pointer, returning the
location of that window in win_x, win_y. Returns NULL if the
window under the mouse pointer is not known to GDK (if the window
belongs to another application and a GdkWindow hasn't been created
for it with gdk_window_foreign_new())
gdk_display_get_window_at_pointer() instead.

Parameters:

Object out_values

gint32 win_x

gint32 win_y

Returns:

Gdk.Window window under the mouse pointer

Constrains a desired width and height according to a
set of geometry hints (such as minimum and maximum size).

Parameters:

Gdk.Geometry geometry Required (not null)

a GdkGeometry structure

guint32 flags Required (not null)

a mask indicating what portions of geometry are set

gint32 width Required (not null)

desired width of window

gint32 height Required (not null)

desired height of the window

Returns:

new_width: gint32

new_height: gint32

Calls gdk_window_process_updates() for all windows (see GdkWindow)
in the application.

Returns:

none

With update debugging enabled, calls to
gdk_window_invalidate_region() clear the invalidated region of the
screen to a noticeable color, and GDK pauses for a short time
before sending exposes to windows during
gdk_window_process_updates(). 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.
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.
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 gdk_window_set_debug_updates()
yourself, though you might want to use this function to enable
updates sometime after application startup time.

Parameters:

gboolean setting Required (not null)

TRUE to turn on update debugging

Returns:

none

Emits a short beep associated to window in the appropriate
display, if supported. Otherwise, emits a short beep on
the display just as gdk_display_beep().

Returns:

none

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 Extended
Window Manager Hints, but has a fallback implementation for
other window managers.

Parameters:

gint32 button Required (not null)

the button being used to drag

gint32 root_x Required (not null)

root window X coordinate of mouse click that began the drag

gint32 root_y Required (not null)

root window Y coordinate of mouse click that began the drag

guint32 timestamp Required (not null)

timestamp of mouse click that began the drag

Returns:

none

A convenience wrapper around gdk_window_begin_paint_region() which
creates a rectangular region for you. See
gdk_window_begin_paint_region() for details.

Parameters:

cairo.RectangleInt rectangle Required (not null)

rectangle you intend to draw to

Returns:

none

Indicates that you are beginning the process of redrawing region.
A backing store (offscreen buffer) large enough to contain region
will be created. The backing store will be initialized with the
background color or background surface for window. Then, all
drawing operations performed on window will be diverted to the
backing store. When you call gdk_window_end_paint(), the backing
store will be copied to window, making it visible onscreen. Only
the part of window contained in region will be modified; that is,
drawing operations are clipped to region.
The net result of all this is to remove flicker, because the user
sees the finished product appear all at once when you call
gdk_window_end_paint(). If you draw to window directly without
calling gdk_window_begin_paint_region(), the user may see flicker
as individual drawing operations are performed in sequence. The
clipping and background-initializing features of
gdk_window_begin_paint_region() are conveniences for the
programmer, so you can avoid doing that work yourself.
When using GTK+, the widget system automatically places calls to
gdk_window_begin_paint_region() and gdk_window_end_paint() 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
GdkEventExpose 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
gdk_window_begin_paint_region(). (You can disable the automatic
calls around expose events on a widget-by-widget basis by calling
gtk_widget_set_double_buffered().)
If you call this function multiple times before calling the
matching gdk_window_end_paint(), the backing stores are pushed onto
a stack. gdk_window_end_paint() 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
gdk_window_end_paint() is required for each call to
gdk_window_begin_paint_region().

Parameters:

cairo.Region region Required (not null)

region you intend to draw to

Returns:

none

Begins a window resize operation (for a toplevel window).
You might use this function to implement a "window resize grip," for
example; in fact GtkStatusbar uses it. The function works best
with window managers that support the Extended Window Manager Hints, but has a
fallback implementation for other window managers.

Parameters:

Gdk.WindowEdge edge Required (not null)

the edge or corner from which the drag is started

gint32 button Required (not null)

the button being used to drag

gint32 root_x Required (not null)

root window X coordinate of mouse click that began the drag

gint32 root_y Required (not null)

root window Y coordinate of mouse click that began the drag

guint32 timestamp Required (not null)

timestamp of mouse click that began the drag (use gdk_event_get_time())

Returns:

none

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.
This function can only be called if gdk_window_enable_synchronized_configure()
was called previously.

Returns:

none

Transforms window coordinates from a parent window to a child
window, where the parent window is the normal parent as returned by
gdk_window_get_parent() for normal windows, and the window's
embedder as returned by gdk_offscreen_window_get_embedder() for
offscreen windows.
For normal windows, calling this function is equivalent to subtracting
the return values of gdk_window_get_position() from the parent coordinates.
For offscreen windows however (which can be arbitrarily transformed),
the coordinates.
You should always use this function when writing generic code that
walks down a window hierarchy.

Parameters:

gdouble parent_x Required (not null)

X coordinate in parent's coordinate system

gdouble parent_y Required (not null)

Y coordinate in parent's coordinate system

Returns:

x: gdouble

y: gdouble

Transforms window coordinates from a child window to its parent
window, where the parent window is the normal parent as returned by
gdk_window_get_parent() for normal windows, and the window's
embedder as returned by gdk_offscreen_window_get_embedder() for
offscreen windows.
For normal windows, calling this function is equivalent to adding
the return values of gdk_window_get_position() to the child coordinates.
For offscreen windows however (which can be arbitrarily transformed),
the coordinates.
You should always use this function when writing generic code that
walks up a window hierarchy.

Parameters:

gdouble x Required (not null)

X coordinate in child's coordinate system

gdouble y Required (not null)

Y coordinate in child's coordinate system

Returns:

parent_x: gdouble

parent_y: gdouble

Create a new surface that is as compatible as possible with the
given window. For example the new surface will have the same
fallback resolution and font options as window. Generally, the new
surface will also use the same backend as window, unless that is
not possible for some reason. The type of the returned surface may
be examined with cairo_surface_get_type().
Initially the surface contents are all 0 (transparent if contents
have transparency, black otherwise.)
owns the surface and should call cairo_surface_destroy() when done
with it.
This function always returns a valid pointer, but it will return a
pointer to a "nil" surface if other is already in an error state
or any other error occurs.

Parameters:

cairo.Content content Required (not null)

the content for the new surface

gint32 width Required (not null)

width of the new surface

gint32 height Required (not null)

height of the new surface

Returns:

cairo.Surface a pointer to the newly allocated surface. The caller

Attempt to deiconify (unminimize) window. On X11 the window manager may
choose to ignore the request to deiconify. When using GTK+,
use gtk_window_deiconify() instead of the GdkWindow variant. Or better yet,
you probably want to use gtk_window_present(), which raises the window, focuses it,
unminimizes it, and puts it on the current desktop.

Returns:

none

Destroys the window system resources associated with window and decrements window's
reference count. The window system resources for all children of window are also
destroyed, but the children's reference counts are not decremented.
Note that a window will not be destroyed automatically when its reference count
reaches zero. You must call this function yourself before that happens.

Returns:

none

Returns:

none

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 gdk_window_configure_finished() every
time it has finished all processing associated with a set of
Configure events. Toplevel GTK+ windows automatically use this
protocol.
On X, calling this function makes window participate in the
_NET_WM_SYNC_REQUEST window manager protocol.

Returns:

none

Indicates that the backing store created by the most recent call to
gdk_window_begin_paint_region() 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
gdk_window_begin_paint_region() for full details. It is an error to
call this function without a matching
gdk_window_begin_paint_region() first.

Returns:

none

Tries to ensure that there is a window-system native window for this
GdkWindow. This may fail in some situations, returning FALSE.
Offscreen window and children of them can never have native windows.
Some backends may not support native child windows.

Returns:

gboolean TRUE if the window has a native window, FALSE otherwise

Flush all outstanding cached operations on a window, leaving the
window in a state which reflects all that has been drawn before.
Gdk uses multiple kinds of caching to get better performance and
nicer drawing. For instance, during exposes all paints to a window
using double buffered rendering are keep on a surface until the last
window has been exposed. It also delays window moves/scrolls until
as long as possible until next update to avoid tearing when moving
windows.
Normally this should be completely invisible to applications, as
we automatically flush the windows when required, but this might
be needed if you for instance mix direct native drawing with
gdk drawing. For Gtk widgets that don't use double buffering this
will be called automatically before sending the expose event.

Returns:

none

Sets keyboard focus to window. In most cases, gtk_window_present()
should be used on a GtkWindow, rather than calling this function.

Parameters:

guint32 timestamp Required (not null)

timestamp of the event triggering the window focus

Returns:

none

Temporarily freezes a window and all its descendants such that it won't
receive expose events. The window will begin receiving expose events
again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If
gdk_window_freeze_toplevel_updates_libgtk_only()
has been called more than once,
gdk_window_thaw_toplevel_updates_libgtk_only() must be called
an equal number of times to begin processing exposes.
This function is not part of the GDK public API and is only
for use by GTK+.

Returns:

none

Temporarily freezes a window such that it won't receive expose
events. The window will begin receiving expose events again when
gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
has been called more than once, gdk_window_thaw_updates() must be called
an equal number of times to begin processing exposes.

Returns:

none

Moves the window into fullscreen mode. This means the
window covers the entire screen and is above any panels
or task bars.
If the window was already fullscreen, then this function does nothing.
On X11, asks the window manager to put window 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.

Returns:

none

This function informs GDK that the geometry of an embedded
offscreen window has changed. This is necessary for GDK to keep
track of which offscreen window the pointer is in.

Returns:

none

Determines whether or not the desktop environment shuld be hinted that
the window does not want to receive input focus.

Returns:

gboolean whether or not the window should receive input focus.

Gets the pattern used to clear the background on window. If window
does not have its own background and reuses the parent's, NULL is
returned and you'll have to query it yourself.
NULL to use the parent's background.

Returns:

cairo.Pattern The pattern to use for the background or

Gets the list of children of window 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.
The returned list must be freed, but the elements in the
list need not be.
list of child windows inside window

Returns:

Array

Computes the region of a window that potentially can be written
to by drawing primitives. This region may not take into account
other factors such as if the window is obscured by other windows,
but no area outside of this region will be affected by drawing
primitives.
when you are done.

Returns:

cairo.Region a cairo_region_t. This must be freed with cairo_region_destroy()

Determines whether window is composited.
See gdk_window_set_composited().

Returns:

gboolean TRUE if the window is composited.

Retrieves a GdkCursor pointer for the cursor currently set on the
specified GdkWindow, or NULL. If the return value is NULL then
there is no custom cursor set on the specified window, and it is
using the cursor for its parent window.
object is owned by the GdkWindow and should not be unreferenced
directly. Use gdk_window_set_cursor() to unset the cursor of the
window

Returns:

Gdk.Cursor a GdkCursor, or NULL. The returned

Returns the decorations set on the GdkWindow with
gdk_window_set_decorations().

Parameters:

Object out_values

Gdk.WMDecoration decorations

Returns:

gboolean TRUE if the window has decorations set, FALSE otherwise.

Retrieves a GdkCursor pointer for the device currently set on the
specified GdkWindow, or NULL. If the return value is NULL then
there is no custom cursor set on the specified window, and it is
using the cursor for its parent window.
object is owned by the GdkWindow and should not be unreferenced
directly. Use gdk_window_set_cursor() to unset the cursor of the
window

Parameters:

Gdk.Device device Required (not null)

a master, pointer GdkDevice.

Returns:

Gdk.Cursor a GdkCursor, or NULL. The returned

Returns the event mask for window corresponding to an specific device.

Parameters:

Gdk.Device device Required (not null)

a GdkDevice.

Returns:

Gdk.EventMask device event mask for window

Obtains the current device position and modifier state.
The position is given in coordinates relative to the upper left
corner of window.
gdk_device_get_window_at_position()), or NULL if the window is not known to GDK.

Parameters:

Gdk.Device device Required (not null)

pointer GdkDevice to query to.

Object out_values

gint32 x

gint32 y

Gdk.ModifierType mask

Returns:

Gdk.Window The window underneath device (as with

Gets the GdkDisplay associated with a GdkWindow.

Returns:

Gdk.Display the GdkDisplay associated with window

Finds out the DND protocol supported by a window.

Parameters:

Object out_values

Gdk.Window target

Returns:

Gdk.DragProtocol the supported DND protocol.

Obtains the parent of window, as known to GDK. Works like
gdk_window_get_parent() for normal windows, but returns the
window's embedder for offscreen windows.

Returns:

Gdk.Window effective parent of window

Gets the toplevel window that's an ancestor of window.
Works like gdk_window_get_toplevel(), but treats an offscreen window's
embedder as its parent, using gdk_window_get_effective_parent().

Returns:

Gdk.Window the effective toplevel window containing window

Gets the event mask for window for all master input devices. See
gdk_window_set_events().

Returns:

Gdk.EventMask event mask for window

Determines whether or not the desktop environment should be hinted that the
window does not want to receive input focus when it is mapped.
it is mapped.

Returns:

gboolean whether or not the window wants to receive input focus when

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 gdk_window_get_origin().

Parameters:

cairo.RectangleInt rect Required (not null)

rectangle to fill with bounding box of the window frame

Returns:

none

Any of the return location arguments to this function may be NULL,
if you aren't interested in getting the value of that field.
The X and Y coordinates returned are relative to the parent window
of window, which for toplevels usually means relative to the
window decorations (titlebar, etc.) rather than relative to the
root window (screen-size background window).
On the X11 platform, the geometry is obtained from the X server,
so reflects the latest position of window; this may be out-of-sync
with the position of window delivered in the most-recently-processed
GdkEventConfigure. gdk_window_get_position() in contrast gets the
position from the most recent configure event.

If window is not a toplevel, it is much better
to call gdk_window_get_position(), gdk_window_get_width() and
gdk_window_get_height() instead, because it avoids the roundtrip to
the X server and because these functions support the full 32-bit
coordinate space, whereas gdk_window_get_geometry() is restricted to
the 16-bit coordinates of X11.

Returns:

x: gint32

y: gint32

width: gint32

height: gint32

Returns the group leader window for window. See gdk_window_set_group().

Returns:

Gdk.Window the group leader window for window

Returns the height of the given window.
On the X11 platform the returned size is the size reported in the
most-recently-processed configure event, rather than the current
size on the X server.

Returns:

gint32 The height of window

Determines whether or not the window manager is hinted that window
has modal behaviour.

Returns:

gboolean whether or not the window has the modal hint set.

Obtains the position of a window in root window coordinates.
(Compare with gdk_window_get_position() and
gdk_window_get_geometry() which return the position of a window
relative to its parent window.)

Parameters:

Object out_values

gint32 x

gint32 y

Returns:

gint32 not meaningful, ignore

Obtains the parent of window, as known to GDK. Does not query the
X server; thus this returns the parent as passed to gdk_window_new(),
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.
Note that you should use gdk_window_get_effective_parent() when
writing generic code that walks up a window hierarchy, because
gdk_window_get_parent() will most likely not do what you expect if
there are offscreen windows in the hierarchy.

Returns:

Gdk.Window parent of window

Obtains the current pointer position and modifier state.
The position is given in coordinates relative to the upper left
corner of window.
gdk_window_at_pointer()), or NULL if the window containing the
pointer isn't known to GDK

Parameters:

Object out_values

gint32 x

gint32 y

Gdk.ModifierType mask

Returns:

Gdk.Window the window containing the pointer (as with

Obtains the position of the window as reported in the
most-recently-processed GdkEventConfigure. Contrast with
gdk_window_get_geometry() which queries the X server for the
current window position, regardless of which events have been
received or processed.
The position coordinates are relative to the window's parent window.

Returns:

x: gint32

y: gint32

Obtains the position of a window position in root
window coordinates. This is similar to
gdk_window_get_origin() but allows you go pass
in any position in the window, not just the origin.

Parameters:

gint32 x Required (not null)

X coordinate in window

gint32 y Required (not null)

Y coordinate in window

Returns:

root_x: gint32

root_y: gint32

Obtains the top-left corner of the window manager frame in root
window coordinates.

Returns:

x: gint32

y: gint32

Gets the GdkScreen associated with a GdkWindow.

Returns:

Gdk.Screen the GdkScreen associated with window

Returns the event mask for window corresponding to the device class specified
by source.

Parameters:

Gdk.InputSource source Required (not null)

a GdkInputSource to define the source class.

Returns:

Gdk.EventMask source event mask for window

Gets the bitwise OR of the currently active window state flags,
from the GdkWindowState enumeration.

Returns:

Gdk.WindowState window state bitfield

Returns TRUE if the window is aware of the existence of multiple
devices.

Returns:

gboolean TRUE if the window handles multidevice features.

Gets the toplevel window that's an ancestor of window.
Any window type but GDK_WINDOW_CHILD is considered a
toplevel window, as is a GDK_WINDOW_CHILD window that
has a root window as parent.
Note that you should use gdk_window_get_effective_toplevel() when
you want to get to a window's toplevel as seen on screen, because
gdk_window_get_toplevel() will most likely not do what you expect
if there are offscreen windows in the hierarchy.

Returns:

Gdk.Window the toplevel window containing window

This function returns the type hint set for a window.

Returns:

Gdk.WindowTypeHint The type hint set for window

Transfers ownership of the update area from window to the caller
of the function. That is, after calling this function, window will
no longer have an invalid/dirty region; the update area is removed
from window and handed to you. If a window has no update area,
gdk_window_get_update_area() returns NULL. You are responsible for
calling cairo_region_destroy() on the returned region if it's non-NULL.

Returns:

cairo.Region the update area for window

Retrieves the user data for window, which is normally the widget
that window belongs to. See gdk_window_set_user_data().

Returns:

void*

Computes the region of the window that is potentially visible.
This does not necessarily take into account if the window is
obscured by other windows, but no area outside of this region
is visible.
when you are done.

Returns:

cairo.Region a cairo_region_t. This must be freed with cairo_region_destroy()

Gets the GdkVisual describing the pixel format of window.

Returns:

Gdk.Visual a GdkVisual

Returns the width of the given window.
On the X11 platform the returned size is the size reported in the
most-recently-processed configure event, rather than the current
size on the X server.

Returns:

gint32 The width of window

Gets the type of the window. See GdkWindowType.

Returns:

Gdk.WindowType type of window

Checks whether the window has a native window or not. Note that
you can use gdk_window_ensure_native() if a native window is needed.

Returns:

gboolean TRUE if the window has a native window, FALSE otherwise.

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 gtk_widget_hide().

Returns:

none

Asks to iconify (minimize) window. The window manager may choose
to ignore the request, but normally will honor it. Using
gtk_window_iconify() is preferred, if you have a GtkWindow widget.
This function only makes sense when window is a toplevel window.

Returns:

none

Like gdk_window_shape_combine_region(), 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 window.
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".
On the X11 platform, this requires version 1.1 of the
shape extension.
On the Win32 platform, this functionality is not present and the
function does nothing.

Parameters:

cairo.Region shape_region Required (not null)

region of window to be non-transparent

gint32 offset_x Required (not null)

X position of shape_region in window coordinates

gint32 offset_y Required (not null)

Y position of shape_region in window coordinates

Returns:

none

Adds region to the update area for window. The update area is the
region that needs to be redrawn, or "dirty region." The call
gdk_window_process_updates() sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of window in
response to those expose events.
GDK will call gdk_window_process_all_updates() 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.
The child_func parameter controls whether the region of
each child window that intersects region will also be invalidated.
Only children for which child_func returns TRUE will have the area
invalidated.

Parameters:

cairo.Region region Required (not null)

a cairo_region_t

Function (Window window, void* user_data) : none Required (not null)

function to use to decide if to recurse to a child, NULL means never recurse.

void* user_data Required (not null)

data passed to child_func

Returns:

none

A convenience wrapper around gdk_window_invalidate_region() which
invalidates a rectangular region. See
gdk_window_invalidate_region() for details.

Parameters:

cairo.RectangleInt rect

rectangle to invalidate or NULL to invalidate the whole window

gboolean invalidate_children Required (not null)

whether to also invalidate child windows

Returns:

none

Adds region to the update area for window. The update area is the
region that needs to be redrawn, or "dirty region." The call
gdk_window_process_updates() sends one or more expose events to the
window, which together cover the entire update area. An
application would normally redraw the contents of window in
response to those expose events.
GDK will call gdk_window_process_all_updates() 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.
The invalidate_children parameter controls whether the region of
each child window that intersects region will also be invalidated.
If FALSE, 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.

Parameters:

cairo.Region region Required (not null)

a cairo_region_t

gboolean invalidate_children Required (not null)

TRUE to also invalidate child windows

Returns:

none

Check to see if a window is destroyed..

Returns:

gboolean TRUE if the window is destroyed

Determines whether or not the window is an input only window.

Returns:

gboolean TRUE if window is input only

Determines whether or not the window is shaped.

Returns:

gboolean TRUE if window is shaped

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.)

Returns:

gboolean TRUE if the window is viewable

Checks whether the window has been mapped (with gdk_window_show() or
gdk_window_show_unraised()).

Returns:

gboolean TRUE if the window is mapped

Lowers window to the bottom of the Z-order (stacking order), so that
other windows with the same parent window appear above window.
This is true whether or not the other windows are visible.
If window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_lower() only
requests the restack, does not guarantee it.
Note that gdk_window_show() raises the window again, so don't call this
function before gdk_window_show(). (Try gdk_window_show_unraised().)

Returns:

none

Maximizes the window. If the window was already maximized, then
this function does nothing.
On X11, asks the window manager to maximize window, 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.
On Windows, reliably maximizes the window.

Returns:

none

Merges the input shape masks for any child windows into the
input shape mask for window. i.e. the union of all input masks
for window and its children will become the new input mask
for window. See gdk_window_input_shape_combine_region().
This function is distinct from gdk_window_set_child_input_shapes()
because it includes window's input shape mask in the set of
shapes to be merged.

Returns:

none

Merges the shape masks for any child windows into the
shape mask for window. i.e. the union of all masks
for window and its children will become the new mask
for window. See gdk_window_shape_combine_region().
This function is distinct from gdk_window_set_child_shapes()
because it includes window's shape mask in the set of shapes to
be merged.

Returns:

none

Repositions a window relative to its parent window.
For toplevel windows, window managers may ignore or modify the move;
you should probably use gtk_window_move() on a GtkWindow widget
anyway, instead of using GDK functions. For child windows,
the move will reliably succeed.
If you're also planning to resize the window, use gdk_window_move_resize()
to both move and resize simultaneously, for a nicer visual effect.

Parameters:

gint32 x Required (not null)

X coordinate relative to window's parent

gint32 y Required (not null)

Y coordinate relative to window's parent

Returns:

none

Move the part of window indicated by region by dy pixels in the Y
direction and dx pixels in the X direction. The portions of region
that not covered by the new position of region are invalidated.
Child windows are not moved.

Parameters:

cairo.Region region Required (not null)

The cairo_region_t to move

gint32 dx Required (not null)

Amount to move in the X direction

gint32 dy Required (not null)

Amount to move in the Y direction

Returns:

none

Equivalent to calling gdk_window_move() and gdk_window_resize(),
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 gdk_window_move_resize().)

Parameters:

gint32 x Required (not null)

new X position relative to window's parent

gint32 y Required (not null)

new Y position relative to window's parent

gint32 width Required (not null)

new width

gint32 height Required (not null)

new height

Returns:

none

Like gdk_window_get_children(), but does not copy the list of
children, so the list does not need to be freed.
a reference to the list of child windows in window

Returns:

Array

Sends one or more expose events to window. The areas in each
expose event will cover the entire update area for the window (see
gdk_window_invalidate_region() for details). Normally GDK calls
gdk_window_process_all_updates() 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.

Parameters:

gboolean update_children Required (not null)

whether to also process updates for child windows

Returns:

none

Raises window to the top of the Z-order (stacking order), so that
other windows with the same parent window appear below window.
This is true whether or not the windows are visible.
If window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_raise() only
requests the restack, does not guarantee it.

Returns:

none

Registers a window as a potential drop destination.

Returns:

none

Reparents window into the given new_parent. The window being
reparented will be unmapped as a side effect.

Parameters:

Gdk.Window new_parent Required (not null)

new parent to move window into

gint32 x Required (not null)

X location inside the new parent

gint32 y Required (not null)

Y location inside the new parent

Returns:

none

Resizes window; for toplevel windows, asks the window manager to resize
the window. The window manager may not allow the resize. When using GTK+,
use gtk_window_resize() instead of this low-level GDK function.
Windows may not be resized below 1x1.
If you're also planning to move the window, use gdk_window_move_resize()
to both move and resize simultaneously, for a nicer visual effect.

Parameters:

gint32 width Required (not null)

new width of the window

gint32 height Required (not null)

new height of the window

Returns:

none

Changes the position of window in the Z-order (stacking order), so that
it is above sibling (if above is TRUE) or below sibling (if above is
FALSE).
If sibling is NULL, then this either raises (if above is TRUE) or
lowers the window.
If window is a toplevel, the window manager may choose to deny the
request to move the window in the Z-order, gdk_window_restack() only
requests the restack, does not guarantee it.

Parameters:

Gdk.Window sibling

a GdkWindow that is a sibling of window, or NULL

gboolean above Required (not null)

a boolean

Returns:

none

Scroll the contents of window, both pixels and children, by the
given amount. window itself does not move. Portions of the window
that the scroll operation brings in from offscreen areas are
invalidated. The invalidated region may be bigger than what would
strictly be necessary.
For X11, a minimum area will be invalidated if the window has no
subwindows, or if the edges of the window's parent do not extend
beyond the edges of the window. In other cases, a multi-step process
is used to scroll the window which may produce temporary visual
artifacts and unnecessary invalidations.

Parameters:

gint32 dx Required (not null)

Amount to scroll in the X direction

gint32 dy Required (not null)

Amount to scroll in the Y direction

Returns:

none

Setting accept_focus to FALSE hints the desktop environment that the
window doesn't want to receive input focus.
On X, it is the responsibility of the window manager to interpret this
hint. ICCCM-compliant window manager usually respect it.

Parameters:

gboolean accept_focus Required (not null)

TRUE if the window should receive input focus

Returns:

none

Sets the background color of window. (However, when using GTK+,
set the background of a widget with gtk_widget_modify_bg() - if
you're an application - or gtk_style_set_background() - if you're
implementing a custom widget.)
See also gdk_window_set_background_pattern().

Parameters:

Gdk.Color color Required (not null)

a GdkColor

Returns:

none

Sets the background of window.
A background of NULL means that the window will inherit its
background form its parent window.
The windowing system will normally fill a window with its background
when the window is obscured then exposed.

Parameters:

cairo.Pattern pattern

a pattern to use, or NULL

Returns:

none

Sets the background color of window.
See also gdk_window_set_background_pattern().

Parameters:

Gdk.RGBA rgba Required (not null)

a GdkRGBA color

Returns:

none

Sets the input shape mask of window to the union of input shape masks
for all children of window, ignoring the input shape mask of window
itself. Contrast with gdk_window_merge_child_input_shapes() which includes
the input shape mask of window in the masks to be merged.

Returns:

none

Sets the shape mask of window to the union of shape masks
for all children of window, ignoring the shape mask of window
itself. Contrast with gdk_window_merge_child_shapes() which includes
the shape mask of window in the masks to be merged.

Returns:

none

Sets a GdkWindow 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
for an example.
It only makes sense for child windows to be composited; see
gdk_window_set_opacity() if you need translucent toplevel
windows.
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.
This call is only supported on some systems (currently,
only X11 with new enough Xcomposite and Xdamage extensions).
You must call gdk_display_supports_composite() to check if
setting a window as composited is supported before
attempting to do so.

Parameters:

gboolean composited Required (not null)

TRUE to set the window as composited

Returns:

none

Sets the default mouse pointer for a GdkWindow. Use gdk_cursor_new_for_display()
or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor
invisible, use GDK_BLANK_CURSOR. Passing NULL for the cursor argument
to gdk_window_set_cursor() means that window will use the cursor of its
parent window. Most windows should use this default.

Parameters:

Gdk.Cursor cursor

a cursor

Returns:

none

"Decorations" are the features the window manager adds to a toplevel GdkWindow.
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 gtk_window_set_decorated() on a GtkWindow instead of
using the GDK function directly.
The decorations argument is the logical OR of the fields in
the GdkWMDecoration enumeration. If GDK_DECOR_ALL is included in the
mask, the other bits indicate which decorations should be turned off.
If GDK_DECOR_ALL is not included, then the other bits indicate
which decorations should be turned on.
Most window managers honor a decorations hint of 0 to disable all decorations,
but very few honor all possible combinations of bits.

Parameters:

Gdk.WMDecoration decorations Required (not null)

decoration hint mask

Returns:

none

Sets a specific GdkCursor for a given device when it gets inside window.
Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create
the cursor. To make the cursor invisible, use GDK_BLANK_CURSOR. Passing
NULL for the cursor argument to gdk_window_set_cursor() means that
use this default.

Parameters:

Gdk.Device device Required (not null)

a master, pointer GdkDevice

Gdk.Cursor cursor Required (not null)

a GdkCursor

Returns:

none

Sets the event mask for a given device (Normally a floating device, not
attached to any visible pointer) to window. For example, an event mask
including GDK_BUTTON_PRESS_MASK means the window should report button
press events. The event mask is the bitwise OR of values from the
GdkEventMask enumeration.

Parameters:

Gdk.Device device Required (not null)

GdkDevice to enable events for.

Gdk.EventMask event_mask Required (not null)

event mask for window

Returns:

none

The event mask for a window determines which events will be reported
for that window from all master input devices. For example, an event mask
including GDK_BUTTON_PRESS_MASK means the window should report button
press events. The event mask is the bitwise OR of values from the
GdkEventMask enumeration.

Parameters:

Gdk.EventMask event_mask Required (not null)

event mask for window

Returns:

none

Setting focus_on_map to FALSE 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).
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.

Parameters:

gboolean focus_on_map Required (not null)

TRUE if the window should receive input focus when mapped

Returns:

none

Sets hints about the window management functions to make available
via buttons on the window frame.
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.
The functions argument is the logical OR of values from the
GdkWMFunction enumeration. If the bitmask includes GDK_FUNC_ALL,
then the other bits indicate which functions to disable; if
it doesn't include GDK_FUNC_ALL, it indicates which functions to
enable.

Parameters:

Gdk.WMFunction functions Required (not null)

bitmask of operations to allow on window

Returns:

none

Sets the geometry hints for window. Hints flagged in geom_mask
are set, hints not flagged in geom_mask are unset.
To unset all hints, use a geom_mask of 0 and a geometry of NULL.
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 gdk_window_resize() or
gdk_window_move_resize().
Note that on X11, this effect has no effect on windows
of type GDK_WINDOW_TEMP or windows where override redirect
has been turned on via gdk_window_set_override_redirect()
since these windows are not resizable by the user.
Since you can't count on the windowing system doing the
constraints for programmatic resizes, you should generally
call gdk_window_constrain_size() yourself to determine
appropriate sizes.

Parameters:

Gdk.Geometry geometry Required (not null)

geometry hints

Gdk.WindowHints geom_mask Required (not null)

bitmask indicating fields of geometry to pay attention to

Returns:

none

Sets the group leader window for window. 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.
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.

Parameters:

Gdk.Window leader Required (not null)

group leader window, or NULL to restore the default group leader window

Returns:

none

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.

Parameters:

Array pixbufs Required (not null)

A list of pixbufs, of different sizes.

Returns:

none

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.
After calling this with a non-NULL name, calls to gdk_window_set_title()
will not update the icon title.
Using NULL for name unsets the icon title; further calls to
gdk_window_set_title() will again update the icon title as well.

Parameters:

String name Required (not null)

name of window while iconified (minimized)

Returns:

none

Set if window must be kept above other windows. If the
window was already above, then this function does nothing.
On X11, asks the window manager to keep window 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.

Parameters:

gboolean setting Required (not null)

whether to keep window above other windows

Returns:

none

Set if window must be kept below other windows. If the
window was already below, then this function does nothing.
On X11, asks the window manager to keep window 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.

Parameters:

gboolean setting Required (not null)

whether to keep window below other windows

Returns:

none

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.
You should only use this on windows for which you have
previously called gdk_window_set_transient_for()

Parameters:

gboolean modal Required (not null)

TRUE if the window is modal, FALSE otherwise.

Returns:

none

Request the windowing system to make window partially transparent,
with opacity 0 being fully transparent and 1 fully opaque. (Values
of the opacity parameter are clamped to the [0,1] range.)
On X11, this works only on X screens with a compositing manager
running.
For setting up per-pixel alpha, see gdk_screen_get_rgba_visual().
For making non-toplevel windows translucent, see
gdk_window_set_composited().

Parameters:

gdouble opacity Required (not null)

opacity

Returns:

none

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.
Override redirect should only be used for short-lived temporary
windows, such as popup menus. GtkMenu uses an override redirect
window in its implementation, for example.

Parameters:

gboolean override_redirect Required (not null)

TRUE if window should be override redirect

Returns:

none

When using GTK+, typically you should use gtk_window_set_role() instead
of this low-level function.
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.

Parameters:

String role Required (not null)

a string indicating its role

Returns:

none

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 gdk_window_set_type_hint()
already fully describes the window, this function should
not be called in addition, instead you should
allow the window to be treated according to standard policy for
its semantic type.

Parameters:

gboolean skips_pager Required (not null)

TRUE to skip the pager

Returns:

none

Toggles whether a window should appear in a task list or window
list. If a window's semantic type as specified with
gdk_window_set_type_hint() already fully describes the window, this
function should not be called in addition,
instead you should allow the window to be treated according to
standard policy for its semantic type.

Parameters:

gboolean skips_taskbar Required (not null)

TRUE to skip the taskbar

Returns:

none

Sets the event mask for any floating device (i.e. not attached to any
visible pointer) that has the source defined as source. This event
mask will be applied both to currently existing, newly added devices
after this call, and devices being attached/detached.

Parameters:

Gdk.InputSource source Required (not null)

a GdkInputSource to define the source class.

Gdk.EventMask event_mask Required (not null)

event mask for window

Returns:

none

When using GTK+, typically you should use gtk_window_set_startup_id()
instead of this low-level function.

Parameters:

String startup_id Required (not null)

a string with startup-notification identifier

Returns:

none

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.

Parameters:

gboolean use_static Required (not null)

TRUE to turn on static gravity

Returns:

gboolean TRUE if the server supports static gravity

This function will enable multidevice features in window.
Multidevice aware windows will need to handle properly multiple,
per device enter/leave events, device grabs and grab ownerships.

Parameters:

gboolean support_multidevice Required (not null)

TRUE to enable multidevice support in window.

Returns:

none

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 gdk_window_set_icon_name()), the icon name will be set to
user-readable strings in GDK/GTK+). title may not be NULL.

Parameters:

String title Required (not null)

title of window

Returns:

none

Indicates to the window manager that window is a transient dialog
associated with the application window parent. This allows the
window manager to do things like center window on parent and
keep window above parent.
See gtk_window_set_transient_for() if you're using GtkWindow or
GtkDialog.

Parameters:

Gdk.Window parent Required (not null)

another toplevel GdkWindow

Returns:

none

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.
The hint must be set before the window is mapped.

Parameters:

Gdk.WindowTypeHint hint Required (not null)

A hint of the function this window will have

Returns:

none

Toggles whether a window needs the user's
urgent attention.

Parameters:

gboolean urgent Required (not null)

TRUE if the window is urgent

Returns:

none

For most purposes this function is deprecated in favor of
g_object_set_data(). However, for historical reasons GTK+ stores
the GtkWidget that owns a GdkWindow as user data on the
GdkWindow. So, custom widget implementations should use
this function for that. If GTK+ receives an event for a GdkWindow,
and the user data for the window is non-NULL, GTK+ will assume the
user data is a GtkWidget, and forward the event to that widget.

Parameters:

void* user_data Required (not null)

user data

Returns:

none

Makes pixels in window outside shape_region be transparent,
so that the window may be nonrectangular.
If shape_region is NULL, the shape will be unset, so the whole
window will be opaque again. offset_x and offset_y are ignored
if shape_region is NULL.
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.
This function works on both toplevel and child windows.

Parameters:

cairo.Region shape_region Required (not null)

region of window to be non-transparent

gint32 offset_x Required (not null)

X position of shape_region in window coordinates

gint32 offset_y Required (not null)

Y position of shape_region in window coordinates

Returns:

none

Like gdk_window_show_unraised(), but also raises the window to the
top of the window stack (moves the window to the front of the
Z-order).
This function maps a window so it's visible onscreen. Its opposite
is gdk_window_hide().
When implementing a GtkWidget, you should call this function on the widget's
GdkWindow as part of the "map" method.

Returns:

none

Shows a GdkWindow onscreen, but does not modify its stacking
order. In contrast, gdk_window_show() will raise the window
to the top of the window stack.
On the X11 platform, in Xlib terms, this function calls
XMapWindow() (it also updates some internal GDK state, which means
that you can't really use XMapWindow() directly on a GDK window).

Returns:

none

"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 GtkWindow, gtk_window_stick() may be more useful.)
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.

Returns:

none

Thaws a window frozen with
gdk_window_freeze_toplevel_updates_libgtk_only().
This function is not part of the GDK public API and is only
for use by GTK+.

Returns:

none

Thaws a window frozen with gdk_window_freeze_updates().

Returns:

none

Moves the window out of fullscreen mode. If the window was not
fullscreen, does nothing.
On X11, asks the window manager to move window 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.

Returns:

none

Unmaximizes the window. If the window wasn't maximized, then this
function does nothing.
On X11, asks the window manager to unmaximize window, 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.
On Windows, reliably unmaximizes the window.

Returns:

none

Reverse operation for gdk_window_stick(); see gdk_window_stick(),
and gtk_window_unstick().

Returns:

none

Withdraws a window (unmaps it and asks the window manager to forget about it).
This function is not really useful as gdk_window_hide() automatically
withdraws toplevel windows before hiding them.

Returns:

none

The ::create-surface signal is emitted when an offscreen window
needs its surface (re)created, which happens either when the the
window is first drawn to, or when the window is being
resized. The first signal handler that returns a non-NULL
surface will stop any further signal emission, and its surface
will be used.
Note that it is not possible to access the window's previous
surface from within any callback of this signal. Calling
gdk_offscreen_window_get_surface() will lead to a crash.

Parameters:

Gdk.Window self

gint32 width

gint32 height

Returns:

{cairo.Surface}

The ::from-embedder signal is emitted to translate coordinates
in the embedder of an offscreen window to the offscreen window.
See also GtkWindow::to-embedder.

Parameters:

Gdk.Window self

gdouble embedder-x

gdouble embedder-y

Object out_values

Return Object, use an empty Object, and the properties will get set as follows

gdouble offscreen-y

Returns:

{none}

The ::pick-embedded-child signal is emitted to find an embedded
child at the given position.

Parameters:

Gdk.Window self

gdouble x

gdouble y

Returns:

{Gdk.Window}

The ::to-embedder signal is emitted to translate coordinates
in an offscreen window to its embedder.
See also GtkWindow::from-embedder.

Parameters:

Gdk.Window self

gdouble offscreen-x

gdouble offscreen-y

Object out_values

Return Object, use an empty Object, and the properties will get set as follows

gdouble embedder-y

Returns:

{none}