gtk.application

Module for [Application] class

class Application ApplicationGidBuilder ApplicationGidBuilderImpl

Types 3

classApplication : gio.application.Application

#GtkApplication is a class that handles many important aspects of a GTK+ application in a convenient fashion, without enforcing a one-size-fits-all application model.

Currently, GtkApplication handles GTK+ initialization, application uniqueness, session management, provides some basic scriptability and desktop shell integration by exporting actions and menus and manages a list of toplevel windows whose life-cycle is automatically tied to the life-cycle of your application.

While GtkApplication works fine with plain #GtkWindows, it is recommended to use it together with #GtkApplicationWindow.

When GDK threads are enabled, GtkApplication will acquire the GDK lock when invoking actions that arrive from other processes. The GDK lock is not touched for local action invocations. In order to have actions invoked in a predictable context it is therefore recommended that the GDK lock be held while invoking actions locally with [gio.action_group.ActionGroup.activateAction]. The same applies to actions associated with #GtkApplicationWindow and to the “activate” and “open” #GApplication methods.

Automatic resources ## {#automatic-resources}

#GtkApplication will automatically load menus from the #GtkBuilder resource located at "gtk/menus.ui", relative to the application's resource base path (see [gio.application.Application.setResourceBasePath]). The menu with the ID "app-menu" is taken as the application's app menu and the menu with the ID "menubar" is taken as the application's menubar. Additional menus (most interesting submenus) can be named and accessed via [gtk.application.Application.getMenuById] which allows for dynamic population of a part of the menu structure.

If the resources "gtk/menus-appmenu.ui" or "gtk/menus-traditional.ui" are present then these files will be used in preference, depending on the value of [gtk.application.Application.prefersAppMenu]. If the resource "gtk/menus-common.ui" is present it will be loaded as well. This is useful for storing items that are referenced from both "gtk/menus-appmenu.ui" and "gtk/menus-traditional.ui".

It is also possible to provide the menus manually using [gtk.application.Application.setAppMenu] and [gtk.application.Application.setMenubar].

#GtkApplication will also automatically setup an icon search path for the default icon theme by appending "icons" to the resource base path. This allows your application to easily store its icons as resources. See [gtk.icon_theme.IconTheme.addResourcePath] for more information.

If there is a resource located at "gtk/help-overlay.ui" which defines a #GtkShortcutsWindow with ID "help_overlay" then GtkApplication associates an instance of this shortcuts window with each #GtkApplicationWindow and sets up keyboard accelerators (Control-F1 and Control-?) to open it. To create a menu item that displays the shortcuts window, associate the item with the action win.show-help-overlay.

A simple application ## {#gtkapplication}

A simple example

