Class

GtkApplication

Description [src]

class Gtk.Application : Gio.Application {
  parent: GApplication
}

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 g_action_group_activate_action(). 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 g_application_set_resource_base_path()). 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_get_menu_by_id() 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_prefers_app_menu(). 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_set_app_menu() and gtk_application_set_menubar().

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_add_resource_path() 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_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

Hierarchy

hierarchy this GtkApplication implements_0 GActionGroup this--implements_0 implements_1 GActionMap this--implements_1 ancestor_0 GtkApplication ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Constructors

gtk_application_new

Creates a new GtkApplication instance.

Available since: 3.0

Instance methods

gtk_application_add_accelerator

Installs an accelerator that will cause the named action to be activated when the key combination specificed by accelerator is pressed.

Available since: 3.4

Deprecated since: 3.14

gtk_application_add_window

Adds a window to application.

Available since: 3.0

gtk_application_get_accels_for_action

Gets the accelerators that are currently associated with the given action.

Available since: 3.12

gtk_application_get_actions_for_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.

Available since: 3.14

gtk_application_get_active_window

Gets the “active” window for the application.

Available since: 3.6

gtk_application_get_app_menu

Returns the menu model that has been set with gtk_application_set_app_menu().

Available since: 3.4

gtk_application_get_menu_by_id

Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information.

Available since: 3.14

gtk_application_get_menubar

Returns the menu model that has been set with gtk_application_set_menubar().

Available since: 3.4

gtk_application_get_window_by_id

Returns the GtkApplicationWindow with the given ID.

Available since: 3.6

gtk_application_get_windows

Gets a list of the GtkWindows associated with application.

Available since: 3.0

gtk_application_inhibit

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.

Available since: 3.4

gtk_application_is_inhibited

Determines if any of the actions specified in flags are currently inhibited (possibly by another application).

Available since: 3.4

gtk_application_list_action_descriptions

Lists the detailed action names which have associated accelerators. See gtk_application_set_accels_for_action().

Available since: 3.12

gtk_application_prefers_app_menu

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

Available since: 3.14

gtk_application_remove_accelerator

Removes an accelerator that has been previously added with gtk_application_add_accelerator().

Available since: 3.4

Deprecated since: 3.14

gtk_application_remove_window

Remove a window from application.

Available since: 3.0

gtk_application_set_accels_for_action

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.

Available since: 3.12

gtk_application_set_app_menu

Sets or unsets the application menu for application.

Available since: 3.4

gtk_application_set_menubar

Sets or unsets the menubar for windows of application.

Available since: 3.4

gtk_application_uninhibit

Removes an inhibitor that has been established with gtk_application_inhibit(). Inhibitors are also cleared when the application exits.

Available since: 3.4

Methods inherited from GtkApplication (20)
gtk_application_add_accelerator

Installs an accelerator that will cause the named action to be activated when the key combination specificed by accelerator is pressed.

Available since: 3.4

Deprecated since: 3.14

gtk_application_add_window

Adds a window to application.

Available since: 3.0

gtk_application_get_accels_for_action

Gets the accelerators that are currently associated with the given action.

Available since: 3.12

gtk_application_get_actions_for_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.

Available since: 3.14

gtk_application_get_active_window

Gets the “active” window for the application.

Available since: 3.6

gtk_application_get_app_menu

Returns the menu model that has been set with gtk_application_set_app_menu().

Available since: 3.4

gtk_application_get_menu_by_id

Gets a menu from automatically loaded resources. See [Automatic resources][automatic-resources] for more information.

Available since: 3.14

gtk_application_get_menubar

Returns the menu model that has been set with gtk_application_set_menubar().

Available since: 3.4

gtk_application_get_window_by_id

Returns the GtkApplicationWindow with the given ID.

Available since: 3.6

gtk_application_get_windows

Gets a list of the GtkWindows associated with application.

Available since: 3.0

gtk_application_inhibit

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.

Available since: 3.4

