Memory-managed wrapper type.

Type class for types which can be safely cast to Action, for instance with toAction.

Cast to Action, for types for which this is known to be safe. For general casts, use castTo.

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

If the parameter [typegLib.Variant] is floating, it is consumed.

Since: 2.28

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

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

If the value [typegLib.Variant] is floating, it is consumed.

Since: 2.30

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.

Since: 2.28

Queries the name of action.

Since: 2.28

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

When activating the action using actionActivate, the [typegLib.Variant] 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 [typegLib.Variant], but NULL instead.

Since: 2.28

Queries the current state of action.

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

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

Since: 2.28

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

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 [typegLib.Variant] array is returned then each item in the array is a possible value for the state. If a [typegLib.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-NULL) should be freed with variantUnref when it is no longer required.

Since: 2.28

Queries the type of the state of action.

If the action is stateful (e.g. created with simpleActionNewStateful) then this function returns the [typegLib.VariantType] of the state. This is the type of the initial value given as the state. All calls to actionChangeState must give a [typegLib.Variant] of this type and actionGetState will return a [typegLib.Variant] of the same type.

If the action is not stateful (e.g. created with simpleActionNew) then this function will return NULL. In that case, actionGetState will return NULL and you must not call actionChangeState.

Since: 2.28

Checks if actionName is valid.

actionName 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-UTF-8 actionName. actionName must not be NULL.

Since: 2.38

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 variantParse. 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-NULL value is guaranteed to be returned in actionName (if a pointer is passed in). A NULL value may still be returned in targetValue, as the detailedName may not contain a target.

If returned, the [typegLib.Variant] in targetValue is guaranteed to not be floating.

Since: 2.38

Formats a detailed action name from actionName and targetValue.

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

This function is the opposite of actionParseDetailedName. It will produce a string that can be parsed back to the actionName and targetValue by that function.

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

Since: 2.38

Get the value of the “enabled” property. When overloading is enabled, this is equivalent to

get action #enabled

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get action #name

Get the value of the “parameter-type” property. When overloading is enabled, this is equivalent to

get action #parameterType

Get the value of the “state” property. When overloading is enabled, this is equivalent to

get action #state

Get the value of the “state-type” property. When overloading is enabled, this is equivalent to

get action #stateType