Application

Added in version 2.28.

class Application(**properties: Any)

Superclasses: Object

Implemented Interfaces: ActionGroup, ActionMap

Constructors:

Application(**properties)
new(application_id:str=None, flags:Gio.ApplicationFlags) -> Gio.Application

Constructors

class Application
classmethod new(application_id: str | None, flags: ApplicationFlags) → Application

Creates a new Application instance.

If non-None, the application id must be valid. See id_is_valid().

If no application ID is given then some features of Application (most notably application uniqueness) will be disabled.

Parameters:

  • application_id – the application id

  • flags – the application flags

Methods

class Application
activate() → None

Activates the application.

In essence, this results in the Application::activate signal being emitted in the primary instance.

The application must be registered before calling this function.

Added in version 2.28.

add_main_option(long_name: str, short_name: int, flags: OptionFlags, arg: OptionArg, description: str, arg_description: str | None = None) → None

Add an option to be handled by application.

Calling this function is the equivalent of calling add_main_option_entries() with a single OptionEntry that has its arg_data member set to None.

The parsed arguments will be packed into a VariantDict which is passed to Application::handle-local-options. If HANDLES_COMMAND_LINE is set, then it will also be sent to the primary instance. See add_main_option_entries() for more details.

See OptionEntry for more documentation of the arguments.

Added in version 2.42.

Parameters:

  • long_name – the long name of an option used to specify it in a commandline

  • short_name – the short name of an option

  • flags – flags from OptionFlags

  • arg – the type of the option, as a OptionArg

  • description – the description for the option in --help output

  • arg_description – the placeholder to use for the extra argument parsed by the option in --help output

add_main_option_entries(entries: Sequence[OptionEntry]) → None

Adds main option entries to be handled by application.

This function is comparable to add_main_entries().

After the commandline arguments are parsed, the Application::handle-local-options signal will be emitted. At this point, the application can inspect the values pointed to by arg_data in the given OptionEntry.

Unlike OptionContext, Application supports giving a None arg_data for a non-callback OptionEntry. This results in the argument in question being packed into a VariantDict which is also passed to Application::handle-local-options, where it can be inspected and modified. If HANDLES_COMMAND_LINE is set, then the resulting dictionary is sent to the primary instance, where get_options_dict() will return it. As it has been passed outside the process at this point, the types of all values in the options dict must be checked before being used. This “packing” is done according to the type of the argument – booleans for normal flags, strings for strings, bytestrings for filenames, etc. The packing only occurs if the flag is given (ie: we do not pack a “false” Variant in the case that a flag is missing).

In general, it is recommended that all commandline arguments are parsed locally. The options dictionary should then be used to transmit the result of the parsing to the primary instance, where lookup() can be used. For local options, it is possible to either use arg_data in the usual way, or to consult (and potentially remove) the option from the options dictionary.

This function is new in GLib 2.40. Before then, the only real choice was to send all of the commandline arguments (options and all) to the primary instance for handling. Application ignored them completely on the local side. Calling this function “opts in” to the new behaviour, and in particular, means that unrecognized options will be treated as errors. Unrecognized options have never been ignored when HANDLES_COMMAND_LINE is unset.

If Application::handle-local-options needs to see the list of filenames, then the use of %G_OPTION_REMAINING is recommended. If arg_data is None then %G_OPTION_REMAINING can be used as a key into the options dictionary. If you do use %G_OPTION_REMAINING then you need to handle these arguments for yourself because once they are consumed, they will no longer be visible to the default handling (which treats them as filenames to be opened).

It is important to use the proper GVariant format when retrieving the options with lookup():

  • for %G_OPTION_ARG_NONE, use b

  • for %G_OPTION_ARG_STRING, use &s

  • for %G_OPTION_ARG_INT, use i

  • for %G_OPTION_ARG_INT64, use x

  • for %G_OPTION_ARG_DOUBLE, use d

  • for %G_OPTION_ARG_FILENAME, use ^&ay

  • for %G_OPTION_ARG_STRING_ARRAY, use ^a&s

  • for %G_OPTION_ARG_FILENAME_ARRAY, use ^a&ay

