Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

Interface Gio.Action

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GAction
Interface :	Action
Implementations:	Gio.SimpleAction

GAction represents a single named action.
The main interface to an action is that it can be activated with
g_action_activate(). This results in the 'activate' signal being
emitted. An activation has a GVariant parameter (which may be
NULL). 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 g_action_set_state(). This call takes a GVariant. 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.
GAction is merely the interface to the concept of an action, as
described above. Various implementations of actions exist, including
GSimpleAction and GtkAction.
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 responsible for filtering
calls to g_action_activate() and g_action_set_state() for type safety
and for the state being enabled.
Probably the only useful thing to do with a GAction is to put it
inside of a GSimpleActionGroup.

Properties
Properties		Defined By
	enabled : gboolean If action is currently enabled. If action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_set_state() have no effect.	Gio.Action
	name : String The name of the action. The name of the action. This is mostly meaningful for identifying the action once it has been added to a GActionGroup.	Gio.Action
	state : GLib.Variant The state of the action, or NULL if the action is stateless. The state of the action, or NULL if the action is stateless.	Gio.Action

Methods / Constructors
Method / Constructor		Defined By
	activate (Variant *parameter) : none Activates the action. Activates the action. the parameter type given at construction time). If the parameter type was NULL* then parameter must also be NULL. Parameters: GLib.Variant parameter the parameter to the activation Returns: none	Gio.Action
	get_enabled () : gboolean Checks if action is currently 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. Returns: gboolean whether the action is enabled	Gio.Action
	get_name () : String Queries the name of action. Queries the name of action. Returns: String the name of the action	Gio.Action
	get_parameter_type () : GLib.VariantType Queries the type of the parameter that must be given when activating When activating the action using g_action_activate(), the GVariant given to that function must be of the type returned by this function. Queries the type of the parameter that must be given when activating When activating the action using g_action_activate(), the GVariant 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 GVariant, but NULL instead. Returns: GLib.VariantType the parameter type	Gio.Action
	get_state () : GLib.Variant Queries the current state of action. 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 g_action_get_state_type(). The return value (if non-NULL) should be freed with g_variant_unref() when it is no longer required. Returns: GLib.Variant the current state of the action	Gio.Action
	get_state_hint () : GLib.Variant Requests a hint about the valid range of values for the state of 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. Requests a hint about the valid range of values for the state of 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 GVariant array is returned then each item in the array is a 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 g_variant_unref() when it is no longer required. Returns: GLib.Variant the state range hint	Gio.Action
	get_state_type () : GLib.VariantType Queries the type of the state of action. Queries the type of the state of action. g_action_new_stateful()) then this function returns the GVariantType of the state. This is the type of the initial value given as the state. All calls to g_action_set_state() must give a GVariant of this type and g_action_get_state() will return a GVariant of the same type. this function will return NULL. In that case, g_action_get_state() will return NULL and you must not call g_action_set_state(). Returns: GLib.VariantType the state type, if the action is stateful	Gio.Action
	set_state (Variant *value) : none Request for the state of action* to be changed to value. 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 g_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 g_action_get_state_hint(). If the value GVariant is floating, it is consumed. Parameters: GLib.Variant value Required (not null) the new state Returns: none	Gio.Action

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio.SimpleActionGroup Method	insert (Action *action*) : none Adds an action to the action group.
Gio.SimpleActionGroup Method	lookup (String *action_name) : Gio.Action Looks up the action with the name action_name* in the group.