gi-gobject
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GObject.Objects.Binding

Description

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:

c code

 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 GObject.GObject.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:

c code

 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:

c code

 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 celsiusToFahrenheit function will be called whenever the "value" property of adjustment1 changes and will transform the current value of the property before applying it to the "value" property of adjustment2.

Vice versa, the fahrenheitToCelsius function will be called whenever the "value" property of adjustment2 changes, and will transform the current value of the property before applying it to the "value" property of adjustment1.

Note that Binding does not resolve cycles by itself; a cycle like

 object1:propertyA -> object2:propertyB
 object2:propertyB -> object3:propertyC
 object3:propertyC -> object1:propertyA

might lead to an infinite loop. The loop, in this particular case, can be avoided if the objects emit the GObject::notify signal only if the value has effectively been changed. A binding is implemented using the GObject::notify signal, so it is susceptible to all the various ways of blocking a signal emission, like signalStopEmission or signalHandlerBlock.

A binding will be severed, and the resources it allocates freed, whenever either one of the GObject instances it refers to are finalized, or when the Binding instance loses its last reference.

Bindings for languages with garbage collection can use bindingUnbind to explicitly release a binding between the source and target properties, instead of relying on the last reference on the binding, source, and target instances to drop.

Since: 2.26

Synopsis

Exported types

newtype Binding Source #

Memory-managed wrapper type.

Constructors

Binding (ManagedPtr Binding) 

Instances

Instances details
Eq Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

(==) :: Binding -> Binding -> Bool #

(/=) :: Binding -> Binding -> Bool #

GObject Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

ManagedPtrNewtype Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

TypedObject Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

glibType :: IO GType #

HasParentTypes Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

HasAttributeList Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