Added in version 2.40.

Parameters:

entries – the main options for the application

add_option_group(group: OptionGroup) → None

Adds a OptionGroup to the commandline handling of application.

This function is comparable to add_group().

Unlike add_main_option_entries(), this function does not deal with None arg_data and never transmits options to the primary instance.

The reason for that is because, by the time the options arrive at the primary instance, it is typically too late to do anything with them. Taking the GTK option group as an example: GTK will already have been initialised by the time the Application::command-line handler runs. In the case that this is not the first-running instance of the application, the existing instance may already have been running for a very long time.

This means that the options from OptionGroup are only really usable in the case that the instance of the application being run is the first instance. Passing options like --display= or --gdk-debug= on future runs will have no effect on the existing primary instance.

Calling this function will cause the options in the supplied option group to be parsed, but it does not cause you to be “opted in” to the new functionality whereby unrecognized options are rejected even if HANDLES_COMMAND_LINE was given.

Added in version 2.40.

Parameters:

group – a OptionGroup

bind_busy_property(object: Object, property: str) → None

Marks application as busy (see mark_busy()) while property on object is True.

The binding holds a reference to application while it is active, but not to object. Instead, the binding is destroyed when object is finalized.

Added in version 2.44.

Parameters:

  • object – a Object

  • property – the name of a boolean property of object

get_application_id() → str | None

Gets the unique identifier for application.

Added in version 2.28.

get_dbus_connection() → DBusConnection | None

Gets the DBusConnection being used by the application, or None.

If Application is using its D-Bus backend then this function will return the DBusConnection being used for uniqueness and communication with the desktop environment and other instances of the application.

If Application is not using D-Bus then this function will return None. This includes the situation where the D-Bus backend would normally be in use but we were unable to connect to the bus.

This function must not be called before the application has been registered. See get_is_registered().

Added in version 2.34.

get_dbus_object_path() → str | None

Gets the D-Bus object path being used by the application, or None.

If Application is using its D-Bus backend then this function will return the D-Bus object path that Application is using. If the application is the primary instance then there is an object published at this path. If the application is not the primary instance then the result of this function is undefined.

If Application is not using D-Bus then this function will return None. This includes the situation where the D-Bus backend would normally be in use but we were unable to connect to the bus.

This function must not be called before the application has been registered. See get_is_registered().

Added in version 2.34.

get_default() → Application | None

Returns the default Application instance for this process.

Normally there is only one Application per process and it becomes the default when it is created. You can exercise more control over this by using set_default().

If there is no default application then None is returned.

Added in version 2.32.

get_flags() → ApplicationFlags

Gets the flags for application.

See ApplicationFlags.

Added in version 2.28.

get_inactivity_timeout() → int

Gets the current inactivity timeout for the application.

This is the amount of time (in milliseconds) after the last call to release() before the application stops running.

Added in version 2.28.

get_is_busy() → bool

Gets the application’s current busy state, as set through mark_busy() or bind_busy_property().

Added in version 2.44.

get_is_registered() → bool

Checks if application is registered.

An application is registered if register() has been successfully called.

Added in version 2.28.

get_is_remote() → bool

Checks if application is remote.

If application is remote then it means that another instance of application already exists (the ‘primary’ instance). Calls to perform actions on application will result in the actions being performed by the primary instance.

The value of this property cannot be accessed before register() has been called. See get_is_registered().

Added in version 2.28.

get_resource_base_path() → str | None

Gets the resource base path of application.

See set_resource_base_path() for more information.

Added in version 2.42.

get_version() → str | None

Gets the version of application.

Added in version 2.80.

hold() → None

Increases the use count of application.

Use this function to indicate that the application has a reason to continue to run. For example, hold() is called by GTK when a toplevel window is on the screen.

