Class for setup the table layout. More...

#include <TableLayout.hpp>

Inheritance diagram for geos::TableLayout:

Classes
class	Cell
	Represents a cell in a table with ownership of its text data. More...

class	CellLayout
	View on cell data with information to display it in a table (content, type, alignment, ...). More...

class	Column
	Class representing a column in a table layout. More...

struct	ColumnAlignement
	Structure to set up values m_alignment for each colum. More...

class	DeepFirstIterator
	Iterator to loop over all columns, starting by the deepest sub columns, then to their parents, then to their siblings. More...

Public Types
enum	Alignment { right , left , center }
	Type of aligment for a column.

enum	MarginValue : integer { tiny = 0 , small = 1 , medium = 2 , large = 3 }
	Space to apply between all data and border.

enum	Section { header , values }
	Enumeration for table sections.

using	TableLayoutArgs = std::initializer_list< std::variant< string_view, TableLayout::Column > >
	Alias for an initializer list of variants that can contain either a string or a layout column.

using	ColumnsList = Column::ColumnsList
	Alias for the list of columns.

Public Member Functions
DeepFirstIterator	beginDeepFirst () const

DeepFirstIterator	endDeepFirst () const

	TableLayout (string_view title, std::vector< TableLayout::Column > const &columns)
	Construct a new Table Layout object. More...

	TableLayout (string_view title, TableLayoutArgs args)
	Construct a new Table Layout object. More...

	TableLayout (TableLayoutArgs args)
	Construct a new Table Layout object. More...

	TableLayout (string_view title, std::vector< string > const &args)
	Construct a new Table Layout object. More...

ColumnsList const &	getColumns () const

ColumnsList &	getColumns ()

CellLayout const &	getTitleLayout () const

CellLayout &	getTitleLayout ()

string_view	getTitleStr () const

TableLayout &	setTitle (string_view title)

TableLayout &	enableLineBreak (bool value)
	Remove the return line at the end & begenning of the table. More...

TableLayout &	setMargin (MarginValue marginValue)
	Set the minimal margin width between cell content and borders. More...

TableLayout &	setMaxColumnWidth (size_t width)
	Set the maximal width for each column. More...

bool	isMaxColumnWidthSet ()
	check if a column max width has been set More...

bool	isLineBreakEnabled () const

integer const &	getBorderMargin () const

integer const &	getColumnMargin () const

integer const &	getMarginValue () const

size_t const &	getMaxColumnWidth () const

void	addColumns (std::vector< TableLayout::Column > const &columnNames)
	Create and add columns to the columns vector given a string vector. More...

void	addColumns (std::vector< string > const &columns)
	Create and add columns to the columns vector given a string vector. More...

void	addColumn (string_view columnName)
	Create and add a column to the columns vector given a string. More...

void	addColumn (TableLayout::Column const &column)
	Create and add a column to the columns vector given a Column. More...

Static Public Attributes
static constexpr size_t	noColumnMaxWidth = std::numeric_limits< size_t >::max()
	default value for m_maxColumnWidth when it is not set

static constexpr Alignment	defaultHeaderAlignment = Alignment::center
	default value for columns header cells alignement

static constexpr Alignment	defaultValueAlignment = Alignment::right
	default value for data cells alignement

Protected Member Functions
void	processArguments (TableLayoutArgs args)
	Add a column to the table given an initializer_list of string & Column. More...

template<typename ... Ts>
void	processArguments (Ts &... args)

Protected Attributes
ColumnsList	m_tableColumns
	Columns settings hierarchy.

bool	m_lineBreakAtBegin = true
	Indicate if we have a line break a the beginning of the table.

string	m_tableTitleStr
	Table title text.

CellLayout	m_tableTitleLayout = CellLayout( CellType::Header, Alignment::center )
	Table title cell layout settings.

size_t	m_maxColumnWidth = noColumnMaxWidth
	Max width for each column.

integer	m_borderMargin
	The number of spaces at each table sides.

integer	m_columnMargin
	The number of character between two columns (spaces + the separacting character).

integer	m_marginValue
	The number of margin spaces around contents.

Detailed Description

Class for setup the table layout.

Definition at line 35 of file TableLayout.hpp.

Constructor & Destructor Documentation

◆ TableLayout() [1/4]

geos::TableLayout::TableLayout	(	string_view	title,
		std::vector< TableLayout::Column > const &	columns
	)

inline

Construct a new Table Layout object.

Parameters

title	The table title
columns	A vector containing all column initialized

Definition at line 535 of file TableLayout.hpp.

◆ TableLayout() [2/4]

geos::TableLayout::TableLayout	(	string_view	title,
		TableLayoutArgs	args
	)

inline

Construct a new Table Layout object.

Parameters

title	The table title
args	An initializer_list containing string / column

Definition at line 548 of file TableLayout.hpp.

◆ TableLayout() [3/4]

geos::TableLayout::TableLayout ( TableLayoutArgs args )

inline

Construct a new Table Layout object.

Parameters

args	An initializer_list containing string / column

Definition at line 561 of file TableLayout.hpp.

◆ TableLayout() [4/4]

geos::TableLayout::TableLayout	(	string_view	title,
		std::vector< string > const &	args
	)

inline

Construct a new Table Layout object.

Parameters

title	The table title
args	An initializer_list containing string / column

Definition at line 572 of file TableLayout.hpp.

Member Function Documentation

◆ addColumn() [1/2]

void geos::TableLayout::addColumn ( string_view columnName )

Create and add a column to the columns vector given a string.

Parameters

columnName The column name

◆ addColumn() [2/2]

void geos::TableLayout::addColumn ( TableLayout::Column const & column )

Create and add a column to the columns vector given a Column.

Parameters

