Window#

class Window(*args, **kwargs)#

Superclasses: Widget, InitiallyUnowned, Object

Subclasses: AboutDialog, ApplicationWindow, Assistant, Dialog, ShortcutsWindow

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

A GtkWindow is a toplevel window which can contain other widgets.

Windows normally have decorations that are under the control of the windowing system and allow the user to manipulate the window (resize it, move it, close it,…).

GtkWindow as GtkBuildable#

The GtkWindow implementation of the Buildable interface supports setting a child as the titlebar by specifying “titlebar” as the “type” attribute of a <child> element.

Shortcuts and Gestures#

GtkWindow supports the following keyboard shortcuts:

F10 activates the menubar, if present.
Alt makes the mnemonics visible while pressed.

The following signals have default keybindings:

activate_default
activate_focus
enable_debugging

Actions#

GtkWindow defines a set of built-in actions:

default.activate activates the default widget.
window.minimize minimizes the window.
window.toggle-maximized maximizes or restores the window.
window.close closes the window.

CSS nodes#

window.background [.csd / .solid-csd / .ssd] [.maximized / .fullscreen / .tiled]
├── <child>
╰── <titlebar child>.titlebar [.default-decoration]

GtkWindow has a main CSS node with name window and style class .background.

Style classes that are typically used with the main CSS node are .csd (when client-side decorations are in use), .solid-csd (for client-side decorations without invisible borders), .ssd (used by mutter when rendering server-side decorations). GtkWindow also represents window states with the following style classes on the main node: .maximized, .fullscreen, .tiled (when supported, also .tiled-top, .tiled-left, .tiled-right, .tiled-bottom).

GtkWindow subclasses often add their own discriminating style classes, such as .dialog, .popup or .tooltip.

Generally, some CSS properties don’t make sense on the toplevel window node, such as margins or padding. When client-side decorations without invisible borders are in use (i.e. the .solid-csd style class is added to the main window node), the CSS border of the toplevel window is used for resize drags. In the .csd case, the shadow area outside of the window can be used to resize it.

GtkWindow adds the .titlebar and .default-decoration style classes to the widget that is added as a titlebar child.

Accessibility#

Until GTK 4.10, GtkWindow used the GTK_ACCESSIBLE_ROLE_WINDOW role.

Since GTK 4.12, GtkWindow uses the GTK_ACCESSIBLE_ROLE_APPLICATION role.

Constructors#

class Window

classmethod new() → Widget#

Creates a new GtkWindow.

To get an undecorated window (no window borders), use set_decorated.

All top-level windows created by new() are stored in an internal top-level window list. This list can be obtained from list_toplevels. Due to GTK keeping a reference to the window internally, new() does not return a reference to the caller.

To delete a GtkWindow, call destroy.

Methods#

class Window

close() → None#

Requests that the window is closed.

This is similar to what happens when a window manager close button is clicked.

This function can be used with close buttons in custom titlebars.

destroy() → None#: Drop the internal reference GTK holds on toplevel windows.

do_activate_default(self) → None#

do_activate_focus(self) → None#

do_close_request(self) → bool#

do_enable_debugging(self, toggle: bool) → bool#

Parameters:: toggle

do_keys_changed(self) → None#

fullscreen() → None#

Asks to place window in the fullscreen state.

Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager) unfullscreen it again, and not all window managers honor requests to fullscreen windows.

You can track the result of this operation via the state property, or by listening to notifications of the fullscreened property.

fullscreen_on_monitor(monitor: Monitor) → None#

Asks to place window in the fullscreen state on the given monitor.

Note that you shouldn’t assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on any given monitor.

You can track the result of this operation via the state property, or by listening to notifications of the fullscreened property.

Parameters:: monitor – which monitor to go fullscreen on

get_application() → Application | None#: Gets the GtkApplication associated with the window.

get_child() → Widget | None#: Gets the child widget of window.

get_decorated() → bool#: Returns whether the window has been set to have decorations.

classmethod get_default_icon_name() → str | None#

Returns the fallback icon name for windows.

