Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

cursor: Gdk.Cursor

The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and gdk_window_get_cursor() for details.

g_type_instance: TypeInstance
$gtype: GType<Gdk.Window>
name: string

Methods

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

    Returns void

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

    If window is a top level #GdkWindow, backed by a native window implementation, a backing store (offscreen buffer) large enough to contain region will be created. The backing store will be initialized with the background color or background surface for window. Then, all drawing operations performed on window will be diverted to the backing store. When you call gdk_window_end_frame(), the contents of the backing store will be copied to window, making it visible on screen. Only the part of window contained in region will be modified; that is, drawing operations are clipped to region.

    The net result of all this is to remove flicker, because the user sees the finished product appear all at once when you call gdk_window_end_draw_frame(). If you draw to window directly without calling gdk_window_begin_draw_frame(), the user may see flicker as individual drawing operations are performed in sequence.

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

    Parameters

    Returns DrawingContext

  • begin_move_drag(button: number, root_x: number, root_y: number, timestamp: number): void
  • Begins a window move operation (for a toplevel window).

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

    Parameters

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • root_x: number

      root window X coordinate of mouse click that began the drag

    • root_y: number

      root window Y coordinate of mouse click that began the drag

    • timestamp: number

      timestamp of mouse click that began the drag

    Returns void

  • begin_move_drag_for_device(device: Gdk.Device, button: number, root_x: number, root_y: number, timestamp: number): void
  • Begins a window move operation (for a toplevel window). You might use this function to implement a “window move grip,” for example. The function works best with window managers that support the Extended Window Manager Hints but has a fallback implementation for other window managers.

    Parameters

    • device: Gdk.Device

      the device used for the operation

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • root_x: number

      root window X coordinate of mouse click that began the drag

    • root_y: number

      root window Y coordinate of mouse click that began the drag

    • timestamp: number

      timestamp of mouse click that began the drag

    Returns void

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

    Parameters

    Returns void

  • Indicates that you are beginning the process of redrawing region. A backing store (offscreen buffer) large enough to contain region will be created. The backing store will be initialized with the background color or background surface for window. Then, all drawing operations performed on window will be diverted to the backing store. When you call gdk_window_end_paint(), the backing store will be copied to window, making it visible onscreen. Only the part of window contained in region will be modified; that is, drawing operations are clipped to region.

    The net result of all this is to remove flicker, because the user sees the finished product appear all at once when you call gdk_window_end_paint(). If you draw to window directly without calling gdk_window_begin_paint_region(), the user may see flicker as individual drawing operations are performed in sequence. The clipping and background-initializing features of gdk_window_begin_paint_region() are conveniences for the programmer, so you can avoid doing that work yourself.

    When using GTK+, the widget system automatically places calls to gdk_window_begin_paint_region() and gdk_window_end_paint() around emissions of the expose_event signal. That is, if you’re writing an expose event handler, you can assume that the exposed area in #GdkEventExpose has already been cleared to the window background, is already set as the clip region, and already has a backing store. Therefore in most cases, application code need not call gdk_window_begin_paint_region(). (You can disable the automatic calls around expose events on a widget-by-widget basis by calling gtk_widget_set_double_buffered().)

    If you call this function multiple times before calling the matching gdk_window_end_paint(), the backing stores are pushed onto a stack. gdk_window_end_paint() copies the topmost backing store onscreen, subtracts the topmost region from all other regions in the stack, and pops the stack. All drawing operations affect only the topmost backing store in the stack. One matching call to gdk_window_end_paint() is required for each call to gdk_window_begin_paint_region().

    Parameters

    Returns void

  • begin_resize_drag(edge: Gdk.WindowEdge, button: number, root_x: number, root_y: number, timestamp: number): void
  • Begins a window resize operation (for a toplevel window).

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

    Parameters

    • edge: Gdk.WindowEdge

      the edge or corner from which the drag is started

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • root_x: number

      root window X coordinate of mouse click that began the drag

    • root_y: number

      root window Y coordinate of mouse click that began the drag

    • timestamp: number

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

    Returns void

  • begin_resize_drag_for_device(edge: Gdk.WindowEdge, device: Gdk.Device, button: number, root_x: number, root_y: number, timestamp: number): void
  • Begins a window resize operation (for a toplevel window). You might use this function to implement a “window resize grip,” for example; in fact #GtkStatusbar uses it. The function works best with window managers that support the Extended Window Manager Hints but has a fallback implementation for other window managers.

    Parameters

    • edge: Gdk.WindowEdge

      the edge or corner from which the drag is started

    • device: Gdk.Device

      the device used for the operation

    • button: number

      the button being used to drag, or 0 for a keyboard-initiated drag

    • root_x: number

      root window X coordinate of mouse click that began the drag

    • root_y: number

      root window Y coordinate of mouse click that began the drag

    • timestamp: number

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

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • configure_finished(): void
  • coords_from_parent(parent_x: number, parent_y: number): [number, number]
  • Transforms window coordinates from a parent window to a child window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for offscreen windows.

    For normal windows, calling this function is equivalent to subtracting the return values of gdk_window_get_position() from the parent coordinates. For offscreen windows however (which can be arbitrarily transformed), 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: gdk_window_coords_to_parent()

    Parameters

    • parent_x: number

      X coordinate in parent’s coordinate system

    • parent_y: number

      Y coordinate in parent’s coordinate system

    Returns [number, number]

  • coords_to_parent(x: number, y: number): [number, number]
  • Transforms window coordinates from a child window to its parent window, where the parent window is the normal parent as returned by gdk_window_get_parent() for normal windows, and the window's embedder as returned by gdk_offscreen_window_get_embedder() for offscreen windows.

    For normal windows, calling this function is equivalent to adding the return values of gdk_window_get_position() to the child coordinates. For offscreen windows however (which can be arbitrarily transformed), 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: gdk_window_coords_from_parent()

    Parameters

    • x: number

      X coordinate in child’s coordinate system

    • y: number

      Y coordinate in child’s coordinate system

    Returns [number, number]

  • Creates a new #GdkGLContext matching the framebuffer format to the visual of the #GdkWindow. The context is disconnected from any particular window or surface.

    If the creation of the #GdkGLContext failed, error will be set.

    Before using the returned #GdkGLContext, you will need to call gdk_gl_context_make_current() or gdk_gl_context_realize().

    Returns Gdk.GLContext

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

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

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

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

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

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

    Parameters

    • format: cairo.Format

      the format for the new surface

    • width: number

      width of the new surface

    • height: number

      height of the new surface

    • scale: number

      the scale of the new surface, or 0 to use same as window

    Returns cairo.Surface

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

    Parameters

    • content: cairo.Content

      the content for the new surface

    • width: number

      width of the new surface

    • height: number

      height of the new surface

    Returns cairo.Surface

  • deiconify(): void
  • 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_with_time(), which raises the window, focuses it, unminimizes it, and puts it on the current desktop.

    Returns void

  • destroy(): void
  • Destroys the window system resources associated with window and decrements window's reference count. The window system resources for all children of window are also destroyed, but the children’s reference counts are not decremented.

    Note that a window will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens.

    Returns void

  • destroy_notify(): void
  • disconnect(id: number): void
  • emit(sigName: "create-surface", width: number, height: number, ...args: any[]): void
  • emit(sigName: "from-embedder", embedder_x: number, embedder_y: number, ...args: any[]): void
  • emit(sigName: "moved-to-rect", flipped_rect: object, final_rect: object, flipped_x: boolean, flipped_y: boolean, ...args: any[]): void
  • emit(sigName: "pick-embedded-child", x: number, y: number, ...args: any[]): void
  • emit(sigName: "to-embedder", offscreen_x: number, offscreen_y: number, ...args: any[]): void
  • emit(sigName: "notify::cursor", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • enable_synchronized_configure(): void
  • Indicates that the drawing of the contents of window started with gdk_window_begin_frame() has been completed.

    This function will take care of destroying the #GdkDrawingContext.

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

    Parameters

    • context: DrawingContext

      the #GdkDrawingContext created by gdk_window_begin_draw_frame()

    Returns void

  • end_paint(): void
  • Indicates that the backing store created by the most recent call to gdk_window_begin_paint_region() should be copied onscreen and deleted, leaving the next-most-recent backing store or no backing store at all as the active paint region. See gdk_window_begin_paint_region() for full details.

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

    Returns void

  • ensure_native(): boolean
  • Tries to ensure that there is a window-system native window for this GdkWindow. This may fail in some situations, returning %FALSE.

    Offscreen window and children of them can never have native windows.

    Some backends may not support native child windows.

    Returns boolean

  • flush(): void
  • focus(timestamp: number): void
  • Sets keyboard focus to window. In most cases, gtk_window_present_with_time() should be used on a #GtkWindow, rather than calling this function.

    Parameters

    • timestamp: number

      timestamp of the event triggering the window focus

    Returns void

  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • freeze_toplevel_updates_libgtk_only(): void
  • Temporarily freezes a window and all its descendants such that it won't receive expose events. The window will begin receiving expose events again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If gdk_window_freeze_toplevel_updates_libgtk_only() has been called more than once, gdk_window_thaw_toplevel_updates_libgtk_only() must be called an equal number of times to begin processing exposes.

    This function is not part of the GDK public API and is only for use by GTK+.

    Returns void

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

    Returns void

  • fullscreen(): void
  • Moves the window into fullscreen mode. This means the window covers the entire screen and is above any panels or task bars.

    If the window was already fullscreen, then this function does nothing.

    On X11, asks the window manager to put window in a fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “fullscreen”; so you can’t rely on the fullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    Returns void

  • fullscreen_on_monitor(monitor: number): void
  • Moves the window into fullscreen mode on the given monitor. This means the window covers the entire screen and is above any panels or task bars.

    If the window was already fullscreen, then this function does nothing.

    Parameters

    • monitor: number

      Which monitor to display fullscreen on.

    Returns void

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

    Returns void

  • get_accept_focus(): boolean
  • Determines whether or not the desktop environment shuld be hinted that the window does not want to receive input focus.

    Returns boolean

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

    Returns Gdk.Window[]

  • get_children_with_user_data(user_data: object): Gdk.Window[]
  • Gets the list of children of window known to GDK with a particular user_data set on it.

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

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

    Parameters

    • user_data: object

      user data to look for

    Returns Gdk.Window[]

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

    Returns cairo.Region

  • get_composited(): boolean
  • Retrieves a #GdkCursor pointer for the cursor currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window.

    Returns Gdk.Cursor

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Retrieves a #GdkCursor pointer for the device currently set on the specified #GdkWindow, or %NULL. If the return value is %NULL then there is no custom cursor set on the specified window, and it is using the cursor for its parent window.

    Parameters

    • device: Gdk.Device

      a master, pointer #GdkDevice.

    Returns Gdk.Cursor

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

    Use gdk_window_get_device_position_double() if you need subpixel precision.

    Parameters

    • device: Gdk.Device

      pointer #GdkDevice to query to.

    Returns [Gdk.Window, number, number, Gdk.ModifierType]

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

    See also: gdk_offscreen_window_get_embedder()

    Returns Gdk.Window

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

    Works like gdk_window_get_toplevel(), but treats an offscreen window's embedder as its parent, using gdk_window_get_effective_parent().

    See also: gdk_offscreen_window_get_embedder()

    Returns Gdk.Window

  • get_event_compression(): boolean
  • get_focus_on_map(): boolean
  • Determines whether or not the desktop environment should be hinted that the window does not want to receive input focus when it is mapped.

    Returns boolean

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

    Returns Gdk.Rectangle

  • get_geometry(): [number, number, number, number]
  • 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(), gdk_window_get_width() and gdk_window_get_height() instead, because it avoids the roundtrip to the X server and because these functions support the full 32-bit coordinate space, whereas gdk_window_get_geometry() is restricted to the 16-bit coordinates of X11.

    Returns [number, number, number, number]

  • get_height(): number
  • Returns the height of the given window.

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

    Returns number

  • get_modal_hint(): boolean
  • Determines whether or not the window manager is hinted that window has modal behaviour.

    Returns boolean

  • get_origin(): [number, number, number]
  • 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.)

    Returns [number, number, number]

  • Obtains the parent of window, as known to GDK. Does not query the X server; thus this returns the parent as passed to gdk_window_new(), not the actual parent. This should never matter unless you’re using Xlib calls mixed with GDK calls on the X11 platform. It may also matter for toplevel windows, because the window manager may choose to reparent them.

    Note that you should use gdk_window_get_effective_parent() when writing generic code that walks up a window hierarchy, because gdk_window_get_parent() will most likely not do what you expect if there are offscreen windows in the hierarchy.

    Returns Gdk.Window

  • get_pass_through(): boolean
  • Returns whether input to the window is passed through to the window below.

    See gdk_window_set_pass_through() for details

    Returns boolean

  • get_position(): [number, number]
  • Obtains the position of the window as reported in the most-recently-processed #GdkEventConfigure. Contrast with gdk_window_get_geometry() which queries the X server for the current window position, regardless of which events have been received or processed.

    The position coordinates are relative to the window’s parent window.

    Returns [number, number]

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_root_coords(x: number, y: number): [number, number]
  • Obtains the position of a window position in root window coordinates. This is similar to gdk_window_get_origin() but allows you to pass in any position in the window, not just the origin.

    Parameters

    • x: number

      X coordinate in window

    • y: number

      Y coordinate in window

    Returns [number, number]

  • get_root_origin(): [number, number]
  • Obtains the top-left corner of the window manager frame in root window coordinates.

    Returns [number, number]

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

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

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

    Returns number

  • get_support_multidevice(): boolean
  • Gets the toplevel window that’s an ancestor of window.

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

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

    Returns Gdk.Window

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

    Returns cairo.Region

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

    Returns object

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

    Returns cairo.Region

  • get_width(): number
  • Returns the width of the given window.

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

    Returns number

  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

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

    Returns boolean

  • hide(): void
  • For toplevel windows, withdraws them, so they will no longer be known to the window manager; for all windows, unmaps them, so they won’t be displayed. Normally done automatically as part of gtk_widget_hide().

    Returns void

  • iconify(): void
  • Asks to iconify (minimize) window. The window manager may choose to ignore the request, but normally will honor it. Using gtk_window_iconify() is preferred, if you have a #GtkWindow widget.

    This function only makes sense when window is a toplevel window.

    Returns void

  • input_shape_combine_region(shape_region: cairo.Region, offset_x: number, offset_y: number): void
  • Like gdk_window_shape_combine_region(), but the shape applies only to event handling. Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the window below window.

    An input shape is typically used with RGBA windows. The alpha channel of the window defines which pixels are invisible and allows for nicely antialiased borders, and the input shape controls where the window is “clickable”.

    On the X11 platform, this requires version 1.1 of the shape extension.

    On the Win32 platform, this functionality is not present and the function does nothing.

    Parameters

    • shape_region: cairo.Region

      region of window to be non-transparent

    • offset_x: number

      X position of shape_region in window coordinates

    • offset_y: number

      Y position of shape_region in window coordinates

    Returns void

  • Adds region to the update area for window. The update area is the region that needs to be redrawn, or “dirty region.” The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of window in response to those expose events.

    GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so normally there’s no need to do that manually, you just need to invalidate regions that you know should be redrawn.

    The child_func parameter controls whether the region of each child window that intersects region will also be invalidated. Only children for which child_func returns #TRUE will have the area invalidated.

    Parameters

    • region: cairo.Region

      a #cairo_region_t

    • child_func: WindowChildFunc

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

    Returns void

  • invalidate_rect(rect: Gdk.Rectangle, invalidate_children: boolean): void
  • A convenience wrapper around gdk_window_invalidate_region() which invalidates a rectangular region. See gdk_window_invalidate_region() for details.

    Parameters

    • rect: Gdk.Rectangle

      rectangle to invalidate or %NULL to invalidate the whole window

    • invalidate_children: boolean

      whether to also invalidate child windows

    Returns void

  • invalidate_region(region: cairo.Region, invalidate_children: boolean): void
  • Adds region to the update area for window. The update area is the region that needs to be redrawn, or “dirty region.” The call gdk_window_process_updates() sends one or more expose events to the window, which together cover the entire update area. An application would normally redraw the contents of window in response to those expose events.

    GDK will call gdk_window_process_all_updates() on your behalf whenever your program returns to the main loop and becomes idle, so normally there’s no need to do that manually, you just need to invalidate regions that you know should be redrawn.

    The invalidate_children parameter controls whether the region of each child window that intersects region will also be invalidated. If %FALSE, then the update area for child windows will remain unaffected. See gdk_window_invalidate_maybe_recurse if you need fine grained control over which children are invalidated.

    Parameters

    • region: cairo.Region

      a #cairo_region_t

    • invalidate_children: boolean

      %TRUE to also invalidate child windows

    Returns void

  • is_destroyed(): boolean
  • is_floating(): boolean
  • is_input_only(): boolean
  • is_shaped(): boolean
  • is_viewable(): boolean
  • Check if the window and all ancestors of the window are mapped. (This is not necessarily "viewable" in the X sense, since we only check as far as we have GDK window parents, not to the root window.)

    Returns boolean

  • is_visible(): boolean
  • Checks whether the window has been mapped (with gdk_window_show() or gdk_window_show_unraised()).

    Returns boolean

  • lower(): void
  • Lowers window to the bottom of the Z-order (stacking order), so that other windows with the same parent window appear above window. This is true whether or not the other windows are visible.

    If window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_lower() only requests the restack, does not guarantee it.

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

    Returns void

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

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

    Parameters

    Returns void

  • maximize(): void
  • Maximizes the window. If the window was already maximized, then this function does nothing.

    On X11, asks the window manager to maximize window, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “maximized”; so you can’t rely on the maximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    On Windows, reliably maximizes the window.

    Returns void

  • merge_child_input_shapes(): void
  • Merges the input shape masks for any child windows into the input shape mask for window. i.e. the union of all input masks for window and its children will become the new input mask for window. See gdk_window_input_shape_combine_region().

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

    Returns void

  • merge_child_shapes(): void
  • Merges the shape masks for any child windows into the shape mask for window. i.e. the union of all masks for window and its children will become the new mask for window. See gdk_window_shape_combine_region().

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

    Returns void

  • move(x: number, y: number): void
  • Repositions a window relative to its parent window. For toplevel windows, window managers may ignore or modify the move; you should probably use gtk_window_move() on a #GtkWindow widget anyway, instead of using GDK functions. For child windows, the move will reliably succeed.

    If you’re also planning to resize the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect.

    Parameters

    • x: number

      X coordinate relative to window’s parent

    • y: number

      Y coordinate relative to window’s parent

    Returns void

  • move_region(region: cairo.Region, dx: number, dy: number): void
  • Move the part of window indicated by region by dy pixels in the Y direction and dx pixels in the X direction. The portions of region that not covered by the new position of region are invalidated.

    Child windows are not moved.

    Parameters

    • region: cairo.Region

      The #cairo_region_t to move

    • dx: number

      Amount to move in the X direction

    • dy: number

      Amount to move in the Y direction

    Returns void

  • move_resize(x: number, y: number, width: number, height: number): void
  • Equivalent to calling gdk_window_move() and gdk_window_resize(), except that both operations are performed at once, avoiding strange visual effects. (i.e. the user may be able to see the window first move, then resize, if you don’t use gdk_window_move_resize().)

    Parameters

    • x: number

      new X position relative to window’s parent

    • y: number

      new Y position relative to window’s parent

    • width: number

      new width

    • height: number

      new height

    Returns void

  • Moves window to rect, aligning their anchor points.

    rect is relative to the top-left corner of the window that window is transient for. rect_anchor and window_anchor determine anchor points on rect and window to pin together. rect's anchor point can optionally be offset by rect_anchor_dx and rect_anchor_dy, which is equivalent to offsetting the position of window.

    anchor_hints determines how window will be moved if the anchor points cause it to move off-screen. For example, %GDK_ANCHOR_FLIP_X will replace %GDK_GRAVITY_NORTH_WEST with %GDK_GRAVITY_NORTH_EAST and vice versa if window extends beyond the left or right edges of the monitor.

    Connect to the #GdkWindow::moved-to-rect signal to find out how it was actually positioned.

    Parameters

    • rect: Gdk.Rectangle

      the destination #GdkRectangle to align window with

    • rect_anchor: Gdk.Gravity

      the point on rect to align with window's anchor point

    • window_anchor: Gdk.Gravity

      the point on window to align with rect's anchor point

    • anchor_hints: Gdk.AnchorHints

      positioning hints to use when limited on space

    • rect_anchor_dx: number

      horizontal offset to shift window, i.e. rect's anchor point

    • rect_anchor_dy: number

      vertical offset to shift window, i.e. rect's anchor point

    Returns void

  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • process_updates(update_children: boolean): void
  • Sends one or more expose events to window. The areas in each expose event will cover the entire update area for the window (see gdk_window_invalidate_region() for details). Normally GDK calls gdk_window_process_all_updates() on your behalf, so there’s no need to call this function unless you want to force expose events to be delivered immediately and synchronously (vs. the usual case, where GDK delivers them in an idle handler). Occasionally this is useful to produce nicer scrolling behavior, for example.

    Parameters

    • update_children: boolean

      whether to also process updates for child windows

    Returns void

  • raise(): void
  • Raises window to the top of the Z-order (stacking order), so that other windows with the same parent window appear below window. This is true whether or not the windows are visible.

    If window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_raise() only requests the restack, does not guarantee it.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • register_dnd(): void
  • reparent(new_parent: Gdk.Window, x: number, y: number): void
  • Reparents window into the given new_parent. The window being reparented will be unmapped as a side effect.

    Parameters

    • new_parent: Gdk.Window

      new parent to move window into

    • x: number

      X location inside the new parent

    • y: number

      Y location inside the new parent

    Returns void

  • resize(width: number, height: number): void
  • Resizes window; for toplevel windows, asks the window manager to resize the window. The window manager may not allow the resize. When using GTK+, use gtk_window_resize() instead of this low-level GDK function.

    Windows may not be resized below 1x1.

    If you’re also planning to move the window, use gdk_window_move_resize() to both move and resize simultaneously, for a nicer visual effect.

    Parameters

    • width: number

      new width of the window

    • height: number

      new height of the window

    Returns void

  • restack(sibling: Gdk.Window, above: boolean): void
  • Changes the position of window in the Z-order (stacking order), so that it is above sibling (if above is %TRUE) or below sibling (if above is %FALSE).

    If sibling is %NULL, then this either raises (if above is %TRUE) or lowers the window.

    If window is a toplevel, the window manager may choose to deny the request to move the window in the Z-order, gdk_window_restack() only requests the restack, does not guarantee it.

    Parameters

    • sibling: Gdk.Window

      a #GdkWindow that is a sibling of window, or %NULL

    • above: boolean

      a boolean

    Returns void

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • scroll(dx: number, dy: number): void
  • Scroll the contents of window, both pixels and children, by the given amount. window itself does not move. Portions of the window that the scroll operation brings in from offscreen areas are invalidated. The invalidated region may be bigger than what would strictly be necessary.

    For X11, a minimum area will be invalidated if the window has no subwindows, or if the edges of the window’s parent do not extend beyond the edges of the window. In other cases, a multi-step process is used to scroll the window which may produce temporary visual artifacts and unnecessary invalidations.

    Parameters

    • dx: number

      Amount to scroll in the X direction

    • dy: number

      Amount to scroll in the Y direction

    Returns void

  • set_accept_focus(accept_focus: boolean): void
  • Setting accept_focus to %FALSE hints the desktop environment that the window doesn’t want to receive input focus.

    On X, it is the responsibility of the window manager to interpret this hint. ICCCM-compliant window manager usually respect it.

    Parameters

    • accept_focus: boolean

      %TRUE if the window should receive input focus

    Returns void

  • Sets the background color of window.

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

    Parameters

    Returns void

  • Sets the background of window.

    A background of %NULL means that the window won't have any background. On the X11 backend it's also possible to inherit the background from the parent window using gdk_x11_get_parent_relative_pattern().

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

    Parameters

    Returns void

  • set_background_rgba(rgba: Gdk.RGBA): void
  • set_child_input_shapes(): void
  • Sets the input shape mask of window to the union of input shape masks for all children of window, ignoring the input shape mask of window itself. Contrast with gdk_window_merge_child_input_shapes() which includes the input shape mask of window in the masks to be merged.

    Returns void

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

    Returns void

  • set_composited(composited: boolean): void
  • Sets a #GdkWindow as composited, or unsets it. Composited windows do not automatically have their contents drawn to the screen. Drawing is redirected to an offscreen buffer and an expose event is emitted on the parent of the composited window. It is the responsibility of the parent’s expose handler to manually merge the off-screen content onto the screen in whatever way it sees fit.

    It only makes sense for child windows to be composited; see gdk_window_set_opacity() if you need translucent toplevel windows.

    An additional effect of this call is that the area of this window is no longer clipped from regions marked for invalidation on its parent. Draws done on the parent window are also no longer clipped by the child.

    This call is only supported on some systems (currently, only X11 with new enough Xcomposite and Xdamage extensions). You must call gdk_display_supports_composite() to check if setting a window as composited is supported before attempting to do so.

    Parameters

    • composited: boolean

      %TRUE to set the window as composited

    Returns void

  • Sets the default mouse pointer for a #GdkWindow.

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

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

    Parameters

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • “Decorations” are the features the window manager adds to a toplevel #GdkWindow. This function sets the traditional Motif window manager hints that tell the window manager which decorations you would like your window to have. Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of using the GDK function directly.

    The decorations argument is the logical OR of the fields in the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the mask, the other bits indicate which decorations should be turned off. If #GDK_DECOR_ALL is not included, then the other bits indicate which decorations should be turned on.

    Most window managers honor a decorations hint of 0 to disable all decorations, but very few honor all possible combinations of bits.

    Parameters

    Returns void

  • Sets a specific #GdkCursor for a given device when it gets inside window. Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the cursor argument to gdk_window_set_cursor() means that window will use the cursor of its parent window. Most windows should use this default.

    Parameters

    Returns void

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

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

    Parameters

    Returns void

  • set_event_compression(event_compression: boolean): void
  • Determines whether or not extra unprocessed motion events in the event queue can be discarded. If %TRUE only the most recent event will be delivered.

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

    By default, event compression is enabled.

    Parameters

    • event_compression: boolean

      %TRUE if motion events should be compressed

    Returns void

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

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

    Parameters

    Returns void

  • set_focus_on_map(focus_on_map: boolean): void
  • Setting focus_on_map to %FALSE hints the desktop environment that the window doesn’t want to receive input focus when it is mapped. focus_on_map should be turned off for windows that aren’t triggered interactively (such as popups from network activity).

    On X, it is the responsibility of the window manager to interpret this hint. Window managers following the freedesktop.org window manager extension specification should respect it.

    Parameters

    • focus_on_map: boolean

      %TRUE if the window should receive input focus when mapped

    Returns void

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

    The mode argument is from the #GdkFullscreenMode enumeration. If #GDK_FULLSCREEN_ON_ALL_MONITORS is specified, the fullscreen window will span over all monitors from the #GdkScreen.

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

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

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

    Parameters

    Returns void

  • Sets hints about the window management functions to make available via buttons on the window frame.

    On the X backend, this function sets the traditional Motif window manager hint for this purpose. However, few window managers do anything reliable or interesting with this hint. Many ignore it entirely.

    The functions argument is the logical OR of values from the #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL, then the other bits indicate which functions to disable; if it doesn’t include #GDK_FUNC_ALL, it indicates which functions to enable.

    Parameters

    • functions: Gdk.WMFunction

      bitmask of operations to allow on window

    Returns void

  • Sets the geometry hints for window. Hints flagged in geom_mask are set, hints not flagged in geom_mask are unset. To unset all hints, use a geom_mask of 0 and a geometry of %NULL.

    This function provides hints to the windowing system about acceptable sizes for a toplevel window. The purpose of this is to constrain user resizing, but the windowing system will typically (but is not required to) also constrain the current size of the window to the provided values and constrain programatic resizing via gdk_window_resize() or gdk_window_move_resize().

    Note that on X11, this effect has no effect on windows of type %GDK_WINDOW_TEMP or windows where override redirect has been turned on via gdk_window_set_override_redirect() since these windows are not resizable by the user.

    Since you can’t count on the windowing system doing the constraints for programmatic resizes, you should generally call gdk_window_constrain_size() yourself to determine appropriate sizes.

    Parameters

    Returns void

  • Sets the group leader window for window. By default, GDK sets the group leader for all toplevel windows to a global window implicitly created by GDK. With this function you can override this default.

    The group leader window allows the window manager to distinguish all windows that belong to a single application. It may for example allow users to minimize/unminimize all windows belonging to an application at once. You should only set a non-default group window if your application pretends to be multiple applications.

    Parameters

    • leader: Gdk.Window

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

    Returns void

  • set_icon_list(pixbufs: Pixbuf[]): void
  • Sets a list of icons for the window. One of these will be used to represent the window when it has been iconified. The icon is usually shown in an icon box or some sort of task bar. Which icon size is shown depends on the window manager. The window manager can scale the icon but setting several size icons can give better image quality since the window manager may only need to scale the icon by a small amount or not at all.

    Note that some platforms don't support window icons.

    Parameters

    • pixbufs: Pixbuf[]

      A list of pixbufs, of different sizes.

    Returns void

  • set_icon_name(name: string): void
  • Windows may have a name used while minimized, distinct from the name they display in their titlebar. Most of the time this is a bad idea from a user interface standpoint. But you can set such a name with this function, if you like.

    After calling this with a non-%NULL name, calls to gdk_window_set_title() will not update the icon title.

    Using %NULL for name unsets the icon title; further calls to gdk_window_set_title() will again update the icon title as well.

    Note that some platforms don't support window icons.

    Parameters

    • name: string

      name of window while iconified (minimized)

    Returns void

  • set_keep_above(setting: boolean): void
  • Set if window must be kept above other windows. If the window was already above, then this function does nothing.

    On X11, asks the window manager to keep window above, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “keep above”; so you can’t rely on the window being kept above. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    Parameters

    • setting: boolean

      whether to keep window above other windows

    Returns void

  • set_keep_below(setting: boolean): void
  • Set if window must be kept below other windows. If the window was already below, then this function does nothing.

    On X11, asks the window manager to keep window below, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “keep below”; so you can’t rely on the window being kept below. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    Parameters

    • setting: boolean

      whether to keep window below other windows

    Returns void

  • set_modal_hint(modal: boolean): void
  • The application can use this hint to tell the window manager that a certain window has modal behaviour. The window manager can use this information to handle modal windows in a special way.

    You should only use this on windows for which you have previously called gdk_window_set_transient_for()

    Parameters

    • modal: boolean

      %TRUE if the window is modal, %FALSE otherwise.

    Returns void

  • set_opacity(opacity: number): void
  • Set window to render as partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.)

    For toplevel windows this depends on support from the windowing system that may not always be there. For instance, On X11, this works only on X screens with a compositing manager running. On Wayland, there is no per-window opacity value that the compositor would apply. Instead, use gdk_window_set_opaque_region (window, NULL) to tell the compositor that the entire window is (potentially) non-opaque, and draw your content with alpha, or use gtk_widget_set_opacity() to set an overall opacity for your widgets.

    For child windows this function only works for non-native windows.

    For setting up per-pixel alpha topelevels, see gdk_screen_get_rgba_visual(), and for non-toplevels, see gdk_window_set_composited().

    Support for non-toplevel windows was added in 3.8.

    Parameters

    • opacity: number

      opacity

    Returns void

  • For optimisation purposes, compositing window managers may like to not draw obscured regions of windows, or turn off blending during for these regions. With RGB windows with no transparency, this is just the shape of the window, but with ARGB32 windows, the compositor does not know what regions of the window are transparent or not.

    This function only works for toplevel windows.

    GTK+ will update this property automatically if the window background is opaque, as we know where the opaque regions are. If your window background is not opaque, please update this property in your #GtkWidget::style-updated handler.

    Parameters

    Returns void

  • set_override_redirect(override_redirect: boolean): void
  • An override redirect window is not under the control of the window manager. This means it won’t have a titlebar, won’t be minimizable, etc. - it will be entirely under the control of the application. The window manager can’t see the override redirect window at all.

    Override redirect should only be used for short-lived temporary windows, such as popup menus. #GtkMenu uses an override redirect window in its implementation, for example.

    Parameters

    • override_redirect: boolean

      %TRUE if window should be override redirect

    Returns void

  • set_pass_through(pass_through: boolean): void
  • Sets whether input to the window is passed through to the window below.

    The default value of this is %FALSE, which means that pointer events that happen inside the window are send first to the window, but if the event is not selected by the event mask then the event is sent to the parent window, and so on up the hierarchy.

    If pass_through is %TRUE then such pointer events happen as if the window wasn't there at all, and thus will be sent first to any windows below window. This is useful if the window is used in a transparent fashion. In the terminology of the web this would be called "pointer-events: none".

    Note that a window with pass_through %TRUE can still have a subwindow without pass through, so you can get events on a subset of a window. And in that cases you would get the in-between related events such as the pointer enter/leave events on its way to the destination window.

    Parameters

    • pass_through: boolean

      a boolean

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_role(role: string): void
  • When using GTK+, typically you should use gtk_window_set_role() instead of this low-level function.

    The window manager and session manager use a window’s role to distinguish it from other kinds of window in the same application. When an application is restarted after being saved in a previous session, all windows with the same title and role are treated as interchangeable. So if you have two windows with the same title that should be distinguished for session management purposes, you should set the role on those windows. It doesn’t matter what string you use for the role, as long as you have a different role for each non-interchangeable kind of window.

    Parameters

    • role: string

      a string indicating its role

    Returns void

  • set_shadow_width(left: number, right: number, top: number, bottom: number): void
  • Newer GTK+ windows using client-side decorations use extra geometry around their frames for effects like shadows and invisible borders. Window managers that want to maximize windows or snap to edges need to know where the extents of the actual frame lie, so that users don’t feel like windows are snapping against random invisible edges.

    Note that this property is automatically updated by GTK+, so this function should only be used by applications which do not use GTK+ to create toplevel windows.

    Parameters

    • left: number

      The left extent

    • right: number

      The right extent

    • top: number

      The top extent

    • bottom: number

      The bottom extent

    Returns void

  • set_skip_pager_hint(skips_pager: boolean): void
  • Toggles whether a window should appear in a pager (workspace switcher, or other desktop utility program that displays a small thumbnail representation of the windows on the desktop). If a window’s semantic type as specified with gdk_window_set_type_hint() already fully describes the window, this function should not be called in addition, instead you should allow the window to be treated according to standard policy for its semantic type.

    Parameters

    • skips_pager: boolean

      %TRUE to skip the pager

    Returns void

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

    Parameters

    • skips_taskbar: boolean

      %TRUE to skip the taskbar

    Returns void

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

    Parameters

    Returns void

  • set_startup_id(startup_id: string): void
  • When using GTK+, typically you should use gtk_window_set_startup_id() instead of this low-level function.

    Parameters

    • startup_id: string

      a string with startup-notification identifier

    Returns void

  • set_static_gravities(use_static: boolean): boolean
  • Used to 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.

    Parameters

    • use_static: boolean

      %TRUE to turn on static gravity

    Returns boolean

  • set_support_multidevice(support_multidevice: boolean): void
  • This function will enable multidevice features in window.

    Multidevice aware windows will need to handle properly multiple, per device enter/leave events, device grabs and grab ownerships.

    Parameters

    • support_multidevice: boolean

      %TRUE to enable multidevice support in window.

    Returns void

  • set_title(title: string): void
  • 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.

    Parameters

    • title: string

      title of window

    Returns void

  • Indicates to the window manager that window is a transient dialog associated with the application window parent. This allows the window manager to do things like center window on parent and keep window above parent.

    See gtk_window_set_transient_for() if you’re using #GtkWindow or #GtkDialog.

    Parameters

    • parent: Gdk.Window

      another toplevel #GdkWindow

    Returns void

  • The application can use this call to provide a hint to the window manager about the functionality of a window. The window manager can use this information when determining the decoration and behaviour of the window.

    The hint must be set before the window is mapped.

    Parameters

    Returns void

  • set_urgency_hint(urgent: boolean): void
  • Toggles whether a window needs the user's urgent attention.

    Parameters

    • urgent: boolean

      %TRUE if the window is urgent

    Returns void

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

    Parameters

    Returns void

  • shape_combine_region(shape_region: cairo.Region, offset_x: number, offset_y: number): void
  • Makes pixels in window outside shape_region be transparent, so that the window may be nonrectangular.

    If shape_region is %NULL, the shape will be unset, so the whole window will be opaque again. offset_x and offset_y are ignored if shape_region is %NULL.

    On the X11 platform, this uses an X server extension which is widely available on most common platforms, but not available on very old X servers, and occasionally the implementation will be buggy. On servers without the shape extension, this function will do nothing.

    This function works on both toplevel and child windows.

    Parameters

    • shape_region: cairo.Region

      region of window to be non-transparent

    • offset_x: number

      X position of shape_region in window coordinates

    • offset_y: number

      Y position of shape_region in window coordinates

    Returns void

  • show(): void
  • Like gdk_window_show_unraised(), but also raises the window to the top of the window stack (moves the window to the front of the Z-order).

    This function maps a window so it’s visible onscreen. Its opposite is gdk_window_hide().

    When implementing a #GtkWidget, you should call this function on the widget's #GdkWindow as part of the “map” method.

    Returns void

  • show_unraised(): void
  • Shows a #GdkWindow onscreen, but does not modify its stacking order. In contrast, gdk_window_show() will raise the window to the top of the window stack.

    On the X11 platform, in Xlib terms, this function calls XMapWindow() (it also updates some internal GDK state, which means that you can’t really use XMapWindow() directly on a GDK window).

    Returns void

  • show_window_menu(event: Gdk.Event): boolean
  • Asks the windowing system to show the window menu. The window menu is the menu shown when right-clicking the titlebar on traditional windows managed by the window manager. This is useful for windows using client-side decorations, activating it with a right-click on the window decorations.

    Parameters

    • event: Gdk.Event

      a #GdkEvent to show the menu for

    Returns boolean

  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • stick(): void
  • “Pins” a window such that it’s on all workspaces and does not scroll with viewports, for window managers that have scrollable viewports. (When using #GtkWindow, gtk_window_stick() may be more useful.)

    On the X11 platform, this function depends on window manager support, so may have no effect with many window managers. However, GDK will do the best it can to convince the window manager to stick the window. For window managers that don’t support this operation, there’s nothing you can do to force it to happen.

    Returns void

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • thaw_toplevel_updates_libgtk_only(): void
  • Thaws a window frozen with gdk_window_freeze_toplevel_updates_libgtk_only().

    This function is not part of the GDK public API and is only for use by GTK+.

    Returns void

  • thaw_updates(): void
  • unfullscreen(): void
  • Moves the window out of fullscreen mode. If the window was not fullscreen, does nothing.

    On X11, asks the window manager to move window out of the fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “fullscreen”; so you can’t rely on the unfullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    Returns void

  • unmaximize(): void
  • Unmaximizes the window. If the window wasn’t maximized, then this function does nothing.

    On X11, asks the window manager to unmaximize window, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don’t have a concept of “maximized”; so you can’t rely on the unmaximization actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.

    On Windows, reliably unmaximizes the window.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • unstick(): void
  • Reverse operation for gdk_window_stick(); see gdk_window_stick(), and gtk_window_unstick().

    Returns void

  • vfunc_constructed(): void
  • vfunc_create_surface(width: number, height: number): cairo.Surface
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_from_embedder(embedder_x: number, embedder_y: number, offscreen_x: number, offscreen_y: number): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_to_embedder(offscreen_x: number, offscreen_y: number, embedder_x: number, embedder_y: number): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

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

    Returns void

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

    Returns [Gdk.Window, number, number]

  • compat_control(what: number, data: object): number
  • Constrains a desired width and height according to a set of geometry hints (such as minimum and maximum size).

    Parameters

    • geometry: Gdk.Geometry

      a #GdkGeometry structure

    • flags: Gdk.WindowHints

      a mask indicating what portions of geometry are set

    • width: number

      desired width of window

    • height: number

      desired height of the window

    Returns [number, number]

  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

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

    Parameters

    • parent: Gdk.Window

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

    • attributes: Gdk.WindowAttr

      attributes of the new window

    • attributes_mask: Gdk.WindowAttributesType

      mask indicating which fields in attributes are valid

    Returns Gdk.Window

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • process_all_updates(): void
  • set_debug_updates(setting: boolean): void
  • With update debugging enabled, calls to gdk_window_invalidate_region() clear the invalidated region of the screen to a noticeable color, and GDK pauses for a short time before sending exposes to windows during gdk_window_process_updates(). The net effect is that you can see the invalid region for each window and watch redraws as they occur. This allows you to diagnose inefficiencies in your application.

    In essence, because the GDK rendering model prevents all flicker, if you are redrawing the same region 400 times you may never notice, aside from noticing a speed problem. Enabling update debugging causes GTK to flicker slowly and noticeably, so you can see exactly what’s being redrawn when, in what order.

    The --gtk-debug=updates command line option passed to GTK+ programs enables this debug option at application startup time. That's usually more useful than calling gdk_window_set_debug_updates() yourself, though you might want to use this function to enable updates sometime after application startup time.

    Parameters

    • setting: boolean

      %TRUE to turn on update debugging

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method