PropertyAction

A gio.property_action.PropertyAction is a way to get a gio.action.Action with a state value reflecting and controlling the value of a gobject.object.ObjectG 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 gobject.param_spec.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 gobject.enum_value.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 glib.variant.VariantG 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). gio.property_action.PropertyAction 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 gio.action.Action corresponding to the visible-child-name property of a [gtk.stack.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.Stack.

An anti-example would be binding the active-id property on a [gtk.combo_box.ComboBox]. 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 [gtk.stack.Stack] if this value is actually stored in gio.settings.Settings. In that case, the real source of the value is* gio.settings.Settings. If you want a gio.action.Action to control a setting stored in gio.settings.Settings, see gio.settings.Settings.createAction instead, and possibly combine its use with gio.settings.Settings.bind.

Constructors

this
this(string name, gobject.object.ObjectG object, string propertyName)

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

Mixed In Members

From mixin ActionT!()

activate
void activate(glib.variant.VariantG parameter)

Activates the action.

changeState
void changeState(glib.variant.VariantG value)

Request for the state of action to be changed to value.

getEnabled
bool getEnabled()

Checks if action is currently enabled.

getName
string getName()

Queries the name of action.

getParameterType
glib.variant_type.VariantType getParameterType()

Queries the type of the parameter that must be given when activating action.

getState
glib.variant.VariantG getState()

Queries the current state of action.

getStateHint
glib.variant.VariantG getStateHint()

Requests a hint about the valid range of values for the state of action.

getStateType
glib.variant_type.VariantType getStateType()

Queries the type of the state of action.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From Action

nameIsValid
bool nameIsValid(string actionName)

Checks if action_name is valid.

parseDetailedName
bool parseDetailedName(string detailedName, string actionName, glib.variant.VariantG targetValue)

Parses a detailed action name into its separate name and target components.

printDetailedName
string printDetailedName(string actionName, glib.variant.VariantG targetValue)

Formats a detailed action name from action_name and target_value.

activate
void activate(glib.variant.VariantG parameter)

Activates the action.

changeState
void changeState(glib.variant.VariantG value)

Request for the state of action to be changed to value.

getEnabled
bool getEnabled()

Checks if action is currently enabled.

getName
string getName()

Queries the name of action.

getParameterType
glib.variant_type.VariantType getParameterType()

Queries the type of the parameter that must be given when activating action.

getState
glib.variant.VariantG getState()

Queries the current state of action.

getStateHint
glib.variant.VariantG getStateHint()

Requests a hint about the valid range of values for the state of action.

getStateType
glib.variant_type.VariantType getStateType()

Queries the type of the state of action.