GI.Clutter.Objects.FlowLayout

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

Since: 1.2

Exported types

newtype FlowLayout

Memory-managed wrapper type.

Constructors

FlowLayout (ManagedPtr FlowLayout)

Instances

Eq FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

Methods

(==) :: FlowLayout -> FlowLayout -> Bool

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

GObject FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

ManagedPtrNewtype FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

Methods

toManagedPtr :: FlowLayout -> ManagedPtr FlowLayout

TypedObject FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

Methods

glibType :: IO GType

HasParentTypes FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

IsGValue (Maybe FlowLayout)

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

Defined in GI.Clutter.Objects.FlowLayout

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes FlowLayout

Defined in GI.Clutter.Objects.FlowLayout

type ParentTypes FlowLayout = '[LayoutManager, Object]

class (GObject o, IsDescendantOf FlowLayout o) => IsFlowLayout o

Type class for types which can be safely cast to FlowLayout, for instance with toFlowLayout.

Instances

(GObject o, IsDescendantOf FlowLayout o) => IsFlowLayout o

Defined in GI.Clutter.Objects.FlowLayout

toFlowLayout :: (MonadIO m, IsFlowLayout o) => o -> m FlowLayout

Cast to FlowLayout, 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, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAnimationProgress, getChildMeta, getColumnSpacing, getColumnWidth, getData, getHomogeneous, getOrientation, getPreferredHeight, getPreferredWidth, getProperty, getQdata, getRowHeight, getRowSpacing, getSnapToGrid.

Setters

setColumnSpacing, setColumnWidth, setContainer, setData, setDataFull, setHomogeneous, setOrientation, setProperty, setRowHeight, setRowSpacing, setSnapToGrid.

getColumnSpacing

flowLayoutGetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m Float

Returns: the spacing between columns of the FlowLayout, in pixels

Retrieves the spacing between columns

Since: 1.2

getColumnWidth

flowLayoutGetColumnWidth

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m (Float, Float)

Retrieves the minimum and maximum column widths

Since: 1.2

getHomogeneous

flowLayoutGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m Bool

Returns: True if the FlowLayout is homogeneous

Retrieves whether the layout is homogeneous

Since: 1.2

getOrientation

flowLayoutGetOrientation

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m FlowOrientation

Returns: the orientation of the FlowLayout

Retrieves the orientation of the layout

Since: 1.2

getRowHeight

flowLayoutGetRowHeight

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m (Float, Float)

Retrieves the minimum and maximum row heights

Since: 1.2

getRowSpacing

flowLayoutGetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m Float

Returns: the spacing between rows of the FlowLayout, in pixels

Retrieves the spacing between rows

Since: 1.2

getSnapToGrid

flowLayoutGetSnapToGrid

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> m Bool

Returns: True if the layout is placing its children on a grid

Retrieves the value of FlowLayout:snap-to-grid property

Since: 1.16

new

flowLayoutNew

Arguments

:: (HasCallStack, MonadIO m)

=> FlowOrientation

orientation: the orientation of the flow layout

-> m FlowLayout

Returns: the newly created FlowLayout

Creates a new FlowLayout with the given orientation

Since: 1.2

setColumnSpacing

flowLayoutSetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Float

spacing: the space between columns

-> m ()

Sets the space between columns, in pixels

Since: 1.2

setColumnWidth

flowLayoutSetColumnWidth

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Float

minWidth: minimum width of a column

-> Float

maxWidth: maximum width of a column

-> m ()

Sets the minimum and maximum widths that a column can have

Since: 1.2

setHomogeneous

flowLayoutSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Bool

homogeneous: whether the layout should be homogeneous or not

-> m ()

Sets whether the layout should allocate the same space for each child

Since: 1.2

setOrientation

flowLayoutSetOrientation

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> FlowOrientation

orientation: the orientation of the layout

-> m ()

Sets the orientation of the flow layout

The orientation controls the direction used to allocate the children: either horizontally or vertically. The orientation also controls the direction of the overflowing

Since: 1.2

setRowHeight

flowLayoutSetRowHeight

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Float

minHeight: the minimum height of a row

-> Float

maxHeight: the maximum height of a row

-> m ()

Sets the minimum and maximum heights that a row can have

Since: 1.2

setRowSpacing

flowLayoutSetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Float

spacing: the space between rows

-> m ()

Sets the spacing between rows, in pixels

Since: 1.2

setSnapToGrid

flowLayoutSetSnapToGrid

Arguments

:: (HasCallStack, MonadIO m, IsFlowLayout a)

=> a

layout: a FlowLayout

-> Bool

snapToGrid: True if layout should place its children on a grid

-> m ()

Whether the layout should place its children on a grid.

Since: 1.16

Properties

columnSpacing

