Gtk.ApplicationWindow

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gio.ActionGroup Gio.ActionGroup GObject.GInterface->Gio.ActionGroup Gio.ActionMap Gio.ActionMap GObject.GInterface->Gio.ActionMap Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.ApplicationWindow Gtk.ApplicationWindow Gio.ActionGroup->Gtk.ApplicationWindow Gio.ActionMap->Gtk.ApplicationWindow Gtk.Bin Gtk.Bin Gtk.Window Gtk.Window Gtk.Bin->Gtk.Window Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container Gtk.Window->Gtk.ApplicationWindow

Subclasses:None

Properties

Inherited:Gtk.Window (33), Gtk.Container (3), Gtk.Widget (39)
Name Type Flags Short Description
show-menubar bool r/w/c/en True if the window should show a menubar at the top of the window

Style Properties

Inherited:Gtk.Window (2), Gtk.Widget (17)

Fields

Inherited:Gtk.Window (5), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Gio.ActionGroup (4)
Name Type Access Description
parent_instance Gtk.Window r  

Class Details

class Gtk.ApplicationWindow(*args, **kwargs)
Bases:Gtk.Window, Gio.ActionGroup, Gio.ActionMap
Abstract:No
Structure:Gtk.ApplicationWindowClass

Gtk.ApplicationWindow is a Gtk.Window subclass that offers some extra functionality for better integration with Gtk.Application features. Notably, it can handle both the application menu as well as the menubar. See Gtk.Application.set_app_menu() and Gtk.Application.set_menubar().

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

Note that widgets that are placed inside a Gtk.ApplicationWindow can also activate these actions, if they implement the Gtk.Actionable interface.

As with Gtk.Application, the GDK lock will be acquired when processing actions arriving from other processes and should therefore be held when activating actions locally (if GDK threads are enabled).

The settings Gtk.Settings :gtk-shell-shows-app-menu and 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. gnome-shell (starting with version 3.4) will display the application menu, but not the menubar.

If the desktop environment does not display the menubar, then Gtk.ApplicationWindow will automatically show a Gtk.MenuBar for it. This behaviour can be overridden with the Gtk.ApplicationWindow :show-menubar property. If the desktop environment does not display the application menu, then it will automatically be included in the menubar or in the windows client-side decorations.

A Gtk.ApplicationWindow with a menubar
GtkApplication *app = gtk_application_new ("org.gtk.test", 0);

GtkBuilder *builder = gtk_builder_new_from_string (
    "<interface>"
    "  <menu id='menubar'>"
    "    <submenu label='_Edit'>"
    "      <item label='_Copy' action='win.copy'/>"
    "      <item label='_Paste' action='win.paste'/>"
    "    </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);
Handling fallback yourself

A simple example

The XML format understood by Gtk.Builder for Gio.MenuModel consists of a toplevel <menu> element, which contains one or more <item> elements. Each <item> element contains <attribute> and <link> elements with a mandatory name attribute. <link> elements have the same content model as <menu>. Instead of <link name="submenu> or <link name="section">, you can use <submenu> or <section> elements.

Attribute values can be translated using gettext, like other Gtk.Builder content. <attribute> elements can be marked for translation with a translatable="yes" attribute. It is also possible to specify message context and translator comments, using the context and comments attributes. To make use of this, the Gtk.Builder must have been given the gettext domain to use.

The following attributes are used when constructing menu items:

  • “label”: a user-visible string to display
  • “action”: the prefixed name of the action to trigger
  • “target”: the parameter to use when activating the action
  • “icon” and “verb-icon”: names of icons that may be displayed
  • “submenu-action”: name of an action that may be used to determine if a submenu can be opened
  • “hidden-when”: a string used to determine when the item will be hidden. Possible values include “action-disabled”, “action-missing”, “macos-menubar”.

The following attributes are used when constructing sections:

  • “label”: a user-visible string to use as section heading
  • “display-hint”: a string used to determine special formatting for the section. Possible values include “horizontal-buttons”.
  • “text-direction”: a string used to determine the Gtk.TextDirection to use when “display-hint” is set to “horizontal-buttons”. Possible values include “rtl”, “ltr”, and “none”.

The following attributes are used when constructing submenus:

  • “label”: a user-visible string to display
  • “icon”: icon name to display
classmethod new(application)[source]
Parameters:application (Gtk.Application) – a Gtk.Application
Returns:a newly created Gtk.ApplicationWindow
Return type:Gtk.Widget

Creates a new Gtk.ApplicationWindow.

New in version 3.4.

get_help_overlay()[source]
Returns:the help overlay associated with self, or None
Return type:Gtk.ShortcutsWindow or None

Gets the Gtk.ShortcutsWindow that has been set up with a prior call to Gtk.ApplicationWindow.set_help_overlay().

New in version 3.20.

get_id()[source]
Returns:the unique ID for self, or 0 if the window has not yet been added to a Gtk.Application
Return type:int

Returns the unique ID of the window. If the window has not yet been added to a Gtk.Application, returns 0.

New in version 3.6.

get_show_menubar()[source]
Returns:True if self 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.

New in version 3.4.

set_help_overlay(help_overlay)[source]
Parameters:help_overlay (Gtk.ShortcutsWindow or None) – a Gtk.ShortcutsWindow

Associates a shortcuts window with the application window, and sets up an action with the name win.show-help-overlay to present it.

self takes resposibility for destroying help_overlay.

New in version 3.20.

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.

New in version 3.4.

Property Details

Gtk.ApplicationWindow.props.show_menubar
Name:show-menubar
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

If this property is True, the window will display a menubar that includes the app menu and menubar, unless these are shown by the desktop shell. See Gtk.Application.set_app_menu() and Gtk.Application.set_menubar().

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