ApplicationWindow

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 [class@Gtk.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 [iface@Gtk.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 GtkApplicationWindow 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 [class@Gtk.PopoverMenu] for information about the XML language used by GtkBuilder for menu models.

See also: [method@Gtk.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 [class@Gtk.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);

class ApplicationWindow : Window , ActionGroupIF , ActionMapIF {

protected

GtkApplicationWindow* gtkApplicationWindow;

GtkApplicationWindow* getApplicationWindowStruct(bool transferOwnership);

void* getStruct();

this(GtkApplicationWindow* gtkApplicationWindow, bool ownedRef);

mixin ActionGroupT!(GtkApplicationWindow) ;

mixin ActionMapT!(GtkApplicationWindow) ;

static GType getType();

this(Application application);

ShortcutsWindow getHelpOverlay();

uint getId();

bool getShowMenubar();

void setHelpOverlay(ShortcutsWindow helpOverlay);

void setShowMenubar(bool showMenubar);

}

Constructors

this this(GtkApplicationWindow* gtkApplicationWindow, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(Application application): Creates a new GtkApplicationWindow.

Members

Functions

getApplicationWindowStruct GtkApplicationWindow* getApplicationWindowStruct(bool transferOwnership): Get the main Gtk struct
getHelpOverlay ShortcutsWindow getHelpOverlay(): Gets the GtkShortcutsWindow that is associated with @window.
getId uint getId(): Returns the unique ID of the window.
getShowMenubar bool getShowMenubar(): Returns whether the window will display a menubar for the app menu and menubar as needed.
getStruct void* getStruct(): the main Gtk struct as a void*
setHelpOverlay void setHelpOverlay(ShortcutsWindow helpOverlay): Associates a shortcuts window with the application window.
setShowMenubar void setShowMenubar(bool showMenubar): Sets whether the window will display a menubar for the app menu and menubar as needed.

Mixins

__anonymous mixin ActionGroupT!(GtkApplicationWindow): Undocumented in source.
__anonymous mixin ActionMapT!(GtkApplicationWindow): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkApplicationWindow GtkApplicationWindow* gtkApplicationWindow;: the main Gtk struct

Inherited Members

From Window

gtkWindow GtkWindow* gtkWindow;: the main Gtk struct
getWindowStruct GtkWindow* getWindowStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin NativeT!(GtkWindow): Undocumented in source.
__anonymous mixin RootT!(GtkWindow): Undocumented in source.
__anonymous mixin ShortcutManagerT!(GtkWindow): Undocumented in source.
getType GType getType()
getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows.
getToplevels ListModelIF getToplevels(): Returns a list of all existing toplevel windows.
listToplevels ListG listToplevels(): Returns a list of all existing toplevel windows.
setAutoStartupNotification void setAutoStartupNotification(bool setting): Sets whether the window should request startup notification.
setDefaultIconName void setDefaultIconName(string name): Sets an icon to be used as fallback.
setInteractiveDebugging void setInteractiveDebugging(bool enable): Opens or closes the interactive debugger.
close void close(): Requests that the window is closed.
destroy void destroy(): Drop the internal reference GTK holds on toplevel windows.
fullscreen void fullscreen(): Asks to place @window in the fullscreen state.
fullscreenOnMonitor void fullscreenOnMonitor(MonitorGdk monitor): Asks to place @window in the fullscreen state on the given @monitor.
getApplication Application getApplication(): Gets the GtkApplication associated with the window.
getChild Widget getChild(): Gets the child widget of @window.
getDecorated bool getDecorated(): Returns whether the window has been set to have decorations.
getDefaultSize void getDefaultSize(int width, int height): Gets the default size of the window.
getDefaultWidget Widget getDefaultWidget(): Returns the default widget for @window.
getDeletable bool getDeletable(): Returns whether the window has been set to have a close button.
getDestroyWithParent bool getDestroyWithParent(): Returns whether the window will be destroyed with its transient parent.
getFocus Widget getFocus(): Retrieves the current focused widget within the window.
getFocusVisible bool getFocusVisible(): Gets whether “focus rectangles” are supposed to be visible.
getGroup WindowGroup getGroup(): Returns the group for @window.
getHandleMenubarAccel bool getHandleMenubarAccel(): Returns whether this window reacts to F10 key presses by activating a menubar it contains.
getHideOnClose bool getHideOnClose(): Returns whether the window will be hidden when the close button is clicked.
getIconName string getIconName(): Returns the name of the themed icon for the window.
getMnemonicsVisible bool getMnemonicsVisible(): Gets whether mnemonics are supposed to be visible.
getModal bool getModal(): Returns whether the window is modal.
getResizable bool getResizable(): Gets the value set by gtk_window_set_resizable().
getTitle string getTitle(): Retrieves the title of the window.
getTitlebar Widget getTitlebar(): Returns the custom titlebar that has been set with gtk_window_set_titlebar().
getTransientFor Window getTransientFor(): Fetches the transient parent for this window.
hasGroup bool hasGroup(): Returns whether @window has an explicit window group.
isActive bool isActive(): Returns whether the window is part of the current active toplevel.
isFullscreen bool isFullscreen(): Retrieves the current fullscreen state of @window.
isMaximized bool isMaximized(): Retrieves the current maximized state of @window.
maximize void maximize(): Asks to maximize @window, so that it fills the screen.
minimize void minimize(): Asks to minimize the specified @window.
present void present(): Presents a window to the user.
presentWithTime void presentWithTime(uint timestamp): Presents a window to the user.
setApplication void setApplication(Application application): Sets or unsets the GtkApplication associated with the window.
setChild void setChild(Widget child): Sets the child widget of @window.
setDecorated void setDecorated(bool setting): Sets whether the window should be decorated.
setDefaultSize void setDefaultSize(int width, int height): Sets the default size of a window.
setDefaultWidget void setDefaultWidget(Widget defaultWidget): Sets the default widget.
setDeletable void setDeletable(bool setting): Sets whether the window should be deletable.
setDestroyWithParent void setDestroyWithParent(bool setting): If @setting is %TRUE, then destroying the transient parent of @window will also destroy @window itself.
setDisplay void setDisplay(Display display): Sets the GdkDisplay where the @window is displayed.
setFocus void setFocus(Widget focus): Sets the focus widget.
setFocusVisible void setFocusVisible(bool setting): Sets whether “focus rectangles” are supposed to be visible.
setHandleMenubarAccel void setHandleMenubarAccel(bool handleMenubarAccel): Sets whether this window should react to F10 key presses by activating a menubar it contains.
setHideOnClose void setHideOnClose(bool setting): If @setting is %TRUE, then clicking the close button on the window will not destroy it, but only hide it.
setIconName void setIconName(string name): Sets the icon for the window from a named themed icon.
setMnemonicsVisible void setMnemonicsVisible(bool setting): Sets whether mnemonics are supposed to be visible.
setModal void setModal(bool modal): Sets a window modal or non-modal.
setResizable void setResizable(bool resizable): Sets whether the user can resize a window.
setStartupId void setStartupId(string startupId): Sets the startup notification ID.
setTitle void setTitle(string title): Sets the title of the GtkWindow.
setTitlebar void setTitlebar(Widget titlebar): Sets a custom titlebar for @window.
setTransientFor void setTransientFor(Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. [ctor@Gtk.Dialog.new_with_buttons] and other convenience functions in GTK will sometimes call gtk_window_set_transient_for() on your behalf.
unfullscreen void unfullscreen(): Asks to remove the fullscreen state for @window, and return to its previous state.
unmaximize void unmaximize(): Asks to unmaximize @window.
unminimize void unminimize(): Asks to unminimize the specified @window.
addOnActivateDefault gulong addOnActivateDefault(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the default widget of @window.
addOnActivateFocus gulong addOnActivateFocus(void delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user activates the currently focused widget of @window.
addOnCloseRequest gulong addOnCloseRequest(bool delegate(Window) dlg, ConnectFlags connectFlags): Emitted when the user clicks on the close button of the window.
addOnEnableDebugging gulong addOnEnableDebugging(bool delegate(bool, Window) dlg, ConnectFlags connectFlags): Emitted when the user enables or disables interactive debugging.
addOnKeysChanged gulong addOnKeysChanged(void delegate(Window) dlg, ConnectFlags connectFlags): emitted when the set of accelerators or mnemonics that are associated with @window changes.

From ActionGroupIF

getActionGroupStruct GActionGroup* getActionGroupStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
actionAdded void actionAdded(string actionName): Emits the #GActionGroup::action-added signal on @action_group.
actionEnabledChanged void actionEnabledChanged(string actionName, bool enabled): Emits the #GActionGroup::action-enabled-changed signal on @action_group.
actionRemoved void actionRemoved(string actionName): Emits the #GActionGroup::action-removed signal on @action_group.
actionStateChanged void actionStateChanged(string actionName, Variant state): Emits the #GActionGroup::action-state-changed signal on @action_group.
activateAction void activateAction(string actionName, Variant parameter): Activate the named action within @action_group.
changeActionState void changeActionState(string actionName, Variant value): Request for the state of the named action within @action_group to be changed to @value.
getActionEnabled bool getActionEnabled(string actionName): Checks if the named action within @action_group is currently enabled.
getActionParameterType VariantType getActionParameterType(string actionName): Queries the type of the parameter that must be given when activating the named action within @action_group.
getActionState Variant getActionState(string actionName): Queries the current state of the named action within @action_group.
getActionStateHint Variant getActionStateHint(string actionName): Requests a hint about the valid range of values for the state of the named action within @action_group.
getActionStateType VariantType getActionStateType(string actionName): Queries the type of the state of the named action within @action_group.
hasAction bool hasAction(string actionName): Checks if the named action exists within @action_group.
listActions string[] listActions(): Lists the actions contained within @action_group.
queryAction bool queryAction(string actionName, bool enabled, VariantType parameterType, VariantType stateType, Variant stateHint, Variant state): Queries all aspects of the named action within an @action_group.
addOnActionAdded gulong addOnActionAdded(void delegate(string, ActionGroupIF) dlg, ConnectFlags connectFlags): Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.
addOnActionEnabledChanged gulong addOnActionEnabledChanged(void delegate(string, bool, ActionGroupIF) dlg, ConnectFlags connectFlags): Signals that the enabled status of the named action has changed.
addOnActionRemoved gulong addOnActionRemoved(void delegate(string, ActionGroupIF) dlg, ConnectFlags connectFlags): Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.
addOnActionStateChanged gulong addOnActionStateChanged(void delegate(string, Variant, ActionGroupIF) dlg, ConnectFlags connectFlags): Signals that the state of the named action has changed.

From ActionMapIF

getActionMapStruct GActionMap* getActionMapStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
addAction void addAction(ActionIF action): Adds an action to the @action_map.
addActionEntries void addActionEntries(GActionEntry[] entries, void* userData): A convenience function for creating multiple #GSimpleAction instances and adding them to a #GActionMap.
lookupAction ActionIF lookupAction(string actionName): Looks up the action with the name @action_name in @action_map.
removeAction void removeAction(string actionName): Removes the named action from the action map.