column Vector containing addition information on the column

◆ addColumns() [1/2]

void geos::TableLayout::addColumns ( std::vector< string > const & columns )

Create and add columns to the columns vector given a string vector.

Parameters

columns The columns list

◆ addColumns() [2/2]

void geos::TableLayout::addColumns ( std::vector< TableLayout::Column > const & columnNames )

Create and add columns to the columns vector given a string vector.

Parameters

columnNames The columns name

◆ beginDeepFirst()

DeepFirstIterator geos::TableLayout::beginDeepFirst ( ) const

Returns: Return an itarator pointing on the first leaf of the first columns vector Example on 2 column with Column A : 2 layer and Column B : 3 layers A.A -> A-B -> A-C -> A -> B-A-A -> B-A-B -> B-A -> B-B-A -> B-B-B -> B-B -> B

◆ enableLineBreak()

TableLayout& geos::TableLayout::enableLineBreak ( bool value )

Remove the return line at the end & begenning of the table.

Parameters

value Value to desactivate or not wrapLine at the end

Returns: The tableLayout reference

◆ endDeepFirst()

DeepFirstIterator geos::TableLayout::endDeepFirst ( ) const

inline

Returns: Return a end itarator This iterator is initialized with a null pointer representing a position after the last valid element

Definition at line 515 of file TableLayout.hpp.

◆ getBorderMargin()

integer const& geos::TableLayout::getBorderMargin ( ) const

inline

Returns: The number of spaces at each table sides

Definition at line 652 of file TableLayout.hpp.

◆ getColumnMargin()

integer const& geos::TableLayout::getColumnMargin ( ) const

inline

Returns: The number of character between two columns (spaces + the separacting character).

Definition at line 658 of file TableLayout.hpp.

◆ getColumns() [1/2]

ColumnsList& geos::TableLayout::getColumns ( )

inline

Returns: The columns list

Definition at line 589 of file TableLayout.hpp.

◆ getColumns() [2/2]

ColumnsList const& geos::TableLayout::getColumns ( ) const

inline

Returns: The columns list

Definition at line 583 of file TableLayout.hpp.

◆ getMarginValue()

integer const& geos::TableLayout::getMarginValue ( ) const

inline

Returns: The number of margin spaces around contents.

Definition at line 664 of file TableLayout.hpp.

◆ getMaxColumnWidth()

size_t const& geos::TableLayout::getMaxColumnWidth ( ) const

inline

Returns: The margin title

Definition at line 670 of file TableLayout.hpp.

◆ getTitleLayout() [1/2]

CellLayout& geos::TableLayout::getTitleLayout ( )

inline

Returns: The table name. Returned as a for multiline support.

Definition at line 601 of file TableLayout.hpp.

◆ getTitleLayout() [2/2]

CellLayout const& geos::TableLayout::getTitleLayout ( ) const

inline

Returns: The table name. Returned as a for multiline support.

Definition at line 595 of file TableLayout.hpp.

◆ getTitleStr()

string_view geos::TableLayout::getTitleStr ( ) const

inline

Returns: The table name. Returned as a for multiline support.

Definition at line 607 of file TableLayout.hpp.

◆ isLineBreakEnabled()

bool geos::TableLayout::isLineBreakEnabled ( ) const

Returns: check if the line break at the end & beginning is activated

◆ isMaxColumnWidthSet()

bool geos::TableLayout::isMaxColumnWidthSet ( )

inline

check if a column max width has been set

Returns: Truef a column max width has been set, otherwise false

Definition at line 641 of file TableLayout.hpp.

◆ processArguments() [1/2]

void geos::TableLayout::processArguments ( TableLayoutArgs args )

inlineprotected

Add a column to the table given an initializer_list of string & Column.

Parameters

args	An initializer_list containing string / column

Definition at line 703 of file TableLayout.hpp.

◆ processArguments() [2/2]

template<typename ... Ts>

void geos::TableLayout::processArguments ( Ts &... args )

inlineprotected

Template Parameters

Ts	The remaining arguments

Parameters

args	The remaining arguments to be processed

Definition at line 718 of file TableLayout.hpp.

◆ setMargin()

TableLayout& geos::TableLayout::setMargin ( MarginValue marginValue )

Set the minimal margin width between cell content and borders.

Parameters

marginValue The margin value

Returns: The tableLayout reference

◆ setMaxColumnWidth()

TableLayout& geos::TableLayout::setMaxColumnWidth ( size_t width )

Set the maximal width for each column.

Parameters

width The max column width

Returns: The tableLayout reference

◆ setTitle()

TableLayout& geos::TableLayout::setTitle ( string_view title )

Parameters

title The table title

Returns: The tableLayout reference

The documentation for this class was generated from the following file:

coreComponents/common/format/table/TableLayout.hpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TableLayout() [1/4]

◆ TableLayout() [2/4]

◆ TableLayout() [3/4]

◆ TableLayout() [4/4]

Member Function Documentation

◆ addColumn() [1/2]

◆ addColumn() [2/2]

◆ addColumns() [1/2]

◆ addColumns() [2/2]

◆ beginDeepFirst()

◆ enableLineBreak()

◆ endDeepFirst()

◆ getBorderMargin()

◆ getColumnMargin()

◆ getColumns() [1/2]

◆ getColumns() [2/2]

◆ getMarginValue()

◆ getMaxColumnWidth()

◆ getTitleLayout() [1/2]

◆ getTitleLayout() [2/2]

◆ getTitleStr()

◆ isLineBreakEnabled()

◆ isMaxColumnWidthSet()

◆ processArguments() [1/2]

◆ processArguments() [2/2]

◆ setMargin()

◆ setMaxColumnWidth()

◆ setTitle()