gi-clutter-1.0.2: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.TableLayout

Description

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

Since: 1.4

Synopsis

Exported types

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

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

Instances

Instances details
(GObject o, IsDescendantOf TableLayout o) => IsTableLayout o Source # 
Instance details

Defined in GI.Clutter.Objects.TableLayout

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

Cast to TableLayout, for types for which this is known to be safe. For general casts, use castTo.

Methods

getAlignment

tableLayoutGetAlignment Source #

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

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

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:column-spacing

Retrieves the spacing set using tableLayoutSetColumnSpacing

Since: 1.4

getEasingDuration

tableLayoutGetEasingDuration Source #

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

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

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

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

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

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:row-spacing instead

Retrieves the spacing set using tableLayoutSetRowSpacing

Since: 1.4

getSpan

tableLayoutGetSpan Source #

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

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

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

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

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

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:column-spacing instead

Sets the spacing between columns of layout

Since: 1.4

setEasingDuration

tableLayoutSetEasingDuration Source #

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

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

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

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

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:row-spacing instead

Sets the spacing between rows of layout

Since: 1.4

setSpan

tableLayoutSetSpan Source #

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

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

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

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

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:use-animations is set to True.

The duration is expressed in milliseconds.

Since: 1.4

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

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

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

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:use-animations 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) Source #

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

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

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

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

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

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:easing-mode and TableLayout:easing-duration properties.

Since: 1.4

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

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

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

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

set tableLayout [ #useAnimations := value ]