gdk.Window.Window Class Reference

Inheritance diagram for gdk.Window.Window:

gdk.Drawable.Drawable gobject.ObjectG.ObjectG gtk.Assistant.Assistant gtk.Dialog.Dialog gtk.MainWindow.MainWindow gtk.Plug.Plug gtk.AboutDialog.AboutDialog gtk.ColorSelectionDialog.ColorSelectionDialog gtk.FileChooserDialog.FileChooserDialog gtk.FileSelection.FileSelection gtk.FontSelectionDialog.FontSelectionDialog gtk.InputDialog.InputDialog gtk.MessageDialog.MessageDialog List of all members.

Public Member Functions

GdkWindowgetWindowStruct ()
 this (GdkWindow *gdkWindow)
 Sets our main struct and passes it to the parent class.
 this (GdkWindowAttr *attributes, int attributesMask)
 Creates a new GdkWindow using the attributes from attributes.
void destroy ()
 Destroys the window system resources associated with window and decrements window's reference count.
GdkWindowType getWindowType ()
 Gets the type of the window.
void show ()
 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).
void showUnraised ()
 Shows a GdkWindow onscreen, but does not modify its stacking order.
void hide ()
 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.
int isVisible ()
 Checks whether the window has been mapped (with gdk_window_show() or gdk_window_show_unraised()).
int isViewable ()
 Check if the window and all ancestors of the window are mapped.
GdkWindowState getState ()
 Gets the bitwise OR of the currently active window state flags, from the GdkWindowState enumeration.
void withdraw ()
 Withdraws a window (unmaps it and asks the window manager to forget about it).
void iconify ()
 Asks to iconify (minimize) window.
void deiconify ()
 Attempt to deiconify (unminimize) window.
void stick ()
 "Pins" a window such that it's on all workspaces and does not scroll with viewports, for window managers that have scrollable viewports.
void unstick ()
 Reverse operation for gdk_window_stick(); see gdk_window_stick(), and gtk_window_unstick().
void maximize ()
 Maximizes the window.
void unmaximize ()
 Unmaximizes the window.
void fullscreen ()
 Moves the window into fullscreen mode.
void unfullscreen ()
 Moves the window out of fullscreen mode.
void setKeepAbove (int setting)
 Set if window must be kept above other windows.
void setKeepBelow (int setting)
 Set if window must be kept below other windows.
void move (int x, int y)
 Repositions a window relative to its parent window.
void resize (int width, int height)
 Resizes window; for toplevel windows, asks the window manager to resize the window.
void moveResize (int x, int y, int width, int height)
 Equivalent to calling gdk_window_move() and gdk_window_resize(), except that both operations are performed at once, avoiding strange visual effects.
void scroll (int dx, int dy)
 Scroll the contents of window, both pixels and children, by the given amount.
void moveRegion (Region region, int dx, int dy)
 Move the part of window indicated by region by dy pixels in the Y direction and dx pixels in the X direction.
void reparent (Window newParent, int x, int y)
 Reparents window into the given new_parent.
void clear ()
 Clears an entire window to the background color or background pixmap.
void clearArea (int x, int y, int width, int height)
 Clears an area of window to the background color or background pixmap.
void clearAreaE (int x, int y, int width, int height)
 Like gdk_window_clear_area(), but also generates an expose event for the cleared area.
void raise ()
 Raises window to the top of the Z-order (stacking order), so that other windows with the same parent window appear below window.
void lower ()
 Lowers window to the bottom of the Z-order (stacking order), so that other windows with the same parent window appear above window.
void focus (uint timestamp)
 Sets keyboard focus to window.
void registerDnd ()
 Registers a window as a potential drop destination.
void beginResizeDrag (GdkWindowEdge edge, int button, int rootX, int rootY, uint timestamp)
 Begins a window resize operation (for a toplevel window).
void beginMoveDrag (int button, int rootX, int rootY, uint timestamp)
 Begins a window move operation (for a toplevel window).
void beep ()
 Emits a short beep associated to window in the appropriate display, if supported.
void beginPaintRect (Rectangle rectangle)
 A convenience wrapper around gdk_window_begin_paint_region() which creates a rectangular region for you.
void beginPaintRegion (Region region)
 Indicates that you are beginning the process of redrawing region.
void endPaint ()
 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.
