ApplicationWindowProtocol

public protocol ApplicationWindowProtocol : ActionGroupProtocol, ActionMapProtocol, WindowProtocol

GtkApplicationWindow is a GtkWindow subclass that offers some extra functionality for better integration with GtkApplication 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 GActionGroup and GActionMap interfaces, to let you add window-specific actions that will be exported by the associated GtkApplication, 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 GMenuModel.

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

As with GtkApplication, 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 GtkSettings:gtk-shell-shows-app-menu and GtkSettings: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 GtkApplicationWindow will automatically show a GtkMenuBar for it. This behaviour can be overridden with the GtkApplicationWindow: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 Language Example):

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 GtkBuilder for GMenuModel consists of a toplevel &lt;menu&gt; element, which contains one or more &lt;item&gt; elements. Each &lt;item&gt; element contains &lt;attribute&gt; and &lt;link&gt; elements with a mandatory name attribute. &lt;link&gt; elements have the same content model as &lt;menu&gt;. Instead of &lt;link name="submenu&gt; or &lt;link name="section"&gt;, you can use &lt;submenu&gt; or &lt;section&gt; elements.

Attribute values can be translated using gettext, like other GtkBuilder content. &lt;attribute&gt; 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 GtkBuilder 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 GtkTextDirection 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

The ApplicationWindowProtocol protocol exposes the methods and properties of an underlying GtkApplicationWindow instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ApplicationWindow. Alternatively, use ApplicationWindowRef as a lighweight, unowned reference if you already have an instance you just want to use.

  • ptr

    Untyped pointer to the underlying GtkApplicationWindow instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • application_window_ptr Default implementation

    Typed pointer to the underlying GtkApplicationWindow instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkApplicationWindow instance.

    Declaration

    Swift

    var application_window_ptr: UnsafeMutablePointer<GtkApplicationWindow>! { get }
  • Required Initialiser for types conforming to ApplicationWindowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

ApplicationWindow Class

  • Bind a ApplicationWindowPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
    @inlinable
    func bind<Q, T>(property source_property: ApplicationWindowPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind

    target

    the target object to bind to

    target_property

    the target property to bind to

    flags

    the flags to pass to the Binding

    transform_from

    ValueTransformer to use for forward transformation

    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

  • get(property:) Extension method

    Get the value of a ApplicationWindow property

    Declaration

    Swift

    @inlinable
    func get(property: ApplicationWindowPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

    Set the value of a ApplicationWindow property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
    func set(property: ApplicationWindowPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

ApplicationWindow Class: ApplicationWindowProtocol extension (methods and fields)

  • getHelpOverlay() Extension method

    Gets the GtkShortcutsWindow that has been set up with a prior call to gtk_application_window_set_help_overlay().

    Declaration

    Swift

    @inlinable
    func getHelpOverlay() -> ShortcutsWindowRef!
  • getID() Extension method

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

    Declaration

    Swift

    @inlinable
    func getID() -> Int
  • getShowMenubar() Extension method

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

    Declaration

    Swift

    @inlinable
    func getShowMenubar() -> Bool
  • set(helpOverlay:) Extension method

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

    Declaration

    Swift

    @inlinable
    func set(helpOverlay: ShortcutsWindowRef? = nil)
  • set(helpOverlay:) Extension method

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

    Declaration

    Swift

    @inlinable
    func set<ShortcutsWindowT>(helpOverlay: ShortcutsWindowT?) where ShortcutsWindowT : ShortcutsWindowProtocol
  • set(showMenubar:) Extension method

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

    Declaration

    Swift

    @inlinable
    func set(showMenubar: Bool)
  • helpOverlay Extension method

    Gets the GtkShortcutsWindow that has been set up with a prior call to gtk_application_window_set_help_overlay().

    Declaration

    Swift

    @inlinable
    var helpOverlay: ShortcutsWindowRef! { get nonmutating set }
  • id Extension method

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

    Declaration

    Swift

    @inlinable
    var id: Int { get }
  • showMenubar Extension method

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

    Declaration

    Swift

    @inlinable
    var showMenubar: Bool { get nonmutating set }
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var parentInstance: GtkWindow { get }