class: PropertyAction

[47:7] extends: object

A GPropertyAction is 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 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 [iface@Gio.Action] 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 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-name property 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].

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• PropertyAction (name = null, object = null, property_name = null)

  Creates a #GAction corresponding 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.

  • @p name is the name of the action to create.
  • @p object is the object that has the property to wrap.
  • @p property_name is the name of the property.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• asAction ()

  Wraps this handle as Action.

  • @r A Action object.

class: PropertyActionMeta

[160:14] static extends: object

Generated metadata helpers for PropertyAction class surfaces.

Methods

• properties ()

  Returns property metadata for PropertyAction.

  • @r A list.