(info ~ ResolveBindingMethod t Binding, OverloadedMethod info Binding p, HasField t Binding p) => HasField (t :: Symbol) Binding (p :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

getField :: Binding -> p #

(info ~ ResolveBindingMethod t Binding, OverloadedMethodInfo info Binding) => IsLabel t (MethodProxy info Binding) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

(info ~ ResolveBindingMethod t Binding, OverloadedMethod info Binding p) => IsLabel t (Binding -> p) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

fromLabel :: Binding -> p #

IsGValue (Maybe Binding) Source #

Convert Binding to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.GObject.Objects.Binding

type AttributeList Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type ParentTypes Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type SignalList Binding Source # 
Instance details

Defined in GI.GObject.Objects.Binding

class (GObject o, IsDescendantOf Binding o) => IsBinding o Source #

Type class for types which can be safely cast to Binding, for instance with toBinding.

Instances

Instances details
(GObject o, IsDescendantOf Binding o) => IsBinding o Source # 
Instance details

Defined in GI.GObject.Objects.Binding

toBinding :: (MonadIO m, IsBinding o) => o -> m Binding Source #

Cast to Binding, for types for which this is known to be safe. For general casts, use castTo.

Methods

type family ResolveBindingMethod (t :: Symbol) o where ... Source #

Equations

ResolveBindingMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveBindingMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveBindingMethod "dupSource" o = BindingDupSourceMethodInfo 
ResolveBindingMethod "dupTarget" o = BindingDupTargetMethodInfo 
ResolveBindingMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveBindingMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveBindingMethod "getv" o = ObjectGetvMethodInfo 
ResolveBindingMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveBindingMethod "notify" o = ObjectNotifyMethodInfo 
ResolveBindingMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveBindingMethod "ref" o = ObjectRefMethodInfo 
ResolveBindingMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveBindingMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveBindingMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveBindingMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveBindingMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveBindingMethod "unbind" o = BindingUnbindMethodInfo 
ResolveBindingMethod "unref" o = ObjectUnrefMethodInfo 
ResolveBindingMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveBindingMethod "getData" o = ObjectGetDataMethodInfo 
ResolveBindingMethod "getFlags" o = BindingGetFlagsMethodInfo 
ResolveBindingMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveBindingMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveBindingMethod "getSource" o = BindingGetSourceMethodInfo 
ResolveBindingMethod "getSourceProperty" o = BindingGetSourcePropertyMethodInfo 
ResolveBindingMethod "getTarget" o = BindingGetTargetMethodInfo 
ResolveBindingMethod "getTargetProperty" o = BindingGetTargetPropertyMethodInfo 
ResolveBindingMethod "setData" o = ObjectSetDataMethodInfo 
ResolveBindingMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveBindingMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveBindingMethod l o = MethodResolutionFailed l o :: Type 

dupSource

data BindingDupSourceMethodInfo Source #

Instances

Instances details
(signature ~ m (Maybe Object), MonadIO m, IsBinding a) => OverloadedMethod BindingDupSourceMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingDupSourceMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingDupSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m (Maybe Object)

Returns: the source Object, or Nothing if the source does not exist any more.

Retrieves the Object instance used as the source of the binding.

A Binding can outlive the source Object as the binding does not hold a strong reference to the source. If the source is destroyed before the binding then this function will return Nothing.

Since: 2.68

dupTarget

data BindingDupTargetMethodInfo Source #

Instances

Instances details
(signature ~ m (Maybe Object), MonadIO m, IsBinding a) => OverloadedMethod BindingDupTargetMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingDupTargetMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingDupTarget Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m (Maybe Object)

Returns: the target Object, or Nothing if the target does not exist any more.

Retrieves the Object instance used as the target of the binding.

A Binding can outlive the target Object as the binding does not hold a strong reference to the target. If the target is destroyed before the binding then this function will return Nothing.

Since: 2.68

getFlags

data BindingGetFlagsMethodInfo Source #

Instances

Instances details
(signature ~ m [BindingFlags], MonadIO m, IsBinding a) => OverloadedMethod BindingGetFlagsMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingGetFlagsMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m [BindingFlags]

Returns: the BindingFlags used by the Binding

Retrieves the flags passed when constructing the Binding.

Since: 2.26

getSource

data BindingGetSourceMethodInfo Source #

Instances

Instances details
(signature ~ m (Maybe Object), MonadIO m, IsBinding a) => OverloadedMethod BindingGetSourceMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingGetSourceMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingGetSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m (Maybe Object)

Returns: the source Object, or Nothing if the source does not exist any more.

Deprecated: (Since version 2.68)Use bindingDupSource for a safer version of thisfunction.

Retrieves the Object instance used as the source of the binding.

A Binding can outlive the source Object as the binding does not hold a strong reference to the source. If the source is destroyed before the binding then this function will return Nothing.

Use bindingDupSource if the source or binding are used from different threads as otherwise the pointer returned from this function might become invalid if the source is finalized from another thread in the meantime.

Since: 2.26

getSourceProperty

bindingGetSourceProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m Text

Returns: the name of the source property

Retrieves the name of the property of Binding:source used as the source of the binding.

Since: 2.26

getTarget

data BindingGetTargetMethodInfo Source #

Instances

Instances details
(signature ~ m (Maybe Object), MonadIO m, IsBinding a) => OverloadedMethod BindingGetTargetMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingGetTargetMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingGetTarget Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m (Maybe Object)

Returns: the target Object, or Nothing if the target does not exist any more.

Deprecated: (Since version 2.68)Use bindingDupTarget for a safer version of thisfunction.

Retrieves the Object instance used as the target of the binding.

A Binding can outlive the target Object as the binding does not hold a strong reference to the target. If the target is destroyed before the binding then this function will return Nothing.

Use bindingDupTarget if the target or binding are used from different threads as otherwise the pointer returned from this function might become invalid if the target is finalized from another thread in the meantime.

Since: 2.26

getTargetProperty

bindingGetTargetProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m Text

Returns: the name of the target property

Retrieves the name of the property of Binding:target used as the target of the binding.

Since: 2.26

unbind

data BindingUnbindMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m, IsBinding a) => OverloadedMethod BindingUnbindMethodInfo a signature Source # 
Instance details