void invalidateRect (Rectangle rect, int invalidateChildren)
 A convenience wrapper around gdk_window_invalidate_region() which invalidates a rectangular region.
void invalidateRegion (Region region, int invalidateChildren)
 Adds region to the update area for window.
Region getUpdateArea ()
 Transfers ownership of the update area from window to the caller of the function.
void freezeUpdates ()
 Temporarily freezes a window such that it won't receive expose events.
void thawUpdates ()
 Thaws a window frozen with gdk_window_freeze_updates().
void processUpdates (int updateChildren)
 Sends one or more expose events to window.
void getInternalPaintInfo (GdkDrawable **realDrawable, int *xOffset, int *yOffset)
 If you bypass the GDK layer and use windowing system primitives to draw directly onto a GdkWindow, 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 gdk_window_begin_paint_region() calls.
void enableSynchronizedConfigure ()
 Indicates that the application will cooperate with the window system in synchronizing the window repaint with the window manager during resizing operations.
void configureFinished ()
 Signal to the window system that the application has finished handling Configure events it has received.
void setUserData (void *userData)
 For most purposes this function is deprecated in favor of g_object_set_data().
void setOverrideRedirect (int overrideRedirect)
 An override redirect window is not under the control of the window manager.
void setAcceptFocus (int acceptFocus)
 Setting accept_focus to FALSE hints the desktop environment that the window doesn't want to receive input focus.
void setFocusOnMap (int focusOnMap)
 Setting focus_on_map to FALSE hints the desktop environment that the window doesn't want to receive input focus when it is mapped.
void addFilter (GdkFilterFunc funct, void *data)
 Adds an event filter to window, allowing you to intercept events before they reach GDK.
void removeFilter (GdkFilterFunc funct, void *data)
 Remove a filter previously added with gdk_window_add_filter().
void shapeCombineMask (Bitmap mask, int x, int y)
 Applies a shape mask to window.
void shapeCombineRegion (Region shapeRegion, int offsetX, int offsetY)
 Makes pixels in window outside shape_region be transparent, so that the window may be nonrectangular.
void setChildShapes ()
 Sets the shape mask of window to the union of shape masks for all children of window, ignoring the shape mask of window itself.
void mergeChildShapes ()
 Merges the shape masks for any child windows into the shape mask for window.
void inputShapeCombineMask (Bitmap mask, int x, int y)
 Like gdk_window_shape_combine_mask(), but the shape applies only to event handling.
void inputShapeCombineRegion (Region shapeRegion, int offsetX, int offsetY)
 Like gdk_window_shape_combine_region(), but the shape applies only to event handling.
void setChildInputShapes ()
 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.
void mergeChildInputShapes ()
 Merges the input shape masks for any child windows into the input shape mask for window.
int setStaticGravities (int useStatic)
 Set the bit gravity of the given window to static, and flag it so all children get static subwindow gravity.
void setHints (int x, int y, int minWidth, int minHeight, int maxWidth, int maxHeight, int flags)
 Warning gdk_window_set_hints is deprecated and should not be used in newly-written code.
void setTitle (char[] title)
 Sets the title of a toplevel window, to be displayed in the titlebar.
void setBackground (Color color)
 Sets the background color of window.
void setBackPixmap (Pixmap pixmap, int parentRelative)
 Sets the background pixmap of window.
void setCursor (Cursor cursor)
 Sets the mouse pointer for a GdkWindow.
void getUserData (void **data)
 Retrieves the user data for window, which is normally the widget that window belongs to.
void getGeometry (int *x, int *y, int *width, int *height, int *depth)
 Any of the return location arguments to this function may be NULL, if you aren't interested in getting the value of that field.
void setGeometryHints (GdkGeometry *geometry, GdkWindowHints geomMask)
 Sets the geometry hints for window.
void setIconList (ListG pixbufs)
 Sets a list of icons for the window.
void setModalHint (int modal)
 The application can use this hint to tell the window manager that a certain window has modal behaviour.
void setTypeHint (GdkWindowTypeHint hint)
 The application can use this call to provide a hint to the window manager about the functionality of a window.
GdkWindowTypeHint getTypeHint ()
 This function returns the type hint set for a window.
void setSkipTaskbarHint (int skipsTaskbar)
 Toggles whether a window should appear in a task list or window list.
void setSkipPagerHint (int skipsPager)
 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).
