GI.Clutter.Objects.TableLayout

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

Since: 1.4

Exported types

newtype TableLayout

Memory-managed wrapper type.

Constructors

TableLayout (ManagedPtr TableLayout)

Instances

Eq TableLayout

Defined in GI.Clutter.Objects.TableLayout

Methods

(==) :: TableLayout -> TableLayout -> Bool

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

GObject TableLayout

Defined in GI.Clutter.Objects.TableLayout

ManagedPtrNewtype TableLayout

Defined in GI.Clutter.Objects.TableLayout

Methods

toManagedPtr :: TableLayout -> ManagedPtr TableLayout

TypedObject TableLayout

Defined in GI.Clutter.Objects.TableLayout

Methods

glibType :: IO GType

HasParentTypes TableLayout

Defined in GI.Clutter.Objects.TableLayout

IsGValue (Maybe TableLayout)

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

Defined in GI.Clutter.Objects.TableLayout

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes TableLayout

Defined in GI.Clutter.Objects.TableLayout

type ParentTypes TableLayout = '[LayoutManager, Object]

class (GObject o, IsDescendantOf TableLayout o) => IsTableLayout o

Type class for types which can be safely cast to TableLayout, for instance with toTableLayout.

Instances

(GObject o, IsDescendantOf TableLayout o) => IsTableLayout o

Defined in GI.Clutter.Objects.TableLayout

toTableLayout :: (MonadIO m, IsTableLayout o) => o -> m TableLayout

Cast to TableLayout, 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, getColumnCount, getColumnSpacing, getData, getEasingDuration, getEasingMode, getExpand, getFill, getPreferredHeight, getPreferredWidth, getProperty, getQdata, getRowCount, getRowSpacing, getSpan, getUseAnimations.

Setters

setAlignment, setColumnSpacing, setContainer, setData, setDataFull, setEasingDuration, setEasingMode, setExpand, setFill, setProperty, setRowSpacing, setSpan, setUseAnimations.

getAlignment

tableLayoutGetAlignment

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> m (TableAlignment, TableAlignment)

Deprecated: (Since version 1.12)Use actorGetXAlign and actorGetYAlign instead.

Retrieves the horizontal and vertical alignment policies for actor as set using tableLayoutPack or tableLayoutSetAlignment.

Since: 1.4

getColumnCount

tableLayoutGetColumnCount

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: A TableLayout

-> m Int32

Returns: the number of columns

Deprecated: (Since version 1.18)No direct replacement is available

Retrieve the current number of columns in layout

Since: 1.4

getColumnSpacing

tableLayoutGetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> m Word32

Returns: the spacing between columns of the TableLayout

Deprecated: (Since version 1.18)Use GridLayout:columnSpacing

Retrieves the spacing set using tableLayoutSetColumnSpacing

Since: 1.4

getEasingDuration

tableLayoutGetEasingDuration

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> m Word32

Returns: the duration of the animations, in milliseconds

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Retrieves the duration set using tableLayoutSetEasingDuration

Since: 1.4

getEasingMode

tableLayoutGetEasingMode

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> m CULong

Returns: an easing mode

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Retrieves the easing mode set using tableLayoutSetEasingMode

Since: 1.4

getExpand

tableLayoutGetExpand

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> m (Bool, Bool)

Deprecated: (Since version 1.12)Use actorGetXExpand and actorGetYExpand instead.

Retrieves the horizontal and vertical expand policies for actor as set using tableLayoutPack or tableLayoutSetExpand

Since: 1.4

getFill

tableLayoutGetFill

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> m (Bool, Bool)

Deprecated: (Since version 1.12)Use actorGetXAlign and actorGetYAlign instead.

Retrieves the horizontal and vertical fill policies for actor as set using tableLayoutPack or tableLayoutSetFill

Since: 1.4

getRowCount

tableLayoutGetRowCount

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: A TableLayout

-> m Int32

Returns: the number of rows

Deprecated: (Since version 1.18)No direct replacement is available

Retrieve the current number rows in the layout

Since: 1.4

getRowSpacing

tableLayoutGetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> m Word32

Returns: the spacing between rows of the TableLayout

Deprecated: (Since version 1.18)Use GridLayout:rowSpacing instead

Retrieves the spacing set using tableLayoutSetRowSpacing

Since: 1.4

getSpan

tableLayoutGetSpan

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> m (Int32, Int32)

Deprecated: (Since version 1.18)Use the width and height layout properties of GridLayout instead

Retrieves the row and column span for actor as set using tableLayoutPack or tableLayoutSetSpan

Since: 1.4

getUseAnimations

tableLayoutGetUseAnimations

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> m Bool

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

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Retrieves whether layout should animate changes in the layout properties

Since tableLayoutSetUseAnimations

Since: 1.4

new

tableLayoutNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TableLayout

Returns: the newly created TableLayout

Deprecated: (Since version 1.18)Use GridLayout instead

Creates a new TableLayout layout manager

Since: 1.4

pack

tableLayoutPack

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor

-> Int32

column: the column the actor should be put, or -1 to append

-> Int32

row: the row the actor should be put, or -1 to append

-> m ()

Deprecated: (Since version 1.18)Use gridLayoutAttach instead

Packs actor inside the Container associated to layout at the given row and column.

Since: 1.4

setAlignment

tableLayoutSetAlignment

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> TableAlignment

xAlign: Horizontal alignment policy for actor

-> TableAlignment

