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

#include <TableLayout.hpp>

Public Types
using	ColumnsList = std::vector< Column >
	Alias for the list of columns.

Public Member Functions
	Column ()
	Construct a default column with no parameter (must be configurated).

	Column (string_view name)
	Construct a default column with minimal parameters. More...

	Column (string_view name, ColumnAlignement alignment)
	Construct a default column with minimal parameters. More...

Column *	getParent ()
	Get the parent column. More...

Column const *	getParent () const
	Get the parent column. More...

void	setParent (Column *parent)
	Set the parent column. More...

Column *	getNext ()

Column const *	getNext () const

void	setNext (Column *nextCell)

Column &	setName (string_view name)
	Sets the name of the column. More...

Column &	setVisibility (bool visible)
	Set the column and its children visibility. More...

Column &	addSubColumns (std::initializer_list< Column > subCol)
	Adds multiple sub-columns to the column. More...

Column &	addSubColumns (std::initializer_list< string > subColNames)
	Adds multiple sub-columns to the column. More...

Column &	addSubColumns (std::vector< string > const &subColNames)
	Adds multiple sub-columns to the column. More...

Column &	addSubColumn (string_view subColName)
	Adds a single sub-column to the column. More...

Column &	addSubColumn (Column const &subCol)
	Adds a single sub-column to the column. More...

Column &	setHeaderAlignment (Alignment headerAlignment)
	Sets the header alignment for the column. More...

Column &	setValuesAlignment (Alignment valueAlignment)
	Sets the values alignment for the column. More...

bool	hasChild () const
	Checks if the column has any child columns. More...

bool	hasParent () const
	Checks if the column has a parent column. More...

bool	hasNext () const

bool	isVisible () const

Public Attributes
Cell	m_header
	The header cell.

ColumnsList	m_subColumns
	A vector containing all sub-columns in the column.

ColumnAlignement	m_alignment
	struct containing m_alignment for the column (header and values)

Detailed Description

Class representing a column in a table layout.

Definition at line 242 of file TableLayout.hpp.

Constructor & Destructor Documentation

◆ Column() [1/2]

geos::TableLayout::Column::Column ( string_view name )

inlineexplicit

Construct a default column with minimal parameters.

Parameters

name	The name of the Column.

Definition at line 264 of file TableLayout.hpp.

◆ Column() [2/2]

geos::TableLayout::Column::Column	(	string_view	name,
		ColumnAlignement	alignment
	)

Construct a default column with minimal parameters.

Parameters

name	The name of the Column.
alignment	The alignment setting of the column header and values.

Member Function Documentation

◆ addSubColumn() [1/2]

Column& geos::TableLayout::Column::addSubColumn ( Column const & subCol )

Adds a single sub-column to the column.

Parameters

subCol The sub-column to add.

Returns: The current column object.

◆ addSubColumn() [2/2]

Column& geos::TableLayout::Column::addSubColumn ( string_view subColName )

Adds a single sub-column to the column.

Parameters

subColName The name of the sub-column to add.

Returns: The current column object.

◆ addSubColumns() [1/3]

Column& geos::TableLayout::Column::addSubColumns ( std::initializer_list< Column > subCol )

Adds multiple sub-columns to the column.

Parameters

subCol A list of sub-column names to add.

Returns: The current column object

◆ addSubColumns() [2/3]

Column& geos::TableLayout::Column::addSubColumns ( std::initializer_list< string > subColNames )

Adds multiple sub-columns to the column.

Parameters

subColNames A list of sub-column names to add.

Returns: The current column object

◆ addSubColumns() [3/3]

Column& geos::TableLayout::Column::addSubColumns ( std::vector< string > const & subColNames )

Adds multiple sub-columns to the column.

Parameters

subColNames A list of sub-column names to add.

Returns: The current column object

◆ getNext() [1/2]

Column* geos::TableLayout::Column::getNext ( )

inline

Returns: Pointer to the next column that has the same parent or nullptr if no next column exists.

Definition at line 299 of file TableLayout.hpp.

◆ getNext() [2/2]

Column const* geos::TableLayout::Column::getNext ( ) const

inline

Returns: Pointer to the next column that has the same parent or nullptr if no next column exists.

Definition at line 305 of file TableLayout.hpp.

◆ getParent() [1/2]

Column* geos::TableLayout::Column::getParent ( )

inline

Get the parent column.

Returns: Pointer to the parent column, or nullptr if no parent is set.

Definition at line 279 of file TableLayout.hpp.

◆ getParent() [2/2]

Column const* geos::TableLayout::Column::getParent ( ) const

inline

Get the parent column.

Returns: Pointer to the parent column, or nullptr if no parent is set.

Definition at line 286 of file TableLayout.hpp.

◆ hasChild()

bool geos::TableLayout::Column::hasChild ( ) const

inline

Checks if the column has any child columns.

Returns: bool True if the column has child columns, otherwise false.

Definition at line 381 of file TableLayout.hpp.

◆ hasNext()

bool geos::TableLayout::Column::hasNext ( ) const

inline

Returns: bool True if the column has a neightboor to its right that has the same parent.

Definition at line 394 of file TableLayout.hpp.

◆ hasParent()

bool geos::TableLayout::Column::hasParent ( ) const

inline

Checks if the column has a parent column.

Returns: bool True if the column has a parent, otherwise false.

Definition at line 388 of file TableLayout.hpp.

◆ isVisible()

bool geos::TableLayout::Column::isVisible ( ) const

inline

Returns: True if the column and its children are visible.

Definition at line 400 of file TableLayout.hpp.

◆ setHeaderAlignment()

Column& geos::TableLayout::Column::setHeaderAlignment ( Alignment headerAlignment )

Sets the header alignment for the column.

Parameters

headerAlignment The alignment to set for the column header (left, right, or center).

Returns: The current column object

◆ setName()

Column& geos::TableLayout::Column::setName ( string_view name )

Sets the name of the column.

Parameters

name	The name to set for the column.

Returns: The current column object.

◆ setNext()

void geos::TableLayout::Column::setNext ( Column * nextCell )

inline

Parameters

nextCell The next column in the table layout that has the same parent.

Definition at line 311 of file TableLayout.hpp.

◆ setParent()

void geos::TableLayout::Column::setParent ( Column * parent )

inline

Set the parent column.

Parameters

parent Pointer to the parent column to set.

Definition at line 293 of file TableLayout.hpp.

◆ setValuesAlignment()

Column& geos::TableLayout::Column::setValuesAlignment ( Alignment valueAlignment )

Sets the values alignment for the column.

Parameters

valueAlignment The alignment to set for the column values (left, right, or center).

Returns: The current column object

◆ setVisibility()

Column& geos::TableLayout::Column::setVisibility ( bool visible )

Set the column and its children visibility.

Parameters

visible True to make the column visible.

Returns: The current column .

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

coreComponents/common/format/table/TableLayout.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Column() [1/2]

◆ Column() [2/2]

Member Function Documentation

◆ addSubColumn() [1/2]

◆ addSubColumn() [2/2]

◆ addSubColumns() [1/3]

◆ addSubColumns() [2/3]

◆ addSubColumns() [3/3]

◆ getNext() [1/2]

◆ getNext() [2/2]

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ hasChild()

◆ hasNext()

◆ hasParent()

◆ isVisible()

◆ setHeaderAlignment()

◆ setName()

◆ setNext()

◆ setParent()

◆ setValuesAlignment()

◆ setVisibility()