void setUrgencyHint (int urgent)
 Toggles whether a window needs the user's urgent attention.
void getPosition (int *x, int *y)
 Obtains the position of the window as reported in the most-recently-processed GdkEventConfigure.
void getRootOrigin (int *x, int *y)
 Obtains the top-left corner of the window manager frame in root window coordinates.
void getFrameExtents (Rectangle rect)
 Obtains the bounding box of the window, including window manager titlebar/borders if any.
int getOrigin (int *x, int *y)
 Obtains the position of a window in root window coordinates.
int getDeskrelativeOrigin (int *x, int *y)
 Warning gdk_window_get_deskrelative_origin is deprecated and should not be used in newly-written code.
Window getPointer (int *x, int *y, GdkModifierType *mask)
 Obtains the current pointer position and modifier state.
Window getParent ()
 Obtains the parent of window, as known to GDK.
Window getToplevel ()
 Gets the toplevel window that's an ancestor of window.
ListG getChildren ()
 Gets the list of children of window known to GDK.
ListG peekChildren ()
 Like gdk_window_get_children(), but does not copy the list of children, so the list does not need to be freed.
GdkEventMask getEvents ()
 Gets the event mask for window.
void setEvents (GdkEventMask eventMask)
 The event mask for a window determines which events will be reported for that window.
void setIcon (Window iconWindow, Pixmap pixmap, Bitmap mask)
 Sets the icon of window as a pixmap or window.
void setIconName (char[] name)
 Windows may have a name used while minimized, distinct from the name they display in their titlebar.
void setTransientFor (Window parent)
 Indicates to the window manager that window is a transient dialog associated with the application window parent.
void setRole (char[] role)
 When using GTK+, typically you should use gtk_window_set_role() instead of this low-level function.
void setGroup (Window leader)
 Sets the group leader window for window.
Window getGroup ()
 Returns the group leader window for window.
void setDecorations (GdkWMDecoration decorations)
 "Decorations" are the features the window manager adds to a toplevel GdkWindow.
int getDecorations (GdkWMDecoration *decorations)
 Returns the decorations set on the GdkWindow with gdk_window_set_decorations window: The toplevel GdkWindow to get the decorations from decorations: The window decorations will be written here Returns: TRUE if the window has decorations set, FALSE otherwise.
void setFunctions (GdkWMFunction functions)
 Sets hints about the window management functions to make available via buttons on the window frame.

Static Public Member Functions

static Window atPointer (int *winX, int *winY)
 Obtains the window underneath the mouse pointer, returning the location of that window in win_x, win_y.
static void constrainSize (GdkGeometry *geometry, uint flags, int width, int height, int *newWidth, int *newHeight)
 Constrains a desired width and height according to a set of geometry hints (such as minimum and maximum size).
static void processAllUpdates ()
 Calls gdk_window_process_updates() for all windows (see GdkWindow) in the application.
static void setDebugUpdates (int setting)
 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().
static ListG getToplevels ()
 Obtains a list of all toplevel windows known to GDK on the default screen (see gdk_screen_get_toplevel_windows()).
static Window gdkGetDefaultRootWindow ()
 Obtains the root window (parent all other windows are inside) for the default display and screen.
static GdkPointerHooksgdkSetPointerHooks (GdkPointerHooks *newHooks)
 This function allows for hooking into the operation of getting the current location of the pointer.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GdkWindowgdkWindow
 the main Gtk struct

Constructor & Destructor Documentation

gdk.Window.Window.this ( GdkWindow gdkWindow  ) 

Sets our main struct and passes it to the parent class.

gdk.Window.Window.this ( GdkWindowAttr attributes,
int  attributesMask 
)

Creates a new GdkWindow using the attributes from attributes.

See GdkWindowAttr and GdkWindowAttributesType for more details. Note: to use this on displays other than the default display, parent must be specified. parent: a GdkWindow, or NULL to create the window as a child of the default root window for the default display. attributes: attributes of the new window attributes_mask: mask indicating which fields in attributes are valid Returns: the new GdkWindow


Member Function Documentation

void gdk.Window.Window.addFilter ( GdkFilterFunc  funct,
void *  data 
)

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. window: a GdkWindow function: filter callback data: data to pass to filter callback

