Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
AlignConstraint
is an opaque structure
whose members cannot be directly accesses
Since: 1.4
Synopsis
- newtype AlignConstraint = AlignConstraint (ManagedPtr AlignConstraint)
- class (GObject o, IsDescendantOf AlignConstraint o) => IsAlignConstraint o
- toAlignConstraint :: (MonadIO m, IsAlignConstraint o) => o -> m AlignConstraint
- alignConstraintGetAlignAxis :: (HasCallStack, MonadIO m, IsAlignConstraint a) => a -> m AlignAxis
- alignConstraintGetFactor :: (HasCallStack, MonadIO m, IsAlignConstraint a) => a -> m Float
- alignConstraintGetSource :: (HasCallStack, MonadIO m, IsAlignConstraint a) => a -> m Actor
- alignConstraintNew :: (HasCallStack, MonadIO m, IsActor a) => Maybe a -> AlignAxis -> Float -> m AlignConstraint
- alignConstraintSetAlignAxis :: (HasCallStack, MonadIO m, IsAlignConstraint a) => a -> AlignAxis -> m ()
- alignConstraintSetFactor :: (HasCallStack, MonadIO m, IsAlignConstraint a) => a -> Float -> m ()
- alignConstraintSetSource :: (HasCallStack, MonadIO m, IsAlignConstraint a, IsActor b) => a -> Maybe b -> m ()
- constructAlignConstraintAlignAxis :: (IsAlignConstraint o, MonadIO m) => AlignAxis -> m (GValueConstruct o)
- getAlignConstraintAlignAxis :: (MonadIO m, IsAlignConstraint o) => o -> m AlignAxis
- setAlignConstraintAlignAxis :: (MonadIO m, IsAlignConstraint o) => o -> AlignAxis -> m ()
- constructAlignConstraintFactor :: (IsAlignConstraint o, MonadIO m) => Float -> m (GValueConstruct o)
- getAlignConstraintFactor :: (MonadIO m, IsAlignConstraint o) => o -> m Float
- setAlignConstraintFactor :: (MonadIO m, IsAlignConstraint o) => o -> Float -> m ()
- clearAlignConstraintSource :: (MonadIO m, IsAlignConstraint o) => o -> m ()
- constructAlignConstraintSource :: (IsAlignConstraint o, MonadIO m, IsActor a) => a -> m (GValueConstruct o)
- getAlignConstraintSource :: (MonadIO m, IsAlignConstraint o) => o -> m Actor
- setAlignConstraintSource :: (MonadIO m, IsAlignConstraint o, IsActor a) => o -> a -> m ()
Exported types
newtype AlignConstraint Source #
Memory-managed wrapper type.
Instances
Eq AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint (==) :: AlignConstraint -> AlignConstraint -> Bool # (/=) :: AlignConstraint -> AlignConstraint -> Bool # | |
GObject AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint | |
ManagedPtrNewtype AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint | |
TypedObject AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint | |
HasParentTypes AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint | |
IsGValue (Maybe AlignConstraint) Source # | Convert |
Defined in GI.Clutter.Objects.AlignConstraint gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe AlignConstraint -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe AlignConstraint) # | |
type ParentTypes AlignConstraint Source # | |
Defined in GI.Clutter.Objects.AlignConstraint |
class (GObject o, IsDescendantOf AlignConstraint o) => IsAlignConstraint o Source #
Type class for types which can be safely cast to AlignConstraint
, for instance with toAlignConstraint
.
Instances
(GObject o, IsDescendantOf AlignConstraint o) => IsAlignConstraint o Source # | |
Defined in GI.Clutter.Objects.AlignConstraint |
toAlignConstraint :: (MonadIO m, IsAlignConstraint o) => o -> m AlignConstraint Source #
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 Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a) | |
=> a |
|
-> m AlignAxis | Returns: the alignment axis |
Retrieves the value set using alignConstraintSetAlignAxis
Since: 1.4
getFactor
alignConstraintGetFactor Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a) | |
=> a |
|
-> m Float | Returns: the alignment factor |
Retrieves the factor set using alignConstraintSetFactor
Since: 1.4
getSource
alignConstraintGetSource Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a) | |
=> a |
|
-> m Actor | Returns: the |
Retrieves the source of the alignment
Since: 1.4
new
:: (HasCallStack, MonadIO m, IsActor a) | |
=> Maybe a |
|
-> AlignAxis |
|
-> Float |
|
-> m AlignConstraint | Returns: the newly created |
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 Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a) | |
=> a |
|
-> AlignAxis |
|
-> m () |
Sets the axis to which the alignment refers to
Since: 1.4
setFactor
alignConstraintSetFactor Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a) | |
=> a |
|
-> Float |
|
-> m () |
Sets the alignment factor of the constraint
The factor depends on the AlignConstraint
:align-axis
property
and it is a value between 0.0 (meaning left, when
AlignConstraint
:align-axis
is set to AlignAxisXAxis
; or
meaning top, when AlignConstraint
:align-axis
is set to
AlignAxisYAxis
) and 1.0 (meaning right, when
AlignConstraint
:align-axis
is set to AlignAxisXAxis
; or
meaning bottom, when AlignConstraint
:align-axis
is set to
AlignAxisYAxis
). A value of 0.5 aligns in the middle in either
cases
Since: 1.4
setSource
alignConstraintSetSource Source #
:: (HasCallStack, MonadIO m, IsAlignConstraint a, IsActor b) | |
=> a |
|
-> Maybe b | |
-> 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) Source #
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 Source #
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 () Source #
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
:align-axis
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) Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “source
” property.
When overloading is enabled, this is equivalent to
set
alignConstraint [ #source:=
value ]