GI.Clutter.Objects.BindConstraint

BindConstraint is an opaque structure whose members cannot be directly accessed

Since: 1.4

Exported types

newtype BindConstraint

Memory-managed wrapper type.

Constructors

BindConstraint (ManagedPtr BindConstraint)

Instances

Eq BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

Methods

(==) :: BindConstraint -> BindConstraint -> Bool

(/=) :: BindConstraint -> BindConstraint -> Bool

GObject BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

ManagedPtrNewtype BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

Methods

toManagedPtr :: BindConstraint -> ManagedPtr BindConstraint

TypedObject BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

Methods

glibType :: IO GType

HasParentTypes BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

IsGValue (Maybe BindConstraint)

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

Defined in GI.Clutter.Objects.BindConstraint

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BindConstraint -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BindConstraint)

type ParentTypes BindConstraint

Defined in GI.Clutter.Objects.BindConstraint

type ParentTypes BindConstraint = '[Constraint, ActorMeta, Object]

class (GObject o, IsDescendantOf BindConstraint o) => IsBindConstraint o

Type class for types which can be safely cast to BindConstraint, for instance with toBindConstraint.

Instances

(GObject o, IsDescendantOf BindConstraint o) => IsBindConstraint o

Defined in GI.Clutter.Objects.BindConstraint

toBindConstraint :: (MonadIO m, IsBindConstraint o) => o -> m BindConstraint

Cast to BindConstraint, 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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getCoordinate, getData, getEnabled, getName, getOffset, getProperty, getQdata, getSource.

Setters

setCoordinate, setData, setDataFull, setEnabled, setName, setOffset, setProperty, setSource.

getCoordinate

bindConstraintGetCoordinate

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a)

=> a

constraint: a BindConstraint

-> m BindCoordinate

Returns: the bound coordinate

Retrieves the bound coordinate of the constraint

Since: 1.4

getOffset

bindConstraintGetOffset

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a)

=> a

constraint: a BindConstraint

-> m Float

Returns: the offset, in pixels

Retrieves the offset set using bindConstraintSetOffset

Since: 1.4

getSource

bindConstraintGetSource

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a)

=> a

constraint: a BindConstraint

-> m Actor

Returns: a pointer to the source actor

Retrieves the Actor set using bindConstraintSetSource

Since: 1.4

new

bindConstraintNew

Arguments

:: (HasCallStack, MonadIO m, IsActor a)

=> Maybe a

source: the Actor to use as the source of the binding, or Nothing

-> BindCoordinate

coordinate: the coordinate to bind

-> Float

offset: the offset to apply to the binding, in pixels

-> m BindConstraint

Returns: the newly created BindConstraint

Creates a new constraint, binding a Actor's position to the given coordinate of the position of source

Since: 1.4

setCoordinate

bindConstraintSetCoordinate

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a)

=> a

constraint: a BindConstraint

-> BindCoordinate

coordinate: the coordinate to bind

-> m ()

Sets the coordinate to bind in the constraint

Since: 1.4

setOffset

bindConstraintSetOffset

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a)

=> a

constraint: a BindConstraint

-> Float

offset: the offset to apply, in pixels

-> m ()

Sets the offset to be applied to the constraint

Since: 1.4

setSource

bindConstraintSetSource

Arguments

:: (HasCallStack, MonadIO m, IsBindConstraint a, IsActor b)

=> a

constraint: a BindConstraint

-> Maybe b

source: a Actor, or Nothing to unset the source

-> m ()

Sets the source Actor for the constraint

Since: 1.4

Properties

coordinate

The coordinate to be bound

Since: 1.4

constructBindConstraintCoordinate :: (IsBindConstraint o, MonadIO m) => BindCoordinate -> m (GValueConstruct o)

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

getBindConstraintCoordinate :: (MonadIO m, IsBindConstraint o) => o -> m BindCoordinate

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

get bindConstraint #coordinate

setBindConstraintCoordinate :: (MonadIO m, IsBindConstraint o) => o -> BindCoordinate -> m ()

Set the value of the “coordinate” property. When overloading is enabled, this is equivalent to

set bindConstraint [ #coordinate := value ]

offset

The offset, in pixels, to be applied to the binding

Since: 1.4

constructBindConstraintOffset :: (IsBindConstraint o, MonadIO m) => Float -> m (GValueConstruct o)

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

getBindConstraintOffset :: (MonadIO m, IsBindConstraint o) => o -> m Float

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

get bindConstraint #offset

setBindConstraintOffset :: (MonadIO m, IsBindConstraint o) => o -> Float -> m ()

Set the value of the “offset” property. When overloading is enabled, this is equivalent to

set bindConstraint [ #offset := value ]

source

The Actor used as the source for the binding.

The Actor must not be contained inside the actor associated to the constraint.

Since: 1.4

clearBindConstraintSource :: (MonadIO m, IsBindConstraint o) => o -> m ()

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

clear #source

constructBindConstraintSource :: (IsBindConstraint o, MonadIO m, IsActor a) => a -> m (GValueConstruct o)

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

getBindConstraintSource :: (MonadIO m, IsBindConstraint o) => o -> m Actor

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

get bindConstraint #source

setBindConstraintSource :: (MonadIO m, IsBindConstraint o, IsActor a) => o -> a -> m ()

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

set bindConstraint [ #source := value ]