The returned string is owned by GTK and should not be modified. It is only valid until the next call to set_default_icon_name.

get_default_size() → tuple[int, int]#

Gets the default size of the window.

A value of 0 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.

This function is the recommended way for saving window state across restarts of applications.

get_default_widget() → Widget | None#: Returns the default widget for window.

get_deletable() → bool#: Returns whether the window has been set to have a close button.

get_destroy_with_parent() → bool#: Returns whether the window will be destroyed with its transient parent.

get_focus() → Widget | None#

Retrieves the current focused widget within the window.

Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be True for the widget.

get_focus_visible() → bool#: Gets whether “focus rectangles” are supposed to be visible.

get_group() → WindowGroup#

Returns the group for window.

If the window has no group, then the default group is returned.

get_handle_menubar_accel() → bool#: Returns whether this window reacts to F10 key presses by activating a menubar it contains.

Added in version 4.2.

get_hide_on_close() → bool#: Returns whether the window will be hidden when the close button is clicked.

get_icon_name() → str | None#: Returns the name of the themed icon for the window.

get_mnemonics_visible() → bool#: Gets whether mnemonics are supposed to be visible.

get_modal() → bool#: Returns whether the window is modal.

get_resizable() → bool#: Gets the value set by set_resizable().

get_title() → str | None#: Retrieves the title of the window.

get_titlebar() → Widget | None#: Returns the custom titlebar that has been set with set_titlebar().

classmethod get_toplevels() → ListModel#

Returns a list of all existing toplevel windows.

If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets or add new ones, be aware that the list of toplevels will change and emit the “items-changed” signal.

get_transient_for() → Window | None#: Fetches the transient parent for this window.

has_group() → bool#: Returns whether window has an explicit window group.

is_active() → bool#

Returns whether the window is part of the current active toplevel.

The active toplevel is the window receiving keystrokes.

The return value is True if the window is active toplevel itself. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window.

is_fullscreen() → bool#

Retrieves the current fullscreen state of window.

Note that since fullscreening is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling fullscreen or unfullscreen.

If the window isn’t yet mapped, the value returned will whether the initial requested state is fullscreen.

is_maximized() → bool#

Retrieves the current maximized state of window.

Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling maximize or unmaximize.

If the window isn’t yet mapped, the value returned will whether the initial requested state is maximized.

is_suspended() → bool#

Retrieves the current suspended state of window.

A window being suspended means it’s currently not visible to the user, for example by being on a inactive workspace, minimized, obstructed.

Added in version 4.12.

classmethod list_toplevels() → list[Widget]#

Returns a list of all existing toplevel windows.

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.

maximize() → None#

Asks to maximize window, so that it fills the screen.

Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization.

It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

You can track the result of this operation via the state property, or by listening to notifications on the maximized property.

minimize() → None#

Asks to minimize the specified window.

Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager) could unminimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

It’s permitted to call this function before showing a window, in which case the window will be minimized before it ever appears onscreen.

You can track result of this operation via the state property.

present() → None#

Presents a window to the user.

This may mean raising the window in the stacking order, unminimizing it, moving it to the current desktop and/or giving it the keyboard focus (possibly dependent on the user’s platform, window manager and preferences).

If window is hidden, this function also makes it visible.

present_with_time(timestamp: int) → None#

Presents a window to the user in response to an user interaction.

See present for more details.

The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown.

Deprecated since version 4.14: Use present()

Parameters:: timestamp – the timestamp of the user interaction (typically a button or key press event) which triggered this call

set_application(application: Application | None = None) → None#

Sets or unsets the GtkApplication associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the application to None.

This is equivalent to calling remove_window and/or add_window on the old/new applications as relevant.

Parameters:: application – a GtkApplication, or None to unset

classmethod set_auto_startup_notification() → None#

Sets whether the window should request startup notification.

By default, after showing the first GtkWindow, GTK calls set_startup_id. Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.

In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.

set_child(child: Widget | None = None) → None#

Sets the child widget of window.

Parameters:: child – the child widget

set_decorated(setting: bool) → None#

Sets whether the window should be decorated.

