Memory-managed wrapper type.

Type class for types which can be safely cast to Application, for instance with toApplication.

Cast to Application, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe Application.

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

accelerator must be a string that can be parsed by acceleratorParse, e.g. "<Primary>q" or “<Control><Alt>p”.

actionName must be the name of an action as it would be used in the app menu, i.e. actions that have been added to the application are referred to with an “app.” prefix, and window-specific actions with a “win.” prefix.

GtkApplication also extracts accelerators out of “accel” attributes in the GMenuModels passed to applicationSetAppMenu and applicationSetMenubar, which is usually more convenient than calling this function for each accelerator.

Since: 3.4

Adds a window to application.

This call can only happen after the application has started; typically, you should add new application windows in response to the emission of the Application::activate signal.

This call is equivalent to setting the Window:application property of window to application.

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it with applicationRemoveWindow.

GTK+ will keep the application running as long as it has any windows.

Since: 3.0

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

Since: 3.12

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.

This might be useful to discover if an accel already exists in order to prevent installation of a conflicting accelerator (from an accelerator editor or a plugin system, for example). Note that having more than one action per accelerator may not be a bad thing and might make sense in cases where the actions never appear in the same context.

In case there are no actions for a given accelerator, an empty array is returned. Nothing is never returned.

It is a programmer error to pass an invalid accelerator string. If you are unsure, check it with acceleratorParse first.

Since: 3.14

Gets the “active” window for the application.

The active window is the one that was most recently focused (within the application). This window may not have the focus at the moment if another application has it — this is just the most recently-focused window within this application.

Since: 3.6

Returns the menu model that has been set with applicationSetAppMenu.

Since: 3.4

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

Since: 3.14

Returns the menu model that has been set with applicationSetMenubar.

Since: 3.4

Returns the ApplicationWindow with the given ID.

The ID of a ApplicationWindow can be retrieved with applicationWindowGetId.

Since: 3.6

Gets a list of the GtkWindows associated with application.

The list is sorted by most recently focused window, such that the first element is the currently focused window. (Useful for choosing a parent for a transient window.)

The list that is returned should not be modified in any way. It will only remain valid until the next focus change or window creation or deletion.

Since: 3.0

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.

Applications should invoke this method when they begin an operation that should not be interrupted, such as creating a CD or DVD. The types of actions that may be blocked are specified by the flags parameter. When the application completes the operation it should call applicationUninhibit to remove the inhibitor. Note that an application can have multiple inhibitors, and all of them must be individually removed. Inhibitors are also cleared when the application exits.

Applications should not expect that they will always be able to block the action. In most cases, users will be given the option to force the action to take place.

Reasons should be short and to the point.

If window is given, the session manager may point the user to this window to find out more about why the action is inhibited.

Since: 3.4

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

Note that this information may not be available (for example when the application is running in a sandbox).

Since: 3.4

Lists the detailed action names which have associated accelerators. See applicationSetAccelsForAction.

Since: 3.12

Creates a new Application instance.

When using Application, it is not necessary to call init manually. It is called as soon as the application gets registered as the primary instance.

Concretely, init is called in the default handler for the Application::startup signal. Therefore, Application subclasses should chain up in their Application::startup handler before using any GTK+ API.

Note that commandline arguments are not passed to init. All GTK+ functionality that is available via commandline arguments can also be achieved by setting suitable environment variables such as G_DEBUG, so this should not be a big problem. If you absolutely must support GTK+ commandline arguments, you can explicitly call init before creating the application instance.

If non-Nothing, the application ID must be valid. See applicationIdIsValid.

If no application ID is given then some features (most notably application uniqueness) will be disabled. A null application ID is only allowed with GTK+ 3.6 or later.

Since: 3.0

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

If this function returns True then the application should call applicationSetAppMenu with the contents of an application menu, which will be shown by the desktop environment. If it returns False then you should consider using an alternate approach, such as a menubar.

The value returned by this function is purely advisory and you are free to ignore it. If you call applicationSetAppMenu even if the desktop environment doesn't support app menus, then a fallback will be provided.

Applications are similarly free not to set an app menu even if the desktop environment wants to show one. In that case, a fallback will also be created by the desktop environment (GNOME, for example, uses a menu with only a "Quit" item in it).

