gtk.application

Module for Application class

class Application ApplicationGidBuilder ApplicationGidBuilderImpl

Types 3

classApplication : gio.application.Application

gtk.application.Application is a high-level API for writing applications.

It supports many aspects of writing a GTK application in a convenient fashion, without enforcing a one-size-fits-all model.

Currently, gtk.application.Application 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 gtk.application.Application works fine with plain gtk.window.Windows, it is recommended to use it together with gtk.application_window.ApplicationWindow.

Automatic resources

gtk.application.Application will automatically load menus from the gtk.builder.Builder resource located at "gtk/menus.ui", relative to the application's resource base path (see gio.application.Application.setResourceBasePath). 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.

Note that automatic resource loading uses the resource base path that is set at construction time and will not work if the resource base path is changed at a later time.

It is also possible to provide the menubar manually using gtk.application.Application.setMenubar.

gtk.application.Application 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 gtk.shortcuts_window.ShortcutsWindow with ID help_overlay then gtk.application.Application associates an instance of this shortcuts window with each gtk.application_window.ApplicationWindow and sets up the keyboard accelerator <kbd>Control</kbd>+<kbd>?</kbd> 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

A simple example is available in the GTK source code repository

gtk.application.Application optionally registers with a session manager of the users session (if you set the gtk.application.Application.registerSession 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

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() @propertyGet `activeWindow` property. Returns: The currently focused window of the application.
gio.menu_model.MenuModel menubar() @propertyGet `menubar` property. Returns: The [gio.menu_model.MenuModel] to be used for the application's menu bar.
void menubar(gio.menu_model.MenuModel propval) @propertySet `menubar` property. Params: propval = The [gio.menu_model.MenuModel] to be used for the application's menu bar.
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.
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.
gtk.window.Window getActiveWindow()Gets the “active” window for the application.
gio.menu.Menu getMenuById(string id)Gets a menu from automatically loaded resources.
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 [gtk.application_window.ApplicationWindow] with the given ID.
gtk.window.Window[] getWindows()Gets a list of the [gtk.window.Window] instances 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.
string[] listActionDescriptions()Lists the detailed action names which have associated accelerators.
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.
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 previously established.
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 [gtk.application.Application] instance.
classApplicationGidBuilderImpl(T) : gio.application.ApplicationGidBuilderImpl!T

Fluent builder implementation template for gtk.application.Application

Methods
T menubar(gio.menu_model.MenuModel propval)Set `menubar` property. Params: propval = The [gio.menu_model.MenuModel] to be used for the application's menu bar. Returns: Builder instance for fluent chaining
T registerSession(bool propval)Set `registerSession` property. Params: propval = Set this property to `TRUE` to register with the session manager.
classApplicationGidBuilder : ApplicationGidBuilderImpl!ApplicationGidBuilder

Fluent builder for gtk.application.Application

Methods
Application build()Create object from builder. Returns: New object