By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK to disable these decorations, creating a borderless window. If you set the decorated property to False using this function, GTK will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling show.

On Windows, this function always works, since there’s no window manager policy involved.

Parameters:: setting – True to decorate the window

classmethod set_default_icon_name() → None#

Sets an icon to be used as fallback.

The fallback icon is used for windows that haven’t had set_icon_name called on them.

set_default_size(width: int, height: int) → None#

Sets the default size of a window.

The default size of a window is the size that will be used if no other constraints apply.

The default size will be updated whenever the window is resized to reflect the new size, unless the window is forced to a size, like when it is maximized or fullscreened.

If the window’s minimum size request is larger than the default, the default will be ignored.

Setting the default size to a value <= 0 will cause it to be ignored and the natural size request will be used instead. It is possible to do this while the window is showing to “reset” it to its initial size.

Unlike set_size_request, which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the “natural” default size (the size request of the window).

If you use this function to reestablish a previously saved window size, note that the appropriate size to save is the one returned by get_default_size. Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.

Parameters:

width – width in pixels, or -1 to unset the default width
height – height in pixels, or -1 to unset the default height

set_default_widget(default_widget: Widget | None = None) → None#

Sets the default widget.

The default widget is the widget that is activated when the user presses Enter in a dialog (for example).

Parameters:: default_widget – widget to be the default to unset the default widget for the toplevel

set_deletable(setting: bool) → None#

Sets whether the window should be deletable.

By default, windows have a close button in the window frame. Some window managers allow GTK to disable this button. If you set the deletable property to False using this function, GTK will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling show.

On Windows, this function always works, since there’s no window manager policy involved.

Parameters:: setting – True to decorate the window as deletable

set_destroy_with_parent(setting: bool) → None#

If setting is True, then destroying the transient parent of window will also destroy window itself.

This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example.

Parameters:: setting – whether to destroy window with its transient parent

set_display(display: Display) → None#

Sets the GdkDisplay where the window is displayed.

If the window is already mapped, it will be unmapped, and then remapped on the new display.

Parameters:: display – a GdkDisplay

set_focus(focus: Widget | None = None) → None#

Sets the focus widget.

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is None, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use grab_focus instead of this function.

Parameters:: focus – widget to be the new focus widget, or None to unset any focus widget for the toplevel window.

set_focus_visible(setting: bool) → None#

Sets whether “focus rectangles” are supposed to be visible.

This property is maintained by GTK based on user input, and should not be set by applications.

Parameters:: setting – the new value

set_handle_menubar_accel(handle_menubar_accel: bool) → None#

Sets whether this window should react to F10 key presses by activating a menubar it contains.

Added in version 4.2.

Parameters:: handle_menubar_accel – True to make window handle F10

set_hide_on_close(setting: bool) → None#

If setting is True, then clicking the close button on the window will not destroy it, but only hide it.

Parameters:: setting – whether to hide the window when it is closed

set_icon_name(name: str | None = None) → None#

Sets the icon for the window from a named themed icon.

See the docs for IconTheme for more details. On some platforms, the window icon is not used at all.

Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

Parameters:: name – the name of the themed icon

classmethod set_interactive_debugging() → None#

Opens or closes the interactive debugger.

The debugger offers access to the widget hierarchy of the application and to useful debugging tools.

This function allows applications that already use Ctrl+:kbd:Shift+:kbd:I (or Ctrl+:kbd:Shift+:kbd:D) for their own key shortcuts to add a different shortcut to open the Inspector.

If you are not overriding the default key shortcuts for the Inspector, you should not use this function.

set_mnemonics_visible(setting: bool) → None#

Sets whether mnemonics are supposed to be visible.

This property is maintained by GTK based on user input, and should not be set by applications.

Parameters:: setting – the new value

set_modal(modal: bool) → None#

Sets a window modal or non-modal.

Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use set_transient_for to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

Parameters:: modal – whether the window is modal

set_resizable(resizable: bool) → None#

Sets whether the user can resize a window.

Windows are user resizable by default.

Parameters:: resizable – True if the user can resize this window

set_startup_id(startup_id: str) → None#

