Description

Gnome::Gio::R-Action represents a single named action.

The main interface to an action is that it can be activated with .activate(). This results in the 'activate' signal being emitted. An activation has a Gnome::Glib::N-Variant parameter (which may be undefined). 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 .change-state(). This call takes a Gnome::Glib::N-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.

Gnome::Gio::R-Action is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including Gnome::Gio::Action.

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 .activate() and .change-state() for type safety and for the state being enabled.

Probably the only useful thing to do with a Gnome::Gio::R-Action is to put it inside of a Gnome::Gio::Action.

Methods

activate

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 undefined then $parameter must also be undefined.

If the $parameter GVariant is floating, it is consumed.

method activate ( N-Object $parameter )

• $parameter; the parameter to the activation

change-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 .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 .get-state-hint().

If the $value GVariant is floating, it is consumed.

method change-state ( N-Object $value )

• $value; the new state

get-enabled

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.

method get-enabled (--> Bool )

Return value; whether the action is enabled.

get-name

Queries the name of $action.

method get-name (--> Str )

Return value; the name of the action.

get-parameter-type

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

When activating the action using .activate(), the Gnome::Glib::N-Variant given to that function must be of the type returned by this function.

In the case that this function returns undefined, you must not give any Gnome::Glib::N-Variant, but undefined instead.

method get-parameter-type (--> N-Object )

Return value; the parameter type.

get-state

Queries the current state of $action.

If the action is not stateful then undefined will be returned. If the action is stateful then the type of the return value is the type given by .get-state-type().

The return value (if non-undefined) should be freed with g_variant_unref() when it is no longer required.

method get-state (--> N-Object )

Return value; the current state of the action.

get-state-hint

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

If undefined 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 Gnome::Glib::N-Variant array is returned then each item in the array is a possible value for the state. If a Gnome::Glib::N-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-undefined) should be freed with g_variant_unref() when it is no longer required.

method get-state-hint (--> N-Object )

Return value; the state range hint.

get-state-type

Queries the type of the state of $action.

If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the Gnome::Glib::N-VariantType of the state. This is the type of the initial value given as the state. All calls to .change-state() must give a Gnome::Glib::N-Variant of this type and .get-state() will return a Gnome::Glib::N-Variant of the same type.

If the action is not stateful (e.g. created with g_simple_action_new()) then this function will return undefined. In that case, .get-state() will return undefined and you must not call .change-state().

method get-state-type (--> N-Object )

Return value; the state type, if the action is stateful.

Functions

name-is-valid

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 undefined.

method name-is-valid ( Str $action-name --> Bool )

• $action-name; a potential action name.

Return value; True if $action-name is valid.

parse-detailed-name

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 g_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 `.`.

If this function returns True, a non-undefined value is guaranteed to be returned in $action-name (if a pointer is passed in). A undefined value may still be returned in $target-value, as the $detailed-name may not contain a target.

If returned, the Gnome::Glib::N-Variant in $target-value is guaranteed to not be floating.

method parse-detailed-name ( Str $detailed-name, Array[Str] $action-name, N-Object $target-value, CArray[N-Error] $err --> Bool )

• $detailed-name; a detailed action name.

• $action-name; (transfer ownership: full) the action name.

• $target-value; (transfer ownership: full) the target value, or undefined for no target

• $err; Error object. When defined, an error can be returned when there is one. Use Pointer when you want to ignore the error. .

Return value; True if successful, else False with $error set.

print-detailed-name

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 .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.

method print-detailed-name ( Str $action-name, N-Object $target-value --> Str )

• $action-name; a valid action name.

• $target-value; a Gnome::Glib::N-Variant target value, or undefined

Return value; a detailed format string.