To cancel the hold, call release().

id_is_valid(application_id: str) → bool

Checks if application_id is a valid application identifier.

A valid ID is required for calls to new() and set_application_id().

Application identifiers follow the same format as D-Bus well-known bus names. For convenience, the restrictions on application identifiers are reproduced here:

  • Application identifiers are composed of 1 or more elements separated by a period (.) character. All elements must contain at least one character.

  • Each element must only contain the ASCII characters [A-Z][a-z][0-9]_-, with - discouraged in new application identifiers. Each element must not begin with a digit.

  • Application identifiers must contain at least one . (period) character (and thus at least two elements).

  • Application identifiers must not begin with a . (period) character.

  • Application identifiers must not exceed 255 characters.

Note that the hyphen (-) character is allowed in application identifiers, but is problematic or not allowed in various specifications and APIs that refer to D-Bus, such as Flatpak application IDs, the `DBusActivatable interface in the Desktop Entry Specification <https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#dbus>`_, and the convention that an application’s “main” interface and object path resemble its application identifier and bus name. To avoid situations that require special-case handling, it is recommended that new application identifiers consistently replace hyphens with underscores.

Like D-Bus interface names, application identifiers should start with the reversed DNS domain name of the author of the interface (in lower-case), and it is conventional for the rest of the application identifier to consist of words run together, with initial capital letters.

As with D-Bus interface names, if the author’s DNS domain name contains hyphen/minus characters they should be replaced by underscores, and if it contains leading digits they should be escaped by prepending an underscore. For example, if the owner of 7-zip.org used an application identifier for an archiving application, it might be named org._7_zip.Archiver.

Parameters:

application_id – a potential application identifier

mark_busy() → None

Increases the busy count of application.

Use this function to indicate that the application is busy, for instance while a long running operation is pending.

The busy state will be exposed to other processes, so a session shell will use that information to indicate the state to the user (e.g. with a spinner).

To cancel the busy indication, use unmark_busy().

The application must be registered before calling this function.

Added in version 2.38.

open(files: Sequence[File], hint: str) → None

Opens the given files.

In essence, this results in the Application::open signal being emitted in the primary instance.

n_files must be greater than zero.

hint is simply passed through to the ::open signal. It is intended to be used by applications that have multiple modes for opening files (eg: “view” vs “edit”, etc). Unless you have a need for this functionality, you should use “”.

The application must be registered before calling this function and it must have the HANDLES_OPEN flag set.

Added in version 2.28.

Parameters:

  • files – an array of File to open

  • hint – a hint (or “”), but never None

quit() → None

Immediately quits the application.

Upon return to the mainloop, run() will return, calling only the ‘shutdown’ function before doing so.

The hold count is ignored. Take care if your code has called hold() on the application and is therefore still expecting it to exist. (Note that you may have called hold() indirectly, for example through gtk_application_add_window().)

The result of calling run() again after it returns is unspecified.

Added in version 2.32.

register(cancellable: Cancellable | None = None) → bool

Attempts registration of the application.

This is the point at which the application discovers if it is the primary instance or merely acting as a remote for an already-existing primary instance. This is implemented by attempting to acquire the application identifier as a unique bus name on the session bus using GDBus.

If there is no application ID or if NON_UNIQUE was given, then this process will always become the primary instance.

Due to the internal architecture of GDBus, method calls can be dispatched at any time (even if a main loop is not running). For this reason, you must ensure that any object paths that you wish to register are registered before calling this function.

If the application has already been registered then True is returned with no work performed.

The Application::startup signal is emitted if registration succeeds and application is the primary instance (including the non-unique case).

In the event of an error (such as cancellable being cancelled, or a failure to connect to the session bus), False is returned and error is set appropriately.

Note: the return value of this function is not an indicator that this instance is or is not the primary instance of the application. See get_is_remote() for that.

Added in version 2.28.

Parameters:

cancellable – a Cancellable, or None

