Class: Clutter::BoxLayout

Inherits:

LayoutManager

• Object
• GObject::InitiallyUnowned
• LayoutManager
• Clutter::BoxLayout

Defined in:

(unknown)

Overview

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

Instance Method Summary

• #easing_duration ⇒ Integer

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

• #easing_duration=(easing_duration) ⇒ Integer

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

• #easing_mode ⇒ Clutter::gulong

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

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

  The easing mode for the animations, in case Clutter::BoxLayout: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_box_layout_pack() or clutter_box_layout_set_alignment().

• #get_expand(actor) ⇒ Boolean

  Retrieves whether actor should expand inside layout.

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

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

• #homogeneous ⇒ Boolean

  Retrieves if the children sizes are allocated homogeneously.

• #homogeneous=(homogeneous) ⇒ Boolean

  Whether the Clutter::BoxLayout should arrange its children homogeneously, i.e.

• #homogeneous? ⇒ Boolean

  Whether the Clutter::BoxLayout should arrange its children homogeneously, i.e.

• #initialize ⇒ Clutter::LayoutManager constructor

  Creates a new Clutter::BoxLayout layout manager.

• #orientation ⇒ Clutter::Orientation

  The orientation of the Clutter::BoxLayout, either horizontal or vertical.

• #orientation=(orientation) ⇒ Clutter::Orientation

  The orientation of the Clutter::BoxLayout, either horizontal or vertical.

• #pack(actor, expand, x_fill, y_fill, x_align, y_align) ⇒ nil

  Packs actor inside the Clutter::Container associated to layout and sets the layout properties.

• #pack_start ⇒ Boolean

  Retrieves the value set using clutter_box_layout_set_pack_start().

• #pack_start=(pack_start) ⇒ Boolean

  Whether the Clutter::BoxLayout should pack items at the start or append them at the end.

• #pack_start? ⇒ Boolean

  Whether the Clutter::BoxLayout should pack items at the start or append them at the end.

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

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

• #set_expand(actor, expand) ⇒ nil

  Sets whether actor should expand inside layout.

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

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

• #spacing ⇒ Integer

  The spacing between children of the Clutter::BoxLayout, in pixels.

• #spacing=(spacing) ⇒ Integer

  The spacing between children of the Clutter::BoxLayout, in pixels.

• #use_animations ⇒ Boolean

  Retrieves whether layout should animate changes in the layout properties.

• #use_animations=(use_animations) ⇒ Boolean

  Whether the Clutter::BoxLayout should animate changes in the layout, overriding the easing state of the children.

• #use_animations? ⇒ Boolean

  Whether the Clutter::BoxLayout should animate changes in the layout, overriding the easing state of the children.

• #vertical ⇒ Boolean

  Retrieves the orientation of the layout as set using the clutter_box_layout_set_vertical() function.

• #vertical=(vertical) ⇒ Boolean

  Whether the Clutter::BoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis.

• #vertical? ⇒ Boolean

  Whether the Clutter::BoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis.

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::BoxLayout layout manager

Instance Method Details

#easing_duration ⇒ Integer

The duration of the animations, in case Clutter::BoxLayout: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::BoxLayout: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::BoxLayout: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::BoxLayout: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_box_layout_pack() or clutter_box_layout_set_alignment()

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• x_align (Clutter::BoxAlignment) —

  return location for the horizontal alignment policy

• y_align (Clutter::BoxAlignment) —

  return location for the vertical alignment policy

Returns:

• (nil)

#get_expand(actor) ⇒ Boolean

Retrieves whether actor should expand inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

Returns:

• (Boolean) —

  true if the Clutter::Actor should expand, false otherwise

#get_fill(actor, x_fill, y_fill) ⇒ nil

Retrieves the horizontal and vertical fill policies for actor as set using clutter_box_layout_pack() or clutter_box_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)

#homogeneous ⇒ Boolean

Retrieves if the children sizes are allocated homogeneously.

Returns:

• (Boolean) —

  true if the Clutter::BoxLayout is arranging its children homogeneously, and false otherwise

#homogeneous=(homogeneous) ⇒ Boolean

