ApplicationWindowProtocol

public protocol ApplicationWindowProtocol : ActionGroupProtocol, ActionMapProtocol, WindowProtocol

GtkApplicationWindow is a GtkWindow subclass that integrates with GtkApplication.

Notably, GtkApplicationWindow can handle an application menubar.

This class implements the GActionGroup and GActionMap interfaces, to let you add window-specific actions that will be exported by the associated [classGtk.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 GMenuModel.

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

The settings [propertyGtk.Settings:gtk-shell-shows-app-menu] and [propertyGtk.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.

If the desktop environment does not display the menubar, then GtkApplicationWindow will automatically show a menubar for it. This behaviour can be overridden with the [propertyGtk.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.

See [classGtk.PopoverMenu] for information about the XML language used by GtkBuilder for menu models.

See also: [methodGtk.Application.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 [classGtk.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);

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.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkApplicationWindow instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • 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 }
    Show on GitHub

  • Required Initialiser for types conforming to ApplicationWindowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

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

    Show on GitHub
  • 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

    Show on GitHub
  • 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

    Show on GitHub

ApplicationWindow Class: ApplicationWindowProtocol extension (methods and fields)

  • getHelpOverlay() Extension method

    Gets the GtkShortcutsWindow that is associated with window.

    See [methodGtk.ApplicationWindow.set_help_overlay].

    Declaration

    Swift

    @inlinable
func getHelpOverlay() -> ShortcutsWindowRef!
    Show on GitHub
  • 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
    Show on GitHub
  • 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
    Show on GitHub
  • set(helpOverlay:) Extension method

    Associates a shortcuts window with the application window.

    Additionally, sets up an action with the name win.show-help-overlay to present it.

    window takes responsibility for destroying help_overlay.

    Declaration

    Swift

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

    Associates a shortcuts window with the application window.

    Additionally, sets up an action with the name win.show-help-overlay to present it.

    window takes responsibility for destroying help_overlay.

    Declaration

    Swift

    @inlinable
func set<ShortcutsWindowT>(helpOverlay: ShortcutsWindowT?) where ShortcutsWindowT : ShortcutsWindowProtocol
    Show on GitHub
  • 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)
    Show on GitHub
  • helpOverlay Extension method

    Gets the GtkShortcutsWindow that is associated with window.

    See [methodGtk.ApplicationWindow.set_help_overlay].

    Declaration

    Swift

    @inlinable
var helpOverlay: ShortcutsWindowRef! { get nonmutating set }
    Show on GitHub
  • 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 }
    Show on GitHub
  • 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 }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkWindow { get }
    Show on GitHub