Class: Clutter::TableLayout

Inherits:

LayoutManager

• Object
• GObject::InitiallyUnowned
• LayoutManager
• Clutter::TableLayout

Defined in:

(unknown)

Overview

The Clutter::TableLayoutClass structure contains only private data and should be accessed using the provided API

Instance Method Summary

• #column_count ⇒ Integer

  Retrieve the current number of columns in layout.

• #column_spacing ⇒ Integer

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

• #column_spacing=(column_spacing) ⇒ Integer

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

• #easing_duration ⇒ Integer

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

• #easing_duration=(easing_duration) ⇒ Integer

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

• #easing_mode ⇒ Clutter::gulong

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

• #easing_mode=(easing_mode) ⇒ Clutter::gulong

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

• #get_alignment(actor, x_align, y_align) ⇒ nil

  Retrieves the horizontal and vertical alignment policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_alignment().

• #get_expand(actor, x_expand, y_expand) ⇒ nil

  Retrieves the horizontal and vertical expand policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_expand().

• #get_fill(actor, x_fill, y_fill) ⇒ nil

  Retrieves the horizontal and vertical fill policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_fill().

• #get_span(actor, column_span, row_span) ⇒ nil

  Retrieves the row and column span for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_span().

• #initialize ⇒ Clutter::LayoutManager constructor

  Creates a new Clutter::TableLayout layout manager.

• #pack(actor, column, row) ⇒ nil

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

• #row_count ⇒ Integer

  Retrieve the current number rows in the layout.

• #row_spacing ⇒ Integer

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

• #row_spacing=(row_spacing) ⇒ Integer

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

• #set_alignment(actor, x_align, y_align) ⇒ nil

  Sets the horizontal and vertical alignment policies for actor inside layout.

• #set_expand(actor, x_expand, y_expand) ⇒ nil

  Sets the horizontal and vertical expand policies for actor inside layout.

• #set_fill(actor, x_fill, y_fill) ⇒ nil

  Sets the horizontal and vertical fill policies for actor inside layout.

• #set_span(actor, column_span, row_span) ⇒ nil

  Sets the row and column span for actor inside layout.

• #use_animations ⇒ Boolean

  Retrieves whether layout should animate changes in the layout properties.

• #use_animations=(use_animations) ⇒ Boolean

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

• #use_animations? ⇒ Boolean

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

Methods inherited from LayoutManager

#allocate, #animation_progress, #begin_animation, #child_get, #child_get_property, #child_set, #child_set_property, #container=, #end_animation, #find_child_property, #get_child_meta, #get_preferred_height, #get_preferred_width, #layout_changed, #list_child_properties

Constructor Details

#initialize ⇒ Clutter::LayoutManager

Creates a new Clutter::TableLayout layout manager

Instance Method Details

#column_count ⇒ Integer

Retrieve the current number of columns in layout

Returns:

• (Integer) —

  the number of columns

#column_spacing ⇒ Integer

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

Returns:

• (Integer) —

  column-spacing

#column_spacing=(column_spacing) ⇒ Integer

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

Parameters:

• column_spacing (Integer)

Returns:

• (Integer) —

  column-spacing

• (Integer) —

  column-spacing

#easing_duration ⇒ Integer

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

The duration is expressed in milliseconds.

Returns:

• (Integer) —

  easing-duration

#easing_duration=(easing_duration) ⇒ Integer

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

The duration is expressed in milliseconds.

Parameters:

• easing_duration (Integer)

Returns:

• (Integer) —

  easing-duration

• (Integer) —

  easing-duration

#easing_mode ⇒ Clutter::gulong

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_EASE_OUT_CUBIC, or a logical id as returned by clutter_alpha_register_func().

The default value is %CLUTTER_EASE_OUT_CUBIC.

Returns:

• (Clutter::gulong) —

  easing-mode

#easing_mode=(easing_mode) ⇒ Clutter::gulong

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_EASE_OUT_CUBIC, or a logical id as returned by clutter_alpha_register_func().

The default value is %CLUTTER_EASE_OUT_CUBIC.

Parameters:

• easing_mode (Clutter::gulong)

Returns:

• (Clutter::gulong) —

  easing-mode

• (Clutter::gulong) —

  easing-mode

#get_alignment(actor, x_align, y_align) ⇒ nil

Retrieves the horizontal and vertical alignment policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_alignment().

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_align (Clutter::TableAlignment) —

  return location for the horizontal alignment policy

• y_align (Clutter::TableAlignment) —

  return location for the vertical alignment policy

Returns:

• (nil)

#get_expand(actor, x_expand, y_expand) ⇒ nil

Retrieves the horizontal and vertical expand policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_expand()

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_expand (Boolean) —

  return location for the horizontal expand policy

• y_expand (Boolean) —

  return location for the vertical expand policy

Returns:

• (nil)

#get_fill(actor, x_fill, y_fill) ⇒ nil

Retrieves the horizontal and vertical fill policies for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_fill()

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_fill (Boolean) —

  return location for the horizontal fill policy

• y_fill (Boolean) —

  return location for the vertical fill policy

Returns:

• (nil)

#get_span(actor, column_span, row_span) ⇒ nil

Retrieves the row and column span for actor as set using clutter_table_layout_pack() or clutter_table_layout_set_span()

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• column_span (Integer) —

  return location for the col span

• row_span (Integer) —

  return location for the row span

Returns:

• (nil)

#pack(actor, column, row) ⇒ nil

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

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor

• column (Integer) —

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

• row (Integer) —

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

Returns:

• (nil)

#row_count ⇒ Integer

Retrieve the current number rows in the layout

Returns:

• (Integer) —

  the number of rows

#row_spacing ⇒ Integer

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

Returns:

• (Integer) —

  row-spacing

#row_spacing=(row_spacing) ⇒ Integer

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

Parameters:

• row_spacing (Integer)

Returns:

• (Integer) —

  row-spacing

• (Integer) —

  row-spacing

#set_alignment(actor, x_align, y_align) ⇒ nil

Sets the horizontal and vertical alignment policies for actor inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_align (Clutter::TableAlignment) —

  Horizontal alignment policy for actor

• y_align (Clutter::TableAlignment) —

  Vertical alignment policy for actor

Returns:

• (nil)

#set_expand(actor, x_expand, y_expand) ⇒ nil

Sets the horizontal and vertical expand policies for actor inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_expand (Boolean) —

  whether actor should allocate extra space horizontally

• y_expand (Boolean) —

  whether actor should allocate extra space vertically

Returns:

• (nil)

#set_fill(actor, x_fill, y_fill) ⇒ nil

Sets the horizontal and vertical fill policies for actor inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_fill (Boolean) —

  whether actor should fill horizontally the allocated space

• y_fill (Boolean) —

  whether actor should fill vertically the allocated space

Returns:

• (nil)

#set_span(actor, column_span, row_span) ⇒ nil

Sets the row and column span for actor inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• column_span (Integer) —

  Column span for actor

• row_span (Integer) —

  Row span for actor

Returns:

• (nil)

#use_animations ⇒ Boolean

Retrieves whether layout should animate changes in the layout properties

Since clutter_table_layout_set_use_animations()

Returns:

• (Boolean) —

  true if the animations should be used, false otherwise

#use_animations=(use_animations) ⇒ Boolean

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 #ClutterTableLayout:easing-duration properties.

Parameters:

• use_animations (Boolean)

Returns:

• (Boolean) —

  use-animations

• (Boolean) —

  use-animations

#use_animations? ⇒ Boolean

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 #ClutterTableLayout:easing-duration properties.

Returns:

• (Boolean) —

  use-animations