GObject.Object
Gio.SimpleAction
Import line: | Gio = imports.gi.Gio; |
GIR File: | Gio-2.0.gir |
C documentation: | GSimpleAction |
Class : | SimpleAction |
Implements: | Gio.Action |
Extends: | GObject.Object |
Properties | Defined By | |
---|---|---|
enabled : gboolean
If action is currently enabled.
If action is currently enabled.
If the action is disabled then calls to g_simple_action_activate() and g_simple_action_set_state() have no effect. |
Gio.SimpleAction | |
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 GSimpleActionGroup. |
Gio.SimpleAction | |
parent_instance : GObject.Object
read only
|
Gio.SimpleAction | |
priv : Gio.SimpleActionPrivate
read only
|
Gio.SimpleAction | |
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.SimpleAction |
Method / Constructor | Defined By | |
---|---|---|
new Gio.SimpleAction
(Object properties)
Create a new Gio.SimpleAction
Create a new Gio.SimpleAction
|
||
Create a new Gio.SimpleAction
Create a new Gio.SimpleAction
|
||
new Gio.SimpleAction.stateful
(String name, VariantType parameter_type, Variant state)
:
Gio.SimpleAction
Create a new Gio.SimpleAction
Create a new Gio.SimpleAction
|
||
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.
|
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.
|
Gio.Action | |
get_name
()
:
String
Queries the name of action.
Queries the name of 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.
|
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.
|
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.
|
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().
|
Gio.Action | |
set_enabled
(gboolean enabled)
:
none
Sets the action as enabled or not.
Sets the action as enabled or not.
An action must be enabled in order to be activated or in order to have its state changed from outside callers.
|
Gio.SimpleAction | |
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.
|
Gio.Action |
Event | Defined By | |
---|---|---|
activate (SimpleAction self, Variant parameter)
:
none
Indicates that the action was just activated.
Indicates that the action was just activated.
an incorrect type was given, no signal will be emitted.
|
Gio.SimpleAction |