Gio.Action

g GObject.GInterface GObject.GInterface Gio.Action Gio.Action GObject.GInterface->Gio.Action

Implementations:
 Gio.PropertyAction, Gio.SimpleAction

Methods

class name_is_valid (action_name)
class parse_detailed_name (detailed_name)
class print_detailed_name (action_name, target_value)
  activate (parameter)
  change_state (value)
  get_enabled ()
  get_name ()
  get_parameter_type ()
  get_state ()
  get_state_hint ()
  get_state_type ()

Virtual Methods

  do_activate (parameter)
  do_change_state (value)
  do_get_enabled ()
  do_get_name ()
  do_get_parameter_type ()
  do_get_state ()
  do_get_state_hint ()
  do_get_state_type ()

Properties

Name Type Flags Short Description
enabled bool r If the action can be activated
name str r The name used to invoke the action
parameter-type GLib.VariantType r The type of GLib.Variant passed to activate()
state GLib.Variant r The state the action is in
state-type GLib.VariantType r The type of the state kept by the action

Signals

None

Fields

None

Class Details

class Gio.Action
Bases:GObject.GInterface
Structure:Gio.ActionInterface

Gio.Action represents a single named action.

The main interface to an action is that it can be activated with Gio.Action.activate(). This results in the ‘activate’ signal being emitted. An activation has a GLib.Variant parameter (which may be None). 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.change_state(). This call takes a GLib.Variant. 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 is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including Gio.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.activate() and Gio.Action.change_state() for type safety and for the state being enabled.

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

classmethod name_is_valid(action_name)[source]
Parameters:action_name (str) – an potential action name
Returns:True if action_name is valid
Return type:bool

Checks if action_name is valid.

action_name is valid if it consists only of alphanumeric characters, plus ‘-‘ and ‘.’. The empty string is not a valid action name.

It is an error to call this function with a non-utf8 action_name. action_name must not be None.

New in version 2.38.

classmethod parse_detailed_name(detailed_name)[source]
Parameters:detailed_name (str) – a detailed action name
Raises:GLib.Error
Returns:True if successful, else False with error set
action_name:the action name
target_value:the target value, or None for no target
Return type:(bool, action_name: str, target_value: GLib.Variant)

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

Detailed action names can have three formats.

The first format is used to represent an action name with no target value and consists of just an action name containing no whitespace nor the characters ‘:’, ‘(‘ or ‘)’. For example: “app.action”.

The second format is used to represent an action with a target value that is a non-empty string consisting only of alphanumerics, plus ‘-‘ and ‘.’. In that case, the action name and target value are separated by a double colon (“::”). For example: “app.action::target”.

The third format is used to represent an action with any type of target value, including strings. The target value follows the action name, surrounded in parens. For example: “app.action(42)”. The target value is parsed using GLib.Variant.parse(). If a tuple-typed value is desired, it must be specified in the same way, resulting in two sets of parens, for example: “app.action((1,2,3))”. A string target can be specified this way as well: “app.action(‘target’)”. For strings, this third format must be used if * target value is empty or contains characters other than alphanumerics, ‘-‘ and ‘.’.

New in version 2.38.

classmethod print_detailed_name(action_name, target_value)[source]
Parameters:
Returns:

a detailed format string

Return type:

str

Formats a detailed action name from action_name and target_value.

It is an error to call this function with an invalid action name.

This function is the opposite of Gio.Action.parse_detailed_name(). It will produce a string that can be parsed back to the action_name and target_value by that function.

See that function for the types of strings that will be printed by this function.

New in version 2.38.

activate(parameter)[source]
Parameters:parameter (GLib.Variant or None) – the parameter to the activation

Activates the action.

parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter type was None then parameter must also be None.

If the parameter GLib.Variant is floating, it is consumed.

New in version 2.28.

change_state(value)[source]
Parameters:value (GLib.Variant) – the new state

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

The action must be stateful and value must be of the correct type. See Gio.Action.get_state_type().

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.get_state_hint().

If the value GLib.Variant is floating, it is consumed.

New in version 2.30.

get_enabled()[source]
Returns:whether the action is enabled
Return type:bool

Checks if self is currently enabled.

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

New in version 2.28.

get_name()[source]
Returns:the name of the action
Return type:str

Queries the name of self.

New in version 2.28.

get_parameter_type()[source]
Returns:the parameter type
Return type:GLib.VariantType or None

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

When activating the action using Gio.Action.activate(), the GLib.Variant given to that function must be of the type returned by this function.

In the case that this function returns None, you must not give any GLib.Variant, but None instead.

New in version 2.28.

get_state()[source]
Returns:the current state of the action
Return type:GLib.Variant

