gtk.application_window

Module for [ApplicationWindow] class

class ApplicationWindow ApplicationWindowGidBuilder ApplicationWindowGidBuilderImpl

Types 3

classApplicationWindow : gtk.window.Window, gio.action_group.ActionGroup, gio.action_map.ActionMap

[gtk.application_window.ApplicationWindow] is a [gtk.window.Window] subclass that integrates with [gtk.application.Application].

Notably, [gtk.application_window.ApplicationWindow] can handle an application menubar.

This class implements the [gio.action_group.ActionGroup] and [gio.action_map.ActionMap] interfaces, to let you add window-specific actions that will be exported by the associated [gtk.application.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.menu_model.MenuModel].

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

The settings property@Gtk.Settings:gtk-shell-shows-app-menu and property@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.

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

See [gtk.popover_menu.PopoverMenu] for information about the XML language used by [gtk.builder.Builder] for menu models.

See also: [gtk.application.Application.setMenubar].

A GtkApplicationWindow with a menubar

The code sample below shows how to set up a [gtk.application_window.ApplicationWindow] with a menu bar defined on the [gtk.application.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);

Methods

GType _getGType()

GType _gType() @property

ApplicationWindow self()Returns `this`, for use in `with` statements.

ApplicationWindowGidBuilder builder()Get builder for [gtk.application_window.ApplicationWindow] Returns: New builder object

bool showMenubar() @propertyGet `showMenubar` property. Returns: If this property is true, the window will display a menubar unless it is shown by the desktop shell.

void showMenubar(bool propval) @propertySet `showMenubar` property. Params: propval = If this property is true, the window will display a menubar unless it is shown by the desktop shell.

gtk.shortcuts_window.ShortcutsWindow getHelpOverlay()Gets the [gtk.shortcuts_window.ShortcutsWindow] that is associated with window.

uint getId()Returns the unique ID of the window.

bool getShowMenubar()Returns whether the window will display a menubar for the app menu and menubar as needed. Returns: true if window will display a menubar when needed

void setHelpOverlay(gtk.shortcuts_window.ShortcutsWindow helpOverlay = null)Associates a shortcuts window with the application window.

void setShowMenubar(bool showMenubar)Sets whether the window will display a menubar for the app menu and menubar as needed.

Constructors

this(void * ptr, Flag!"Take" take)

this(gtk.application.Application application)Creates a new [gtk.application_window.ApplicationWindow].

classApplicationWindowGidBuilderImpl(T) : gtk.window.WindowGidBuilderImpl!T, gio.action_group.ActionGroupGidBuilderImpl!T, gio.action_map.ActionMapGidBuilderImpl!T

Methods

T showMenubar(bool propval)Set `showMenubar` property. Params: propval = If this property is true, the window will display a menubar unless it is shown by the desktop shell.

classApplicationWindowGidBuilder : ApplicationWindowGidBuilderImpl!ApplicationWindowGidBuilder

Fluent builder for [gtk.application_window.ApplicationWindow]

Methods

ApplicationWindow build()