static Window gdk.Window.Window.atPointer ( int winX,
int winY 
) [static]

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()) NOTE: For multihead-aware widgets or applications use gdk_display_get_window_at_pointer() instead. win_x: return location for origin of the window under the pointer win_y: return location for origin of the window under the pointer Returns: window under the mouse pointer

void gdk.Window.Window.beep (  ) 

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(). window: a toplevel GdkWindow Since 2.12

void gdk.Window.Window.beginMoveDrag ( int  button,
int  rootX,
int  rootY,
uint  timestamp 
)

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. window: a toplevel GdkWindow button: the button being used to drag root_x: root window X coordinate of mouse click that began the drag root_y: root window Y coordinate of mouse click that began the drag timestamp: timestamp of mouse click that began the drag

void gdk.Window.Window.beginPaintRect ( Rectangle  rectangle  ) 

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

See gdk_window_begin_paint_region() for details. window: a GdkWindow rectangle: rectangle you intend to draw to

void gdk.Window.Window.beginPaintRegion ( Region  region  ) 

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 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(). window: a GdkWindow region: region you intend to draw to

void gdk.Window.Window.beginResizeDrag ( GdkWindowEdge  edge,
int  button,
int  rootX,
int  rootY,
uint  timestamp 
)

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. window: a toplevel GdkWindow edge: the edge or corner from which the drag is started button: the button being used to drag root_x: root window X coordinate of mouse click that began the drag root_y: root window Y coordinate of mouse click that began the drag timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())

void gdk.Window.Window.clear (  ) 

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

window: a GdkWindow

void gdk.Window.Window.clearArea ( int  x,
int  y,
int  width,
int  height 
)

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

window: a GdkWindow x: x coordinate of rectangle to clear y: y coordinate of rectangle to clear width: width of rectangle to clear height: height of rectangle to clear

void gdk.Window.Window.clearAreaE ( int  x,
int  y,
int  width,
int  height 
)

Like gdk_window_clear_area(), 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. window: a GdkWindow x: x coordinate of rectangle to clear y: y coordinate of rectangle to clear width: width of rectangle to clear height: height of rectangle to clear

void gdk.Window.Window.configureFinished (  ) 

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. window: a toplevel GdkWindow Since 2.6

static void gdk.Window.Window.constrainSize ( GdkGeometry geometry,
uint  flags,
int  width,
int  height,
int newWidth,
int newHeight 
) [static]

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

geometry: a GdkGeometry structure flags: a mask indicating what portions of geometry are set width: desired width of window height: desired height of the window new_width: location to store resulting width new_height: location to store resulting height

void gdk.Window.Window.deiconify (  ) 

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. window: a toplevel GdkWindow

void gdk.Window.Window.destroy (  ) 

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. window: a GdkWindow

void gdk.Window.Window.enableSynchronizedConfigure (  ) 

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. window: a toplevel GdkWindow Since 2.6

void gdk.Window.Window.endPaint (  ) 

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. window: a GdkWindow

void gdk.Window.Window.focus ( uint  timestamp  ) 

Sets keyboard focus to window.

In most cases, gtk_window_present() should be used on a GtkWindow, rather than calling this function. window: a GdkWindow timestamp: timestamp of the event triggering the window focus

void gdk.Window.Window.freezeUpdates (  ) 

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. window: a GdkWindow

void gdk.Window.Window.fullscreen (  ) 

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. window: a toplevel GdkWindow Since 2.2

static Window gdk.Window.Window.gdkGetDefaultRootWindow (  )  [static]

Obtains the root window (parent all other windows are inside) for the default display and screen.

Returns: the default root window

static GdkPointerHooks* gdk.Window.Window.gdkSetPointerHooks ( GdkPointerHooks newHooks  )  [static]

This function allows for hooking into the operation of getting the current location of the pointer.

This is only useful for such low-level tools as an event recorder. Applications should never have any reason to use this facility. This function is not multihead safe. For multihead operation, see gdk_display_set_pointer_hooks(). new_hooks: a table of pointers to functions for getting quantities related to the current pointer position, or NULL to restore the default table. Returns: the previous pointer hook table

ListG gdk.Window.Window.getChildren (  ) 

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. window: a GdkWindow Returns: list of child windows inside window

int gdk.Window.Window.getDecorations ( GdkWMDecoration decorations  ) 

Returns the decorations set on the GdkWindow with gdk_window_set_decorations window: The toplevel GdkWindow to get the decorations from decorations: The window decorations will be written here Returns: TRUE if the window has decorations set, FALSE otherwise.

