Clutter.FlowLayout

g Clutter.FlowLayout Clutter.FlowLayout Clutter.LayoutManager Clutter.LayoutManager Clutter.LayoutManager->Clutter.FlowLayout GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Clutter.LayoutManager GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned

Subclasses:None

Methods

Inherited:Clutter.LayoutManager (13), GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new (orientation)
  get_column_spacing ()
  get_column_width ()
  get_homogeneous ()
  get_orientation ()
  get_row_height ()
  get_row_spacing ()
  get_snap_to_grid ()
  set_column_spacing (spacing)
  set_column_width (min_width, max_width)
  set_homogeneous (homogeneous)
  set_orientation (orientation)
  set_row_height (min_height, max_height)
  set_row_spacing (spacing)
  set_snap_to_grid (snap_to_grid)

Virtual Methods

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

Properties

Name Type Flags Short Description
column-spacing float r/w The spacing between columns
homogeneous bool r/w Whether each item should receive the same allocation
max-column-width float r/w Maximum width for each column
max-row-height float r/w Maximum height for each row
min-column-width float r/w Minimum width for each column
min-row-height float r/w Minimum height for each row
orientation Clutter.FlowOrientation r/w/c The orientation of the layout
row-spacing float r/w The spacing between rows
snap-to-grid bool r/w Snap to grid

Fields

Inherited:Clutter.LayoutManager (1), GObject.Object (1)
Name Type Access Description
parent_instance Clutter.LayoutManager r  

Class Details

class Clutter.FlowLayout(**kwargs)
Bases:Clutter.LayoutManager
Abstract:No
Structure:Clutter.FlowLayoutClass

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

New in version 1.2.

classmethod new(orientation)
Parameters:orientation (Clutter.FlowOrientation) – the orientation of the flow layout
Returns:the newly created Clutter.FlowLayout
Return type:Clutter.LayoutManager

Creates a new Clutter.FlowLayout with the given orientation

New in version 1.2.

get_column_spacing()
Returns:the spacing between columns of the Clutter.FlowLayout, in pixels
Return type:float

Retrieves the spacing between columns

New in version 1.2.

get_column_width()
Returns:
min_width:return location for the minimum column width, or None
max_width:return location for the maximum column width, or None
Return type:(min_width: float, max_width: float)

Retrieves the minimum and maximum column widths

New in version 1.2.

get_homogeneous()
Returns:True if the Clutter.FlowLayout is homogeneous
Return type:bool

Retrieves whether the self is homogeneous

New in version 1.2.

get_orientation()
Returns:the orientation of the Clutter.FlowLayout
Return type:Clutter.FlowOrientation

Retrieves the orientation of the self

New in version 1.2.

get_row_height()
Returns:
min_height:return location for the minimum row height, or None
max_height:return location for the maximum row height, or None
Return type:(min_height: float, max_height: float)

Retrieves the minimum and maximum row heights

New in version 1.2.

get_row_spacing()
Returns:the spacing between rows of the Clutter.FlowLayout, in pixels
Return type:float

Retrieves the spacing between rows

New in version 1.2.

get_snap_to_grid()
Returns:True if the self is placing its children on a grid
Return type:bool

Retrieves the value of Clutter.FlowLayout :snap-to-grid property

New in version 1.16.

set_column_spacing(spacing)
Parameters:spacing (float) – the space between columns

Sets the space between columns, in pixels

New in version 1.2.

set_column_width(min_width, max_width)
Parameters:
  • min_width (float) – minimum width of a column
  • max_width (float) – maximum width of a column

Sets the minimum and maximum widths that a column can have

New in version 1.2.

set_homogeneous(homogeneous)
Parameters:homogeneous (bool) – whether the layout should be homogeneous or not

Sets whether the self should allocate the same space for each child

New in version 1.2.

set_orientation(orientation)
Parameters:orientation (Clutter.FlowOrientation) – the orientation of the layout

Sets the orientation of the flow layout

The orientation controls the direction used to allocate the children: either horizontally or vertically. The orientation also controls the direction of the overflowing

New in version 1.2.

set_row_height(min_height, max_height)
Parameters:
  • min_height (float) – the minimum height of a row
  • max_height (float) – the maximum height of a row

Sets the minimum and maximum heights that a row can have

New in version 1.2.

set_row_spacing(spacing)
Parameters:spacing (float) – the space between rows

Sets the spacing between rows, in pixels

New in version 1.2.

set_snap_to_grid(snap_to_grid)
Parameters:snap_to_grid (bool) – True if self should place its children on a grid

Whether the self should place its children on a grid.

New in version 1.16.

Property Details

Clutter.FlowLayout.props.column_spacing
Name:column-spacing
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

The spacing between columns, in pixels; the value of this property is honoured by horizontal non-overflowing layouts and by vertical overflowing layouts

New in version 1.2.

Clutter.FlowLayout.props.homogeneous
Name:homogeneous
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Whether each child inside the Clutter.FlowLayout should receive the same allocation

New in version 1.2.

Clutter.FlowLayout.props.max_column_width
Name:max-column-width
Type:float
Default Value:-1.0
Flags:READABLE, WRITABLE

Maximum width for each column in the layout, in pixels. If set to -1 the width will be the maximum child width

New in version 1.2.

Clutter.FlowLayout.props.max_row_height
Name:max-row-height
Type:float
Default Value:-1.0
Flags:READABLE, WRITABLE

Maximum height for each row in the layout, in pixels. If set to -1 the width will be the maximum child height

New in version 1.2.

Clutter.FlowLayout.props.min_column_width
Name:min-column-width
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

Minimum width for each column in the layout, in pixels

New in version 1.2.

Clutter.FlowLayout.props.min_row_height
Name:min-row-height
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

Minimum height for each row in the layout, in pixels

New in version 1.2.

Clutter.FlowLayout.props.orientation
Name:orientation
Type:Clutter.FlowOrientation
Default Value:Clutter.FlowOrientation.HORIZONTAL
Flags:READABLE, WRITABLE, CONSTRUCT

The orientation of the Clutter.FlowLayout. The children of the layout will be layed out following the orientation.

This property also controls the overflowing directions

New in version 1.2.

Clutter.FlowLayout.props.row_spacing
Name:row-spacing
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

The spacing between rows, in pixels; the value of this property is honoured by vertical non-overflowing layouts and by horizontal overflowing layouts

New in version 1.2.

Clutter.FlowLayout.props.snap_to_grid
Name:snap-to-grid
Type:bool
Default Value:True
Flags:READABLE, WRITABLE

Whether the Clutter.FlowLayout should arrange its children on a grid

New in version 1.16.