ApplicationWindow

class ApplicationWindow(*args, **kwargs)

Superclasses: Window, Widget, InitiallyUnowned, Object

Implemented Interfaces: ActionGroup, ActionMap, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

A GtkWindow subclass that integrates with GtkApplication.

Notably, GtkApplicationWindow can handle an application menubar.

This class implements the ActionGroup and ActionMap interfaces, to let you add window-specific actions that will be exported by the associated 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 Actionable interface.

The settings gtk_shell_shows_app_menu and 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 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 PopoverMenu for information about the XML language used by GtkBuilder for menu models.

See also: set_menubar.

A GtkApplicationWindow with a menubar

The code sample below shows how to set up a GtkApplicationWindow with a menu bar defined on the Application:

GtkApplication *app = gtk_application_new ("org.gtk.test", 0);

GtkBuilder *builder = gtk_builder_new_from_string (
    "<interface>"
    "  <menu id='menubar'>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Edit</attribute>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Copy</attribute>"
    "        <attribute name='action'>win.copy</attribute>"
    "      </item>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Paste</attribute>"
    "        <attribute name='action'>win.paste</attribute>"
    "      </item>"
    "    </submenu>"
    "  </menu>"
    "</interface>",
    -1);

GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder, "menubar"));
gtk_application_set_menubar (GTK_APPLICATION (app), menubar);
g_object_unref (builder);

// ...

GtkWidget *window = gtk_application_window_new (app);

Constructors

class ApplicationWindow

classmethod new(application: Application) → Widget

Creates a new GtkApplicationWindow.

Parameters:

application – an application

Methods

class ApplicationWindow

get_help_overlay() → ShortcutsWindow | None

Gets the GtkShortcutsWindow that is associated with window.

See set_help_overlay.

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

get_id() → int

Returns the unique ID of the window.

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

get_show_menubar() → bool

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

set_help_overlay(help_overlay: ShortcutsWindow | None = None) → None

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

Parameters:

help_overlay – a shortcuts window

set_show_menubar(show_menubar: bool) → None

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

Parameters:

show_menubar – whether to show a menubar when needed

Properties

class ApplicationWindow

props.show_menubar: bool

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

See set_menubar.

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

Fields

class ApplicationWindow

parent_instance