Inheritance diagram for stmg::VarWidget:

Classes
struct	Init

struct	LocalInit

Public Member Functions
const std::string &	getTitle () const noexcept
	The title shown with the variable. More...

int32_t	getTitleFactorPerc () const noexcept
	The percent of space of the widget the title should occupy. More...

bool	getTitleBesideValue () const noexcept
	Whether the title and value are boxed horizontally or vertically. More...

int32_t	getValueDigits () const noexcept
	Guideline maximum size in digits the variable value can take. More...

WidgetAxisFit::ALIGN	getTitleAlign (int32_t nLayoutConfig) const noexcept
	How the title should be aligned by the view. More...

WidgetAxisFit::ALIGN	getValueAlign (int32_t nLayoutConfig) const noexcept
	How the variable value should be aligned by the view. More...

const Variable &	variable () const noexcept
	The variable shown by the widget. More...

bool	isChanged () const noexcept
	Whether the variable's value has changed. More...

	VarWidget (Init &&oInit) noexcept
	Constructor. More...

void	dump (int32_t nIndentSpaces, bool bHeader) const noexcept override
	Writes object contents to std::cout. More...

Public Member Functions inherited from stmg::RelSizedGameWidget
double	getReferenceWFactor () const noexcept
	The width size factor to the reference widget. More...

double	getReferenceHFactor () const noexcept
	The height size factor to the reference widget. More...

double	getWHRatio () const noexcept
	The width to height ratio. More...

Public Member Functions inherited from stmg::GameWidget
virtual	~GameWidget () noexcept=default

int32_t	getViewWidgetNameIdx () const noexcept
	The type (name) that might be used to choose a ThemeWidget. More...

const std::string &	getName () const noexcept
	The name of the widget. More...

int32_t	getTeam () const noexcept
	The team the widget is assigned to. More...

int32_t	getMate () const noexcept
	The mate the widget is assigned to. More...

WidgetAxisFit	getWidgetHorizAxisFit (int32_t nLayoutConfig) const noexcept
	Widget alignment and expansion for the x axis. More...

WidgetAxisFit	getWidgetVertAxisFit (int32_t nLayoutConfig) const noexcept
	Widget alignment and expansion for the y axis. More...

bool	isAssignedToHuman () const noexcept
	Tells whether the widget is assigned to a human. More...

ContainerWidget *	getContainer () const noexcept
	The container to which this widget was added to. More...

void	dump (int32_t nIndentSpaces) const noexcept
	Writes object contents to std::cout (header included). More...

void	dump () const noexcept
	Writes object contents to std::cout (header included). More...

Protected Member Functions
void	reInit (Init &&oInit) noexcept
	Reinitialization. More...

Protected Member Functions inherited from stmg::RelSizedGameWidget
	RelSizedGameWidget (Init &&oInit) noexcept
	Constructor. More...

void	reInit (Init &&oInit) noexcept
	Reinitialization. More...

Protected Member Functions inherited from stmg::GameWidget
	GameWidget (Init &&oData) noexcept
	Constructor. More...

void	reInit (Init &&oData) noexcept
	Reinitialization. More...

Layout &	layout () noexcept
	The layout the widget belongs to. More...

const Layout &	layout () const noexcept
	The layout the widget belongs to. More...

GameProxy &	game () noexcept
	The game the widget belongs to. More...

const GameProxy &	game () const noexcept
	The game the widget belongs to. More...

virtual void	onAddedToLayout () noexcept
	Signals widget was added to layout. More...

virtual void	onAddedToGame () noexcept
	Signals widget was added to game. More...

Detailed Description

Variable widget.

Used for representing a variable such as points or time.

Constructor & Destructor Documentation

◆ VarWidget()

stmg::VarWidget::VarWidget ( Init && oInit )

inlineexplicitnoexcept

Constructor.

Parameters

oInit The initialization data.

Member Function Documentation

◆ dump()

void stmg::VarWidget::dump	(	int32_t	nIndentSpaces,
		bool	bHeader
	)		const

overridevirtualnoexcept

Writes object contents to std::cout.

Should only do it in debug mode. The function is also exposed in release mode because it is virtual.

If bHeader is true this function should also output the type of the object and its address.

Parameters

nIndentSpaces	Number of spaces put in front of each output line.
bHeader	Whether the header of the object should be displayed.

Reimplemented from stmg::RelSizedGameWidget.

◆ getTitle()

const std::string& stmg::VarWidget::getTitle ( ) const

inlinenoexcept

The title shown with the variable.

Returns: The title. Can be empty.

◆ getTitleAlign()

WidgetAxisFit::ALIGN stmg::VarWidget::getTitleAlign ( int32_t nLayoutConfig ) const

inlinenoexcept

How the title should be aligned by the view.

If WidgetAxisFit::ALIGN_FILL is returned the view should decide the alignment.

Parameters

nLayoutConfig The layout config.

Returns: The title alignment.

◆ getTitleBesideValue()

bool stmg::VarWidget::getTitleBesideValue ( ) const

inlinenoexcept

Whether the title and value are boxed horizontally or vertically.

Returns: Whether title is beside value (boxed horizontally).

◆ getTitleFactorPerc()

int32_t stmg::VarWidget::getTitleFactorPerc ( ) const

inlinenoexcept

The percent of space of the widget the title should occupy.

Returns: The percent. Must be >=0 and <=100.

◆ getValueAlign()

WidgetAxisFit::ALIGN stmg::VarWidget::getValueAlign ( int32_t nLayoutConfig ) const

inlinenoexcept

How the variable value should be aligned by the view.

If WidgetAxisFit::ALIGN_FILL is returned the view should decide the alignment.

Parameters

nLayoutConfig The layout config.

Returns: The variable value alignment.

◆ getValueDigits()

int32_t stmg::VarWidget::getValueDigits ( ) const

inlinenoexcept

Guideline maximum size in digits the variable value can take.

Example: If the variable is expected to vary from '-500' to '500' this function should return '4' (= sizeof('-500')).

Returns: The maximum number of digits the variable can take.

◆ isChanged()

bool stmg::VarWidget::isChanged ( ) const

noexcept

Whether the variable's value has changed.

If reInit() is called the change is not detected.

◆ reInit()

void stmg::VarWidget::reInit ( Init && oInit )

inlineprotectednoexcept

Reinitialization.

Parameters

oInit The initialization data.

◆ variable()

const Variable& stmg::VarWidget::variable ( ) const

noexcept

The variable shown by the widget.

Returns: The variable.

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VarWidget()

Member Function Documentation

◆ dump()

◆ getTitle()

◆ getTitleAlign()

◆ getTitleBesideValue()

◆ getTitleFactorPerc()

◆ getValueAlign()

◆ getValueDigits()

◆ isChanged()

◆ reInit()

◆ variable()