ActionGroupT.queryAction

Queries all aspects of the named action within an @action_group.

This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), g_action_group_get_action_parameter_type(), g_action_group_get_action_state_type(), g_action_group_get_action_state_hint() and g_action_group_get_action_state() with a single function call.

This provides two main benefits.

The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing #GActionGroup can now be done by only overriding this one virtual function.

The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

If the action exists, %TRUE is returned and any of the requested fields (as indicated by having a non-%NULL reference passed in) are filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified.

template ActionGroupT(TStruct)
bool
queryAction
(
string actionName
,
out bool enabled
,
out VariantType parameterType
,
out VariantType stateType
,
out Variant stateHint
,
out Variant state
)

Parameters

actionName string

the name of an action in the group

enabled bool

if the action is presently enabled

parameterType VariantType

the parameter type, or %NULL if none needed

stateType VariantType

the state type, or %NULL if stateless

stateHint Variant

the state hint, or %NULL if none

state Variant

the current state, or %NULL if stateless

Return: %TRUE if the action exists, else %FALSE

Meta

Since

2.32