gtk.Application 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.
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 Action.groupActivateAction. The same applies to actions associated with gtk.ApplicationWindow and to the “activate” and “open” gtk.Application methods.
gtk.Application will automatically load menus from the gtk.Builder resource located at "gtk/menus.ui", relative to the application's resource base path (see 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 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 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".
gtk.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 IconTheme.addResourcePath for more information.
If there is a resource located at "gtk/help-overlay.ui" which defines a gtk.ShortcutsWindow with ID "help_overlay" then GtkApplication associates an instance of this shortcuts window with each gtk.ApplicationWindow 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.
GtkApplication optionally registers with a session manager of the users session (if you set the 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 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.
Sets our main struct and passes it to the parent class.
Creates a new gtk.Application instance.
Installs an accelerator that will cause the named action to be activated when the key combination specificed by accelerator is pressed.
Adds a window to application.
Gets the accelerators that are currently associated with the given action.
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.
Gets the “active” window for the application.
Returns the menu model that has been set with Application.setAppMenu.
Get the main Gtk struct
Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information.
Returns the menu model that has been set with Application.setMenubar.
the main Gtk struct as a void*
Returns the gtk.ApplicationWindow with the given ID.
Gets a list of the gtk.Windows associated with application.
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.
Determines if any of the actions specified in flags are currently inhibited (possibly by another application).
Lists the detailed action names which have associated accelerators. See Application.setAccelsForAction.
Determines if the desktop environment in which the application is running would prefer an application menu be shown.
Removes an accelerator that has been previously added with Application.addAccelerator.
Remove a window from application.
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.
Sets or unsets the application menu for application.
Sets or unsets the menubar for windows of application.
Removes an inhibitor that has been established with Application.inhibit. Inhibitors are also cleared when the application exits.
the main Gtk struct