release() → None

Decrease the use count of application.

When the use count reaches zero, the application will stop running.

Never call this function except to cancel the effect of a previous call to hold().

run(*args, **kwargs)

Runs the application.

This function is intended to be run from main() and its return value is intended to be returned by main(). Although you are expected to pass the argc, argv parameters from main() to this function, it is possible to pass None if argv is not available or commandline handling is not required. Note that on Windows, argc and argv are ignored, and g_win32_get_command_line() is called internally (for proper support of Unicode commandline arguments).

Application will attempt to parse the commandline arguments. You can add commandline flags to the list of recognised options by way of add_main_option_entries(). After this, the Application::handle-local-options signal is emitted, from which the application can inspect the values of its OptionEntry.

Application::handle-local-options is a good place to handle options such as --version, where an immediate reply from the local process is desired (instead of communicating with an already-running instance). A Application::handle-local-options handler can stop further processing by returning a non-negative value, which then becomes the exit status of the process.

What happens next depends on the flags: if HANDLES_COMMAND_LINE was specified then the remaining commandline arguments are sent to the primary instance, where a Application::command-line signal is emitted. Otherwise, the remaining commandline arguments are assumed to be a list of files. If there are no files listed, the application is activated via the Application::activate signal. If there are one or more files, and HANDLES_OPEN was specified then the files are opened via the Application::open signal.

If you are interested in doing more complicated local handling of the commandline then you should implement your own Application subclass and override local_command_line(). In this case, you most likely want to return True from your local_command_line() implementation to suppress the default handling. See [gapplication-example-cmdline2.c][https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline2.c] for an example.

If, after the above is done, the use count of the application is zero then the exit status is returned immediately. If the use count is non-zero then the default main context is iterated until the use count falls to zero, at which point 0 is returned.

If the IS_SERVICE flag is set, then the service will run for as much as 10 seconds with a use count of zero while waiting for the message that caused the activation to arrive. After that, if the use count falls to zero the application will exit immediately, except in the case that set_inactivity_timeout() is in use.

This function sets the prgname (set_prgname()), if not already set, to the basename of argv[0].

Much like run(), this function will acquire the main context for the duration that the application is running.

Since 2.40, applications that are not explicitly flagged as services or launchers (ie: neither IS_SERVICE or IS_LAUNCHER are given as flags) will check (from the default handler for local_command_line) if “–gapplication-service” was given in the command line. If this flag is present then normal commandline processing is interrupted and the IS_SERVICE flag is set. This provides a “compromise” solution whereby running an application directly from the commandline will invoke it in the normal way (which can be useful for debugging) while still allowing applications to be D-Bus activated in service mode. The D-Bus service file should invoke the executable with “–gapplication-service” as the sole commandline argument. This approach is suitable for use by most graphical applications but should not be used from applications like editors that need precise control over when processes invoked via the commandline will exit and what their exit status will be.

Added in version 2.28.

Parameters:

  • args

  • kwargs

send_notification(id: str | None, notification: Notification) → None

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.

Notifications may persist after the application exits. It will be D-Bus-activated when the notification or one of its actions is activated.

Modifying notification after this call has no effect. However, the object can be reused for a later call to this function.

id may be any string that uniquely identifies the event for the application. It does not need to be in any special format. For example, “new-message” might be appropriate for a notification about new messages.

If a previous notification was sent with the same id, it will be replaced with notification and shown again as if it was a new notification. This works even for notifications sent from a previous execution of the application, as long as id is the same string.

id may be NULL, but it is impossible to replace or withdraw notifications without an id.

If notification is no longer relevant, it can be withdrawn with withdraw_notification.

It is an error to call this function if application has no application ID.

Added in version 2.40.

Parameters:

  • id – id of the notification, or None

  • notification – the Notification to send

set_action_group(action_group: ActionGroup | None = None) → None

This used to be how actions were associated with a Application. Now there is ActionMap for that.

Added in version 2.28.

