Class
GtkWindow
since: 4.0
Description [src]
class Gtk.Window : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Native, Gtk.Root, Gtk.ShortcutManager {
/* No available fields */
}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 GtkBuildable interface supports
setting a child as the titlebar by specifying “titlebar” as the “type”
attribute of a <child> element.
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.
Actions
GtkWindow defines a set of built-in actions:
- default.activate: Activate the default widget.
- window.minimize: Minimize the window.
- window.toggle-maximized: Maximize or restore the window.
- window.close: Close the window.
Available since: 4.0
Functions
gtk_window_set_auto_startup_notification
Sets whether the window should request startup notification.
since: 4.0
Instance methods
gtk_window_fullscreen_on_monitor
Asks to place window in the fullscreen state on the given monitor.
since: 4.0
gtk_window_get_destroy_with_parent
Returns whether the window will be destroyed with its transient parent.
since: 4.0
gtk_window_get_handle_menubar_accel
Returns whether this window reacts to F10 key presses by activating a menubar it contains.
since: 4.2
gtk_window_get_hide_on_close
Returns whether the window will be hidden when the close button is clicked.
since: 4.0
gtk_window_get_titlebar
Returns the custom titlebar that has been set with gtk_window_set_titlebar().
since: 4.0
gtk_window_present_with_time
Presents a window to the user in response to an user interaction.
deprecated: 4.14 since: 4.0
gtk_window_set_destroy_with_parent
If setting is TRUE, then destroying the transient parent of window
will also destroy window itself.
since: 4.0
gtk_window_set_handle_menubar_accel
Sets whether this window should react to F10 key presses by activating a menubar it contains.
since: 4.2
gtk_window_set_hide_on_close
If setting is TRUE, then clicking the close button on the window
will not destroy it, but only hide it.
since: 4.0
gtk_window_set_transient_for
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. gtk_dialog_new_with_buttons() and other
convenience functions in GTK will sometimes call
gtk_window_set_transient_for() on your behalf.
since: 4.0
gtk_window_unfullscreen
Asks to remove the fullscreen state for window, and return to
its previous state.
since: 4.0
Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
since: 4.0
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible.
since: 4.10
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
since: 4.10
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
since: 4.10
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
since: 4.10
gtk_accessible_get_platform_state
Query a platform state, such as focus.
since: 4.10
gtk_accessible_reset_property
Resets the accessible property to its default value.
since: 4.0
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
since: 4.0
gtk_accessible_reset_state
Resets the accessible state to its default value.
since: 4.0
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
since: 4.10
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self.
since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
since: 4.0
gtk_accessible_update_property_value
Updates an array of accessible properties.
since: 4.0
gtk_accessible_update_relation
Updates a list of accessible relations.
since: 4.0
gtk_accessible_update_relation_value
Updates an array of accessible relations.
since: 4.0
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
since: 4.0
gtk_accessible_update_state_value
Updates an array of accessible states.
since: 4.0
Methods inherited from GtkBuildable (1)
Methods inherited from GtkNative (5)
gtk_native_get_renderer
Returns the renderer that is used for this GtkNative.
since: 4.0
gtk_native_get_surface
Returns the surface of this GtkNative.
since: 4.0
gtk_native_get_surface_transform
Retrieves the surface transform of self.
since: 4.0
gtk_native_realize
Realizes a GtkNative.
since: 4.0
gtk_native_unrealize
Unrealizes a GtkNative.
since: 4.0
Methods inherited from GtkRoot (3)
gtk_root_get_display
Returns the display that this GtkRoot is on.
since: 4.0
gtk_root_get_focus
Retrieves the current focused widget within the root.
since: 4.0
gtk_root_set_focus
If focus is not the current focus widget, and is focusable, sets
it as the focus widget for the root.
since: 4.0
Properties
Gtk.Window:destroy-with-parent
If this window should be destroyed when the parent is destroyed.
since: 4.0
Gtk.Window:focus-visible
Whether ‘focus rectangles’ are currently visible in this window.
since: 4.0
Gtk.Window:handle-menubar-accel
Whether the window frame should handle F10 for activating menubars.
since: 4.2
Gtk.Window:hide-on-close
If this window should be hidden when the users clicks the close button.
since: 4.0
Gtk.Window:startup-id
A write-only property for setting window’s startup notification identifier.
since: 4.0
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
since: 4.0
Gtk.Widget:can-target
Whether the widget can receive pointer events.
since: 4.0
Gtk.Widget:css-classes
A list of css classes applied to this widget.
since: 4.0
Gtk.Widget:css-name
The name of this widget in the CSS tree.
since: 4.0
Gtk.Widget:cursor
The cursor used by widget.
since: 4.0
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
since: 4.0
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
since: 4.0
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
since: 4.0
Gtk.Widget:has-default
Whether the widget is the default widget.
since: 4.0
Gtk.Widget:has-focus
Whether the widget has the input focus.
since: 4.0
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget.
since: 4.0
Gtk.Widget:height-request
Override for height request of the widget.
since: 4.0
Gtk.Widget:hexpand
Whether to expand horizontally.
since: 4.0
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
since: 4.0
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute the preferred size
of the widget, and allocate its children.
since: 4.0
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
since: 4.0
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
since: 4.0
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
since: 4.0
Gtk.Widget:margin-top
Margin on top side of widget.
since: 4.0
Gtk.Widget:name
The name of the widget.
since: 4.0
Gtk.Widget:opacity
The requested opacity of the widget.
since: 4.0
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
since: 4.0
Gtk.Widget:parent
The parent widget of this widget.
since: 4.0
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
since: 4.0
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
since: 4.0
Gtk.Widget:scale-factor
The scale factor of the widget.
since: 4.0
Gtk.Widget:sensitive
Whether the widget responds to input.
since: 4.0
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
since: 4.0
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
since: 4.0
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
since: 4.0
Gtk.Widget:vexpand
Whether to expand vertically.
since: 4.0
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
since: 4.0
Gtk.Widget:visible
Whether the widget is visible.
since: 4.0
Gtk.Widget:width-request
Override for width request of the widget.
since: 4.0
Properties inherited from GtkAccessible (1)
GtkAccessible:accessible-role
The accessible role of the given GtkAccessible implementation.
since: 4.0
Signals
Gtk.Window::activate-default
Emitted when the user activates the default widget
of window.
since: 4.0
Gtk.Window::activate-focus
Emitted when the user activates the currently focused
widget of window.
since: 4.0
Gtk.Window::close-request
Emitted when the user clicks on the close button of the window.
since: 4.0
Gtk.Window::enable-debugging
Emitted when the user enables or disables interactive debugging.
since: 4.0
Gtk.Window::keys-changed
Emitted when the set of accelerators or mnemonics that
are associated with window changes.
deprecated: 4.10 since: 4.0
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
since: 4.0
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
since: 4.0
GtkWidget::hide
Emitted when widget is hidden.
since: 4.0
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
since: 4.0
GtkWidget::map
Emitted when widget is going to be mapped.
since: 4.0
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
since: 4.0
GtkWidget::move-focus
Emitted when the focus is moved.
since: 4.0
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
since: 4.0
GtkWidget::realize
Emitted when widget is associated with a GdkSurface.
since: 4.0
GtkWidget::show
Emitted when widget is shown.
since: 4.0
GtkWidget::state-flags-changed
Emitted when the widget state changes.
since: 4.0
GtkWidget::unmap
Emitted when widget is going to be unmapped.
since: 4.0
GtkWidget::unrealize
Emitted when the GdkSurface associated with widget is destroyed.
since: 4.0
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
since: 2.0
Class structure
struct GtkWindowClass {
GtkWidgetClass parent_class;
void (* activate_focus) (
GtkWindow* window
);
void (* activate_default) (
GtkWindow* window
);
void (* keys_changed) (
GtkWindow* window
);
gboolean (* enable_debugging) (
GtkWindow* window,
gboolean toggle
);
gboolean (* close_request) (
GtkWindow* window
);
}Class members
parent_class: GtkWidgetClassThe parent class.
activate_focus: void (* activate_focus) ( GtkWindow* window )- No description available.
activate_default: void (* activate_default) ( GtkWindow* window )- No description available.
keys_changed: void (* keys_changed) ( GtkWindow* window )- No description available.
enable_debugging: gboolean (* enable_debugging) ( GtkWindow* window, gboolean toggle )- No description available.
close_request: gboolean (* close_request) ( GtkWindow* window )- No description available.