Memory-managed wrapper type.

Type class for types which can be safely cast to Window, for instance with toWindow.

Cast to Window, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe Window.

Obtains the window underneath the mouse pointer, returning the location of that window in winX, winY. Returns Nothing if the window under the mouse pointer is not known to GDK (if the window belongs to another application and a Window hasn’t been created for it with gdk_window_foreign_new())

NOTE: For multihead-aware widgets or applications use displayGetWindowAtPointer instead.

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

Since: 2.12

Indicates that you are beginning the process of redrawing region on window, and provides you with a DrawingContext.

If window is a top level Window, backed by a native window implementation, 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_frame(), the contents of the backing store will be copied to window, making it visible on screen. 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 windowEndDrawFrame. If you draw to window directly without calling windowBeginDrawFrame, the user may see flicker as individual drawing operations are performed in sequence.

When using GTK+, the widget system automatically places calls to windowBeginDrawFrame and windowEndDrawFrame around emissions of the GtkWidget::draw signal. That is, if you’re drawing the contents of the widget yourself, you can assume that the widget has a cleared background, is already set as the clip region, and already has a backing store. Therefore in most cases, application code in GTK does not need to call windowBeginDrawFrame explicitly.

Since: 3.22

Begins a window move operation (for a toplevel window).

This function assumes that the drag is controlled by the client pointer device, use windowBeginMoveDragForDevice to begin a drag with a different device.

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.

Since: 3.4

A convenience wrapper around windowBeginPaintRegion which creates a rectangular region for you. See windowBeginPaintRegion for details.

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 windowEndPaint, 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 windowEndPaint. If you draw to window directly without calling windowBeginPaintRegion, the user may see flicker as individual drawing operations are performed in sequence. The clipping and background-initializing features of windowBeginPaintRegion are conveniences for the programmer, so you can avoid doing that work yourself.

When using GTK+, the widget system automatically places calls to windowBeginPaintRegion and windowEndPaint 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 EventExpose 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 windowBeginPaintRegion. (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 windowEndPaint, the backing stores are pushed onto a stack. windowEndPaint 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 windowEndPaint is required for each call to windowBeginPaintRegion.

Begins a window resize operation (for a toplevel window).

This function assumes that the drag is controlled by the client pointer device, use windowBeginResizeDragForDevice to begin a drag with a different device.

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.

Since: 3.4

Does nothing, present only for compatiblity.

Since: 2.6

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

Transforms window coordinates from a parent window to a child window, where the parent window is the normal parent as returned by windowGetParent for normal windows, and the window's embedder as returned by offscreenWindowGetEmbedder for offscreen windows.

For normal windows, calling this function is equivalent to subtracting the return values of windowGetPosition from the parent coordinates. For offscreen windows however (which can be arbitrarily transformed), this function calls the GdkWindow::from-embedder: signal to translate the coordinates.

You should always use this function when writing generic code that walks down a window hierarchy.

See also: windowCoordsToParent

Since: 2.22

Transforms window coordinates from a child window to its parent window, where the parent window is the normal parent as returned by windowGetParent for normal windows, and the window's embedder as returned by offscreenWindowGetEmbedder for offscreen windows.

For normal windows, calling this function is equivalent to adding the return values of windowGetPosition to the child coordinates. For offscreen windows however (which can be arbitrarily transformed), this function calls the GdkWindow::to-embedder: signal to translate the coordinates.

You should always use this function when writing generic code that walks up a window hierarchy.

See also: windowCoordsFromParent

Since: 2.22

Creates a new GLContext matching the framebuffer format to the visual of the Window. The context is disconnected from any particular window or surface.

If the creation of the GLContext failed, error will be set.

Before using the returned GLContext, you will need to call gLContextMakeCurrent or gLContextRealize.

Since: 3.16

Create a new image surface that is efficient to draw on the given window.

Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.)

The width and height of the new surface are not affected by the scaling factor of the window, or by the scale argument; they are the size of the surface in device pixels. If you wish to create an image surface capable of holding the contents of window you can use:

C code

 int scale = gdk_window_get_scale_factor (window);
 int width = gdk_window_get_width (window) * scale;
 int height = gdk_window_get_height (window) * scale;

 // format is set elsewhere
 cairo_surface_t *surface =
   gdk_window_create_similar_image_surface (window,
                                            format,
                                            width, height,
                                            scale);

Note that unlike cairo_surface_create_similar_image(), the new surface's device scale is set to scale, or to the scale factor of window if scale is 0.

Since: 3.10

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

Since: 2.22

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

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.

No description available in the introspection data.

Does nothing, present only for compatiblity.

Since: 2.6

Indicates that the drawing of the contents of window started with gdk_window_begin_frame() has been completed.

This function will take care of destroying the DrawingContext.

It is an error to call this function without a matching gdk_window_begin_frame() first.

Since: 3.22

Indicates that the backing store created by the most recent call to windowBeginPaintRegion 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 windowBeginPaintRegion for full details.

It is an error to call this function without a matching windowBeginPaintRegion first.

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.

Since: 2.18

This function does nothing.