Deprecated since version 2.32: Use the ActionMap interface instead. Never ever mix use of this API with use of ActionMap on the same application or things will go very badly wrong. This function is known to introduce buggy behaviour (ie: signals not emitted on changes to the action group), so you should really use ActionMap instead.

Parameters:

action_group – a ActionGroup, or None

set_application_id(application_id: str | None = None) → None

Sets the unique identifier for application.

The application id can only be modified if application has not yet been registered.

If non-None, the application id must be valid. See id_is_valid().

Added in version 2.28.

Parameters:

application_id – the identifier for application

set_default() → None

Sets or unsets the default application for the process, as returned by get_default().

This function does not take its own reference on application. If application is destroyed then the default application will revert back to None.

Added in version 2.32.

set_flags(flags: ApplicationFlags) → None

Sets the flags for application.

The flags can only be modified if application has not yet been registered.

See ApplicationFlags.

Added in version 2.28.

Parameters:

flags – the flags for application

set_inactivity_timeout(inactivity_timeout: int) → None

Sets the current inactivity timeout for the application.

This is the amount of time (in milliseconds) after the last call to release() before the application stops running.

This call has no side effects of its own. The value set here is only used for next time release() drops the use count to zero. Any timeouts currently in progress are not impacted.

Added in version 2.28.

Parameters:

inactivity_timeout – the timeout, in milliseconds

set_option_context_description(description: str | None = None) → None

Adds a description to the application option context.

See set_description() for more information.

Added in version 2.56.

Parameters:

description – a string to be shown in --help output after the list of options, or None

set_option_context_parameter_string(parameter_string: str | None = None) → None

Sets the parameter string to be used by the commandline handling of application.

This function registers the argument to be passed to new() when the internal OptionContext of application is created.

See new() for more information about parameter_string.

Added in version 2.56.

Parameters:

parameter_string – a string which is displayed in the first line of --help output, after the usage summary programname [OPTION...].

set_option_context_summary(summary: str | None = None) → None

Adds a summary to the application option context.

See set_summary() for more information.

Added in version 2.56.

Parameters:

summary – a string to be shown in --help output before the list of options, or None

set_resource_base_path(resource_path: str | None = None) → None

Sets (or unsets) the base resource path of application.

The path is used to automatically load various [application resources][gresource] such as menu layouts and action descriptions. The various types of resources will be found at fixed names relative to the given base path.

By default, the resource base path is determined from the application ID by prefixing ‘/’ and replacing each ‘.’ with ‘/’. This is done at the time that the Application object is constructed. Changes to the application ID after that point will not have an impact on the resource base path.

As an example, if the application has an ID of “org.example.app” then the default resource base path will be “/org/example/app”. If this is a GtkApplication (and you have not manually changed the path) then Gtk will then search for the menus of the application at “/org/example/app/gtk/menus.ui”.

See Resource for more information about adding resources to your application.

You can disable automatic resource loading functionality by setting the path to None.

Changing the resource base path once the application is running is not recommended. The point at which the resource path is consulted for forming paths for various purposes is unspecified. When writing a sub-class of Application you should either set the Application:resource-base-path property at construction time, or call this function during the instance initialization. Alternatively, you can call this function in the GApplicationClass.startup virtual function, before chaining up to the parent implementation.

Added in version 2.42.

Parameters:

resource_path – the resource path to use

set_version(version: str) → None

Sets the version number of application. This will be used to implement a --version command line argument

The application version can only be modified if application has not yet been registered.

Added in version 2.80.

Parameters:

version – the version of application

unbind_busy_property(object: Object, property: str) → None

Destroys a binding between property and the busy state of application that was previously created with bind_busy_property().

Added in version 2.44.

Parameters:

  • object – a Object

  • property – the name of a boolean property of object

unmark_busy() → None

Decreases the busy count of application.

When the busy count reaches zero, the new state will be propagated to other processes.

This function must only be called to cancel the effect of a previous call to mark_busy().

