GI.Gtk.Objects.ApplicationWindow

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

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

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

As with 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 Settings:gtk-shell-shows-app-menu and 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 ApplicationWindow will automatically show a MenuBar for it. This behaviour can be overridden with the 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 GtkApplicationWindow with a menubar

C code

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 Builder for 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 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 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 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

Exported types

newtype ApplicationWindow

Memory-managed wrapper type.

Constructors

ApplicationWindow (ManagedPtr ApplicationWindow)

Instances

Eq ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

(==) :: ApplicationWindow -> ApplicationWindow -> Bool

(/=) :: ApplicationWindow -> ApplicationWindow -> Bool

IsGValue ApplicationWindow

Convert ApplicationWindow to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

toGValue :: ApplicationWindow -> IO GValue

fromGValue :: GValue -> IO ApplicationWindow

GObject ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

gobjectType :: IO GType

HasParentTypes ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

type ParentTypes ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

type ParentTypes ApplicationWindow = '[Window, Bin, Container, Widget, Object, ImplementorIface, ActionGroup, ActionMap, Buildable, Root]

class (GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o

Type class for types which can be safely cast to ApplicationWindow, for instance with toApplicationWindow.

Instances

(GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o

Defined in GI.Gtk.Objects.ApplicationWindow

toApplicationWindow :: (MonadIO m, IsApplicationWindow o) => o -> m ApplicationWindow

Cast to ApplicationWindow, for types for which this is known to be safe. For general casts, use castTo.

noApplicationWindow :: Maybe ApplicationWindow

A convenience alias for Nothing :: Maybe ApplicationWindow.

Methods

Overloaded methods

getHelpOverlay

applicationWindowGetHelpOverlay

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a ApplicationWindow

-> m (Maybe ShortcutsWindow)

Returns: the help overlay associated with window, or Nothing

Gets the ShortcutsWindow that has been set up with a prior call to applicationWindowSetHelpOverlay.

getId

applicationWindowGetId

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a ApplicationWindow

-> m Word32

Returns: the unique ID for window, or 0 if the window has not yet been added to a Application

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

getShowMenubar

applicationWindowGetShowMenubar

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a ApplicationWindow

-> m Bool

Returns: True if window will display a menubar when needed

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

new

applicationWindowNew

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)

=> a

application: a Application

-> m ApplicationWindow

Returns: a newly created ApplicationWindow

Creates a new ApplicationWindow.

setHelpOverlay

applicationWindowSetHelpOverlay

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b)

=> a

window: a ApplicationWindow

-> Maybe b

helpOverlay: a ShortcutsWindow

-> m ()

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

window takes resposibility for destroying helpOverlay.

setShowMenubar

applicationWindowSetShowMenubar

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a ApplicationWindow

-> Bool

showMenubar: whether to show a menubar when needed

-> m ()

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

Properties

showMenubar

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 applicationSetAppMenu and applicationSetMenubar.

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

constructApplicationWindowShowMenubar :: IsApplicationWindow o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-menubar” property. This is rarely needed directly, but it is used by new.

getApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> m Bool

Get the value of the “show-menubar” property. When overloading is enabled, this is equivalent to

get applicationWindow #showMenubar

setApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> Bool -> m ()

Set the value of the “show-menubar” property. When overloading is enabled, this is equivalent to

set applicationWindow [ #showMenubar := value ]