Gtk.Application (original) (raw)

Class

GtkApplication

Description [src]

class Gtk.Application : Gio.Application
  implements Gio.ActionGroup, Gio.ActionMap {
  /* No available fields */
}

A high-level API for writing applications.

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

Currently, it 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.

Automatic resources

GtkApplication will automatically load menus from the GtkBuilderresource 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 “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.

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 usinggtk_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 thenGtkApplication associates an instance of this shortcuts window with each GtkApplicationWindow and sets up the keyboard acceleratorControl+? to open it. To create a menu item that displays the shortcuts window, associate the item with the actionwin.show-help-overlay.

GtkApplication will also automatically set the application id as the default window icon. Use gtk_window_set_default_icon_name() orGtkWindow:icon-name to override that behavior.

A simple application

A simple exampleis available in the GTK source code repository

GtkApplication optionally registers with a session manager of the users session (if you set the GtkApplication:register-sessionproperty) 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

• Using GtkApplication
• Getting Started with GTK: Basics.

Constructors

Instance methods

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Signals

Signals inherited from GApplication (7)

GApplication::activate

The ::activate signal is emitted on the primary instance when an activation occurs. See g_application_activate().

GApplication::command-line

The ::command-line signal is emitted on the primary instance when a commandline is not handled locally. See g_application_run() and the GApplicationCommandLine documentation for more information.

GApplication::handle-local-options

The ::handle-local-options signal is emitted on the local instance after the parsing of the commandline options has occurred.

GApplication::name-lost

The ::name-lost signal is emitted only on the registered primary instance when a new instance has taken over. This can only happen if the application is using the G_APPLICATION_ALLOW_REPLACEMENT flag.

GApplication::open

The ::open signal is emitted on the primary instance when there are files to open. See g_application_open() for more information.

GApplication::shutdown

The ::shutdown signal is emitted only on the registered primary instance immediately after the main loop terminates.

GApplication::startup

The ::startup signal is emitted on the primary instance immediately after registration. See g_application_register().

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

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

No description available.

Class members

parent_class: GApplicationClass

The parent class.

window_added: void (* window_added) ( GtkApplication* application, GtkWindow* window )

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

window_removed: void (* window_removed) ( GtkApplication* application, GtkWindow* window )

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

Virtual methods

Gtk.ApplicationClass.window_removed

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