int gdk.Window.Window.getDeskrelativeOrigin ( int x,
int y 
)

Warning gdk_window_get_deskrelative_origin is deprecated and should not be used in newly-written code.

This gets the origin of a GdkWindow relative to an Enlightenment-window-manager desktop. As long as you don't assume that the user's desktop/workspace covers the entire root window (i.e. you don't assume that the desktop begins at root window coordinate 0,0) this function is not necessary. It's deprecated for that reason. window: a toplevel GdkWindow x: return location for X coordinate y: return location for Y coordinate Returns: not meaningful

GdkEventMask gdk.Window.Window.getEvents (  ) 

Gets the event mask for window.

See gdk_window_set_events(). window: a GdkWindow Returns: event mask for window

void gdk.Window.Window.getFrameExtents ( Rectangle  rect  ) 

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(). window: a toplevel GdkWindow rect: rectangle to fill with bounding box of the window frame

void gdk.Window.Window.getGeometry ( int x,
int y,
int width,
int height,
int depth 
)

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. Note If window is not a toplevel, it is much better to call gdk_window_get_position() and gdk_drawable_get_size() instead, because it avoids the roundtrip to the X server and because gdk_drawable_get_size() supports the full 32-bit coordinate space, whereas gdk_window_get_geometry() is restricted to the 16-bit coordinates of X11. window: a GdkWindow x: return location for X coordinate of window (relative to its parent) y: return location for Y coordinate of window (relative to its parent) width: return location for width of window height: return location for height of window depth: return location for bit depth of window

Window gdk.Window.Window.getGroup (  ) 

Returns the group leader window for window.

See gdk_window_set_group(). window: a toplevel GdkWindow Returns: the group leader window for window Since 2.4

void gdk.Window.Window.getInternalPaintInfo ( GdkDrawable **  realDrawable,
int xOffset,
int yOffset 
)

If you bypass the GDK layer and use windowing system primitives to draw directly onto a GdkWindow, 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 gdk_window_begin_paint_region() 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. window: a GdkWindow real_drawable: location to store the drawable to which drawing should be done. x_offset: location to store the X offset between coordinates in window, and the underlying window system primitive coordinates for *real_drawable. y_offset: location to store the Y offset between coordinates in window, and the underlying window system primitive coordinates for *real_drawable.

int gdk.Window.Window.getOrigin ( int x,
int y 
)

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.) window: a GdkWindow x: return location for X coordinate y: return location for Y coordinate Returns: not meaningful, ignore

Window gdk.Window.Window.getParent (  ) 

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. window: a GdkWindow Returns: parent of window

Window gdk.Window.Window.getPointer ( int x,
int y,
GdkModifierType mask 
)

Obtains the current pointer position and modifier state.

The position is given in coordinates relative to the upper left corner of window. window: a GdkWindow x: return location for X coordinate of pointer y: return location for Y coordinate of pointer mask: return location for modifier mask Returns: the window containing the pointer (as with gdk_window_at_pointer()), or NULL if the window containing the pointer isn't known to GDK

void gdk.Window.Window.getPosition ( int x,
int y 
)

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. window: a GdkWindow x: X coordinate of window y: Y coordinate of window

void gdk.Window.Window.getRootOrigin ( int x,
int y 
)

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

window: a toplevel GdkWindow x: return location for X position of window frame y: return location for Y position of window frame

GdkWindowState gdk.Window.Window.getState (  ) 

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

window: a GdkWindow Returns: window state bitfield

void* gdk.Window.Window.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gdk.Drawable.Drawable.

Reimplemented in gtk.AboutDialog.AboutDialog, gtk.Assistant.Assistant, gtk.ColorSelectionDialog.ColorSelectionDialog, gtk.Dialog.Dialog, gtk.FileChooserDialog.FileChooserDialog, gtk.FileSelection.FileSelection, gtk.FontSelectionDialog.FontSelectionDialog, gtk.InputDialog.InputDialog, gtk.MessageDialog.MessageDialog, and gtk.Plug.Plug.

Window gdk.Window.Window.getToplevel (  ) 

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

window: a GdkWindow Returns: the toplevel window containing window

static ListG gdk.Window.Window.getToplevels (  )  [static]

Obtains a list of all toplevel windows known to GDK on the default screen (see gdk_screen_get_toplevel_windows()).

