Action

gio.action.Action represents a single named action.

The main interface to an action is that it can be activated with gio.action.Action.activate. This results in the 'activate' signal being emitted. An activation has a glib.variant.VariantG parameter (which may be NULL). The correct type for the parameter is determined by a static parameter type (which is given at construction time).

An action may optionally have a state, in which case the state may be set with gio.action.Action.changeState. This call takes a #GVariant. The correct type for the state is determined by a static state type (which is given at construction time).

The state may have a hint associated with it, specifying its valid range.

gio.action.Action is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including gio.simple_action.SimpleAction.

In all cases, the implementing class is responsible for storing the name of the action, the parameter type, the enabled state, the optional state type and the state and emitting the appropriate signals when these change. The implementor is responsible for filtering calls to gio.action.Action.activate and gio.action.Action.changeState for type safety and for the state being enabled.

Probably the only useful thing to do with a gio.action.Action is to put it inside of a gio.simple_action_group.SimpleActionGroup.

Members

Functions

activate
void activate(glib.variant.VariantG parameter)

Activates the action.

changeState
void changeState(glib.variant.VariantG value)

Request for the state of action to be changed to value.

getEnabled
bool getEnabled()

Checks if action is currently enabled.

getName
string getName()

Queries the name of action.

getParameterType
glib.variant_type.VariantType getParameterType()

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

getState
glib.variant.VariantG getState()

Queries the current state of action.

getStateHint
glib.variant.VariantG getStateHint()

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

getStateType
glib.variant_type.VariantType getStateType()

Queries the type of the state of action.

Static functions

nameIsValid
bool nameIsValid(string actionName)

Checks if action_name is valid.

parseDetailedName
bool parseDetailedName(string detailedName, string actionName, glib.variant.VariantG targetValue)

Parses a detailed action name into its separate name and target components.

printDetailedName
string printDetailedName(string actionName, glib.variant.VariantG targetValue)

Formats a detailed action name from action_name and target_value.