Sets the startup notification ID.

Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkSurface.

Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling present or any equivalent function generating a window map event.

This function is only useful on X11, not with other GTK targets.

Parameters:: startup_id – a string with startup-notification identifier

set_title(title: str | None = None) → None#

Sets the title of the GtkWindow.

The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.

Passing None does the same as setting the title to an empty string.

Parameters:: title – title of the window

set_titlebar(titlebar: Widget | None = None) → None#

Sets a custom titlebar for window.

A typical widget used here is HeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it.

If you set a custom titlebar, GTK will do its best to convince the window manager not to put its own titlebar on the window. Depending on the system, this function may not work for a window that is already visible, so you set the titlebar before calling show.

Parameters:: titlebar – the widget to use as titlebar

set_transient_for(parent: Window | None = None) → None#

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. new_with_buttons and other convenience functions in GTK will sometimes call set_transient_for() on your behalf.

Passing None for parent unsets the current transient window.

On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.

Parameters:: parent – parent window

unfullscreen() → None#

Asks to remove the fullscreen state for window, and return to its previous state.

Note that you shouldn’t assume the window is definitely not fullscreen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows; normally the window will end up restored to its normal state. Just don’t write code that crashes if not.

You can track the result of this operation via the state property, or by listening to notifications of the fullscreened property.

unmaximize() → None#

Asks to unmaximize window.

Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) maximize it again, and not all window managers honor requests to unmaximize.

You can track the result of this operation via the state property, or by listening to notifications on the maximized property.

unminimize() → None#

Asks to unminimize the specified window.

Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager) could minimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

You can track result of this operation via the state property.

Properties#

class Window

props.application: Application#: The type of the None singleton.

props.child: Widget#: The type of the None singleton.

props.decorated: bool#: The type of the None singleton.

props.default_height: int#: The type of the None singleton.

props.default_widget: Widget#: The type of the None singleton.

props.default_width: int#: The type of the None singleton.

props.deletable: bool#: The type of the None singleton.

props.destroy_with_parent: bool#: The type of the None singleton.

props.display: Display#: The type of the None singleton.

props.focus_visible: bool#: The type of the None singleton.

props.focus_widget: Widget#: The type of the None singleton.

props.fullscreened: bool#: The type of the None singleton.

props.handle_menubar_accel: bool#: The type of the None singleton.

Added in version 4.2.

props.hide_on_close: bool#: The type of the None singleton.

props.icon_name: str#: The type of the None singleton.

props.is_active: bool#: The type of the None singleton.

props.maximized: bool#: The type of the None singleton.

props.mnemonics_visible: bool#: The type of the None singleton.

props.modal: bool#: The type of the None singleton.

props.resizable: bool#: The type of the None singleton.

props.startup_id: str#: The type of the None singleton.

props.suspended: bool#: The type of the None singleton.

Added in version 4.12.

props.title: str#: The type of the None singleton.

props.titlebar: Widget#: The type of the None singleton.

Added in version 4.6.

props.transient_for: Window#: The type of the None singleton.

Signals#

class Window.signals

activate_default() → None#: The type of the None singleton.

activate_focus() → None#: The type of the None singleton.

close_request() → bool#: The type of the None singleton.

enable_debugging(toggle: bool) → bool#

The type of the None singleton.

Parameters:: toggle – toggle the debugger

keys_changed() → None#: The type of the None singleton.

Deprecated since version 4.10: Use Shortcut and EventController to implement keyboard shortcuts

Virtual Methods#

class Window

do_activate_default() → None#: Activates the default widget for the window.

do_activate_focus() → None#: The type of the None singleton.

do_close_request() → bool#: The type of the None singleton.

do_enable_debugging(toggle: bool) → bool#

The type of the None singleton.

Parameters:: toggle

do_keys_changed() → None#: The type of the None singleton.

Fields#

class Window

parent_instance#

Window#

GtkWindow as GtkBuildable#

Shortcuts and Gestures#

Actions#

CSS nodes#

Accessibility#

Constructors#

Methods#

Properties#

Signals#

Virtual Methods#

Fields#

This Page