tgui::AbsoluteOrRelativeValue Class Reference

Class to store the a value that is either a constant or a ratio. More...

#include <TGUI/AbsoluteOrRelativeValue.hpp>

Inheritance diagram for tgui::AbsoluteOrRelativeValue:

Public Member Functions
constexpr	AbsoluteOrRelativeValue ()=default
	Default constructor.
template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
constexpr	AbsoluteOrRelativeValue (T constant)
	Constructor to set constant. More...
	AbsoluteOrRelativeValue (const char *expression)
	Construct the value from a string that either contains a value or a percentage. More...
	AbsoluteOrRelativeValue (const String &expression)
	Construct the value from a string that either contains a value or a percentage. More...
constexpr float	getValue () const
	Returns the value. More...
constexpr float	getRatio () const
	Returns the stored ratio. More...
constexpr bool	isConstant () const
	Returns whether the value is constant or a ratio. More...
constexpr void	updateParentSize (float newParentSize)
String	toString () const

Protected Attributes
bool	m_constant = true
float	m_value = 0
float	m_ratio = 0
float	m_parentValue = 0

Detailed Description

Class to store the a value that is either a constant or a ratio.

You don't have to explicitly create an instance of this class, numbers and strings are implicitly cast.

Constructor & Destructor Documentation

AbsoluteOrRelativeValue() [1/3]

template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>

constexpr tgui::AbsoluteOrRelativeValue::AbsoluteOrRelativeValue ( T  constant )

inlineconstexpr

Constructor to set constant.

Parameters

constant

Value to set

AbsoluteOrRelativeValue() [2/3]

tgui::AbsoluteOrRelativeValue::AbsoluteOrRelativeValue ( const char *  expression )

inline

Construct the value from a string that either contains a value or a percentage.

Parameters

expression

String to parse

AbsoluteOrRelativeValue() [3/3]

tgui::AbsoluteOrRelativeValue::AbsoluteOrRelativeValue ( const String &  expression )

inline

Construct the value from a string that either contains a value or a percentage.

Parameters

expression

String to parse

Member Function Documentation

getRatio()

constexpr float tgui::AbsoluteOrRelativeValue::getRatio ( ) const

inlineconstexpr

Returns the stored ratio.

Returns

The ratio that is multiplied with the parent size to get the value, when the value isn't a constant

getValue()

constexpr float tgui::AbsoluteOrRelativeValue::getValue ( ) const

inlineconstexpr

Returns the value.

Returns

The constant value or the value based on the given ratio and parent size

isConstant()

constexpr bool tgui::AbsoluteOrRelativeValue::isConstant ( ) const

inlineconstexpr

Returns whether the value is constant or a ratio.

Returns

Does the value contain a constant?

---

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

• include/TGUI/AbsoluteOrRelativeValue.hpp