Queries the current state of self.

If the action is not stateful then None will be returned. If the action is stateful then the type of the return value is the type given by Gio.Action.get_state_type().

The return value (if non-None) should be freed with GLib.Variant.unref() when it is no longer required.

New in version 2.28.

get_state_hint()[source]
Returns:the state range hint
Return type:GLib.Variant or None

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

If None 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 GLib.Variant array is returned then each item in the array is a possible value for the state. If a GLib.Variant 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-None) should be freed with GLib.Variant.unref() when it is no longer required.

New in version 2.28.

get_state_type()[source]
Returns:the state type, if the action is stateful
Return type:GLib.VariantType or None

Queries the type of the state of self.

If the action is stateful (e.g. created with Gio.SimpleAction.new_stateful()) then this function returns the GLib.VariantType of the state. This is the type of the initial value given as the state. All calls to Gio.Action.change_state() must give a GLib.Variant of this type and Gio.Action.get_state() will return a GLib.Variant of the same type.

If the action is not stateful (e.g. created with Gio.SimpleAction.new()) then this function will return None. In that case, Gio.Action.get_state() will return None and you must not call Gio.Action.change_state().

New in version 2.28.

do_activate(parameter) virtual
Parameters:parameter (GLib.Variant or None) – the parameter to the activation

Activates the action.

parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter type was None then parameter must also be None.

If the parameter GLib.Variant is floating, it is consumed.

New in version 2.28.

do_change_state(value) virtual
Parameters:value (GLib.Variant) – the new state

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

The action must be stateful and value must be of the correct type. See Gio.Action.get_state_type().

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.get_state_hint().

If the value GLib.Variant is floating, it is consumed.

New in version 2.30.

do_get_enabled() virtual
Returns:whether the action is enabled
Return type:bool

Checks if action is currently enabled.

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

New in version 2.28.

do_get_name() virtual
Returns:the name of the action
Return type:str

Queries the name of action.

New in version 2.28.

do_get_parameter_type() virtual
Returns:the parameter type
Return type:GLib.VariantType or None

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

When activating the action using Gio.Action.activate(), the GLib.Variant given to that function must be of the type returned by this function.

In the case that this function returns None, you must not give any GLib.Variant, but None instead.

New in version 2.28.

do_get_state() virtual
Returns:the current state of the action
Return type:GLib.Variant

Queries the current state of action.

If the action is not stateful then None will be returned. If the action is stateful then the type of the return value is the type given by Gio.Action.get_state_type().

The return value (if non-None) should be freed with GLib.Variant.unref() when it is no longer required.

New in version 2.28.

do_get_state_hint() virtual
Returns:the state range hint
Return type:GLib.Variant or None

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

If None 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 GLib.Variant array is returned then each item in the array is a possible value for the state. If a GLib.Variant 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-None) should be freed with GLib.Variant.unref() when it is no longer required.

New in version 2.28.

do_get_state_type() virtual
Returns:the state type, if the action is stateful
Return type:GLib.VariantType or None

Queries the type of the state of action.

If the action is stateful (e.g. created with Gio.SimpleAction.new_stateful()) then this function returns the GLib.VariantType of the state. This is the type of the initial value given as the state. All calls to Gio.Action.change_state() must give a GLib.Variant of this type and Gio.Action.get_state() will return a GLib.Variant of the same type.

If the action is not stateful (e.g. created with Gio.SimpleAction.new()) then this function will return None. In that case, Gio.Action.get_state() will return None and you must not call Gio.Action.change_state().

New in version 2.28.

Property Details

Gio.Action.props.enabled
Name:enabled
Type:bool
Default Value:True
Flags:READABLE

If action is currently enabled.

If the action is disabled then calls to Gio.Action.activate() and Gio.Action.change_state() have no effect.

New in version 2.28.

Gio.Action.props.name
Name:name
Type:str
Default Value:None
Flags:READABLE

The name of the action. This is mostly meaningful for identifying the action once it has been added to a Gio.ActionGroup. It is immutable.

New in version 2.28.

Gio.Action.props.parameter_type
Name:parameter-type
Type:GLib.VariantType
Default Value:None
Flags:READABLE

The type of the parameter that must be given when activating the action. This is immutable, and may be None if no parameter is needed when activating the action.

New in version 2.28.

Gio.Action.props.state
Name:state
Type:GLib.Variant
Default Value:None
Flags:READABLE

The state of the action, or None if the action is stateless.

New in version 2.28.

Gio.Action.props.state_type
Name:state-type
Type:GLib.VariantType
Default Value:None
Flags:READABLE

The GLib.VariantType of the state that the action has, or None if the action is stateless. This is immutable.

New in version 2.28.