Creates a new gtk.application.Application instance.
Adds a window to application.
Connect to QueryEnd signal.
Connect to WindowAdded signal.
Connect to WindowRemoved signal.
Gets the accelerators that are currently associated with the given action.
Returns the list of actions (possibly empty) that accel maps to.
Gets the “active” window for the application.
Gets a menu from automatically loaded resources.
Returns the menu model that has been set with gtk.application.Application.setMenubar.
Returns the gtk.application_window.ApplicationWindow with the given ID.
Gets a list of the gtk.window.Window instances associated with application.
Inform the session manager that certain types of actions should be inhibited.
Lists the detailed action names which have associated accelerators.
Remove a window from application.
Sets zero or more keyboard accelerators that will trigger the given action.
Sets or unsets the menubar for windows of application.
Removes an inhibitor that has been previously established.
Returns the default #GApplication instance for this process.
Checks if application_id is a valid application identifier.
Activates the application.
Add an option to be handled by application.
Adds main option entries to be handled by application.
Adds a #GOptionGroup to the commandline handling of application.
Marks application as busy (see gio.application.Application.markBusy) while property on object is true.
Gets the unique identifier for application.
Gets the #GDBusConnection being used by the application, or null.
Gets the D-Bus object path being used by the application, or null.
Gets the flags for application.
Gets the current inactivity timeout for the application.
Gets the application's current busy state, as set through gio.application.Application.markBusy or gio.application.Application.bindBusyProperty.
Checks if application is registered.
Checks if application is remote.
Gets the resource base path of application.
Gets the version of application.
Increases the use count of application.
Increases the busy count of application.
Opens the given files.
Immediately quits the application.
Attempts registration of the application.
Decrease the use count of application.
Runs the application.
Sends a notification on behalf of application to the desktop shell. There is no guarantee that the notification is displayed immediately, or even at all.
This used to be how actions were associated with a #GApplication. Now there is #GActionMap for that.
Sets the unique identifier for application.
Sets or unsets the default application for the process, as returned by gio.application.Application.getDefault.
Sets the flags for application.
Sets the current inactivity timeout for the application.
Adds a description to the application option context.
Sets the parameter string to be used by the commandline handling of application.
Adds a summary to the application option context.
Sets (or unsets) the base resource path of application.
Sets the version number of application. This will be used to implement a --version command line argument
Destroys a binding between property and the busy state of application that was previously created with gio.application.Application.bindBusyProperty.
Decreases the busy count of application.
Withdraws a notification that was sent with gio.application.Application.sendNotification.
Connect to Activate signal.
Connect to CommandLine signal.
Connect to HandleLocalOptions signal.
Connect to NameLost signal.
Connect to Open signal.
Connect to Shutdown signal.
Connect to Startup signal.
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 property@Gtk.Application: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
HowDoI: Using GtkApplication, Getting Started with GTK: Basics