gtk-window, gtk-bin, gtk-container, gtk-widget, gtk-buildable, g-action-group, g-action-map, g-object, common-lisp:standard-object, common-lisp:t

None

The gtk-application-window class 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 the gtk-application-app-menu and gtk-application-menubar functions.

This class implements the g-action-group and g-action-map interfaces, to let you add window specific actions that will be exported by the associated gtk-application instance, 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 g-menu-model object.

Note that widgets that are placed inside an application window can also activate these actions, if they implement the gtk-actionable interface.

As with the gtk-application class, 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 gtk-shell-shows-app-menu and gtk-shell-shows-menubar settings 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 the application window will automatically show a gtk-menu-bar widget for it. This behaviour can be overridden with the show-menubar property. If the desktop environment does not display the application menu, then it will automatically be included in the menubar.

Example: An application window with a menubar

 ;; Intitialize the menubar
 (let ((builder (make-instance 'gtk-builder)))
   ;; Read the menus from a string
   (gtk-builder-add-from-string
       builder
       (format nil
               "<interface> ~
                   <menu id='menubar'> ~
                     <submenu label='_Edit'> ~
                       <item label='_Copy' action='win.copy'/> ~
                       <item label='_Paste' action='win.paste'/> ~
                     </submenu> ~
                   </menu> ~
                 </interface>"))
   ;; Set the menubar
   (setf (gtk-application-menubar application)
         (gtk-builder-object builder "menubar"))
   ... )  

Handling fallback yourself

The XML format understood by the gtk-builder class for a g-menu-model object 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 GNU 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 object must have been given the GNU 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-text-direction value 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