Since: 2.18

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

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 windowThawToplevelUpdatesLibgtkOnly is called. If windowFreezeToplevelUpdatesLibgtkOnly has been called more than once, windowThawToplevelUpdatesLibgtkOnly 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+.

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

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.

Since: 2.2

Moves the window into fullscreen mode on the given monitor. 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.

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.

Since: 2.18

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

Since: 2.22

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

Since: 2.22

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.

Gets the list of children of window known to GDK with a particular userData set on it.

The returned list must be freed, but the elements in the list need not be.

The list is returned in (relative) stacking order, i.e. the lowest window is first.

Since: 3.10

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.

Determines whether window is composited.

See windowSetComposited.

Since: 2.22

Retrieves a Cursor pointer for the cursor currently set on the specified Window, or Nothing. If the return value is Nothing then there is no custom cursor set on the specified window, and it is using the cursor for its parent window.

Since: 2.18

Returns the decorations set on the GdkWindow with windowSetDecorations.

Retrieves a Cursor pointer for the device currently set on the specified Window, or Nothing. If the return value is Nothing then there is no custom cursor set on the specified window, and it is using the cursor for its parent window.

Since: 3.0

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

Since: 3.0

Obtains the current device position and modifier state. The position is given in coordinates relative to the upper left corner of window.

Use windowGetDevicePositionDouble if you need subpixel precision.

Since: 3.0

Obtains the current device position in doubles and modifier state. The position is given in coordinates relative to the upper left corner of window.

Since: 3.10

Gets the Display associated with a Window.

Since: 2.24

Finds out the DND protocol supported by a window.

Since: 3.0

Obtains the parent of window, as known to GDK. Works like windowGetParent for normal windows, but returns the window’s embedder for offscreen windows.

See also: offscreenWindowGetEmbedder

Since: 2.22

Gets the toplevel window that’s an ancestor of window.

Works like windowGetToplevel, but treats an offscreen window's embedder as its parent, using windowGetEffectiveParent.

See also: offscreenWindowGetEmbedder

Since: 2.22

Get the current event compression setting for this window.

Since: 3.12

Gets the event mask for window for all master input devices. See windowSetEvents.

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

Since: 2.22

Gets the frame clock for the window. The frame clock for a window never changes unless the window is reparented to a new toplevel window.

Since: 3.8

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

Obtains the FullscreenMode of the window.

Since: 3.8

Any of the return location arguments to this function may be Nothing, 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 EventConfigure. windowGetPosition in contrast gets the position from the most recent configure event.

Note: If window is not a toplevel, it is much better to call windowGetPosition, windowGetWidth and windowGetHeight instead, because it avoids the roundtrip to the X server and because these functions support the full 32-bit coordinate space, whereas windowGetGeometry is restricted to the 16-bit coordinates of X11.

Returns the group leader window for window. See windowSetGroup.

Since: 2.4

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.

Since: 2.24

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

Since: 2.22

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

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

Returns whether input to the window is passed through to the window below.

See windowSetPassThrough for details

Since: 3.18

Obtains the current pointer position and modifier state. The position is given in coordinates relative to the upper left corner of window.

Obtains the position of the window as reported in the most-recently-processed EventConfigure. Contrast with windowGetGeometry 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.

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

Since: 2.18

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

Returns the internal scale factor that maps from window coordiantes to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2).

A higher value means that drawing is automatically scaled up to a higher resolution, so any code doing drawing will automatically look nicer. However, if you are supplying pixel-based data the scale value can be used to determine whether to use a pixel resource with higher resolution data.

The scale of a window may change during runtime, if this happens a configure event will be sent to the toplevel window.

Since: 3.10

Gets the Screen associated with a Window.

Since: 2.24

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

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

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

Since: 3.0

Gets the toplevel window that’s an ancestor of window.

Any window type but WindowTypeChild is considered a toplevel window, as is a WindowTypeChild window that has a root window as parent.

Note that you should use windowGetEffectiveToplevel when you want to get to a window’s toplevel as seen on screen, because windowGetToplevel will most likely not do what you expect if there are offscreen windows in the hierarchy.

This function returns the type hint set for a window.

Since: 2.10

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, windowGetUpdateArea returns Nothing. You are responsible for calling cairo_region_destroy() on the returned region if it’s non-Nothing.

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

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.

Gets the Visual describing the pixel format of window.

Since: 2.24

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.

Since: 2.24

Gets the type of the window. See WindowType.

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

Since: 2.22

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

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.

Like windowShapeCombineRegion, 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.

Since: 2.10

Adds region to the update area for window. The update area is the region that needs to be redrawn, or “dirty region.” The call windowProcessUpdates 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 windowProcessAllUpdates 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 childFunc parameter controls whether the region of each child window that intersects region will also be invalidated. Only children for which childFunc returns TRUE will have the area invalidated.

A convenience wrapper around windowInvalidateRegion which invalidates a rectangular region. See windowInvalidateRegion for details.

Adds region to the update area for window. The update area is the region that needs to be redrawn, or “dirty region.” The call windowProcessUpdates 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 windowProcessAllUpdates 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 invalidateChildren 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.

