Package: gio

Class gio:property-action

Superclasses

gio:action, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

enabled
The enabled property of type :boolean (Read)
Whether the action is currently enabled. If the action is disabled then calls to the g:action-activate and g:action-change-state functions have no effect.
Default value: true
invert-boolean
The invert-boolean property of type :boolean (Read / Write / Construct Only)
If true, the state of the action will be the negation of the property value, provided the property is boolean.
Default value: false
name
The name property of type :string (Read / Write / Construct Only)
The name of the action. This is mostly meaningful for identifying the action once it has been added to a g:action-map instance.
Default value: nil
object
The object property of type g:object (Write / Construct Only)
The object to wrap a property on. The object must be a g:object instance with properties.
Note: In the Lisp binding this property is not readable and not writeable.
parameter-type
The parameter-type property of type g:variant-type (Read)
The type of the parameter that must be given when activating the action.
property-name
The property-name property of type :string (Write / Construct only)
The name of the property to wrap on the object. The property must exist on the passed-in object and it must be readable and writable and not construct-only.
Note: In the Lisp binding this property is not readable und not writeable.
state
The state property of type g:variant (Read)
The state of the action, or the cffi:null-pointer value if the action is stateless.
state-type
The state-type property of type g:variant-type (Read)
The variant parameter type of the state that the action has, or nil if the action is stateless.

Details

The g:property-action class is a way to get a g:action object with a state value reflecting and controlling the value of a g:object property. The state of the action will correspond to the value of the property. Changing it will change the property, assuming the requested value matches the requirements as specified in the g:param-spec instance.

Only the most common types are presently supported. Booleans are mapped to booleans, strings to strings, signed/unsigned integers to int32/uint32 and floats and doubles to doubles. If the property is an enumeration then the state will be string-typed and conversion will automatically be performed between the enumeration value and "nick" string.

Flags types are not currently supported. Properties of object types, boxed types and pointer types are not supported and probably never will be. Properties of g:variant parameter types are not currently supported.

If the property is boolean-valued then the action will have a NULL parameter type, and activating the action with no parameter will toggle the value of the property. In all other cases, the parameter type will correspond to the type of the property.

The general idea here is to reduce the number of locations where a particular piece of state is kept and therefore has to be synchronised between. The g:property-action object does not have a separate state that is kept in sync with the property value, its state is the property value.

For example, it might be useful to create a g:action object corresponding to the visible-child-name property of a gtk:stack widget so that the current page can be switched from a menu. The active radio indication in the menu is then directly determined from the active page of the gtk:stack widget.

An anti-example would be to bind to the visible-child-name property of a gtk:stack widget if this value is actually stored in GSettings. In that case, the real source of the value is GSettings. If you want a g:action object to control a setting stored in GSettings, see the g_settings_create_action() function instead, and possibly combine its use with the g_settings_bind() function.
 

Returned by

Slot Access Functions

Inherited Slot Access Functions

See also

2024-12-29