gio/org.gtkkn.bindings.gio/PropertyAction

PropertyAction

open class PropertyAction(pointer: <Error class: unknown class><<Error class: unknown class>>) : Action

A #GPropertyAction is a way to get a #GAction with a state value reflecting and controlling the value of a #GObject 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 #GParamSpec).

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 #GEnumValue 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 #GVariant 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). #GPropertyAction 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 #GAction corresponding to the "visible-child-name" property 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 the #GtkStack.

An anti-example would be binding the "active-id" property on a #GtkComboBox. This is because the state of the combobox itself is probably uninteresting and is actually being used to control something else.

Another anti-example would be to bind to the "visible-child-name" property of a #GtkStack if this value is actually stored in #GSettings. In that case, the real source of the value is #GSettings. If you want a #GAction to control a setting stored in #GSettings, see g_settings_create_action() instead, and possibly combine its use with g_settings_bind().

Skipped during bindings generation

method enabled: Property has no getter nor setter
method invert-boolean: Property has no getter nor setter
method name: Property has no getter nor setter
method object: Property has no getter nor setter
method parameter-type: Property has no getter nor setter
method property-name: Property has no getter nor setter
method state: Property has no getter nor setter
method state-type: Property has no getter nor setter

Since

2.38

Constructors

PropertyAction

constructor(name: String, object: <Error class: unknown class>, propertyName: String)

Creates a #GAction corresponding to the value of property

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

enabled

open val enabled: Boolean

If @action is currently enabled.

gioActionPointer

open override val gioActionPointer: <Error class: unknown class><<Error class: unknown class>>

gioPropertyActionPointer

val gioPropertyActionPointer: <Error class: unknown class><<Error class: unknown class>>

name

open val name: String

The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GActionGroup. It is immutable.

parameterType

open val parameterType: <Error class: unknown class>?

The type of the parameter that must be given when activating the action. This is immutable, and may be null if no parameter is needed when activating the action.

state

open val state: <Error class: unknown class>?

The state of the action, or null if the action is stateless.

stateType

open val stateType: <Error class: unknown class>?

The #GVariantType of the state that the action has, or null if the action is stateless. This is immutable.