A toplevel window is a child of the root window (see gdk_get_default_root_window()). The returned list should be freed with g_list_free(), but its elements need not be freed. Returns: list of toplevel windows, free with g_list_free()

GdkWindowTypeHint gdk.Window.Window.getTypeHint (  ) 

This function returns the type hint set for a window.

window: A toplevel GdkWindow Returns: The type hint set for window Since 2.10

Region gdk.Window.Window.getUpdateArea (  ) 

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 gdk_region_destroy() on the returned region if it's non-NULL. window: a GdkWindow Returns: the update area for window

void gdk.Window.Window.getUserData ( void **  data  ) 

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

See gdk_window_set_user_data(). window: a GdkWindow data: return location for user data

GdkWindow* gdk.Window.Window.getWindowStruct (  ) 

GdkWindowType gdk.Window.Window.getWindowType (  ) 

Gets the type of the window.

See GdkWindowType. window: a GdkWindow Returns: type of window

void gdk.Window.Window.hide (  ) 

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(). window: a GdkWindow

void gdk.Window.Window.iconify (  ) 

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. window: a toplevel GdkWindow

void gdk.Window.Window.inputShapeCombineMask ( Bitmap  mask,
int  x,
int  y 
)

Like gdk_window_shape_combine_mask(), 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. window: a GdkWindow mask: shape mask x: X position of shape mask with respect to window y: Y position of shape mask with respect to window Since 2.10

void gdk.Window.Window.inputShapeCombineRegion ( Region  shapeRegion,
int  offsetX,
int  offsetY 
)

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. window: a GdkWindow shape_region: region of window to be non-transparent offset_x: X position of shape_region in window coordinates offset_y: Y position of shape_region in window coordinates Since 2.10

void gdk.Window.Window.invalidateRect ( Rectangle  rect,
int  invalidateChildren 
)

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

See gdk_window_invalidate_region() for details. window: a GdkWindow rect: rectangle to invalidate invalidate_children: whether to also invalidate child windows

void gdk.Window.Window.invalidateRegion ( Region  region,
int  invalidateChildren 
)

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. window: a GdkWindow region: a GdkRegion invalidate_children: TRUE to also invalidate child windows

int gdk.Window.Window.isViewable (  ) 

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.) window: a GdkWindow Returns: TRUE if the window is viewable

int gdk.Window.Window.isVisible (  ) 

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

window: a GdkWindow Returns: TRUE if the window is mapped

void gdk.Window.Window.lower (  ) 

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().) window: a GdkWindow

void gdk.Window.Window.maximize (  ) 

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. window: a toplevel GdkWindow

void gdk.Window.Window.mergeChildInputShapes (  ) 

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_mask(). 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. window: a GdkWindow Since 2.10

void gdk.Window.Window.mergeChildShapes (  ) 

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_mask(). 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. window: a GdkWindow

void gdk.Window.Window.move ( int  x,
int  y 
)

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. window: a GdkWindow x: X coordinate relative to window's parent y: Y coordinate relative to window's parent

void gdk.Window.Window.moveRegion ( Region  region,
int  dx,
int  dy 
)

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. window: a GdkWindow region: The GdkRegion to move dx: Amount to move in the X direction dy: Amount to move in the Y direction Since 2.8

void gdk.Window.Window.moveResize ( int  x,
int  y,
int  width,
int  height 
)

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().) window: a GdkWindow x: new X position relative to window's parent y: new Y position relative to window's parent width: new width height: new height

ListG gdk.Window.Window.peekChildren (  ) 

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

window: a GdkWindow Returns: a reference to the list of child windows in window

static void gdk.Window.Window.processAllUpdates (  )  [static]

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

void gdk.Window.Window.processUpdates ( int  updateChildren  ) 

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. window: a GdkWindow update_children: whether to also process updates for child windows

void gdk.Window.Window.raise (  ) 

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. window: a GdkWindow

void gdk.Window.Window.registerDnd (  ) 

Registers a window as a potential drop destination.

window: a GdkWindow.

void gdk.Window.Window.removeFilter ( GdkFilterFunc  funct,
void *  data 
)

Remove a filter previously added with gdk_window_add_filter().

window: a GdkWindow function: previously-added filter function data: user data for previously-added filter function

void gdk.Window.Window.reparent ( Window  newParent,
int  x,
int  y 
)

