Gio.PropertyAction¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/co |
|||
w/co |
|||
w/co |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Gio.PropertyAction(**kwargs)¶
- Bases:
- Abstract:
No
A
GPropertyActionis a way to get a [iface`Gio`.Action] with a state value reflecting and controlling the value of a [class`GObject`.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 [type`GObject`.ParamSpec]).
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 enum then the state will be string-typed and conversion will automatically be performed between the enum value and ‘nick’ string as per the [type`GObject`.EnumValue] table.
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 [type`GLib`.Variant] types are not currently supported.
If the property is boolean-valued then the action will have a
NULLparameter 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).
GPropertyActiondoes 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 [iface`Gio`.Action] corresponding to the
visible-child-nameproperty of a GtkStack 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 theGtkStack.An anti-example would be binding the
active-idproperty on a GtkComboBox. This is because the state of the combo box itself is probably uninteresting and is actually being used to control something else.Another anti-example would be to bind to the
visible-child-nameproperty of a GtkStack if this value is actually stored in [class`Gio`.Settings]. In that case, the real source of the value is* [class`Gio`.Settings]. If you want a [iface`Gio`.Action] to control a setting stored in [class`Gio`.Settings], see [method`Gio`.Settings.create_action] instead, and possibly combine its use with [method`Gio`.Settings.bind].New in version 2.38.
- classmethod new(name, object, property_name)[source]¶
- Parameters:
name (
str) – the name of the action to createobject (
GObject.Object) – the object that has the property to wrapproperty_name (
str) – the name of the property
- Returns:
a new
Gio.PropertyAction- Return type:
Creates a
Gio.Actioncorresponding to the value of property property_name on object.The property must be existent and readable and writable (and not construct-only).
This function takes a reference on object and doesn’t release it until the action is destroyed.
New in version 2.38.
Property Details¶
- Gio.PropertyAction.props.invert_boolean¶
- Name:
invert-boolean- Type:
- Default Value:
- Flags:
If
True, the state of the action will be the negation of the property value, provided the property is boolean.New in version 2.46.
- Gio.PropertyAction.props.object¶
- Name:
object- Type:
- Default Value:
- Flags:
The object to wrap a property on.
The object must be a non-
NoneGObject.Objectwith properties.New in version 2.38.
- Gio.PropertyAction.props.property_name¶
- Name:
property-name- Type:
- Default Value:
- Flags:
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).
New in version 2.38.