class Gio::PropertyAction

• Gio::PropertyAction
• GObject::Object
• Reference
• Object

Overview

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 #Gtk::Stack 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.

An anti-example would be binding the "active-id" property on a #Gtk::ComboBox. 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 #Gtk::Stack 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().

Included Modules

• Gio::Action

Defined in:

Constructors

• .new(name : String, object : GObject::Object, property_name : String) : self

  Creates a #GAction corresponding to the value of property property_name on object.

• .new

  Initialize a new PropertyAction.

• .new(*, enabled : Bool | Nil = nil, invert_boolean : Bool | Nil = nil, name : String | Nil = nil, object : GObject::Object | Nil = nil, parameter_type : GLib::VariantType | Nil = nil, property_name : String | Nil = nil, state : GLib::Variant | Nil = nil, state_type : GLib::VariantType | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #enabled? : Bool
• #hash(hasher)

  See Object#hash(hasher)

• #invert_boolean=(value : Bool) : Bool
• #invert_boolean? : Bool
• #name : String
• #name=(value : String) : String
• #name=(value : Nil) : Nil

  Set #name property to nil.

• #name? : String | Nil

  Same as #name, but can return nil.

• #object=(value : GObject::Object | Nil) : GObject::Object | Nil
• #parameter_type : GLib::VariantType | Nil
• #property_name=(value : String) : String
• #property_name=(value : Nil) : Nil

  Set #property_name property to nil.

• #state : GLib::Variant | Nil
• #state_type : GLib::VariantType | Nil

Constructor Detail

Class Method Detail

Instance Method Detail