Creates a new Gtk::Window.

To get an undecorated window (no window borders), use Gtk::Window#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 Gtk::Window#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 Gtk::Window, call Gtk::Window#destroy.

Sets whether the window should request startup notification.

By default, after showing the first Gtk::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.

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 Gtk::Window#default_icon_name=.

Sets an icon to be used as fallback.

The fallback icon is used for windows that haven't had Gtk::Window#icon_name= called on them.

Returns the type id (GType) registered in GLib type system.

Opens or closes the interactive debugger.

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

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

Gets the Gtk::Application associated with the window.

Sets or unsets the Gtk::Application 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 @application to nil.

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

Gets the child widget of @window.

Sets the child widget of @window.

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.

Returns whether the window has been set to have decorations.

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 Gtk::Widget#show.

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

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.

Returns the default widget for @window.

Sets the default widget.

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

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

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 Gtk::Widget#show.

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

Drop the internal reference GTK holds on toplevel windows.

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

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.

Get the Gdk::Display for the toplevel window associated with this widget.

This function can only be called after the widget has been added to a widget hierarchy with a Gtk::Window at the top.

In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Sets the Gdk::Display where the @window is displayed.

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

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.

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 nil, 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 Gtk::Widget#grab_focus instead of this function.

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

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

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

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

Returns the group for @window.

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

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

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

Returns whether @window has an explicit window group.

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

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

Returns the name of the themed icon for the window.

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

See the docs for 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.

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.

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 Gtk::Window#fullscreen or Gtk::Window#unfullscreen.

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

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 Gtk::Window#maximize or Gtk::Window#unmaximize.

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

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 Gdk::Toplevel#state property, or by listening to notifications on the Gtk::Window#maximized property.

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 Gdk::Toplevel#state property.

Gets whether mnemonics are supposed to be visible.

Sets whether mnemonics are supposed to be visible.

Returns whether the window is 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 Gtk::Window#transient_for= to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

Presents a window to the user.

This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.

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 calls Gtk::Widget#show as well.

This function should be used when the user tries to open a window that’s already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use Gtk::Window#present to move the already-open dialog where the user can see it.

Presents a window to the user in response to a user interaction. 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.

Gets the value set by gtk_window_set_resizable().

Sets whether the user can resize a window.

Windows are user resizable by default.

Sets the default size of a window.

If the window’s “natural” size (its size request) is larger than the default, the default will be ignored.

Unlike Gtk::Widget#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).

The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.

Windows can’t actually be 0x0 in size, they must be at least 1x1, but passing 0 for @width and @height is OK, resulting in a 1x1 default size.

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

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 Gdk::Surface.

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 Gtk::Window#present or any equivalent function generating a window map event.

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

Retrieves the title of the window.

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

Returns the custom titlebar that has been set with gtk_window_set_titlebar().

Sets a custom titlebar for @window.

A typical widget used here is 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 Gtk::Widget#show.

Fetches the transient parent for this 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. Gtk::Dialog#new_with_buttons and other convenience functions in GTK will sometimes call gtk_window_set_transient_for() on your behalf.

Passing nil 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.

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

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 Gdk::Toplevel#state property, or by listening to notifications on the Gtk::Window#maximized property.

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 Gdk::Toplevel#state property.