Gtk.ApplicationWindow¶

This class implements the [iface`Gio`.ActionGroup] and [iface`Gio`.ActionMap] interfaces, to let you add window-specific actions that will be exported by the associated [class`Gtk`.Application], together with its application-wide actions. Window-specific actions are prefixed with the “win.” prefix and application-wide actions are prefixed with the “app.” prefix. Actions must be addressed with the prefixed name when referring to them from a menu model.

Note that widgets that are placed inside a GtkApplicationWindow can also activate these actions, if they implement the [iface`Gtk`.Actionable] interface.

The settings [property`Gtk`.Settings:gtk-shell-shows-app-menu] and [property`Gtk`.Settings:gtk-shell-shows-menubar] tell GTK whether the desktop environment is showing the application menu and menubar models outside the application as part of the desktop shell. For instance, on OS X, both menus will be displayed remotely; on Windows neither will be.

If the desktop environment does not display the menubar, it can be shown in the GtkApplicationWindow by setting the [property`Gtk`.ApplicationWindow:show-menubar] property to true. If the desktop environment does not display the application menu, then it will automatically be included in the menubar or in the window’s client-side decorations.

See [class`Gtk`.PopoverMenu] for information about the XML language used by GtkBuilder for menu models.

See also: [method`Gtk`.Application.set_menubar].

A Gtk.ApplicationWindow with a menubar

The code sample below shows how to set up a GtkApplicationWindow with a menu bar defined on the [class`Gtk`.Application]:

```c Gtk.Application *app = Gtk.Application.new (“org.gtk.test”, 0);

Gtk.Builder *builder = Gtk.Builder.new_from_string ( “” “ ” “ <submenu>” “ _Edit</attribute>” “ <item>” “ _Copy</attribute>” “ win.copy</attribute>” “ </item>” “ <item>” “ _Paste</attribute>” “ win.paste</attribute>” “ </item>” “ </submenu>” “ </menu>” “”, -1); Gio.MenuModel *menubar = G_MENU_MODEL (Gtk.Builder.get_object (builder, “menubar”)); Gtk.Application.set_menubar (GTK_APPLICATION (app), menubar); GObject.Object.unref (builder);

// …

Gtk.Widget *window = Gtk.ApplicationWindow.new (app); ```

classmethod new(application)[source]¶

Parameters:: application (Gtk.Application) – an application
Returns:: a newly created GtkApplicationWindow
Return type:: Gtk.Widget

Creates a new GtkApplicationWindow.

get_help_overlay()[source]¶

Returns:: the help overlay associated with the window
Return type:: Gtk.ShortcutsWindow or None

Gets the GtkShortcutsWindow that is associated with self.

See [method`Gtk`.ApplicationWindow.set_help_overlay].

Deprecated since version 4.18: GtkShortcutsWindow will be removed in GTK 5

get_id()[source]¶

Returns:: the unique ID for the window, or 0 if the window has not yet been added to an application
Return type:: int

Returns the unique ID of the window.

If the window has not yet been added to a GtkApplication, returns 0.

get_show_menubar()[source]¶

Returns:: True if the window will display a menubar when needed
Return type:: bool

Returns whether the window will display a menubar for the app menu and menubar as needed.

set_help_overlay(help_overlay)[source]¶

Parameters:: help_overlay (Gtk.ShortcutsWindow or None) – a shortcuts window

Associates a shortcuts window with the application window.

Additionally, sets up an action with the name win.show-help-overlay to present it.

The window takes responsibility for destroying the help overlay.

Deprecated since version 4.18: GtkShortcutsWindow will be removed in GTK 5

set_show_menubar(show_menubar)[source]¶

Parameters:: show_menubar (bool) – whether to show a menubar when needed

Sets whether the window will display a menubar for the app menu and menubar as needed.

Property Details¶

Gtk.ApplicationWindow.props.show_menubar¶

Name:: show-menubar
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

If this property is true, the window will display a menubar unless it is shown by the desktop shell.

See [method`Gtk`.Application.set_menubar].

If false, the window will not display a menubar, regardless of whether the desktop shell is showing it or not.