Check to see if a window is destroyed..

Since: 2.18

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

Since: 2.22

Determines whether or not the window is shaped.

Since: 2.22

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

Checks whether the window has been mapped (with windowShow or windowShowUnraised).

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, windowLower only requests the restack, does not guarantee it.

Note that windowShow raises the window again, so don’t call this function before windowShow. (Try windowShowUnraised.)

If you call this during a paint (e.g. between windowBeginPaintRegion and windowEndPaint then GDK will mark the current clip region of the window as being drawn. This is required when mixing GL rendering via cairoDrawFromGl and cairo rendering, as otherwise GDK has no way of knowing when something paints over the GL-drawn regions.

This is typically called automatically by GTK+ and you don't need to care about this.

Since: 3.16

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.

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

This function is distinct from windowSetChildInputShapes because it includes window’s input shape mask in the set of shapes to be merged.

Since: 2.10

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

This function is distinct from windowSetChildShapes because it includes window’s shape mask in the set of shapes to be merged.

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 windowMoveResize to both move and resize simultaneously, for a nicer visual effect.

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.

Since: 2.8

Equivalent to calling windowMove and windowResize, 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 windowMoveResize.)

Creates a new Window using the attributes from attributes. See WindowAttr and WindowAttributesType for more details. Note: to use this on displays other than the default display, parent must be specified.

Like windowGetChildren, but does not copy the list of children, so the list does not need to be freed.

Calls windowProcessUpdates for all windows (see Window) in the application.

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

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, windowRaise only requests the restack, does not guarantee it.

Registers a window as a potential drop destination.

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

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 windowMoveResize to both move and resize simultaneously, for a nicer visual effect.

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 Nothing, 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, windowRestack only requests the restack, does not guarantee it.

Since: 2.18

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.

Setting acceptFocus 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.

Since: 2.4

Sets the background color of window.

However, when using GTK+, influence the background of a widget using a style class or CSS — if you’re an application — or with gtk_style_context_set_background() — if you're implementing a custom widget.

Sets the background of window.

A background of Nothing means that the window will inherit its background from its parent window.

The windowing system will normally fill a window with its background when the window is obscured then exposed.

Sets the background color of window.

See also windowSetBackgroundPattern.

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 windowMergeChildInputShapes which includes the input shape mask of window in the masks to be merged.

Since: 2.10

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 windowMergeChildShapes which includes the shape mask of window in the masks to be merged.

Sets a Window 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.

It only makes sense for child windows to be composited; see windowSetOpacity 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 displaySupportsComposite to check if setting a window as composited is supported before attempting to do so.

Since: 2.12

Sets the default mouse pointer for a Window.

Note that cursor must be for the same display as window.

Use cursorNewForDisplay or cursorNewFromPixbuf to create the cursor. To make the cursor invisible, use CursorTypeBlankCursor. Passing Nothing for the cursor argument to windowSetCursor means that window will use the cursor of its parent window. Most windows should use this default.

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

“Decorations” are the features the window manager adds to a toplevel Window. 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 WMDecoration 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.

Sets a specific Cursor for a given device when it gets inside window. Use cursorNewForDisplay or cursorNewFromPixbuf to create the cursor. To make the cursor invisible, use CursorTypeBlankCursor. Passing Nothing for the cursor argument to windowSetCursor means that window will use the cursor of its parent window. Most windows should use this default.

Since: 3.0

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 EventMask enumeration.

See the [input handling overview][event-masks] for details.

Since: 3.0

Determines whether or not extra unprocessed motion events in the event queue can be discarded. If True only the most recent event will be delivered.

Some types of applications, e.g. paint programs, need to see all motion events and will benefit from turning off event compression.

By default, event compression is enabled.

Since: 3.12

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 EventMask enumeration.

See the [input handling overview][event-masks] for details.

Setting focusOnMap 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.

Since: 2.6

Specifies whether the window should span over all monitors (in a multi-head setup) or only the current monitor when in fullscreen mode.

The mode argument is from the FullscreenMode enumeration. If GDK_FULLSCREEN_ON_ALL_MONITORS is specified, the fullscreen window will span over all monitors from the Screen.

On X11, searches through the list of monitors from the Screen the ones which delimit the 4 edges of the entire Screen and will ask the window manager to span the window over these monitors.

If the XINERAMA extension is not available or not usable, this function has no effect.

Not all window managers support this, so you can’t rely on the fullscreen window to span over the multiple monitors when GDK_FULLSCREEN_ON_ALL_MONITORS is specified.

Since: 3.8

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

Sets the geometry hints for window. Hints flagged in geomMask are set, hints not flagged in geomMask are unset. To unset all hints, use a geomMask of 0 and a geometry of Nothing.

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 windowResize or windowMoveResize.

Note that on X11, this effect has no effect on windows of type WindowTypeTemp or windows where override redirect has been turned on via windowSetOverrideRedirect 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 windowConstrainSize yourself to determine appropriate sizes.

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.

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.

Note that some platforms don't support window icons.