Struct gtk4::Window

#[repr(transparent)]
pub struct Window { /* private fields */ }

A Window 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 Window implementation of the Buildable interface supports setting a child as the titlebar by specifying “titlebar” as the “type” attribute of a element.

CSS nodes

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

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

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

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

Accessibility

Window uses the AccessibleRole::Window role.

Actions

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

Implements

GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Window

pub const NONE: Option<&'static Window> = None

pub fn new() -> Window

Creates a new Window.

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

All top-level windows created by gtk_window_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, gtk_window_new() does not return a reference to the caller.

To delete a Window, call Gtk::Window::destroy().

Returns

a new Window.

pub fn builder() -> WindowBuilder

Creates a new builder-pattern struct instance to construct Window objects.

This method returns an instance of WindowBuilder which can be used to create Window objects.

pub fn default_icon_name() -> Option<GString>

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

Returns

the fallback icon name for windows

pub fn 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.

Returns

the list of toplevel widgets

pub fn list_toplevels() -> Vec<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.

Returns

list of toplevel widgets

pub fn set_auto_startup_notification(setting: bool)

Sets whether the window should request startup notification.

By default, after showing the first Window, GTK calls Gdk::Display::notify_startup_complete(). 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.

setting

true to automatically do startup notification

pub fn set_default_icon_name(name: &str)

Sets an icon to be used as fallback.

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

name

the name of the themed icon

pub fn set_interactive_debugging(enable: bool)

Opens or closes the interactive debugger.

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

enable

true to enable interactive debugging

Trait Implementations

impl Clone for Window

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Window

fn default() -> Self

Returns the “default value” for a type.

impl Display for Window

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Window

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: WindowImpl> IsSubclassable<T> for Window

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Window

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Window

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Window

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Window

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Window

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Window

impl IsA<Accessible> for Window

impl IsA<Buildable> for Window

impl IsA<ConstraintTarget> for Window

impl IsA<Native> for Window

impl IsA<Root> for Window

impl IsA<ShortcutManager> for Window

impl IsA<Widget> for Window

impl IsA<Window> for AboutDialog

impl IsA<Window> for AppChooserDialog

impl IsA<Window> for ApplicationWindow

impl IsA<Window> for Assistant

impl IsA<Window> for ColorChooserDialog

impl IsA<Window> for Dialog

impl IsA<Window> for FileChooserDialog

impl IsA<Window> for FontChooserDialog

impl IsA<Window> for MessageDialog

impl IsA<Window> for PageSetupUnixDialog

Available on Linux only.

impl IsA<Window> for PrintUnixDialog

Available on Linux only.

impl IsA<Window> for ShortcutsWindow