gio.action_group_mixin

Emits the #GActionGroup::action-added signal on action_group.

This function should only be called by #GActionGroup implementations.

Emits the #GActionGroup::action-enabled-changed signal on action_group.

This function should only be called by #GActionGroup implementations.

Emits the #GActionGroup::action-removed signal on action_group.

This function should only be called by #GActionGroup implementations.

Emits the #GActionGroup::action-state-changed signal on action_group.

This function should only be called by #GActionGroup implementations.

Activate the named action within action_group.

If the action is expecting a parameter, then the correct type of parameter must be given as parameter. If the action is expecting no parameters then parameter must be null. See [gio.action_group.ActionGroup.getActionParameterType].

If the #GActionGroup implementation supports asynchronous remote activation over D-Bus, this call may return before the relevant D-Bus traffic has been sent, or any replies have been received. In order to block on such asynchronous activation calls, [gio.dbus_connection.DBusConnection.flush] should be called prior to the code, which depends on the result of the action activation. Without flushing the D-Bus connection, there is no guarantee that the action would have been activated.

The following code which runs in a remote app instance, shows an example of a "quit" action being activated on the primary app instance over D-Bus. Here [gio.dbus_connection.DBusConnection.flush] is called before exit(). Without [gio.dbus_connection.DBusConnection.flush], the "quit" action may fail to be activated on the primary instance.

// call "quit" action on primary instance
g_action_group_activate_action (G_ACTION_GROUP (app), "quit", NULL);

// make sure the action is activated now
g_dbus_connection_flush (...);

g_debug ("application has been terminated. exiting.");

exit (0);

Request for the state of the named action within action_group to be changed to value.

The action must be stateful and value must be of the correct type. See [gio.action_group.ActionGroup.getActionStateType].

This call merely requests a change. The action may refuse to change its state or may change its state to something other than value. See [gio.action_group.ActionGroup.getActionStateHint].

If the value GVariant is floating, it is consumed.

Checks if the named action within action_group is currently enabled.

An action must be enabled in order to be activated or in order to have its state changed from outside callers.

Queries the type of the parameter that must be given when activating the named action within action_group.

When activating the action using [gio.action_group.ActionGroup.activateAction], the #GVariant given to that function must be of the type returned by this function.

In the case that this function returns null, you must not give any #GVariant, but null instead.

The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type.

Queries the current state of the named action within action_group.

If the action is not stateful then null will be returned. If the action is stateful then the type of the return value is the type given by [gio.action_group.ActionGroup.getActionStateType].

The return value (if non-null) should be freed with [glib.variant.Variant.unref] when it is no longer required.

Requests a hint about the valid range of values for the state of the named action within action_group.

If null is returned it either means that the action is not stateful or that there is no hint about the valid range of values for the state of the action.

If a #GVariant array is returned then each item in the array is a possible value for the state. If a #GVariant pair (ie: two-tuple) is returned then the tuple specifies the inclusive lower and upper bound of valid values for the state.

In any case, the information is merely a hint. It may be possible to have a state value outside of the hinted range and setting a value within the range may fail.

The return value (if non-null) should be freed with [glib.variant.Variant.unref] when it is no longer required.

Queries the type of the state of the named action within action_group.

If the action is stateful then this function returns the #GVariantType of the state. All calls to [gio.action_group.ActionGroup.changeActionState] must give a #GVariant of this type and [gio.action_group.ActionGroup.getActionState] will return a #GVariant of the same type.

If the action is not stateful then this function will return null. In that case, [gio.action_group.ActionGroup.getActionState] will return null and you must not call [gio.action_group.ActionGroup.changeActionState].

The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type.

Checks if the named action exists within action_group.

Lists the actions contained within action_group.

The caller is responsible for freeing the list with [glib.global.strfreev] when it is no longer required.

Queries all aspects of the named action within an action_group.

This function acquires the information available from [gio.action_group.ActionGroup.hasAction], [gio.action_group.ActionGroup.getActionEnabled], [gio.action_group.ActionGroup.getActionParameterType], [gio.action_group.ActionGroup.getActionStateType], [gio.action_group.ActionGroup.getActionStateHint] and [gio.action_group.ActionGroup.getActionState] with a single function call.

This provides two main benefits.

The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing #GActionGroup can now be done by only overriding this one virtual function.

The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

If the action exists, true is returned and any of the requested fields (as indicated by having a non-null reference passed in) are filled. If the action doesn't exist, false is returned and the fields may or may not have been modified.

Connect to ActionAdded signal.

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Connect to ActionEnabledChanged signal.

Signals that the enabled status of the named action has changed.

Connect to ActionRemoved signal.

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Connect to ActionStateChanged signal.

Signals that the state of the named action has changed.