yAlign: Vertical alignment policy for actor

-> m ()

Deprecated: (Since version 1.12)Use actorSetXAlign and actorSetYAlign instead.

Sets the horizontal and vertical alignment policies for actor inside layout

Since: 1.4

setColumnSpacing

tableLayoutSetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> Word32

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

-> m ()

Deprecated: (Since version 1.18)Use GridLayout:columnSpacing instead

Sets the spacing between columns of layout

Since: 1.4

setEasingDuration

tableLayoutSetEasingDuration

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> Word32

msecs: the duration of the animations, in milliseconds

-> m ()

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Sets the duration of the animations used by layout when animating changes in the layout properties

Use tableLayoutSetUseAnimations to enable and disable the animations

Since: 1.4

setEasingMode

tableLayoutSetEasingMode

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> CULong

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

-> m ()

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Sets the easing mode to be used by layout when animating changes in layout properties

Use tableLayoutSetUseAnimations to enable and disable the animations

Since: 1.4

setExpand

tableLayoutSetExpand

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> Bool

xExpand: whether actor should allocate extra space horizontally

-> Bool

yExpand: whether actor should allocate extra space vertically

-> m ()

Deprecated: (Since version 1.12)Use actorSetXExpand or actorSetYExpand instead.

Sets the horizontal and vertical expand policies for actor inside layout

Since: 1.4

setFill

tableLayoutSetFill

Arguments

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

=> a

layout: a TableLayout

-> 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)Use actorSetXAlign and actorSetYAlign instead.

Sets the horizontal and vertical fill policies for actor inside layout

Since: 1.4

setRowSpacing

tableLayoutSetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> Word32

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

-> m ()

Deprecated: (Since version 1.18)Use GridLayout:rowSpacing instead

Sets the spacing between rows of layout

Since: 1.4

setSpan

tableLayoutSetSpan

Arguments

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

=> a

layout: a TableLayout

-> b

actor: a Actor child of layout

-> Int32

columnSpan: Column span for actor

-> Int32

rowSpan: Row span for actor

-> m ()

Deprecated: (Since version 1.18)Use the width and height layout properties of GridLayout instead

Sets the row and column span for actor inside layout

Since: 1.4

setUseAnimations

tableLayoutSetUseAnimations

Arguments

:: (HasCallStack, MonadIO m, IsTableLayout a)

=> a

layout: a TableLayout

-> Bool

animate: True if the layout should use animations

-> m ()

Deprecated: (Since version 1.12)tTableLayout will honour the easing state of the children when allocating them. See actorSetEasingMode and actorSetEasingDuration.

Sets whether layout should animate changes in the layout properties

The duration of the animations is controlled by tableLayoutSetEasingDuration; the easing mode to be used by the animations is controlled by tableLayoutSetEasingMode

Since: 1.4

Properties

columnSpacing

The spacing between columns of the TableLayout, in pixels

Since: 1.4

constructTableLayoutColumnSpacing :: (IsTableLayout o, MonadIO m) => Word32 -> 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.

getTableLayoutColumnSpacing :: (MonadIO m, IsTableLayout o) => o -> m Word32

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

get tableLayout #columnSpacing

setTableLayoutColumnSpacing :: (MonadIO m, IsTableLayout o) => o -> Word32 -> m ()

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

set tableLayout [ #columnSpacing := value ]

easingDuration

The duration of the animations, in case TableLayout:useAnimations is set to True.

The duration is expressed in milliseconds.

Since: 1.4

constructTableLayoutEasingDuration :: (IsTableLayout 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.

getTableLayoutEasingDuration :: (MonadIO m, IsTableLayout o) => o -> m Word32

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

get tableLayout #easingDuration

setTableLayoutEasingDuration :: (MonadIO m, IsTableLayout o) => o -> Word32 -> m ()

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

set tableLayout [ #easingDuration := value ]

easingMode

The easing mode for the animations, in case TableLayout: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.4

constructTableLayoutEasingMode :: (IsTableLayout 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.

getTableLayoutEasingMode :: (MonadIO m, IsTableLayout o) => o -> m CULong

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

get tableLayout #easingMode

setTableLayoutEasingMode :: (MonadIO m, IsTableLayout o) => o -> CULong -> m ()

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

set tableLayout [ #easingMode := value ]

rowSpacing

The spacing between rows of the TableLayout, in pixels

Since: 1.4

constructTableLayoutRowSpacing :: (IsTableLayout o, MonadIO m) => Word32 -> 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.

getTableLayoutRowSpacing :: (MonadIO m, IsTableLayout o) => o -> m Word32

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

get tableLayout #rowSpacing

setTableLayoutRowSpacing :: (MonadIO m, IsTableLayout o) => o -> Word32 -> m ()

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

set tableLayout [ #rowSpacing := value ]

useAnimations

Whether the TableLayout should animate changes in the layout properties.

By default, TableLayout will honour the easing state of the children when allocating them. Setting this property to True will override the easing state with the layout manager's TableLayout:easingMode and TableLayout:easingDuration properties.

Since: 1.4

constructTableLayoutUseAnimations :: (IsTableLayout 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.

getTableLayoutUseAnimations :: (MonadIO m, IsTableLayout o) => o -> m Bool

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

get tableLayout #useAnimations

setTableLayoutUseAnimations :: (MonadIO m, IsTableLayout o) => o -> Bool -> m ()

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

set tableLayout [ #useAnimations := value ]