geos::TableLayout::CellLayout Class Reference

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

#include <TableLayout.hpp>

Public Member Functions
	CellLayout ()
	Constructor to initialize a Cell with a default settings. Use prepareLayout() when setup.
	CellLayout (CellType cellType)
	Constructor to initialize an empty Cell of a given type. More...
	CellLayout (CellType cellType, TableLayout::Alignment alignment)
	Constructor to fully initialize a cell with given celltype, text and alignment. m_cellWidth will be initialized aDter. More...
size_t	getWidth () const
void	setWidth (size_t cellWidth)
	Set the width of the cell, which must be constrained by the content lines length. More...
std::vector< string_view > const &	getLines () const
size_t	getHeight () const
size_t	isEmpty () const
void	prepareLayout (string_view value, size_t maxLineWidth)
	Set the data view to the given string_view & precompute display settings. More...

Public Attributes
CellType	m_cellType
	The type of the cell (Header,Value, Merge, ...).
Alignment	m_alignment
	The alignment of the cell (left, center, right).

Detailed Description

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

Note

the source text must not be freeed/moved as the CellLayout will only be a view on the text data.

Definition at line 81 of file TableLayout.hpp.

Constructor & Destructor Documentation

CellLayout() [1/2]

geos::TableLayout::CellLayout::CellLayout

(

CellType

cellType

)

Constructor to initialize an empty Cell of a given type.

Parameters

cellType

The type of the cell.

CellLayout() [2/2]

geos::TableLayout::CellLayout::CellLayout	(	CellType	cellType,
		TableLayout::Alignment	alignment
	)

Constructor to fully initialize a cell with given celltype, text and alignment. m_cellWidth will be initialized aDter.

Parameters

cellType	The type of the cell.
alignment	The alignment of the cell (left, right, or center).

Member Function Documentation

getHeight()

size_t geos::TableLayout::CellLayout::getHeight ( ) const

inline

Returns

get the height of the cell (its number of lines).

Definition at line 130 of file TableLayout.hpp.

getLines()

std::vector< string_view > const& geos::TableLayout::CellLayout::getLines ( ) const

inline

Returns

The view on each cell line.

Definition at line 124 of file TableLayout.hpp.

getWidth()

size_t geos::TableLayout::CellLayout::getWidth ( ) const

inline

Returns

The width of the cell, which must be constrained by the content lines length.

Definition at line 111 of file TableLayout.hpp.

isEmpty()

size_t geos::TableLayout::CellLayout::isEmpty ( ) const

inline

Returns

True if the cell has no text.

Definition at line 136 of file TableLayout.hpp.

prepareLayout()

void geos::TableLayout::CellLayout::prepareLayout	(	string_view	value,
		size_t	maxLineWidth
	)

Set the data view to the given string_view & precompute display settings.

Parameters

value	The view on the full cell text, with ' ' for manual line breaks. Must not be deallocated! getLines() will then contain each lines, and m_cellWidth, the maximum line width.
maxLineWidth	The maximum allowed line width. Use noColumnMaxWidth to disable.

setWidth()

void geos::TableLayout::CellLayout::setWidth ( size_t  cellWidth )

inline

Set the width of the cell, which must be constrained by the content lines length.

Parameters

cellWidth

the new width to consider for this cell.

Definition at line 118 of file TableLayout.hpp.

---

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

• coreComponents/common/format/table/TableLayout.hpp