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 T hasn't been created for it with ForeignNew)

NOTE: For multihead-aware widgets or applications use Gtk.Gdk.Display.GetWindowAtPointer instead.

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

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

Calls ProcessUpdates for all windows (see T) in the application.

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

Adds an event filter to window, allowing you to intercept events before they reach GDK. This is a low-level operation and makes it easy to break GDK and/or GTK+, so you have to know what you're doing. Pass NULL for window to get all events for all windows, instead of events for a specific window.

See Gtk.Gdk.Display.AddClientMessageFilter if you are interested in X ClientMessage events.

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

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.

A convenience wrapper around BeginPaintRegion which creates a rectangular region for you. See BeginPaintRegion 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 pixmap for window. Then, all drawing operations performed on window will be diverted to the backing store. When you call EndPaint, 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 EndPaint. If you draw to window directly without calling BeginPaintRegion, the user may see flicker as individual drawing operations are performed in sequence. The clipping and background-initializing features of BeginPaintRegion are conveniences for the programmer, so you can avoid doing that work yourself.

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

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.

Clears an entire window to the background color or background pixmap.

Clears an area of window to the background color or background pixmap.

Like ClearArea, but also generates an expose event for the cleared area.

This function has a stupid name because it dates back to the mists time, pre-GDK-1.0.

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 EnableSynchronizedConfigure was called previously.

Transforms window coordinates from a parent window to a child window, where the parent window is the normal parent as returned by GetParent for normal windows, and the window's embedder as returned by Gtk.Gdk.Offscreen.WindowGetEmbedder for offscreen windows.

For normal windows, calling this function is equivalent to subtracting the return values of GetPosition 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: CoordsToParent

Transforms window coordinates from a child window to its parent window, where the parent window is the normal parent as returned by GetParent for normal windows, and the window's embedder as returned by Gtk.Gdk.Offscreen.WindowGetEmbedder for offscreen windows.

For normal windows, calling this function is equivalent to adding the return values of GetPosition 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: CoordsFromParent

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

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

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

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

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

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 such that it won't receive expose events. The window will begin receiving expose events again when ThawUpdates is called. If FreezeUpdates has been called more than once, ThawUpdates 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.

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.

Determines whether or not the desktop environment shuld be hinted that the window does not want to 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.

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.

Determines whether window is composited.

See SetComposited.

Retrieves a Gtk.Gdk.Cursor.T pointer for the cursor currently set on the specified T, 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.

Returns the decorations set on the GdkWindow with SetDecorations

Gets the Gtk.Gdk.Display.T associated with a T.

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

See also: Gtk.Gdk.Offscreen.WindowGetEmbedder

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

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

See also: Gtk.Gdk.Offscreen.WindowGetEmbedder

Gets the event mask for window. See SetEvents.

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

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

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 Gtk.Gdk.EventConfigure.T. GetPosition in contrast gets the position from the most recent configure event.

Returns the group leader window for window. See SetGroup.

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.

If you bypass the GDK layer and use windowing system primitives to draw directly onto a T, then you need to deal with two details: there may be an offset between GDK coordinates and windowing system coordinates, and GDK may have redirected drawing to a offscreen pixmap as the result of a BeginPaintRegion calls. This function allows retrieving the information you need to compensate for these effects.

This function exposes details of the GDK implementation, and is thus likely to change in future releases of GDK.

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

Obtains the position of a window in root window coordinates. (Compare with GetPosition and GetGeometry 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 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 GetEffectiveParent when writing generic code that walks up a window hierarchy, because GetParent will most likely not do what you expect if there are offscreen windows in the hierarchy.

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 Gtk.Gdk.EventConfigure.T. Contrast with GetGeometry 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 GetOrigin but allows you go pass in any position in the window, not just the origin.

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

Gets the Gtk.Gdk.Screen.T associated with a T.

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

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

Any window type but Gtk.Gdk.WindowType.Child is considered a toplevel window, as is a Gtk.Gdk.WindowType.Child window that has a root window as parent.

Note that you should use GetEffectiveToplevel when you want to get to a window's toplevel as seen on screen, because GetToplevel 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.

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, GetUpdateArea returns NULL. You are responsible for calling Gtk.Gdk.Region.Destroy on the returned region if it's non-NULL.

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

Gets the Gtk.Gdk.Visual.T describing the pixel format of window.

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.

Gets the type of the window. See Gtk.Gdk.WindowType.T.

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

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 ShapeCombineMask, 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.

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

A convenience wrapper around InvalidateRegion which invalidates a rectangular region. See InvalidateRegion 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 ProcessUpdates 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 ProcessAllUpdates 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.

Check to see if a window is destroyed..

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

Determines whether or not the 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.)

