| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GObject.Objects.BindingGroup
Description
GBindingGroup can be used to bind multiple properties
from an object collectively.
Use the various methods to bind properties from a single source
object to multiple destination objects. Properties can be bound
bidirectionally and are connected when the source object is set
with bindingGroupSetSource.
Since: 2.72
Synopsis
- newtype BindingGroup = BindingGroup (ManagedPtr BindingGroup)
- class (GObject o, IsDescendantOf BindingGroup o) => IsBindingGroup o
- toBindingGroup :: (MonadIO m, IsBindingGroup o) => o -> m BindingGroup
- type family ResolveBindingGroupMethod (t :: Symbol) o where ...
- data BindingGroupBindMethodInfo
- bindingGroupBind :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) => a -> Text -> b -> Text -> [BindingFlags] -> m ()
- data BindingGroupBindFullMethodInfo
- bindingGroupBindFull :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) => a -> Text -> b -> Text -> [BindingFlags] -> Maybe (GClosure c) -> Maybe (GClosure d) -> m ()
- data BindingGroupDupSourceMethodInfo
- bindingGroupDupSource :: (HasCallStack, MonadIO m, IsBindingGroup a) => a -> m (Maybe Object)
- bindingGroupNew :: (HasCallStack, MonadIO m) => m BindingGroup
- data BindingGroupSetSourceMethodInfo
- bindingGroupSetSource :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) => a -> Maybe b -> m ()
- data BindingGroupSourcePropertyInfo
- bindingGroupSource :: AttrLabelProxy "source"
- clearBindingGroupSource :: (MonadIO m, IsBindingGroup o) => o -> m ()
- constructBindingGroupSource :: (IsBindingGroup o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getBindingGroupSource :: (MonadIO m, IsBindingGroup o) => o -> m (Maybe Object)
- setBindingGroupSource :: (MonadIO m, IsBindingGroup o, IsObject a) => o -> a -> m ()
Exported types
newtype BindingGroup Source #
Memory-managed wrapper type.
Constructors
| BindingGroup (ManagedPtr BindingGroup) |
Instances
class (GObject o, IsDescendantOf BindingGroup o) => IsBindingGroup o Source #
Type class for types which can be safely cast to BindingGroup, for instance with toBindingGroup.
Instances
| (GObject o, IsDescendantOf BindingGroup o) => IsBindingGroup o Source # | |
Defined in GI.GObject.Objects.BindingGroup | |
toBindingGroup :: (MonadIO m, IsBindingGroup o) => o -> m BindingGroup Source #
Cast to BindingGroup, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
bind, bindFull, bindProperty, bindPropertyFull, dupSource, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata.
Setters
type family ResolveBindingGroupMethod (t :: Symbol) o where ... Source #
Equations
bind
data BindingGroupBindMethodInfo Source #
Instances
| (signature ~ (Text -> b -> Text -> [BindingFlags] -> m ()), MonadIO m, IsBindingGroup a, IsObject b) => OverloadedMethod BindingGroupBindMethodInfo a signature Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BindingGroupBindMethodInfo (a :: Type) Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) | |
| => a |
|
| -> Text |
|
| -> b |
|
| -> Text |
|
| -> [BindingFlags] |
|
| -> m () |
Creates a binding between sourceProperty on the source object
and targetProperty on target. Whenever the sourceProperty
is changed the targetProperty is updated using the same value.
The binding flag BindingFlagsSyncCreate is automatically specified.
See objectBindProperty for more information.
Since: 2.72
bindFull
data BindingGroupBindFullMethodInfo Source #
Instances
| (signature ~ (Text -> b -> Text -> [BindingFlags] -> Maybe (GClosure c) -> Maybe (GClosure d) -> m ()), MonadIO m, IsBindingGroup a, IsObject b) => OverloadedMethod BindingGroupBindFullMethodInfo a signature Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BindingGroupBindFullMethodInfo (a :: Type) Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) | |
| => a |
|
| -> Text |
|
| -> b |
|
| -> Text |
|
| -> [BindingFlags] |
|
| -> Maybe (GClosure c) |
|
| -> Maybe (GClosure d) |
|
| -> m () |
Creates a binding between sourceProperty on the source object and
targetProperty on target, allowing you to set the transformation
functions to be used by the binding. The binding flag
BindingFlagsSyncCreate is automatically specified.
This function is the language bindings friendly version of
g_binding_group_bind_property_full(), using GClosures
instead of function pointers.
See objectBindPropertyFull for more information.
Since: 2.72
dupSource
data BindingGroupDupSourceMethodInfo Source #
Instances
| (signature ~ m (Maybe Object), MonadIO m, IsBindingGroup a) => OverloadedMethod BindingGroupDupSourceMethodInfo a signature Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BindingGroupDupSourceMethodInfo (a :: Type) Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods | |
bindingGroupDupSource Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBindingGroup a) | |
| => a |
|
| -> m (Maybe Object) |
Gets the source object used for binding properties.
Since: 2.72
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m BindingGroup | Returns: a new |
Creates a new BindingGroup.
Since: 2.72
setSource
data BindingGroupSetSourceMethodInfo Source #
Instances
| (signature ~ (Maybe b -> m ()), MonadIO m, IsBindingGroup a, IsObject b) => OverloadedMethod BindingGroupSetSourceMethodInfo a signature Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BindingGroupSetSourceMethodInfo (a :: Type) Source # | |
Defined in GI.GObject.Objects.BindingGroup Methods | |
bindingGroupSetSource Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBindingGroup a, IsObject b) | |
| => a |
|
| -> Maybe b | |
| -> m () |
Sets source as the source object used for creating property
bindings. If there is already a source object all bindings from it
will be removed.
Note that all properties that have been bound must exist on source.
Since: 2.72
Properties
source
The source object used for binding properties.
Since: 2.72
data BindingGroupSourcePropertyInfo Source #
Instances
bindingGroupSource :: AttrLabelProxy "source" Source #
clearBindingGroupSource :: (MonadIO m, IsBindingGroup o) => o -> m () Source #
Set the value of the “source” property to Nothing.
When overloading is enabled, this is equivalent to
clear #source
constructBindingGroupSource :: (IsBindingGroup 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.
getBindingGroupSource :: (MonadIO m, IsBindingGroup o) => o -> m (Maybe Object) Source #
Get the value of the “source” property.
When overloading is enabled, this is equivalent to
get bindingGroup #source
setBindingGroupSource :: (MonadIO m, IsBindingGroup o, IsObject a) => o -> a -> m () Source #
Set the value of the “source” property.
When overloading is enabled, this is equivalent to
setbindingGroup [ #source:=value ]