gtk_application_is_inhibited

Determines if any of the actions specified in flags are currently inhibited (possibly by another application).

Available since: 3.4

gtk_application_list_action_descriptions

Lists the detailed action names which have associated accelerators. See gtk_application_set_accels_for_action().

Available since: 3.12

gtk_application_prefers_app_menu

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

Available since: 3.14

gtk_application_remove_accelerator

Removes an accelerator that has been previously added with gtk_application_add_accelerator().

Available since: 3.4

Deprecated since: 3.14

gtk_application_remove_window

Remove a window from application.

Available since: 3.0

gtk_application_set_accels_for_action

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.

Available since: 3.12

gtk_application_set_app_menu

Sets or unsets the application menu for application.

Available since: 3.4

gtk_application_set_menubar

Sets or unsets the menubar for windows of application.

Available since: 3.4

gtk_application_uninhibit

Removes an inhibitor that has been established with gtk_application_inhibit(). Inhibitors are also cleared when the application exits.

Available since: 3.4

Methods inherited from GObject (42)

Properties

Gtk.Application:active-window
No description available.
Gtk.Application:app-menu
No description available.
Gtk.Application:menubar
No description available.
Gtk.Application:register-session

Set this property to TRUE to register with the session manager.

Available since: 3.4

Gtk.Application:screensaver-active

This property is TRUE if GTK+ believes that the screensaver is currently active. GTK+ only tracks session state (including this) when GtkApplication::register-session is set to TRUE.

Available since: 3.24

Properties inherited from GtkApplication (5)
Gtk.Application:active-window
No description available.
Gtk.Application:app-menu
No description available.
Gtk.Application:menubar
No description available.
Gtk.Application:register-session

Set this property to TRUE to register with the session manager.

Available since: 3.4

Gtk.Application:screensaver-active

This property is TRUE if GTK+ believes that the screensaver is currently active. GTK+ only tracks session state (including this) when GtkApplication::register-session is set to TRUE.

Available since: 3.24

Signals

Gtk.Application::query-end

Emitted when the session manager is about to end the session, only if GtkApplication::register-session is TRUE. Applications can connect to this signal and call gtk_application_inhibit() with GTK_APPLICATION_INHIBIT_LOGOUT to delay the end of the session until state has been saved.

Available since: 3.24.8

Gtk.Application::window-added

Emitted when a GtkWindow is added to application through gtk_application_add_window().

Available since: 3.2

Gtk.Application::window-removed

Emitted when a GtkWindow is removed from application, either as a side-effect of being destroyed or explicitly through gtk_application_remove_window().

Available since: 3.2

Signals inherited from GtkApplication (3)
Gtk.Application::query-end

Emitted when the session manager is about to end the session, only if GtkApplication::register-session is TRUE. Applications can connect to this signal and call gtk_application_inhibit() with GTK_APPLICATION_INHIBIT_LOGOUT to delay the end of the session until state has been saved.

Available since: 3.24.8

Gtk.Application::window-added

Emitted when a GtkWindow is added to application through gtk_application_add_window().

Available since: 3.2

Gtk.Application::window-removed

Emitted when a GtkWindow is removed from application, either as a side-effect of being destroyed or explicitly through gtk_application_remove_window().

Available since: 3.2

Signals inherited from GObject (1)

Class structure

struct GtkApplicationClass {
  GApplicationClass parent_class;
  void (* window_added) (
    GtkApplication* application,
    GtkWindow* window
  );
  void (* window_removed) (
    GtkApplication* application,
    GtkWindow* window
  );
  
}
Class members
parent_class
GApplicationClass
 

The parent class.

window_added
void (* window_added) (
    GtkApplication* application,
    GtkWindow* window
  )
  No description available.
window_removed
void (* window_removed) (
    GtkApplication* application,
    GtkWindow* window
  )
  No description available.

Virtual methods

Gtk.ApplicationClass.window_added
No description available.
Gtk.ApplicationClass.window_removed
No description available.