- actionAdded
void actionAdded(string actionName)
Emits the #GActionGroup::action-added signal on action_group.
- actionEnabledChanged
void actionEnabledChanged(string actionName, bool enabled)
Emits the #GActionGroup::action-enabled-changed signal on action_group.
- actionRemoved
void actionRemoved(string actionName)
Emits the #GActionGroup::action-removed signal on action_group.
- actionStateChanged
void actionStateChanged(string actionName, glib.variant.VariantG state)
Emits the #GActionGroup::action-state-changed signal on action_group.
- activateAction
void activateAction(string actionName, glib.variant.VariantG parameter)
Activate the named action within action_group.
- changeActionState
void changeActionState(string actionName, glib.variant.VariantG value)
Request for the state of the named action within action_group to be
changed to value.
- connectActionAdded
ulong connectActionAdded(string detail, T callback, Flag!"After" after)
Connect to ActionAdded signal.
- connectActionEnabledChanged
ulong connectActionEnabledChanged(string detail, T callback, Flag!"After" after)
Connect to ActionEnabledChanged signal.
- connectActionRemoved
ulong connectActionRemoved(string detail, T callback, Flag!"After" after)
Connect to ActionRemoved signal.
- connectActionStateChanged
ulong connectActionStateChanged(string detail, T callback, Flag!"After" after)
Connect to ActionStateChanged signal.
- getActionEnabled
bool getActionEnabled(string actionName)
Checks if the named action within action_group is currently enabled.
- getActionParameterType
glib.variant_type.VariantType getActionParameterType(string actionName)
Queries the type of the parameter that must be given when activating
the named action within action_group.
- getActionState
glib.variant.VariantG getActionState(string actionName)
Queries the current state of the named action within action_group.
- getActionStateHint
glib.variant.VariantG getActionStateHint(string actionName)
Requests a hint about the valid range of values for the state of the
named action within action_group.
- getActionStateType
glib.variant_type.VariantType getActionStateType(string actionName)
Queries the type of the state of the named action within
action_group.
- hasAction
bool hasAction(string actionName)
Checks if the named action exists within action_group.
- listActions
string[] listActions()
Lists the actions contained within action_group.
- queryAction
bool queryAction(string actionName, bool enabled, glib.variant_type.VariantType parameterType, glib.variant_type.VariantType stateType, glib.variant.VariantG stateHint, glib.variant.VariantG state)
Queries all aspects of the named action within an action_group.
gio.action_group.ActionGroup represents a group of actions.
Actions can be used to expose functionality in a structured way, either from one part of a program to another, or to the outside world. Action groups are often used together with a gio.menu_model.MenuModel that provides additional representation data for displaying the actions to the user, e.g. in a menu.
The main way to interact with the actions in a gio.action_group.ActionGroup is to activate them with gio.action_group.ActionGroup.activateAction. Activating an action may require a glib.variant.VariantG parameter. The required type of the parameter can be inquired with gio.action_group.ActionGroup.getActionParameterType. Actions may be disabled, see gio.action_group.ActionGroup.getActionEnabled. Activating a disabled action has no effect.
Actions may optionally have a state in the form of a #GVariant. The current state of an action can be inquired with gio.action_group.ActionGroup.getActionState. Activating a stateful action may change its state, but it is also possible to set the state by calling gio.action_group.ActionGroup.changeActionState.
As typical example, consider a text editing application which has an option to change the current font to 'bold'. A good way to represent this would be a stateful action, with a boolean state. Activating the action would toggle the state.
Each action in the group has a unique name (which is a string). All method calls, except gio.action_group.ActionGroup.listActions take the name of an action as an argument.
The gio.action_group.ActionGroup API is meant to be the 'public' API to the action group. The calls here are exactly the interaction that 'external forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have with actions. 'Internal' APIs (ie: ones meant only to be accessed by the action group implementation) are found on subclasses. This is why you will find - for example - gio.action_group.ActionGroup.getActionEnabled but not an equivalent set() call.
Signals are emitted on the action group in response to state changes on individual actions.
Implementations of gio.action_group.ActionGroup should provide implementations for the virtual functions gio.action_group.ActionGroup.listActions and gio.action_group.ActionGroup.queryAction. The other virtual functions should not be implemented - their "wrappers" are actually implemented with calls to gio.action_group.ActionGroup.queryAction.