The placement class for a vertical list. More...

#include <vertical_list.hpp>

Inheritance diagram for gui2::implementation::tplacer_vertical_list:

Public Member Functions
	tplacer_vertical_list (const unsigned maximum_columns)

virtual void	initialise ()
	Initialises the placer. More...

virtual void	add_item (const tpoint &size)
	Adds a item to be placed. More...

virtual tpoint	get_size () const
	Gets the required size of all items. More...

virtual tpoint	get_origin (const unsigned index) const
	Gets the origin for an item. More...

Public Member Functions inherited from gui2::tplacer_
virtual MAKE_ENUM(tgrow_direction,(horizontal,"horizontal")(vertical,"vertical")) public	~tplacer_ ()
	The direction the placer should grow towards. More...

Private Attributes
unsigned	maximum_columns_
	The maximum number of columns to use. More...

std::vector< std::pair< int, int > >	rows_
	Holds the row sizes. More...

std::vector< int >	columns_
	Holds the widths of the columns. More...

unsigned	row_
	The row to add an item to. More...

unsigned	column_
	The column to add an item to. More...

Detailed Description

The placement class for a vertical list.

See tplacer_ for more information.

Definition at line 38 of file vertical_list.hpp.

Constructor & Destructor Documentation

gui2::implementation::tplacer_vertical_list::tplacer_vertical_list ( const unsigned maximum_columns )

explicit

Definition at line 30 of file vertical_list.cpp.

References maximum_columns_.

Member Function Documentation

void gui2::implementation::tplacer_vertical_list::add_item ( const tpoint & size )

virtual

Adds a item to be placed.

Parameters

size	The required size for the item.

Implements gui2::tplacer_.

Definition at line 49 of file vertical_list.cpp.

References column_, columns_, maximum_columns_, row_, rows_, gui2::tpoint::x, and gui2::tpoint::y.

tpoint gui2::implementation::tplacer_vertical_list::get_origin ( const unsigned index ) const

virtual

Gets the origin for an item.

Parameters

index The index of the item whose origin to return. The index is the index of the call to add_item().

Returns: The origin where to place the widget.

Implements gui2::tplacer_.

Definition at line 76 of file vertical_list.cpp.

References columns_, maximum_columns_, and rows_.

tpoint gui2::implementation::tplacer_vertical_list::get_size ( ) const

virtual

Gets the required size of all items.

Returns: The required size.

Implements gui2::tplacer_.

Definition at line 69 of file vertical_list.cpp.

References columns_, and rows_.

void gui2::implementation::tplacer_vertical_list::initialise ( )

virtual

Initialises the placer.

When the placement needs to be calculated the state often needs to be reset, items are placed, removed or changed visibility causing the old placement to be invalid.

Implements gui2::tplacer_.

Definition at line 40 of file vertical_list.cpp.

References column_, columns_, row_, and rows_.