Vivoe Lite 0.5.0
Lightweight GVA like HMI for military displays.
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gva::CellType Class Reference

This is the class describing a TableWidget cell. More...

#include <cell_type.h>

Collaboration diagram for gva::CellType:
Collaboration graph

Public Member Functions

 CellType ()=default
 Construct a new Cell Type object.
 
 ~CellType ()=default
 Destroy the Cell Type object.
 
 CellType (const std::string text, const uint32_t width, const uint32_t background_colour, const uint32_t foreground_colour, const uint32_t outline_colour, const uint32_t highlight_colour, const widget::CellAlignType alignment)
 Construct a new Cell Type object.
 
 CellType (const CellType &a)
 Construct a new Cell Type object.
 
CellTypeoperator= (const CellType &a)
 Assignment operator.
 
uint32_t GetWidth () const
 Get the Width object.
 
std::string GetText () const
 Get the Text object.
 
void SetText (std::string_view text)
 Set the Text attribute.
 
uint32_t GetForegroundColour () const
 Get the Foreground Colour object.
 
uint32_t GetBackgroundColour () const
 Get the Background Colour object.
 
uint32_t GetOutlineColour () const
 Get the Outline Colour object.
 
uint32_t GetHighlightColour () const
 Get the Highlight Colour object.
 
widget::CellAlignType GetCellAlignment () const
 Get the Cell Alignment object.
 

Detailed Description

This is the class describing a TableWidget cell.

Constructor & Destructor Documentation

◆ CellType() [1/2]

gva::CellType::CellType ( const std::string  text,
const uint32_t  width,
const uint32_t  background_colour,
const uint32_t  foreground_colour,
const uint32_t  outline_colour,
const uint32_t  highlight_colour,
const widget::CellAlignType  alignment 
)

Construct a new Cell Type object.

Parameters
textThe text to display in the cell
widthThe width of the cell
background_colourThe background colour of the cell
foreground_colourThe foreground colour of the cell
outline_colourThe outline colour of the cell
highlight_colourThe highlight colour of the cell
alignmentThe alignment of the cell

◆ CellType() [2/2]

gva::CellType::CellType ( const CellType a)

Construct a new Cell Type object.

Parameters
aThe cell to copy

Member Function Documentation

◆ GetBackgroundColour()

uint32_t gva::CellType::GetBackgroundColour ( ) const

Get the Background Colour object.

Returns
const uint32_t

◆ GetCellAlignment()

widget::CellAlignType gva::CellType::GetCellAlignment ( ) const

Get the Cell Alignment object.

Returns
const CellAlignType

◆ GetForegroundColour()

uint32_t gva::CellType::GetForegroundColour ( ) const

Get the Foreground Colour object.

Returns
const uint32_t

◆ GetHighlightColour()

uint32_t gva::CellType::GetHighlightColour ( ) const

Get the Highlight Colour object.

Returns
const uint32_t

◆ GetOutlineColour()

uint32_t gva::CellType::GetOutlineColour ( ) const

Get the Outline Colour object.

Returns
const uint32_t

◆ GetText()

std::string gva::CellType::GetText ( ) const

Get the Text object.

Returns
const std::string

◆ GetWidth()

uint32_t gva::CellType::GetWidth ( ) const

Get the Width object.

Returns
const uint32_t

◆ operator=()

CellType & gva::CellType::operator= ( const CellType a)

Assignment operator.

Parameters
aThe cell to assign
Returns
CellType&

◆ SetText()

void gva::CellType::SetText ( std::string_view  text)

Set the Text attribute.

Parameters
text

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