Reparents window into the given new_parent.

The window being reparented will be unmapped as a side effect. window: a GdkWindow new_parent: new parent to move window into x: X location inside the new parent y: Y location inside the new parent

void gdk.Window.Window.resize ( int  width,
int  height 
)

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. window: a GdkWindow width: new width of the window height: new height of the window

void gdk.Window.Window.scroll ( int  dx,
int  dy 
)

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.) window: a GdkWindow dx: Amount to scroll in the X direction dy: Amount to scroll in the Y direction

void gdk.Window.Window.setAcceptFocus ( int  acceptFocus  ) 

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. window: a toplevel GdkWindow accept_focus: TRUE if the window should receive input focus Since 2.4

void gdk.Window.Window.setBackground ( Color  color  ) 

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; gdk_rgb_find_color() is the best way to allocate a color. See also gdk_window_set_back_pixmap(). window: a GdkWindow color: an allocated GdkColor

void gdk.Window.Window.setBackPixmap ( Pixmap  pixmap,
int  parentRelative 
)

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 gdk_window_clear(). window: a GdkWindow pixmap: a GdkPixmap, or NULL parent_relative: whether the tiling origin is at the origin of window's parent

void gdk.Window.Window.setChildInputShapes (  ) 

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. window: a GdkWindow Since 2.10

void gdk.Window.Window.setChildShapes (  ) 

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. window: a GdkWindow

void gdk.Window.Window.setCursor ( Cursor  cursor  ) 

Sets the mouse pointer for a GdkWindow.

Use gdk_cursor_new() or gdk_cursor_new_from_pixmap() to create the cursor. To make the cursor invisible, use gdk_cursor_new_from_pixmap() to create a cursor with no pixels in it. 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. window: a GdkWindow cursor: a cursor

static void gdk.Window.Window.setDebugUpdates ( int  setting  )  [static]

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. setting: TRUE to turn on update debugging

void gdk.Window.Window.setDecorations ( GdkWMDecoration  decorations  ) 

"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. window: a toplevel GdkWindow decorations: decoration hint mask

void gdk.Window.Window.setEvents ( GdkEventMask  eventMask  ) 

The event mask for a window determines which events will be reported for that 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. window: a GdkWindow event_mask: event mask for window

void gdk.Window.Window.setFocusOnMap ( int  focusOnMap  ) 

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. window: a toplevel GdkWindow focus_on_map: TRUE if the window should receive input focus when mapped Since 2.6

void gdk.Window.Window.setFunctions ( GdkWMFunction  functions  ) 

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. window: a toplevel GdkWindow functions: bitmask of operations to allow on window

void gdk.Window.Window.setGeometryHints ( GdkGeometry geometry,
GdkWindowHints  geomMask 
)

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. window: a toplevel GdkWindow geometry: geometry hints geom_mask: bitmask indicating fields of geometry to pay attention to

void gdk.Window.Window.setGroup ( Window  leader  ) 

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. window: a toplevel GdkWindow leader: group leader window, or NULL to restore the default group leader window

void gdk.Window.Window.setHints ( int  x,
int  y,
int  minWidth,
int  minHeight,
int  maxWidth,
int  maxHeight,
int  flags 
)

Warning gdk_window_set_hints is deprecated and should not be used in newly-written code.

This function is broken and useless and you should ignore it. If using GTK+, use functions such as gtk_window_resize(), gtk_window_set_size_request(), gtk_window_move(), gtk_window_parse_geometry(), and gtk_window_set_geometry_hints(), depending on what you're trying to do. If using GDK directly, use gdk_window_set_geometry_hints(). window: a GdkWindow x: ignored field, does not matter y: ignored field, does not matter min_width: minimum width hint min_height: minimum height hint max_width: max width hint max_height: max height hint flags: logical OR of GDK_HINT_POS, GDK_HINT_MIN_SIZE, and/or GDK_HINT_MAX_SIZE

void gdk.Window.Window.setIcon ( Window  iconWindow,
Pixmap  pixmap,
Bitmap  mask 
)

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 gdk_window_set_icon_list(). Only if all those are too high-level do you want to fall back to gdk_window_set_icon(). window: a toplevel GdkWindow icon_window: a GdkWindow to use for the icon, or NULL to unset pixmap: a GdkPixmap to use as the icon, or NULL to unset mask: a 1-bit pixmap (GdkBitmap) to use as mask for pixmap, or NULL to have none