The value returned by this function never changes. Once it returns a particular value, it is guaranteed to always return the same value.

You may only call this function after the application has been registered and after the base startup handler has run. You're most likely to want to use this from your own startup handler. It may also make sense to consult this function while constructing UI (in activate, open or an action activation handler) in order to determine if you should show a gear menu or not.

This function will return False on Mac OS and a default app menu will be created automatically with the "usual" contents of that menu typical to most Mac OS applications. If you call applicationSetAppMenu anyway, then this menu will be replaced with your own.

Since: 3.14

Removes an accelerator that has been previously added with applicationAddAccelerator.

Since: 3.4

Remove a window from application.

If window belongs to application then this call is equivalent to setting the Window:application property of window to Nothing.

The application may stop running as a result of a call to this function.

Since: 3.0

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.

To remove all accelerators for an action, use an empty, zero-terminated array for accels.

For the detailedActionName, see actionParseDetailedName and actionPrintDetailedName.

Since: 3.12

Sets or unsets the application menu for application.

This can only be done in the primary instance of the application, after it has been registered. Application::startup is a good place to call this.

The application menu is a single menu containing items that typically impact the application as a whole, rather than acting on a specific window or document. For example, you would expect to see “Preferences” or “Quit” in an application menu, but not “Save” or “Print”.

If supported, the application menu will be rendered by the desktop environment.

Use the base ActionMap interface to add actions, to respond to the user selecting these menu items.

Since: 3.4

Sets or unsets the menubar for windows of application.

This is a menubar in the traditional sense.

This can only be done in the primary instance of the application, after it has been registered. Application::startup is a good place to call this.

Depending on the desktop environment, this may appear at the top of each window, or at the top of the screen. In some environments, if both the application menu and the menubar are set, the application menu will be presented as if it were the first item of the menubar. Other environments treat the two as completely separate — for example, the application menu may be rendered by the desktop shell while the menubar (if set) remains in each individual window.

Use the base ActionMap interface to add actions, to respond to the user selecting these menu items.

Since: 3.4

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

Since: 3.4

Get the value of the “active-window” property. When overloading is enabled, this is equivalent to

get application #activeWindow

Set the value of the “app-menu” property to Nothing. When overloading is enabled, this is equivalent to

clear #appMenu

Construct a GValueConstruct with valid value for the “app-menu” property. This is rarely needed directly, but it is used by new.

Get the value of the “app-menu” property. When overloading is enabled, this is equivalent to

get application #appMenu

Set the value of the “app-menu” property. When overloading is enabled, this is equivalent to

set application [ #appMenu := value ]

Set the value of the “menubar” property to Nothing. When overloading is enabled, this is equivalent to

clear #menubar

Construct a GValueConstruct with valid value for the “menubar” property. This is rarely needed directly, but it is used by new.

Get the value of the “menubar” property. When overloading is enabled, this is equivalent to

get application #menubar

Set the value of the “menubar” property. When overloading is enabled, this is equivalent to

set application [ #menubar := value ]

Construct a GValueConstruct with valid value for the “register-session” property. This is rarely needed directly, but it is used by new.

Get the value of the “register-session” property. When overloading is enabled, this is equivalent to

get application #registerSession

Set the value of the “register-session” property. When overloading is enabled, this is equivalent to

set application [ #registerSession := value ]

Get the value of the “screensaver-active” property. When overloading is enabled, this is equivalent to

get application #screensaverActive

Emitted when a Window is added to application through applicationAddWindow.

Since: 3.2

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “window-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #windowAdded callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ApplicationWindowAddedCallback.

A convenience synonym for Nothing :: Maybe ApplicationWindowAddedCallback.

Connect a signal handler for the “window-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #windowAdded callback

Wrap a ApplicationWindowAddedCallback into a C_ApplicationWindowAddedCallback.

Emitted when a Window is removed from application, either as a side-effect of being destroyed or explicitly through applicationRemoveWindow.

Since: 3.2

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “window-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after application #windowRemoved callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ApplicationWindowRemovedCallback.

A convenience synonym for Nothing :: Maybe ApplicationWindowRemovedCallback.

Connect a signal handler for the “window-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on application #windowRemoved callback

Wrap a ApplicationWindowRemovedCallback into a C_ApplicationWindowRemovedCallback.