Defined in GI.GObject.Objects.Binding

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo BindingUnbindMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.GObject.Objects.Binding

bindingUnbind Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> a

binding: a Binding

-> m () 

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

This function will release the reference that is being held on the binding instance if the binding is still bound; if you want to hold on to the Binding instance after calling bindingUnbind, you will need to hold a reference to it.

Note however that this function does not take ownership of binding, it only unrefs the reference that was initially created by objectBindProperty and is owned by the binding.

Since: 2.38

Properties

flags

Flags to be used to control the Binding

Since: 2.26

data BindingFlagsPropertyInfo Source #

Instances

Instances details
AttrInfo BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrAllowedOps BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrBaseTypeConstraint BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrGetType BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrLabel BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrOrigin BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrSetTypeConstraint BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferType BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferTypeConstraint BindingFlagsPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

constructBindingFlags :: (IsBinding o, MonadIO m) => [BindingFlags] -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “flags” property. This is rarely needed directly, but it is used by new.

getBindingFlags :: (MonadIO m, IsBinding o) => o -> m [BindingFlags] Source #

Get the value of the “flags” property. When overloading is enabled, this is equivalent to

get binding #flags

source

The Object that should be used as the source of the binding

Since: 2.26

data BindingSourcePropertyInfo Source #

Instances

Instances details
AttrInfo BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrAllowedOps BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrBaseTypeConstraint BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrGetType BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrLabel BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrOrigin BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrSetTypeConstraint BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferType BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferTypeConstraint BindingSourcePropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

constructBindingSource :: (IsBinding o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “source” property. This is rarely needed directly, but it is used by new.

getBindingSource :: (MonadIO m, IsBinding o) => o -> m (Maybe Object) Source #

Get the value of the “source” property. When overloading is enabled, this is equivalent to

get binding #source

sourceProperty

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

This should be in [canonical form][classgObject.ParamSpecparameter-names] to get the best performance.

Since: 2.26

data BindingSourcePropertyPropertyInfo Source #

Instances

Instances details
AttrInfo BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrAllowedOps BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrBaseTypeConstraint BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrGetType BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrLabel BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrOrigin BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrSetTypeConstraint BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferType BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferTypeConstraint BindingSourcePropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

constructBindingSourceProperty :: (IsBinding o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “source-property” property. This is rarely needed directly, but it is used by new.

getBindingSourceProperty :: (MonadIO m, IsBinding o) => o -> m Text Source #

Get the value of the “source-property” property. When overloading is enabled, this is equivalent to

get binding #sourceProperty

target

The Object that should be used as the target of the binding

Since: 2.26

data BindingTargetPropertyInfo Source #

Instances

Instances details
AttrInfo BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrAllowedOps BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrBaseTypeConstraint BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrGetType BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrLabel BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrOrigin BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrSetTypeConstraint BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferType BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferTypeConstraint BindingTargetPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

constructBindingTarget :: (IsBinding o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “target” property. This is rarely needed directly, but it is used by new.

getBindingTarget :: (MonadIO m, IsBinding o) => o -> m (Maybe Object) Source #

Get the value of the “target” property. When overloading is enabled, this is equivalent to

get binding #target

targetProperty

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

This should be in [canonical form][classgObject.ParamSpecparameter-names] to get the best performance.

Since: 2.26

data BindingTargetPropertyPropertyInfo Source #

Instances

Instances details
AttrInfo BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrAllowedOps BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrBaseTypeConstraint BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrGetType BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrLabel BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrOrigin BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrSetTypeConstraint BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferType BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

type AttrTransferTypeConstraint BindingTargetPropertyPropertyInfo Source # 
Instance details

Defined in GI.GObject.Objects.Binding

constructBindingTargetProperty :: (IsBinding o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “target-property” property. This is rarely needed directly, but it is used by new.

getBindingTargetProperty :: (MonadIO m, IsBinding o) => o -> m Text Source #

Get the value of the “target-property” property. When overloading is enabled, this is equivalent to

get binding #targetProperty