Struct gtk::Window

#[repr(transparent)]
pub struct Window { /* private 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 Buildable interface supports a custom <accel-groups> element, which supports any number of <group> elements representing the AccelGroup objects you want to add to your window (synonymous with GtkWindowExt::add_accel_group().

It also supports the <initial-focus> element, whose name property names the widget to receive the focus when the window is mapped.

An example of a UI definition fragment with accel groups:

⚠️ The following code is in xml ⚠️

<object class="GtkWindow">
  <accel-groups>
    <group name="accelgroup1"/>
  </accel-groups>
  <initial-focus name="thunderclap"/>
</object>

...

<object class="GtkAccelGroup" id="accelgroup1"/>

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.

CSS nodes

⚠️ The following code is in plain ⚠️

window.background
├── decoration
├── <titlebar child>.titlebar [.default-decoration]
╰── <child>

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

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: .tiled, .maximized, .fullscreen. Specialized types of window often add their own discriminating style classes, such as .popup or .tooltip.

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

Implements

GtkWindowExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, [GtkWindowExtManual][trait@crate::prelude::GtkWindowExtManual], ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl Window

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

pub fn new(type_: WindowType) -> Window

Creates a new Window, which is a toplevel window that can contain other widgets. Nearly always, the type of the window should be WindowType::Toplevel. If you’re implementing something like a popup menu from scratch (which is a bad idea, just use Menu), you might use WindowType::Popup. WindowType::Popup is not for dialogs, though in some other toolkits dialogs are called “popups”. In GTK+, WindowType::Popup means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the [window manager][gtk-X11-arch].

If you simply want an undecorated window (no window borders), use GtkWindowExt::set_decorated(), don’t use WindowType::Popup.

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 Window, call gtk_widget_destroy().

type_

type of window

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_list() -> Vec<Pixbuf>

Gets the value set by set_default_icon_list(). The list is a copy and should be freed with g_list_free(), but the pixbufs in the list have not had their reference count incremented.

Returns

copy of default icon list

pub fn default_icon_name() -> Option<GString>

Returns the fallback icon name for windows that has been set with set_default_icon_name(). 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 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)

By default, after showing the first Window, GTK+ calls gdk_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(icon: &Pixbuf)

Sets an icon to be used as fallback for windows that haven’t had GtkWindowExt::set_icon() called on them from a pixbuf.

icon

the icon

pub fn set_default_icon_from_file(
    filename: impl AsRef<Path>
) -> Result<(), Error>

Sets an icon to be used as fallback for windows that haven’t had GtkWindowExt::set_icon_list() called on them from a file on disk. Warns on failure if err is None.

filename

location of icon file

Returns

true if setting the icon succeeded.

pub fn set_default_icon_list(list: &[Pixbuf])

Sets an icon list to be used as fallback for windows that haven’t had GtkWindowExt::set_icon_list() called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.

See GtkWindowExt::set_icon_list() for more details.

list

a list of gdk_pixbuf::Pixbuf

pub fn set_default_icon_name(name: &str)

Sets an icon to be used as fallback for windows that haven’t had GtkWindowExt::set_icon_list() called on them from a named themed icon, see GtkWindowExt::set_icon_name().

name

the name of the themed icon

pub fn set_interactive_debugging(enable: bool)

Opens or closes the [interactive debugger][interactive-debugging], which 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, 

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) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl ParentClassIs for Window

type Parent = Bin

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 !=.

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<Bin> for Window

impl IsA<Buildable> for Window

impl IsA<Container> for Window

impl IsA<Widget> for Window

impl IsA<Window> for AboutDialog

impl IsA<Window> for AppChooserDialog

impl IsA<Window> for Plug

Available on gdk_backend="x11" only.

impl IsA<Window> for RecentChooserDialog

impl IsA<Window> for ShortcutsWindow

Available on crate feature v3_20 only.

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 OffscreenWindow