GI.Clutter.Objects.BoxLayout

The BoxLayout structure contains only private data and should be accessed using the provided API

Since: 1.2

Exported types

newtype BoxLayout

Memory-managed wrapper type.

Constructors

BoxLayout (ManagedPtr BoxLayout)

Instances

Eq BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

Methods

(==) :: BoxLayout -> BoxLayout -> Bool

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

GObject BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

ManagedPtrNewtype BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

Methods

toManagedPtr :: BoxLayout -> ManagedPtr BoxLayout

TypedObject BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

Methods

glibType :: IO GType

HasParentTypes BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

IsGValue (Maybe BoxLayout)

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

Defined in GI.Clutter.Objects.BoxLayout

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BoxLayout

Defined in GI.Clutter.Objects.BoxLayout

type ParentTypes BoxLayout = '[LayoutManager, Object]

class (GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o

Type class for types which can be safely cast to BoxLayout, for instance with toBoxLayout.

Instances

(GObject o, IsDescendantOf BoxLayout o) => IsBoxLayout o

Defined in GI.Clutter.Objects.BoxLayout

toBoxLayout :: (MonadIO m, IsBoxLayout o) => o -> m BoxLayout

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

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

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m CULong

Returns: an easing mode

Deprecated: (Since version 1.12)

Retrieves the easing mode set using boxLayoutSetEasingMode

Since: 1.2

getExpand

boxLayoutGetExpand

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> m Bool

Returns: True if the Actor should expand, False otherwise

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

boxLayoutGetFill

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Bool

Returns: True if the BoxLayout is arranging its children homogeneously, and False otherwise

Retrieves if the children sizes are allocated homogeneously.

Since: 1.4

getOrientation

boxLayoutGetOrientation

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Orientation

Returns: the orientation of the layout

Retrieves the orientation of the layout.

Since: 1.12

getPackStart

boxLayoutGetPackStart

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Bool

Returns: True if the BoxLayout should pack children at the beginning of the layout, and False otherwise

Retrieves the value set using boxLayoutSetPackStart

Since: 1.2

getSpacing

boxLayoutGetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Word32

Returns: the spacing between children of the BoxLayout

Retrieves the spacing set using boxLayoutSetSpacing

Since: 1.2

getUseAnimations

boxLayoutGetUseAnimations

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Bool

Returns: True if the animations should be used, False otherwise

Deprecated: (Since version 1.12)

Retrieves whether layout should animate changes in the layout properties.

Since: 1.2

getVertical

boxLayoutGetVertical

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> m Bool

Returns: True if the BoxLayout is arranging its children vertically, and False otherwise

Deprecated: (Since version 1.12)Use boxLayoutGetOrientation instead

Retrieves the orientation of the layout as set using the boxLayoutSetVertical function

Since: 1.2

new

boxLayoutNew

Arguments

:: (HasCallStack, MonadIO m)

=> m BoxLayout

Returns: the newly created BoxLayout

Creates a new BoxLayout layout manager

Since: 1.2

pack

boxLayoutPack

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor

-> Bool

expand: whether the actor should expand

-> Bool

xFill: whether the actor should fill horizontally

-> Bool

yFill: whether the actor should fill vertically

-> BoxAlignment

xAlign: the horizontal alignment policy for actor

-> BoxAlignment

yAlign: the vertical alignment policy for actor

-> 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

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> BoxAlignment

xAlign: Horizontal alignment policy for actor

-> BoxAlignment

yAlign: Vertical alignment policy for actor

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Word32

msecs: the duration of the animations, in milliseconds

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> CULong

mode: an easing mode, either from AnimationMode or a logical id from clutter_alpha_register_func()

-> 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

boxLayoutSetExpand

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> Bool

expand: whether actor should expand

-> 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

boxLayoutSetFill

Arguments

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

=> a

layout: a BoxLayout

-> b

actor: a Actor child of layout

-> Bool

xFill: whether actor should fill horizontally the allocated space

-> Bool

yFill: whether actor should fill vertically the allocated space

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Bool

homogeneous: True if the layout should be homogeneous

-> m ()

Sets whether the size of layout children should be homogeneous

Since: 1.4

setOrientation

boxLayoutSetOrientation

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Orientation

orientation: the orientation of the BoxLayout

-> m ()

Sets the orientation of the BoxLayout layout manager.

Since: 1.12

setPackStart

boxLayoutSetPackStart

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Bool

packStart: True if the layout should pack children at the beginning of the layout

-> m ()

Sets whether children of layout should be layed out by appending them or by prepending them

Since: 1.2

setSpacing

boxLayoutSetSpacing

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Word32

spacing: the spacing between children of the layout, in pixels

-> m ()

Sets the spacing between children of layout

Since: 1.2

setUseAnimations

boxLayoutSetUseAnimations

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Bool

animate: True if the layout should use animations

-> 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

boxLayoutSetVertical

Arguments

:: (HasCallStack, MonadIO m, IsBoxLayout a)

=> a

layout: a BoxLayout

-> Bool

vertical: True if the layout should be vertical

-> 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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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

set boxLayout [ #vertical := value ]