The spacing between columns, in pixels; the value of this property is honoured by horizontal non-overflowing layouts and by vertical overflowing layouts

Since: 1.2

constructFlowLayoutColumnSpacing :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutColumnSpacing :: (MonadIO m, IsFlowLayout o) => o -> m Float

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

get flowLayout #columnSpacing

setFlowLayoutColumnSpacing :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

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

set flowLayout [ #columnSpacing := value ]

homogeneous

Whether each child inside the FlowLayout should receive the same allocation

Since: 1.2

constructFlowLayoutHomogeneous :: (IsFlowLayout 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.

getFlowLayoutHomogeneous :: (MonadIO m, IsFlowLayout o) => o -> m Bool

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

get flowLayout #homogeneous

setFlowLayoutHomogeneous :: (MonadIO m, IsFlowLayout o) => o -> Bool -> m ()

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

set flowLayout [ #homogeneous := value ]

maxColumnWidth

Maximum width for each column in the layout, in pixels. If set to -1 the width will be the maximum child width

Since: 1.2

constructFlowLayoutMaxColumnWidth :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutMaxColumnWidth :: (MonadIO m, IsFlowLayout o) => o -> m Float

Get the value of the “max-column-width” property. When overloading is enabled, this is equivalent to

get flowLayout #maxColumnWidth

setFlowLayoutMaxColumnWidth :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

Set the value of the “max-column-width” property. When overloading is enabled, this is equivalent to

set flowLayout [ #maxColumnWidth := value ]

maxRowHeight

Maximum height for each row in the layout, in pixels. If set to -1 the width will be the maximum child height

Since: 1.2

constructFlowLayoutMaxRowHeight :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutMaxRowHeight :: (MonadIO m, IsFlowLayout o) => o -> m Float

Get the value of the “max-row-height” property. When overloading is enabled, this is equivalent to

get flowLayout #maxRowHeight

setFlowLayoutMaxRowHeight :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

Set the value of the “max-row-height” property. When overloading is enabled, this is equivalent to

set flowLayout [ #maxRowHeight := value ]

minColumnWidth

Minimum width for each column in the layout, in pixels

Since: 1.2

constructFlowLayoutMinColumnWidth :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutMinColumnWidth :: (MonadIO m, IsFlowLayout o) => o -> m Float

Get the value of the “min-column-width” property. When overloading is enabled, this is equivalent to

get flowLayout #minColumnWidth

setFlowLayoutMinColumnWidth :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

Set the value of the “min-column-width” property. When overloading is enabled, this is equivalent to

set flowLayout [ #minColumnWidth := value ]

minRowHeight

Minimum height for each row in the layout, in pixels

Since: 1.2

constructFlowLayoutMinRowHeight :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutMinRowHeight :: (MonadIO m, IsFlowLayout o) => o -> m Float

Get the value of the “min-row-height” property. When overloading is enabled, this is equivalent to

get flowLayout #minRowHeight

setFlowLayoutMinRowHeight :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

Set the value of the “min-row-height” property. When overloading is enabled, this is equivalent to

set flowLayout [ #minRowHeight := value ]

orientation

The orientation of the FlowLayout. The children of the layout will be layed out following the orientation.

This property also controls the overflowing directions

Since: 1.2

constructFlowLayoutOrientation :: (IsFlowLayout o, MonadIO m) => FlowOrientation -> m (GValueConstruct o)

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

getFlowLayoutOrientation :: (MonadIO m, IsFlowLayout o) => o -> m FlowOrientation

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

get flowLayout #orientation

setFlowLayoutOrientation :: (MonadIO m, IsFlowLayout o) => o -> FlowOrientation -> m ()

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

set flowLayout [ #orientation := value ]

rowSpacing

The spacing between rows, in pixels; the value of this property is honoured by vertical non-overflowing layouts and by horizontal overflowing layouts

Since: 1.2

constructFlowLayoutRowSpacing :: (IsFlowLayout o, MonadIO m) => Float -> m (GValueConstruct o)

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

getFlowLayoutRowSpacing :: (MonadIO m, IsFlowLayout o) => o -> m Float

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

get flowLayout #rowSpacing

setFlowLayoutRowSpacing :: (MonadIO m, IsFlowLayout o) => o -> Float -> m ()

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

set flowLayout [ #rowSpacing := value ]

snapToGrid

Whether the FlowLayout should arrange its children on a grid

Since: 1.16

constructFlowLayoutSnapToGrid :: (IsFlowLayout o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlowLayoutSnapToGrid :: (MonadIO m, IsFlowLayout o) => o -> m Bool

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

get flowLayout #snapToGrid

setFlowLayoutSnapToGrid :: (MonadIO m, IsFlowLayout o) => o -> Bool -> m ()

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

set flowLayout [ #snapToGrid := value ]