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 |
- Exported types
- Methods
- getAlignment
- getEasingDuration
- getEasingMode
- getExpand
- getFill
- getHomogeneous
- getOrientation
- getPackStart
- getSpacing
- getUseAnimations
- getVertical
- new
- pack
- setAlignment
- setEasingDuration
- setEasingMode
- setExpand
- setFill
- setHomogeneous
- setOrientation
- setPackStart
- setSpacing
- setUseAnimations
- setVertical
- Properties
The BoxLayout
structure contains only private data
and should be accessed using the provided API
Since: 1.2
Synopsis
- newtype BoxLayout = BoxLayout (ManagedPtr BoxLayout)
- class (GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o
- toBoxLayout :: (MonadIO m, IsBoxLayout o) => o -> m BoxLayout
- boxLayoutGetAlignment :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> m (BoxAlignment, BoxAlignment)
- boxLayoutGetEasingDuration :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Word32
- boxLayoutGetEasingMode :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m CULong
- boxLayoutGetExpand :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> m Bool
- boxLayoutGetFill :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> m (Bool, Bool)
- boxLayoutGetHomogeneous :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Bool
- boxLayoutGetOrientation :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Orientation
- boxLayoutGetPackStart :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Bool
- boxLayoutGetSpacing :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Word32
- boxLayoutGetUseAnimations :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Bool
- boxLayoutGetVertical :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> m Bool
- boxLayoutNew :: (HasCallStack, MonadIO m) => m BoxLayout
- boxLayoutPack :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> Bool -> Bool -> Bool -> BoxAlignment -> BoxAlignment -> m ()
- boxLayoutSetAlignment :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> BoxAlignment -> BoxAlignment -> m ()
- boxLayoutSetEasingDuration :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Word32 -> m ()
- boxLayoutSetEasingMode :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> CULong -> m ()
- boxLayoutSetExpand :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> Bool -> m ()
- boxLayoutSetFill :: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) => a -> b -> Bool -> Bool -> m ()
- boxLayoutSetHomogeneous :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Bool -> m ()
- boxLayoutSetOrientation :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Orientation -> m ()
- boxLayoutSetPackStart :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Bool -> m ()
- boxLayoutSetSpacing :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Word32 -> m ()
- boxLayoutSetUseAnimations :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Bool -> m ()
- boxLayoutSetVertical :: (HasCallStack, MonadIO m, IsBoxLayout a) => a -> Bool -> m ()
- constructBoxLayoutEasingDuration :: (IsBoxLayout o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getBoxLayoutEasingDuration :: (MonadIO m, IsBoxLayout o) => o -> m Word32
- setBoxLayoutEasingDuration :: (MonadIO m, IsBoxLayout o) => o -> Word32 -> m ()
- constructBoxLayoutEasingMode :: (IsBoxLayout o, MonadIO m) => CULong -> m (GValueConstruct o)
- getBoxLayoutEasingMode :: (MonadIO m, IsBoxLayout o) => o -> m CULong
- setBoxLayoutEasingMode :: (MonadIO m, IsBoxLayout o) => o -> CULong -> m ()
- constructBoxLayoutHomogeneous :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> m Bool
- setBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m ()
- constructBoxLayoutOrientation :: (IsBoxLayout o, MonadIO m) => Orientation -> m (GValueConstruct o)
- getBoxLayoutOrientation :: (MonadIO m, IsBoxLayout o) => o -> m Orientation
- setBoxLayoutOrientation :: (MonadIO m, IsBoxLayout o) => o -> Orientation -> m ()
- constructBoxLayoutPackStart :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBoxLayoutPackStart :: (MonadIO m, IsBoxLayout o) => o -> m Bool
- setBoxLayoutPackStart :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m ()
- constructBoxLayoutSpacing :: (IsBoxLayout o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> m Word32
- setBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> Word32 -> m ()
- constructBoxLayoutUseAnimations :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBoxLayoutUseAnimations :: (MonadIO m, IsBoxLayout o) => o -> m Bool
- setBoxLayoutUseAnimations :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m ()
- constructBoxLayoutVertical :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBoxLayoutVertical :: (MonadIO m, IsBoxLayout o) => o -> m Bool
- setBoxLayoutVertical :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq BoxLayout Source # | |
GObject BoxLayout Source # | |
Defined in GI.Clutter.Objects.BoxLayout | |
ManagedPtrNewtype BoxLayout Source # | |
Defined in GI.Clutter.Objects.BoxLayout toManagedPtr :: BoxLayout -> ManagedPtr BoxLayout | |
TypedObject BoxLayout Source # | |
Defined in GI.Clutter.Objects.BoxLayout | |
HasParentTypes BoxLayout Source # | |
Defined in GI.Clutter.Objects.BoxLayout | |
IsGValue (Maybe BoxLayout) Source # | Convert |
Defined in GI.Clutter.Objects.BoxLayout gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe BoxLayout -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe BoxLayout) | |
type ParentTypes BoxLayout Source # | |
Defined in GI.Clutter.Objects.BoxLayout |
class (GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o Source #
Type class for types which can be safely cast to BoxLayout
, for instance with toBoxLayout
.
Instances
(GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o Source # | |
Defined in GI.Clutter.Objects.BoxLayout |
toBoxLayout :: (MonadIO m, IsBoxLayout o) => o -> m BoxLayout Source #
Methods
Click to display all available methods, including inherited ones
Methods
allocate, beginAnimation, bindProperty, bindPropertyFull, childGetProperty, childSetProperty, endAnimation, findChildProperty, forceFloating, freezeNotify, getv, isFloating, layoutChanged, listChildProperties, notify, notifyByPspec, pack, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAlignment, getAnimationProgress, getChildMeta, getData, getEasingDuration, getEasingMode, getExpand, getFill, getHomogeneous, getOrientation, getPackStart, getPreferredHeight, getPreferredWidth, getProperty, getQdata, getSpacing, getUseAnimations, getVertical.
Setters
setAlignment, setContainer, setData, setDataFull, setEasingDuration, setEasingMode, setExpand, setFill, setHomogeneous, setOrientation, setPackStart, setProperty, setSpacing, setUseAnimations, setVertical.
getAlignment
boxLayoutGetAlignment Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> m (BoxAlignment, BoxAlignment) |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xAlign and Actor:yAlign properies
Retrieves the horizontal and vertical alignment policies for actor
as set using boxLayoutPack
or boxLayoutSetAlignment
Since: 1.2
getEasingDuration
boxLayoutGetEasingDuration Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Word32 | Returns: the duration of the animations, in milliseconds |
Deprecated: (Since version 1.12)
Retrieves the duration set using boxLayoutSetEasingDuration
Since: 1.2
getEasingMode
boxLayoutGetEasingMode Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m CULong | Returns: an easing mode |
Deprecated: (Since version 1.12)
Retrieves the easing mode set using boxLayoutSetEasingMode
Since: 1.2
getExpand
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> m Bool |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xExpand and Actor:yExpand properies
Retrieves whether actor
should expand inside layout
Since: 1.2
getFill
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> m (Bool, Bool) |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xAlign and Actor:yAlign properies
Retrieves the horizontal and vertical fill policies for actor
as set using boxLayoutPack
or boxLayoutSetFill
Since: 1.2
getHomogeneous
boxLayoutGetHomogeneous Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves if the children sizes are allocated homogeneously.
Since: 1.4
getOrientation
boxLayoutGetOrientation Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Orientation | Returns: the orientation of the layout |
Retrieves the orientation of the layout
.
Since: 1.12
getPackStart
boxLayoutGetPackStart Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves the value set using boxLayoutSetPackStart
Since: 1.2
getSpacing
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Word32 | Returns: the spacing between children of the |
Retrieves the spacing set using boxLayoutSetSpacing
Since: 1.2
getUseAnimations
boxLayoutGetUseAnimations Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 1.12)
Retrieves whether layout
should animate changes in the layout properties.
Since: 1.2
getVertical
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 1.12)Use boxLayoutGetOrientation
instead
Retrieves the orientation of the layout
as set using the
boxLayoutSetVertical
function
Since: 1.2
new
:: (HasCallStack, MonadIO m) | |
=> m BoxLayout | Returns: the newly created |
Creates a new BoxLayout
layout manager
Since: 1.2
pack
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> Bool |
|
-> Bool |
|
-> BoxAlignment |
|
-> BoxAlignment |
|
-> m () |
Deprecated: (Since version 1.12)tBoxLayout
honours Actor
's align and expand properties. The preferred way is adding the actor
with actorAddChild
and setting Actor:xAlign, Actor:yAlign, Actor:xExpand and Actor:yExpand
Packs actor
inside the Container
associated to layout
and sets the layout properties
Since: 1.2
setAlignment
boxLayoutSetAlignment Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> BoxAlignment |
|
-> BoxAlignment |
|
-> m () |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xAlign and Actor:yAlign properies
Sets the horizontal and vertical alignment policies for actor
inside layout
Since: 1.2
setEasingDuration
boxLayoutSetEasingDuration Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Word32 |
|
-> m () |
Deprecated: (Since version 1.12)The layout manager will honour the easing state of the children when allocating them.
Sets the duration of the animations used by layout
when animating changes
in the layout properties.
Since: 1.2
setEasingMode
boxLayoutSetEasingMode Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> CULong |
|
-> m () |
Deprecated: (Since version 1.12)The layout manager will honour the easing state of the children when allocating them.
Sets the easing mode to be used by layout
when animating changes in layout
properties.
Since: 1.2
setExpand
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xExpand and Actor:yExpand properies
Sets whether actor
should expand inside layout
Since: 1.2
setFill
:: (HasCallStack, MonadIO m, IsBoxLayout a, IsActor b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 1.12)tBoxLayout
will honour Actor
's Actor:xAlign and Actor:yAlign properies
Sets the horizontal and vertical fill policies for actor
inside layout
Since: 1.2
setHomogeneous
boxLayoutSetHomogeneous Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the size of layout
children should be
homogeneous
Since: 1.4
setOrientation
boxLayoutSetOrientation Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Orientation |
|
-> m () |
Sets the orientation of the BoxLayout
layout manager.
Since: 1.12
setPackStart
boxLayoutSetPackStart Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether children of layout
should be layed out by appending
them or by prepending them
Since: 1.2
setSpacing
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Word32 |
|
-> m () |
Sets the spacing between children of layout
Since: 1.2
setUseAnimations
boxLayoutSetUseAnimations Source #
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 1.12)The layout manager will honour the easing state of the children when allocating them.
Sets whether layout
should animate changes in the layout properties
The duration of the animations is controlled by
boxLayoutSetEasingDuration
; the easing mode to be used
by the animations is controlled by boxLayoutSetEasingMode
.
Enabling animations will override the easing state of each child
of the actor using layout
, and will use the BoxLayout:easingMode
and BoxLayout:easingDuration properties instead.
Since: 1.2
setVertical
:: (HasCallStack, MonadIO m, IsBoxLayout a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 1.12)Use boxLayoutSetOrientation
instead.
Sets whether layout
should arrange its children vertically alongside
the Y axis, instead of horizontally alongside the X axis
Since: 1.2
Properties
easingDuration
The duration of the animations, in case BoxLayout:useAnimations
is set to True
.
The duration is expressed in milliseconds.
Since: 1.2
constructBoxLayoutEasingDuration :: (IsBoxLayout o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “easing-duration
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutEasingDuration :: (MonadIO m, IsBoxLayout o) => o -> m Word32 Source #
Get the value of the “easing-duration
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #easingDuration
setBoxLayoutEasingDuration :: (MonadIO m, IsBoxLayout o) => o -> Word32 -> m () Source #
Set the value of the “easing-duration
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #easingDuration:=
value ]
easingMode
The easing mode for the animations, in case
BoxLayout:useAnimations is set to True
.
The easing mode has the same semantics of Animation:mode: it can
either be a value from the AnimationMode
enumeration, like
AnimationModeEaseOutCubic
, or a logical id as returned by
clutter_alpha_register_func()
.
The default value is AnimationModeEaseOutCubic
.
Since: 1.2
constructBoxLayoutEasingMode :: (IsBoxLayout o, MonadIO m) => CULong -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “easing-mode
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutEasingMode :: (MonadIO m, IsBoxLayout o) => o -> m CULong Source #
Get the value of the “easing-mode
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #easingMode
setBoxLayoutEasingMode :: (MonadIO m, IsBoxLayout o) => o -> CULong -> m () Source #
Set the value of the “easing-mode
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #easingMode:=
value ]
homogeneous
Whether the BoxLayout
should arrange its children
homogeneously, i.e. all children get the same size
Since: 1.4
constructBoxLayoutHomogeneous :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “homogeneous
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> m Bool Source #
Get the value of the “homogeneous
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #homogeneous
setBoxLayoutHomogeneous :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m () Source #
Set the value of the “homogeneous
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #homogeneous:=
value ]
orientation
The orientation of the BoxLayout
, either horizontal
or vertical
Since: 1.12
constructBoxLayoutOrientation :: (IsBoxLayout o, MonadIO m) => Orientation -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “orientation
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutOrientation :: (MonadIO m, IsBoxLayout o) => o -> m Orientation Source #
Get the value of the “orientation
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #orientation
setBoxLayoutOrientation :: (MonadIO m, IsBoxLayout o) => o -> Orientation -> m () Source #
Set the value of the “orientation
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #orientation:=
value ]
packStart
Whether the BoxLayout
should pack items at the start
or append them at the end
Since: 1.2
constructBoxLayoutPackStart :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “pack-start
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutPackStart :: (MonadIO m, IsBoxLayout o) => o -> m Bool Source #
Get the value of the “pack-start
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #packStart
setBoxLayoutPackStart :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m () Source #
Set the value of the “pack-start
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #packStart:=
value ]
spacing
The spacing between children of the BoxLayout
, in pixels
Since: 1.2
constructBoxLayoutSpacing :: (IsBoxLayout o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “spacing
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> m Word32 Source #
Get the value of the “spacing
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #spacing
setBoxLayoutSpacing :: (MonadIO m, IsBoxLayout o) => o -> Word32 -> m () Source #
Set the value of the “spacing
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #spacing:=
value ]
useAnimations
Whether the BoxLayout
should animate changes in the
layout, overriding the easing state of the children.
Since: 1.2
constructBoxLayoutUseAnimations :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “use-animations
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutUseAnimations :: (MonadIO m, IsBoxLayout o) => o -> m Bool Source #
Get the value of the “use-animations
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #useAnimations
setBoxLayoutUseAnimations :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m () Source #
Set the value of the “use-animations
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #useAnimations:=
value ]
vertical
Whether the BoxLayout
should arrange its children
alongside the Y axis, instead of alongside the X axis
Since: 1.2
constructBoxLayoutVertical :: (IsBoxLayout o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “vertical
” property. This is rarely needed directly, but it is used by new
.
getBoxLayoutVertical :: (MonadIO m, IsBoxLayout o) => o -> m Bool Source #
Get the value of the “vertical
” property.
When overloading is enabled, this is equivalent to
get
boxLayout #vertical
setBoxLayoutVertical :: (MonadIO m, IsBoxLayout o) => o -> Bool -> m () Source #
Set the value of the “vertical
” property.
When overloading is enabled, this is equivalent to
set
boxLayout [ #vertical:=
value ]