GtkApplication optionally registers with a session manager of the users session (if you set the #GtkApplication:register-session property) and offers various functionality related to the session life-cycle.

An application can block various ways to end the session with the [gtk.application.Application.inhibit] function. Typical use cases for this kind of inhibiting are long-running, uninterruptible operations, such as burning a CD or performing a disk backup. The session manager may not honor the inhibitor, but it can be expected to inform the user about the negative consequences of ending the session while inhibitors are present.

See Also ## {#seealso}

HowDoI: Using GtkApplication, Getting Started with GTK+: Basics

Methods

GType _getGType()

GType _gType() @property

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

ApplicationGidBuilder builder()Get builder for [gtk.application.Application] Returns: New builder object

gtk.window.Window activeWindow() @property

gio.menu_model.MenuModel appMenu() @property

void appMenu(gio.menu_model.MenuModel propval) @property

gio.menu_model.MenuModel menubar() @property

void menubar(gio.menu_model.MenuModel propval) @property

bool registerSession() @propertyGet `registerSession` property. Returns: Set this property to true to register with the session manager.

void registerSession(bool propval) @propertySet `registerSession` property. Params: propval = Set this property to true to register with the session manager.

bool screensaverActive() @propertyGet `screensaverActive` property. Returns: This property is true if GTK+ believes that the screensaver is currently active. GTK+ only tracks session state (including this) when #GtkApplication::reg...

void addAccelerator(string accelerator, string actionName, glib.variant.Variant parameter = null)Installs an accelerator that will cause the named action to be activated when the key combination specificed by accelerator is pressed.

void addWindow(gtk.window.Window window)Adds a window to application.

string[] getAccelsForAction(string detailedActionName)Gets the accelerators that are currently associated with the given action.

string[] getActionsForAccel(string accel)Returns the list of actions (possibly empty) that accel maps to. Each item in the list is a detailed action name in the usual form.

gtk.window.Window getActiveWindow()Gets the “active” window for the application.

gio.menu_model.MenuModel getAppMenu()Returns the menu model that has been set with [gtk.application.Application.setAppMenu]. Returns: the application menu of application or null if no application menu has been set.

gio.menu.Menu getMenuById(string id)Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information.

gio.menu_model.MenuModel getMenubar()Returns the menu model that has been set with [gtk.application.Application.setMenubar]. Returns: the menubar for windows of application

gtk.window.Window getWindowById(uint id)Returns the #GtkApplicationWindow with the given ID.

gtk.window.Window[] getWindows()Gets a list of the #GtkWindows associated with application.

uint inhibit(gtk.window.Window window, gtk.types.ApplicationInhibitFlags flags, string reason = null)Inform the session manager that certain types of actions should be inhibited. This is not guaranteed to work on all platforms and for all types of actions.

bool isInhibited(gtk.types.ApplicationInhibitFlags flags)Determines if any of the actions specified in flags are currently inhibited (possibly by another application).

string[] listActionDescriptions()Lists the detailed action names which have associated accelerators. See [gtk.application.Application.setAccelsForAction]. Returns: a null-terminated array of strings, free with [glib.global.strfree...

bool prefersAppMenu()Determines if the desktop environment in which the application is running would prefer an application menu be shown.

void removeAccelerator(string actionName, glib.variant.Variant parameter = null)Removes an accelerator that has been previously added with [gtk.application.Application.addAccelerator].

void removeWindow(gtk.window.Window window)Remove a window from application.

void setAccelsForAction(string detailedActionName, string[] accels)Sets zero or more keyboard accelerators that will trigger the given action. The first item in accels will be the primary accelerator, which may be displayed in the UI.

void setAppMenu(gio.menu_model.MenuModel appMenu = null)Sets or unsets the application menu for application.

void setMenubar(gio.menu_model.MenuModel menubar = null)Sets or unsets the menubar for windows of application.

void uninhibit(uint cookie)Removes an inhibitor that has been established with [gtk.application.Application.inhibit]. Inhibitors are also cleared when the application exits.

gulong connectQueryEnd(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.application.Application)))
   &&  Parameters!T.length <  2)

Connect to `QueryEnd` signal.

gulong connectWindowAdded(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.window.Window)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.application.Application)))
   &&  Parameters!T.length <  3)

Connect to `WindowAdded` signal.

gulong connectWindowRemoved(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.window.Window)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.application.Application)))
   &&  Parameters!T.length <  3)

Connect to `WindowRemoved` signal.

Constructors

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

this(string applicationId, gio.types.ApplicationFlags flags)Creates a new #GtkApplication instance.

classApplicationGidBuilderImpl(T) : gio.application.ApplicationGidBuilderImpl!T

Methods

T appMenu(gio.menu_model.MenuModel propval)

T menubar(gio.menu_model.MenuModel propval)

T registerSession(bool propval)Set `registerSession` property. Params: propval = Set this property to true to register with the session manager. Returns: Builder instance for fluent chaining

classApplicationGidBuilder : ApplicationGidBuilderImpl!ApplicationGidBuilder

Fluent builder for [gtk.application.Application]

Methods

Application build()