GI.Clutter.Objects.AlignConstraint

AlignConstraint is an opaque structure whose members cannot be directly accesses

Since: 1.4

Exported types

newtype AlignConstraint

Memory-managed wrapper type.

Constructors

AlignConstraint (ManagedPtr AlignConstraint)

Instances

Eq AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

Methods

(==) :: AlignConstraint -> AlignConstraint -> Bool

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

GObject AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

ManagedPtrNewtype AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

Methods

toManagedPtr :: AlignConstraint -> ManagedPtr AlignConstraint

TypedObject AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

Methods

glibType :: IO GType

HasParentTypes AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

IsGValue (Maybe AlignConstraint)

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

Defined in GI.Clutter.Objects.AlignConstraint

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AlignConstraint

Defined in GI.Clutter.Objects.AlignConstraint

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

class (GObject o, IsDescendantOf AlignConstraint o) => IsAlignConstraint o

Type class for types which can be safely cast to AlignConstraint, for instance with toAlignConstraint.

Instances

(GObject o, IsDescendantOf AlignConstraint o) => IsAlignConstraint o

Defined in GI.Clutter.Objects.AlignConstraint

toAlignConstraint :: (MonadIO m, IsAlignConstraint o) => o -> m AlignConstraint

Cast to AlignConstraint, 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, getAlignAxis, getData, getEnabled, getFactor, getName, getProperty, getQdata, getSource.

Setters

setAlignAxis, setData, setDataFull, setEnabled, setFactor, setName, setProperty, setSource.

getAlignAxis

alignConstraintGetAlignAxis

Arguments

:: (HasCallStack, MonadIO m, IsAlignConstraint a)

=> a

align: a AlignConstraint

-> m AlignAxis

Returns: the alignment axis

Retrieves the value set using alignConstraintSetAlignAxis

Since: 1.4

getFactor

alignConstraintGetFactor

Arguments

:: (HasCallStack, MonadIO m, IsAlignConstraint a)

=> a

align: a AlignConstraint

-> m Float

Returns: the alignment factor

Retrieves the factor set using alignConstraintSetFactor

Since: 1.4

getSource

alignConstraintGetSource

Arguments

:: (HasCallStack, MonadIO m, IsAlignConstraint a)

=> a

align: a AlignConstraint

-> m Actor

Returns: the Actor used as the source of the alignment

Retrieves the source of the alignment

Since: 1.4

new

alignConstraintNew

Arguments

:: (HasCallStack, MonadIO m, IsActor a)

=> Maybe a

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

-> AlignAxis

axis: the axis to be used to compute the alignment

-> Float

factor: the alignment factor, between 0.0 and 1.0

-> m AlignConstraint

Returns: the newly created AlignConstraint

Creates a new constraint, aligning a Actor's position with regards of the size of the actor to source, with the given alignment factor

Since: 1.4

setAlignAxis

alignConstraintSetAlignAxis

Arguments

:: (HasCallStack, MonadIO m, IsAlignConstraint a)

=> a

align: a AlignConstraint

-> AlignAxis

axis: the axis to which the alignment refers to

-> m ()

Sets the axis to which the alignment refers to

Since: 1.4

setFactor

alignConstraintSetFactor

Arguments

:: (HasCallStack, MonadIO m, IsAlignConstraint a)

=> a

align: a AlignConstraint

-> Float

factor: the alignment factor, between 0.0 and 1.0

-> m ()

Sets the alignment factor of the constraint

The factor depends on the AlignConstraint:alignAxis property and it is a value between 0.0 (meaning left, when AlignConstraint:alignAxis is set to AlignAxisXAxis; or meaning top, when AlignConstraint:alignAxis is set to AlignAxisYAxis) and 1.0 (meaning right, when AlignConstraint:alignAxis is set to AlignAxisXAxis; or meaning bottom, when AlignConstraint:alignAxis is set to AlignAxisYAxis). A value of 0.5 aligns in the middle in either cases

Since: 1.4

setSource

alignConstraintSetSource

Arguments

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

=> a

align: a AlignConstraint

-> Maybe b

source: a Actor, or Nothing to unset the source

-> m ()

Sets the source of the alignment constraint

Since: 1.4

Properties

alignAxis

The axis to be used to compute the alignment

Since: 1.4

constructAlignConstraintAlignAxis :: (IsAlignConstraint o, MonadIO m) => AlignAxis -> m (GValueConstruct o)

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

getAlignConstraintAlignAxis :: (MonadIO m, IsAlignConstraint o) => o -> m AlignAxis

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

get alignConstraint #alignAxis

setAlignConstraintAlignAxis :: (MonadIO m, IsAlignConstraint o) => o -> AlignAxis -> m ()

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

set alignConstraint [ #alignAxis := value ]

factor

The alignment factor, as a normalized value between 0.0 and 1.0

The factor depends on the AlignConstraint:alignAxis property: with an align-axis value of AlignAxisXAxis, 0.0 means left and 1.0 means right; with a value of AlignAxisYAxis, 0.0 means top and 1.0 means bottom.

Since: 1.4

constructAlignConstraintFactor :: (IsAlignConstraint o, MonadIO m) => Float -> m (GValueConstruct o)

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

getAlignConstraintFactor :: (MonadIO m, IsAlignConstraint o) => o -> m Float

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

get alignConstraint #factor

setAlignConstraintFactor :: (MonadIO m, IsAlignConstraint o) => o -> Float -> m ()

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

set alignConstraint [ #factor := value ]

source

The Actor used as the source for the alignment.

The Actor must not be a child or a grandchild of the actor using the constraint.

Since: 1.4

clearAlignConstraintSource :: (MonadIO m, IsAlignConstraint o) => o -> m ()

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

clear #source

constructAlignConstraintSource :: (IsAlignConstraint 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.

getAlignConstraintSource :: (MonadIO m, IsAlignConstraint o) => o -> m Actor

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

get alignConstraint #source

setAlignConstraintSource :: (MonadIO m, IsAlignConstraint o, IsActor a) => o -> a -> m ()

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

set alignConstraint [ #source := value ]