Whether the Clutter::BoxLayout should arrange its children homogeneously, i.e. all children get the same size

Parameters:

• homogeneous (Boolean)

Returns:

• (Boolean) —

  homogeneous

• (Boolean) —

  homogeneous

#homogeneous? ⇒ Boolean

Whether the Clutter::BoxLayout should arrange its children homogeneously, i.e. all children get the same size

Returns:

• (Boolean) —

  homogeneous

#orientation ⇒ Clutter::Orientation

The orientation of the Clutter::BoxLayout, either horizontal or vertical

Returns:

• (Clutter::Orientation) —

  orientation

#orientation=(orientation) ⇒ Clutter::Orientation

The orientation of the Clutter::BoxLayout, either horizontal or vertical

Parameters:

• orientation (Clutter::Orientation)

Returns:

• (Clutter::Orientation) —

  orientation

• (Clutter::Orientation) —

  orientation

#pack(actor, expand, x_fill, y_fill, x_align, y_align) ⇒ nil

Packs actor inside the Clutter::Container associated to layout and sets the layout properties

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor

• expand (Boolean) —

  whether the actor should expand

• x_fill (Boolean) —

  whether the actor should fill horizontally

• y_fill (Boolean) —

  whether the actor should fill vertically

• x_align (Clutter::BoxAlignment) —

  the horizontal alignment policy for actor

• y_align (Clutter::BoxAlignment) —

  the vertical alignment policy for actor

Returns:

• (nil)

#pack_start ⇒ Boolean

Retrieves the value set using clutter_box_layout_set_pack_start()

Returns:

• (Boolean) —

  true if the Clutter::BoxLayout should pack children at the beginning of the layout, and false otherwise

#pack_start=(pack_start) ⇒ Boolean

Whether the Clutter::BoxLayout should pack items at the start or append them at the end

Parameters:

• pack_start (Boolean)

Returns:

• (Boolean) —

  pack-start

• (Boolean) —

  pack-start

#pack_start? ⇒ Boolean

Whether the Clutter::BoxLayout should pack items at the start or append them at the end

Returns:

• (Boolean) —

  pack-start

#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::BoxAlignment) —

  Horizontal alignment policy for actor

• y_align (Clutter::BoxAlignment) —

  Vertical alignment policy for actor

Returns:

• (nil)

#set_expand(actor, expand) ⇒ nil

Sets whether actor should expand inside layout

Parameters:

• actor (Clutter::Actor) —

  a Clutter::Actor child of layout

• expand (Boolean) —

  whether actor should expand

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)

#spacing ⇒ Integer

The spacing between children of the Clutter::BoxLayout, in pixels

Returns:

• (Integer) —

  spacing

#spacing=(spacing) ⇒ Integer

The spacing between children of the Clutter::BoxLayout, in pixels

Parameters:

• spacing (Integer)

Returns:

• (Integer) —

  spacing

• (Integer) —

  spacing

#use_animations ⇒ Boolean

Retrieves whether layout should animate changes in the layout properties.

Returns:

• (Boolean) —

  true if the animations should be used, false otherwise

#use_animations=(use_animations) ⇒ Boolean

Whether the Clutter::BoxLayout should animate changes in the layout, overriding the easing state of the children.

Parameters:

• use_animations (Boolean)

Returns:

• (Boolean) —

  use-animations

• (Boolean) —

  use-animations

#use_animations? ⇒ Boolean

Whether the Clutter::BoxLayout should animate changes in the layout, overriding the easing state of the children.

Returns:

• (Boolean) —

  use-animations

#vertical ⇒ Boolean

Retrieves the orientation of the layout as set using the clutter_box_layout_set_vertical() function

Returns:

• (Boolean) —

  true if the Clutter::BoxLayout is arranging its children vertically, and false otherwise

#vertical=(vertical) ⇒ Boolean

Whether the Clutter::BoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis

Parameters:

• vertical (Boolean)

Returns:

• (Boolean) —

  vertical

• (Boolean) —

  vertical

#vertical? ⇒ Boolean

Whether the Clutter::BoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis

Returns:

• (Boolean) —

  vertical