void gdk.Window.Window.setIconList ( ListG  pixbufs  ) 

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. window: The GdkWindow toplevel window to set the icon of. pixbufs: A list of pixbufs, of different sizes.

void gdk.Window.Window.setIconName ( char[]  name  ) 

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. window: a toplevel GdkWindow name: name of window while iconified (minimized)

void gdk.Window.Window.setKeepAbove ( int  setting  ) 

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. window: a toplevel GdkWindow setting: whether to keep window above other windows Since 2.4

void gdk.Window.Window.setKeepBelow ( int  setting  ) 

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. window: a toplevel GdkWindow setting: whether to keep window below other windows Since 2.4

void gdk.Window.Window.setModalHint ( int  modal  ) 

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() window: A toplevel GdkWindow modal: TRUE if the window is modal, FALSE otherwise.

void gdk.Window.Window.setOverrideRedirect ( int  overrideRedirect  ) 

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. window: a toplevel GdkWindow override_redirect: TRUE if window should be override redirect

void gdk.Window.Window.setRole ( char[]  role  ) 

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. window: a toplevel GdkWindow role: a string indicating its role

void gdk.Window.Window.setSkipPagerHint ( int  skipsPager  ) 

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. window: a toplevel GdkWindow skips_pager: TRUE to skip the pager Since 2.2

void gdk.Window.Window.setSkipTaskbarHint ( int  skipsTaskbar  ) 

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. window: a toplevel GdkWindow skips_taskbar: TRUE to skip the taskbar Since 2.2

int gdk.Window.Window.setStaticGravities ( int  useStatic  ) 

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. window: a GdkWindow use_static: TRUE to turn on static gravity Returns: TRUE if the server supports static gravity

void gdk.Window.Window.setTitle ( char[]  title  ) 

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 title as well. title must be in UTF-8 encoding (as with all user-readable strings in GDK/GTK+). title may not be NULL. window: a toplevel GdkWindow title: title of window

void gdk.Window.Window.setTransientFor ( Window  parent  ) 

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. window: a toplevel GdkWindow parent: another toplevel GdkWindow

void gdk.Window.Window.setTypeHint ( GdkWindowTypeHint  hint  ) 

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. window: A toplevel GdkWindow hint: A hint of the function this window will have

void gdk.Window.Window.setUrgencyHint ( int  urgent  ) 

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

window: a toplevel GdkWindow urgent: TRUE if the window is urgent Since 2.8

void gdk.Window.Window.setUserData ( void *  userData  ) 

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. window: a GdkWindow user_data: user data

void gdk.Window.Window.shapeCombineMask ( Bitmap  mask,
int  x,
int  y 
)

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. On the Win32 platform the functionality is always present. This function works on both toplevel and child windows. window: a GdkWindow mask: shape mask x: X position of shape mask with respect to window y: Y position of shape mask with respect to window

void gdk.Window.Window.shapeCombineRegion ( Region  shapeRegion,
int  offsetX,
int  offsetY 
)

Makes pixels in window outside shape_region be transparent, so that the window may be nonrectangular.

See also gdk_window_shape_combine_mask() 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. On the Win32 platform, this functionality is always present. This function works on both toplevel and child windows. window: a GdkWindow shape_region: region of window to be non-transparent offset_x: X position of shape_region in window coordinates offset_y: Y position of shape_region in window coordinates

void gdk.Window.Window.show (  ) 

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. window: a GdkWindow

void gdk.Window.Window.showUnraised (  ) 

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). window: a GdkWindow

void gdk.Window.Window.stick (  ) 

"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. window: a toplevel GdkWindow

void gdk.Window.Window.thawUpdates (  ) 

Thaws a window frozen with gdk_window_freeze_updates().

window: a GdkWindow

void gdk.Window.Window.unfullscreen (  ) 

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. window: a toplevel GdkWindow Since 2.2

void gdk.Window.Window.unmaximize (  ) 

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. window: a toplevel GdkWindow

void gdk.Window.Window.unstick (  ) 

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

window: a toplevel GdkWindow

void gdk.Window.Window.withdraw (  ) 

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. window: a toplevel GdkWindow


Member Data Documentation

GdkWindow* gdk.Window.Window.gdkWindow [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo