Clutter.TableLayout¶

Subclasses:: None

Methods¶

Inherited:: Clutter.LayoutManager (13), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_alignment` (actor)
	`get_column_count` ()
	`get_column_spacing` ()
	`get_easing_duration` ()
	`get_easing_mode` ()
	`get_expand` (actor)
	`get_fill` (actor)
	`get_row_count` ()
	`get_row_spacing` ()
	`get_span` (actor)
	`get_use_animations` ()
	`pack` (actor, column, row)
	`set_alignment` (actor, x_align, y_align)
	`set_column_spacing` (spacing)
	`set_easing_duration` (msecs)
	`set_easing_mode` (mode)
	`set_expand` (actor, x_expand, y_expand)
	`set_fill` (actor, x_fill, y_fill)
	`set_row_spacing` (spacing)
	`set_span` (actor, column_span, row_span)
	`set_use_animations` (animate)

Virtual Methods¶

Inherited:: Clutter.LayoutManager (9), GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`column-spacing`	`int`	r/w	Spacing between columns `deprecated`
`easing-duration`	`int`	r/w	The duration of the animations `deprecated`
`easing-mode`	`int`	r/w	The easing mode of the animations `deprecated`
`row-spacing`	`int`	r/w	Spacing between rows `deprecated`
`use-animations`	`bool`	r/w	Whether layout changes should be animated `deprecated`

Signals¶

Inherited:: Clutter.LayoutManager (1), GObject.Object (1)

Fields¶

Inherited:: Clutter.LayoutManager (1), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Clutter.LayoutManager`	r

Class Details¶

class Clutter.TableLayout(**kwargs)¶

Bases:: Clutter.LayoutManager
Abstract:: No
Structure:: Clutter.TableLayoutClass

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

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout instead

classmethod new()¶

Returns:: the newly created Clutter.TableLayout
Return type:: Clutter.LayoutManager

Creates a new Clutter.TableLayout layout manager

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout instead

get_alignment(actor)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self

Returns:

x_align:: return location for the horizontal alignment policy
y_align:: return location for the vertical alignment policy

Return type:

(x_align: Clutter.TableAlignment, y_align: Clutter.TableAlignment)

Retrieves the horizontal and vertical alignment policies for actor as set using Clutter.TableLayout.pack() or Clutter.TableLayout.set_alignment().

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.get_x_align() and Clutter.Actor.get_y_align() instead.

get_column_count()¶

Returns:: the number of columns
Return type:: int

Retrieve the current number of columns in self

New in version 1.4.

Deprecated since version 1.18: No direct replacement is available

get_column_spacing()¶

Returns:: the spacing between columns of the Clutter.TableLayout
Return type:: int

Retrieves the spacing set using Clutter.TableLayout.set_column_spacing()

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :column-spacing

get_easing_duration()¶

Returns:: the duration of the animations, in milliseconds
Return type:: int

Retrieves the duration set using Clutter.TableLayout.set_easing_duration()

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

get_easing_mode()¶

Returns:: an easing mode
Return type:: int

Retrieves the easing mode set using Clutter.TableLayout.set_easing_mode()

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

get_expand(actor)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self

Returns:

x_expand:: return location for the horizontal expand policy
y_expand:: return location for the vertical expand policy

Return type:

(x_expand: bool, y_expand: bool)

Retrieves the horizontal and vertical expand policies for actor as set using Clutter.TableLayout.pack() or Clutter.TableLayout.set_expand()

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.get_x_expand() and Clutter.Actor.get_y_expand() instead.

get_fill(actor)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self

Returns:

x_fill:: return location for the horizontal fill policy
y_fill:: return location for the vertical fill policy

Return type:

(x_fill: bool, y_fill: bool)

Retrieves the horizontal and vertical fill policies for actor as set using Clutter.TableLayout.pack() or Clutter.TableLayout.set_fill()

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.get_x_align() and Clutter.Actor.get_y_align() instead.

get_row_count()¶

Returns:: the number of rows
Return type:: int

Retrieve the current number rows in the self

New in version 1.4.

Deprecated since version 1.18: No direct replacement is available

get_row_spacing()¶

Returns:: the spacing between rows of the Clutter.TableLayout
Return type:: int

Retrieves the spacing set using Clutter.TableLayout.set_row_spacing()

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :row-spacing instead

get_span(actor)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self

Returns:

column_span:: return location for the col span
row_span:: return location for the row span

Return type:

(column_span: int, row_span: int)

Retrieves the row and column span for actor as set using Clutter.TableLayout.pack() or Clutter.TableLayout.set_span()

New in version 1.4.

Deprecated since version 1.18: Use the width and height layout properties of Clutter.GridLayout instead

get_use_animations()¶

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

Retrieves whether self should animate changes in the layout properties

Since Clutter.TableLayout.set_use_animations()

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

pack(actor, column, row)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor
column (int) – the column the actor should be put, or -1 to append
row (int) – the row the actor should be put, or -1 to append

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

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout.attach() instead

set_alignment(actor, x_align, y_align)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self
x_align (Clutter.TableAlignment) – Horizontal alignment policy for actor
y_align (Clutter.TableAlignment) – Vertical alignment policy for actor

Sets the horizontal and vertical alignment policies for actor inside self

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.set_x_align() and Clutter.Actor.set_y_align() instead.

set_column_spacing(spacing)¶

Parameters:: spacing (int) – the spacing between columns of the layout, in pixels

Sets the spacing between columns of self

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :column-spacing instead

set_easing_duration(msecs)¶

Parameters:: msecs (int) – the duration of the animations, in milliseconds

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

Use Clutter.TableLayout.set_use_animations() to enable and disable the animations

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

set_easing_mode(mode)¶

Parameters:: mode (int) – an easing mode, either from Clutter.AnimationMode or a logical id from Clutter.Alpha.register_func()

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

Use Clutter.TableLayout.set_use_animations() to enable and disable the animations

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

set_expand(actor, x_expand, y_expand)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self
x_expand (bool) – whether actor should allocate extra space horizontally
y_expand (bool) – whether actor should allocate extra space vertically

Sets the horizontal and vertical expand policies for actor inside self

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.set_x_expand() or Clutter.Actor.set_y_expand() instead.

set_fill(actor, x_fill, y_fill)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self
x_fill (bool) – whether actor should fill horizontally the allocated space
y_fill (bool) – whether actor should fill vertically the allocated space

Sets the horizontal and vertical fill policies for actor inside self

New in version 1.4.

Deprecated since version 1.12: Use Clutter.Actor.set_x_align() and Clutter.Actor.set_y_align() instead.

set_row_spacing(spacing)¶

Parameters:: spacing (int) – the spacing between rows of the layout, in pixels

Sets the spacing between rows of self

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :row-spacing instead

set_span(actor, column_span, row_span)¶

Parameters:

actor (Clutter.Actor) – a Clutter.Actor child of self
column_span (int) – Column span for actor
row_span (int) – Row span for actor

Sets the row and column span for actor inside self

New in version 1.4.

Deprecated since version 1.18: Use the width and height layout properties of Clutter.GridLayout instead

set_use_animations(animate)¶

Parameters:: animate (bool) – True if the self should use animations

Sets whether self should animate changes in the layout properties

The duration of the animations is controlled by Clutter.TableLayout.set_easing_duration(); the easing mode to be used by the animations is controlled by Clutter.TableLayout.set_easing_mode()

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them. See Clutter.Actor.set_easing_mode() and Clutter.Actor.set_easing_duration().

Property Details¶

Clutter.TableLayout.props.column_spacing¶

Name:: column-spacing
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The spacing between columns of the Clutter.TableLayout, in pixels

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :column-spacing instead

Clutter.TableLayout.props.easing_duration¶

Name:: easing-duration
Type:: int
Default Value:: 500
Flags:: READABLE, WRITABLE

The duration of the animations, in case Clutter.TableLayout :use-animations is set to True.

The duration is expressed in milliseconds.

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them

Clutter.TableLayout.props.easing_mode¶

Name:: easing-mode
Type:: int
Default Value:: 6
Flags:: READABLE, WRITABLE

The easing mode for the animations, in case Clutter.TableLayout :use-animations is set to True.

The easing mode has the same semantics of Clutter.Animation :mode: it can either be a value from the Clutter.AnimationMode enumeration, like Clutter.AnimationMode.EASE_OUT_CUBIC, or a logical id as returned by Clutter.Alpha.register_func().

The default value is Clutter.AnimationMode.EASE_OUT_CUBIC.

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them

Clutter.TableLayout.props.row_spacing¶

Name:: row-spacing
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The spacing between rows of the Clutter.TableLayout, in pixels

New in version 1.4.

Deprecated since version 1.18: Use Clutter.GridLayout :row-spacing instead

Clutter.TableLayout.props.use_animations¶

Name:: use-animations
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Clutter.TableLayout should animate changes in the layout properties.

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

New in version 1.4.

Deprecated since version 1.12: Clutter.TableLayout will honour the easing state of the children when allocating them