Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: WindowCloserequestCallback

[1552:7] extends: object

Generated low-level callback wrapper for GIR callback close-request.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WindowCloserequestCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: WindowActivatedefaultCallback

[1412:7] extends: object

Generated low-level callback wrapper for GIR callback activate-default.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WindowActivatedefaultCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: Window

[48:7] extends: object

A toplevel window which can contain other widgets. An
example GtkWindow 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 [iface@Gtk.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: - [signal@Gtk.Window::activate-default] - [signal@Gtk.Window::activate-focus] - [signal@Gtk.Window::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 GtkWindow uses the [enum@Gtk.AccessibleRole.window] role. From GTK 4.12 to 4.18, it used the [enum@Gtk.AccessibleRole.application] role.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • Window ()

    Creates a new GtkWindow. To get an undecorated window (without window borders), use [method@Gtk.Window.set_decorated]. All top-level windows created by this function are stored in an internal top-level window list. This list can be obtained from [func@Gtk.Window.list_toplevels]. Due to GTK keeping a reference to the window internally, this function does not return a reference to the caller. To delete a GtkWindow, call [method@Gtk.Window.destroy].

  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asWidget ()

    Wraps this handle as Widget.

    • @r A Widget object.
  • asAccessible ()

    Wraps this handle as Accessible.

    • @r A Accessible object.
  • asBuildable ()

    Wraps this handle as Buildable.

    • @r A Buildable object.
  • asConstraintTarget ()

    Wraps this handle as ConstraintTarget.

    • @r A ConstraintTarget object.
  • asNative ()

    Wraps this handle as Native.

    • @r A Native object.
  • asRoot ()

    Wraps this handle as Root.

    • @r A Root object.
  • asShortcutManager ()

    Wraps this handle as ShortcutManager.

    • @r A ShortcutManager object.
  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.
  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.
  • setOnActivatedefault (callback Fn, UserData = null)

    Emitted when the user activates the default widget. This is a keybinding signal. The keybindings for this signal are all forms of the Enter key.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Window Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnActivatefocus (callback Fn, UserData = null)

    Emitted when the user activates the currently focused widget of @window. This is a keybinding signal. The default binding for this signal is .

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Window Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnCloserequest (callback Fn, UserData = null)

    Emitted when the user clicks on the close button of the window.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Window Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnEnabledebugging (callback Fn, UserData = null)

    Emitted when the user enables or disables interactive debugging. When

    • @toggle is true, interactive debugging is toggled on or off, when it is false, the debugger will be pointed at the widget under the pointer. This is a keybinding signal. The default bindings for this signal are Ctrl+Shift+I and Ctrl+Shift+D.
    • @p Fn is the Aussom callback.
    • @p Fn is called with (Window Self, bool Toggle).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnKeyschanged (callback Fn, UserData = null)

    Emitted when the set of accelerators or mnemonics that are associated with the window changes.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (Window Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setApplication (object Value)

    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 g_application_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 this property to NULL.

    • @p Value is the new property value.
    • @r None.
  • setChild (object Value)

    The child widget.

    • @p Value is the new property value.
    • @r None.
  • setDecorated (bool Value)

    Whether the window should have a frame (also known as decorations).

    • @p Value is the new property value.
    • @r None.
  • setDefaultheight (int Value)

    The default height of the window.

    • @p Value is the new property value.
    • @r None.
  • setDefaultwidget (object Value)

    The default widget.

    • @p Value is the new property value.
    • @r None.
  • setDefaultwidth (int Value)

    The default width of the window.

    • @p Value is the new property value.
    • @r None.
  • setDeletable (bool Value)

    Whether the window frame should have a close button.

    • @p Value is the new property value.
    • @r None.
  • setDestroywithparent (bool Value)

    If this window should be destroyed when the parent is destroyed.

    • @p Value is the new property value.
    • @r None.
  • setDisplay (object Value)

    The display that will display this window.

    • @p Value is the new property value.
    • @r None.
  • setFocusvisible (bool Value)

    Whether 'focus rectangles' are currently visible in this window. This property is maintained by GTK based on user input and should not be set by applications.

    • @p Value is the new property value.
    • @r None.
  • setFocuswidget (object Value)

    The focus widget.

    • @p Value is the new property value.
    • @r None.
  • setFullscreened (bool Value)

    Whether the window is fullscreen. Setting this property is the equivalent of calling [method@Gtk.Window.fullscreen] or [method@Gtk.Window.unfullscreen]; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

    • @p Value is the new property value.
    • @r None.
  • setGravity (string Value)

    The gravity to use when resizing the window programmatically. Gravity describes which point of the window we want to keep fixed (meaning that the window will grow in the opposite direction). For example, a gravity of GTK_WINDOW_GRAVITY_TOP_RIGHT means that we want the to fix top right corner of the window.

    • @p Value is the new property value.
    • @r None.
  • setHandlemenubaraccel (bool Value)

    Whether the window frame should handle F10 for activating menubars.

    • @p Value is the new property value.
    • @r None.
  • setHideonclose (bool Value)

    If this window should be hidden instead of destroyed when the user clicks the close button.

    • @p Value is the new property value.
    • @r None.
  • setIconname (string Value)

    Specifies the name of the themed icon to use as the window icon. See [class@Gtk.IconTheme] for more details.

    • @p Value is the new property value.
    • @r None.
  • setMaximized (bool Value)

    Whether the window is maximized. Setting this property is the equivalent of calling [method@Gtk.Window.maximize] or [method@Gtk.Window.unmaximize]; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

    • @p Value is the new property value.
    • @r None.
  • setMnemonicsvisible (bool Value)

    Whether mnemonics are currently visible in this window. This property is maintained by GTK based on user input, and should not be set by applications.

    • @p Value is the new property value.
    • @r None.
  • setModal (bool Value)

    If true, the window is modal.

    • @p Value is the new property value.
    • @r None.
  • setResizable (bool Value)

    If true, users can resize the window.

    • @p Value is the new property value.
    • @r None.
  • setStartupid (string Value)

    A write-only property for setting window's startup notification identifier.

    • @p Value is the new property value.
    • @r None.
  • setTitle (string Value)

    The title of the window.

    • @p Value is the new property value.
    • @r None.
  • setTitlebar (object Value)

    The titlebar widget.

    • @p Value is the new property value.
    • @r None.
  • setTransientfor (object Value)

    The transient parent of the window.

    • @p Value is the new property value.
    • @r None.
  • close ()

    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.

    • @r None.
  • destroy ()

    Drops the internal reference GTK holds on toplevel windows.

    • @r None.
  • fullscreen ()

    Asks to place the 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. If a window is not explicitly fullscreened or unfullscreened before it is shown, the initial state is at the window managers discretion. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property.

    • @r None.
  • fullscreen_on_monitor (object monitor)

    Asks to place the 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 [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property.

    • @p monitor is which monitor to go fullscreen on.
    • @r None.
  • get_application ()

    Gets the application object associated with the window.

  • get_child ()

    Gets the child widget of the window.

  • get_decorated ()

    Returns whether the window has been set to have decorations.

  • get_default_widget ()

    Returns the default widget for @window.

  • get_deletable ()

    Returns whether the window has been set to have a close button.

  • get_destroy_with_parent ()

    Returns whether the window will be destroyed with its transient parent.

  • get_focus ()

    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 false for the widget.

  • get_focus_visible ()

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

  • get_gravity ()

    Returns the gravity that is used when changing the window size programmatically.

  • get_group ()

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

  • get_handle_menubar_accel ()

    Returns whether this window reacts to F10 presses by activating a menubar it contains.

  • get_hide_on_close ()

    Returns whether the window will be hidden instead of destroyed when the close button is clicked.

  • get_icon_name ()

    Returns the name of the themed icon for the window.

  • get_mnemonics_visible ()

    Gets whether mnemonics are supposed to be visible.

  • get_modal ()

    Returns whether the window is modal.

  • get_resizable ()

    Gets whether the user can resize the window.

  • get_title ()

    Retrieves the title of the window.

  • get_titlebar ()

    Returns the titlebar that has been set with [method@Gtk.Window.set_titlebar].

  • get_transient_for ()

    Fetches the transient parent for this window.

  • has_group ()

    Returns whether the window has an explicit window group.

  • is_active ()

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

    Retrieves the current fullscreen state of the 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 [method@Gtk.Window.fullscreen] or [method@Gtk.Window.unfullscreen]. If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen.

  • is_maximized ()

    Retrieves the current maximized state of the 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 [method@Gtk.Window.maximize] or [method@Gtk.Window.unmaximize]. If the window isn't yet mapped, the value returned will whether the initial requested state is maximized.

  • is_suspended ()

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

  • maximize ()

    Asks to maximize the 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. If a window is not explicitly maximized or unmaximized before it is shown, the initial state is at the window managers discretion. For example, it might decide to maximize a window that almost fills the screen. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications on the [property@Gtk.Window:maximized] property.

    • @r None.
  • minimize ()

    Asks to minimize the 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 [property@Gdk.Toplevel:state] property.

    • @r None.
  • present ()

    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.

    • @r None.
  • set_application (object application)

    Sets or unsets the application object associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see [method@Gio.Application.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 %NULL. This is equivalent to calling [method@Gtk.Application.remove_window] and/or [method@Gtk.Application.add_window] on the old/new applications as relevant.

    • @p application is a GtkApplication.
    • @r None.
  • set_child (object child)

    Sets the child widget of the window.

    • @p child is the child widget.
    • @r None.
  • set_decorated (bool setting)

    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 [method@Gtk.Widget.show]. On Windows, this function always works, since there’s no window manager policy involved.

    • @p setting is true to decorate the window.
    • @r None.
  • set_default_size (int width, int height)

    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 [method@Gtk.Widget.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 [method@Gtk.Window.get_default_size]. Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.

    • @p width is width in pixels, or -1 to unset the default width.
    • @p height is height in pixels, or -1 to unset the default height.
    • @r None.
  • set_default_widget (object default_widget)

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

    • @p default_widget is widget to be the default.
    • @r None.
  • set_deletable (bool setting)

    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 [method@Gtk.Widget.show]. On Windows, this function always works, since there’s no window manager policy involved.

    • @p setting is true to decorate the window as deletable.
    • @r None.
  • set_destroy_with_parent (bool setting)

    Sets whether to destroy the window when the transient parent is destroyed. This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example.

    • @p setting is whether to destroy the window with its transient parent.
    • @r None.
  • set_display (object display)

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

    • @p display is a display.
    • @r None.
  • set_focus (object focus)

    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 %NULL, 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 [method@Gtk.Widget.grab_focus] instead of this function.

    • @p focus is the new focus widget.
    • @r None.
  • set_focus_visible (bool setting)

    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.

    • @p setting is the new value.
    • @r None.
  • set_gravity (string gravity)

    Sets the gravity that is used when changing the window size programmatically.

    • @p gravity is the new gravity.
    • @r None.
  • set_handle_menubar_accel (bool handle_menubar_accel)

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

    • @p handle_menubar_accel is true to make @window handle F10.
    • @r None.
  • set_hide_on_close (bool setting)

    Sets whether clicking the close button will hide the window instead of destroying it.

    • @p setting is whether to hide the window when it is closed.
    • @r None.
  • set_icon_name (string name)

    Sets the icon for the window from a named themed icon. See the docs for [class@Gtk.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.

    • @p name is the name of the themed icon.
    • @r None.
  • set_mnemonics_visible (bool setting)

    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.

    • @p setting is the new value.
    • @r None.
  • set_modal (bool modal)

    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 [method@Gtk.Window.set_transient_for] to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

    • @p modal is whether the window is modal.
    • @r None.
  • set_resizable (bool resizable)

    Sets whether the user can resize a window. Windows are user resizable by default.

    • @p resizable is true if the user can resize this window.
    • @r None.
  • set_startup_id (string startup_id)

    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 [method@Gtk.Window.present] or any equivalent function generating a window map event. This function is only useful on Wayland or X11, not with other GDK backends.

    • @p startup_id is a string with startup-notification identifier.
    • @r None.
  • set_title (string title)

    Sets the title of the window. 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 NULL does the same as setting the title to an empty string.

    • @p title is title of the window.
    • @r None.
  • set_titlebar (object titlebar)

    Sets a custom titlebar for the window. A typical widget used here is [class@Gtk.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 [method@Gtk.Widget.show].

    • @p titlebar is the widget to use as titlebar.
    • @r None.
  • set_transient_for (object parent)

    Sets a transient parent for the window. 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. [ctor@Gtk.Dialog.new_with_buttons] and other convenience functions in GTK will sometimes call this function on your behalf. Passing NULL 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.
    • @p parent is parent window.
    • @r None.
  • unfullscreen ()

    Asks to remove the fullscreen state for the 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. If a window is not explicitly fullscreened or unfullscreened before it is shown, the initial state is at the window managers discretion. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications of the [property@Gtk.Window:fullscreened] property.

    • @r None.
  • unmaximize ()

    Asks to unmaximize the 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. If a window is not explicitly maximized or unmaximized before it is shown, the initial state is at the window managers discretion. For example, it might decide to maximize a window that almost fills the screen. You can track the result of this operation via the [property@Gdk.Toplevel:state] property, or by listening to notifications on the [property@Gtk.Window:maximized] property.

    • @r None.
  • unminimize ()

    Asks to unminimize the 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 [property@Gdk.Toplevel:state] property.

    • @r None.

class: WindowEnabledebuggingCallback

[1622:7] extends: object

Generated low-level callback wrapper for GIR callback enable-debugging.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WindowEnabledebuggingCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, toggle, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: WindowActivatefocusCallback

[1482:7] extends: object

Generated low-level callback wrapper for GIR callback activate-focus.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WindowActivatefocusCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: WindowKeyschangedCallback

[1693:7] extends: object

Generated low-level callback wrapper for GIR callback keys-changed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WindowKeyschangedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: WindowMeta

[1763:14] static extends: object

Generated metadata helpers for Window class surfaces.

Methods

  • properties ()

    Returns property metadata for Window.

    • @r A list.
  • signals ()

    Returns signal metadata for Window.

    • @r A list.