Added in version 2.38.

withdraw_notification(id: str) → None

Withdraws a notification that was sent with send_notification().

This call does nothing if a notification with id doesn’t exist or the notification was never sent.

This function works even for notifications sent in previous executions of this application, as long id is the same as it was for the sent notification.

Note that notifications are dismissed when the user clicks on one of the buttons in a notification or triggers its default action, so there is no need to explicitly withdraw the notification in that case.

Added in version 2.40.

Parameters:

id – id of a previously sent notification

Properties

class Application
props.action_group: ActionGroup

The type of the None singleton.

Added in version 2.28.

Deprecated since version 2.32: Use the ActionMap interface instead. Never ever mix use of this API with use of GActionMap on the same application or things will go very badly wrong.

props.application_id: str

The type of the None singleton.

Added in version 2.28.

props.flags: ApplicationFlags

The type of the None singleton.

Added in version 2.28.

props.inactivity_timeout: int

The type of the None singleton.

Added in version 2.28.

props.is_busy: bool

The type of the None singleton.

Added in version 2.44.

props.is_registered: bool

The type of the None singleton.

Added in version 2.28.

props.is_remote: bool

The type of the None singleton.

Added in version 2.28.

props.resource_base_path: str

The type of the None singleton.

Added in version 2.28.

props.version: str

The type of the None singleton.

Added in version 2.80.

Signals

class Application.signals
activate() → None

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

command_line(command_line: ApplicationCommandLine) → int

The type of the None singleton.

Parameters:

command_line – a ApplicationCommandLine representing the passed commandline

handle_local_options(options: VariantDict) → int

The type of the None singleton.

Added in version 2.40.

Parameters:

options – the options dictionary

name_lost() → bool

The type of the None singleton.

Added in version 2.60.

open(files: Sequence[File], hint: str) → None

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

Parameters:

  • files – an array of File

  • hint – a hint provided by the calling instance

shutdown() → None

The type of the None singleton.

startup() → None

The type of the None singleton.

Virtual Methods

class Application
do_activate() → None

Activates the application.

In essence, this results in the Application::activate signal being emitted in the primary instance.

The application must be registered before calling this function.

Added in version 2.28.

do_add_platform_data(builder: VariantBuilder) → None

The type of the None singleton.

Parameters:

builder

do_after_emit(platform_data: Variant) → None

The type of the None singleton.

Parameters:

platform_data

do_before_emit(platform_data: Variant) → None

The type of the None singleton.

Parameters:

platform_data

do_command_line(command_line: ApplicationCommandLine) → int

The type of the None singleton.

Parameters:

command_line

do_dbus_register(connection: DBusConnection, object_path: str) → bool

The type of the None singleton.

Parameters:

  • connection

  • object_path

do_dbus_unregister(connection: DBusConnection, object_path: str) → None

The type of the None singleton.

Parameters:

  • connection

  • object_path

do_handle_local_options(options: VariantDict) → int

The type of the None singleton.

Parameters:

options

do_local_command_line() → tuple[bool, list[str], int]

The type of the None singleton.

do_name_lost() → bool

The type of the None singleton.

do_open(files: Sequence[File], hint: str) → None

Opens the given files.

In essence, this results in the Application::open signal being emitted in the primary instance.

n_files must be greater than zero.

hint is simply passed through to the ::open signal. It is intended to be used by applications that have multiple modes for opening files (eg: “view” vs “edit”, etc). Unless you have a need for this functionality, you should use “”.

The application must be registered before calling this function and it must have the HANDLES_OPEN flag set.

Added in version 2.28.

Parameters:

  • files – an array of File to open

  • hint – a hint (or “”), but never None

do_quit_mainloop() → None

The type of the None singleton.

do_run_mainloop() → None

The type of the None singleton.

do_shutdown() → None

The type of the None singleton.

do_startup() → None

The type of the None singleton.

Fields

class Application
parent_instance
priv