Progress widget. More...

Inheritance diagram for stmg::ProgressWidget:

Classes
struct	Init

struct	LocalInit

Public Member Functions
int32_t	getMinValue () const noexcept
	The minimum value. More...

int32_t	getMaxValue () const noexcept
	The maximum value. More...

int32_t	getThresholdValue () const noexcept
	The threshold value. More...

bool	getDangerBelow () const noexcept
	Whether the danger color is below the thresold. More...

const IntSet &	getMarks () const noexcept
	The marks. 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...

	ProgressWidget (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

Progress widget.

Used for representing a variable as a progress bar. The bar can have two colors, normal and danger depending on the value of the threshold.

The bar can also have marks.

Constructor & Destructor Documentation

◆ ProgressWidget()

stmg::ProgressWidget::ProgressWidget ( Init && oInit )

inlineexplicitnoexcept

Constructor.

Parameters

oInit The initialization data.

Member Function Documentation

◆ dump()

void stmg::ProgressWidget::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.

◆ getDangerBelow()

bool stmg::ProgressWidget::getDangerBelow ( ) const

inlinenoexcept

Whether the danger color is below the thresold.

Returns: Whether danger.

◆ getMarks()

const IntSet& stmg::ProgressWidget::getMarks ( ) const

inlinenoexcept

The marks.

Returns: The main marks.

◆ getMaxValue()

int32_t stmg::ProgressWidget::getMaxValue ( ) const

inlinenoexcept

The maximum value.

Returns: The maximum value.

◆ getMinValue()

int32_t stmg::ProgressWidget::getMinValue ( ) const

inlinenoexcept

The minimum value.

Returns: The minimum value.

◆ getThresholdValue()

int32_t stmg::ProgressWidget::getThresholdValue ( ) const

inlinenoexcept

The threshold value.

Returns: The threshold value.

◆ isChanged()

bool stmg::ProgressWidget::isChanged ( ) const

noexcept

Whether the variable's value has changed.

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

◆ reInit()

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

inlineprotectednoexcept

Reinitialization.

Parameters

oInit The initialization data.

◆ variable()

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

inlinenoexcept

The variable shown by the widget.

Returns: The variable.

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ProgressWidget()

Member Function Documentation

◆ dump()

◆ getDangerBelow()

◆ getMarks()

◆ getMaxValue()

◆ getMinValue()

◆ getThresholdValue()

◆ isChanged()

◆ reInit()

◆ variable()