Checks whether the window has been mapped (with Show or ShowUnraised).

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

Note that Show raises the window again, so don't call this function before Show. (Try ShowUnraised.)

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

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

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

This function is distinct from SetChildShapes 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 MoveResize 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.

Equivalent to calling Move and 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 MoveResize.)

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

Sends one or more expose events to window. The areas in each expose event will cover the entire update area for the window (see InvalidateRegion for details). Normally GDK calls ProcessAllUpdates 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, Raise only requests the restack, does not guarantee it.

Registers a window as a potential drop destination.

Remove a filter previously added with AddFilter.

Removes any active redirection started by Gtk.Gdk.WindowRedirect.ToDrawable.

Reparents window into the given new_parent. 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 MoveResize 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 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, Restack only requests the restack, does not guarantee it.

Scroll the contents of its window, both pixels and children, by the given amount. Portions of the window that the scroll operation brings in from offscreen areas are invalidated.

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.

Sets the background pixmap of window. May also be used to set a background of "None" on window, by setting a background pixmap of NULL.

A background pixmap will be tiled, positioning the first tile at the origin of window, or if parent_relative is TRUE, the tiling will be done based on the origin of the parent window (useful to align tiles in a parent with tiles in a child).

A background pixmap of NULL means that the window will have no background. A window with no background will never have its background filled by the windowing system, instead the window will contain whatever pixels were already in the corresponding area of the display.

The windowing system will normally fill a window with its background when the window is obscured then exposed, and when you call Clear.

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

The color must be allocated; Gtk.Gdk.Rgb.FindColor is the best way to allocate a color.

See also SetBackPixmap.

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

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

Sets a T 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 Example 7, "Composited windows" for an example.

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

Sets the mouse pointer for a T. Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixmap() to create the cursor. To make the cursor invisible, use Gtk.Gdk.CursorType.BlankCursor. Passing NULL for the cursor argument to SetCursor means that window will use the cursor of its parent window. Most windows should use this default.

"Decorations" are the features the window manager adds to a toplevel T. 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 Gtk.Gdk.WMDecoration.T enumeration. If Gtk.Gdk.WMDecoration.All is included in the mask, the other bits indicate which decorations should be turned off. If Gtk.Gdk.WMDecoration.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.

The event mask for a window determines which events will be reported for that window. For example, an event mask including Gtk.Gdk.EventMask.ButtonPressMask means the window should report button press events. The event mask is the bitwise OR of values from the Gtk.Gdk.EventMask.T enumeration.

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.

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 Gtk.Gdk.WMFunction.T enumeration. If the bitmask includes Gtk.Gdk.WMFunction.All, then the other bits indicate which functions to disable; if it doesn't include Gtk.Gdk.WMFunction.All, it indicates which functions to enable.

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 Resize or MoveResize.

Note that on X11, this effect has no effect on windows of type Gtk.Gdk.WindowType.Temp or windows where override redirect has been turned on via SetOverrideRedirect 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 ConstrainSize 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 the icon of window as a pixmap or window. If using GTK+, investigate gtk_window_set_default_icon_list() first, and then gtk_window_set_icon_list() and gtk_window_set_icon(). If those don't meet your needs, look at SetIconList. Only if all those are too high-level do you want to fall back to SetIcon.

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.

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 SetTitle will not update the icon title.

Using NULL for name unsets the icon title; further calls to SetTitle will again update the icon title as well.

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.

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.

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 SetTransientFor

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 Gtk.Gdk.Screen.GetRgbaColormap. For making non-toplevel windows translucent, see SetComposited.

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.

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.

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

Toggles whether a window should appear in a task list or window list. If a window's semantic type as specified with SetTypeHint 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.

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

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.

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 SetIconName), the icon name will be set to title as well. title must be in UTF-8 encoding (as with all user-readable strings in GDK/GTK+). title may not be NULL.

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.

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.

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

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 T as user data on the T. So, custom widget implementations should use this function for that. If GTK+ receives an event for a T, 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.

Applies a shape mask to window. Pixels in window corresponding to set bits in the mask will be visible; pixels in window corresponding to unset bits in the mask will be transparent. This gives a non-rectangular window.

If mask is NULL, the shape mask will be unset, and the x/y parameters are not used.

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.

Makes pixels in window outside shape_region be transparent, so that the window may be nonrectangular. See also ShapeCombineMask to use a bitmap as the mask.

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.

Like ShowUnraised, 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 Hide.

When implementing a GtkWidget, you should call this function on the widget's T as part of the "map" method.

Shows a T onscreen, but does not modify its stacking order. In contrast, 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).

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

Thaws a window frozen with FreezeUpdates.

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.

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.

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

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