Package: gio

Function g-action-group-action-state-hint

Lambda List

g-action-group-action-state-hint (group name)

Arguments

group -- a g-action-group object
name -- a string with the name of the action to query

Return Value

The g-variant state range hint, or a null-pointer.

Details

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

If a null-pointer 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 g-variant parameter array is returned then each item in the array is a possible value for the state. If a g-variant parameter pair, i.e. 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.
 

See also

2021-9-8