gobject/org.gtkkn.bindings.gobject/Binding

Binding

open class Binding(pointer: <Error class: unknown class><<Error class: unknown class>>) : Object, KGTyped

#GBinding is the representation of a binding between a property on a #GObject instance (or source) and another property on another #GObject instance (or target).

Whenever the source property changes, the same value is applied to the target property; for instance, the following binding:

| g_object_bind_property (object1, "property-a", object2, "property-b", G_BINDING_DEFAULT); |

will cause the property named "property-b" of @object2 to be updated every time g_object_set() or the specific accessor changes the value of the property "property-a" of @object1.

It is possible to create a bidirectional binding between two properties of two #GObject instances, so that if either property changes, the other is updated as well, for instance:

| g_object_bind_property (object1, "property-a", object2, "property-b", G_BINDING_BIDIRECTIONAL); |

will keep the two properties in sync.

It is also possible to set a custom transformation function (in both directions, in case of a bidirectional binding) to apply a custom transformation from the source value to the target value before applying it; for instance, the following binding:

| g_object_bind_property_full (adjustment1, "value", adjustment2, "value", G_BINDING_BIDIRECTIONAL, celsius_to_fahrenheit, fahrenheit_to_celsius, NULL, NULL); |

will keep the "value" property of the two adjustments in sync; the

Since

2.26

Constructors

Binding

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

Types

Companion

object Companion : TypeCompanion<Binding>

Properties

flags

open val flags: BindingFlags

Flags to be used to control the #GBinding

gobjectBindingPointer

val gobjectBindingPointer: <Error class: unknown class><<Error class: unknown class>>

gPointer

val gPointer: <Error class: unknown class><<Error class: unknown class>>

source

open val source: Object?

The #GObject that should be used as the source of the binding

sourceProperty

open val sourceProperty: String

The name of the property of #GBinding:source that should be used as the source of the binding.

target

open val target: Object?

The #GObject that should be used as the target of the binding

targetProperty

open val targetProperty: String

The name of the property of #GBinding:target that should be used as the target of the binding.

Functions

asType

inline fun <T : KGTyped> Object.asType(): T

Convert object into type T.

bindProperty

open fun bindProperty(sourceProperty: String, target: Object, targetProperty: String, flags: BindingFlags): Binding

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

bindPropertyFull

open fun bindPropertyFull(sourceProperty: String, target: Object, targetProperty: String, flags: BindingFlags, transformTo: Closure, transformFrom: Closure): Binding

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.

connectNotify

fun connectNotify(connectFlags: ConnectFlags = ConnectFlags(0u), handler: (pspec: ParamSpec) -> Unit): <Error class: unknown class>

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

dupSource

open fun dupSource(): Object?

Retrieves the #GObject instance used as the source of the binding.

dupTarget

open fun dupTarget(): Object?

Retrieves the #GObject instance used as the target of the binding.

forceFloating

open fun forceFloating()

This function is intended for #GObject implementations to re-enforce a 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 g_object_ref_sink().

freezeNotify

open fun 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.

getBooleanProperty

fun Object.getBooleanProperty(propertyName: String): Boolean

getFlags

open fun getFlags(): BindingFlags

Retrieves the flags passed when constructing the #GBinding.

getIntProperty

fun Object.getIntProperty(propertyName: String): Int

getProperty

open fun getProperty(propertyName: String, value: Value)

Gets a property of an object.

getSource

open fun getSource(): Object?

Retrieves the #GObject instance used as the source of the binding.

getSourceProperty

open fun getSourceProperty(): String

Retrieves the name of the property of #GBinding:source used as the source of the binding.

getStringProperty

fun Object.getStringProperty(propertyName: String): String?

getTarget

open fun getTarget(): Object?

Retrieves the #GObject instance used as the target of the binding.

getTargetProperty

open fun getTargetProperty(): String

Retrieves the name of the property of #GBinding:target used as the target of the binding.

isFloating

open fun isFloating(): Boolean

Checks whether @object has a floating-ref reference.

notify

open fun notify(propertyName: String)

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

notifyByPspec

open fun notifyByPspec(pspec: ParamSpec)

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

ref

open fun ref(): Object

Increases the reference count of @object.

refSink

open fun refSink(): Object

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

runDispose

open fun runDispose()

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

setProperty

open fun setProperty(propertyName: String, value: Value)

Sets a property on an object.

setProperty

fun Object.setProperty(propertyName: String, value: Boolean)

fun Object.setProperty(propertyName: String, value: Int)

fun Object.setProperty(propertyName: String, value: String?)

thawNotify

open fun thawNotify()

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

unbind

open fun unbind()

Explicitly releases the binding between the source and the target property expressed by @binding.

unref

open fun unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure

open fun watchClosure(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 g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the