TGUI  v0.7.5
tgui::Layout Class Reference

Class to store the left, top, width or height of a widget. More...

#include <Layout.hpp>

Public Member Functions

 Layout ()
 Default constructor.
 
template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
 Layout (T constant)
 Constructor to implicitly construct from numeric constant. More...
 
 Layout (const char *expression)
 Construct the layout based on a string which will be parsed to determine the value of the layout. More...
 
 Layout (const std::string &expression)
 Construct the layout based on a string which will be parsed to determine the value of the layout. More...
 
 Layout (const Layout &copy)
 Copy constructor. More...
 
 ~Layout ()
 Destructor.
 
Layoutoperator= (const Layout &right)
 Overload of assignment operator. More...
 
float getValue () const
 Return the cached value of the layout. More...
 
Layout operator+ ()
 Unary plus operator for the Layout class.
 
Layout operator- ()
 Unary minus operator for the Layout class.
 
Layout operator+= (Layout right)
 += operator for the Layout class
 
Layout operator-= (Layout right)
 -= operator for the Layout class
 
Layout operator*= (Layout right)
 *= operator for the Layout class
 
Layout operator/= (Layout right)
 /= operator for the Layout class
 
Layout operator%= (Layout right)
 %= operator for the Layout class (floating point modulo)
 

Detailed Description

Class to store the left, top, width or height of a widget.

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

Constructor & Destructor Documentation

◆ Layout() [1/4]

template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
tgui::Layout::Layout ( constant)
inline

Constructor to implicitly construct from numeric constant.

Parameters
constantValue of the layout

◆ Layout() [2/4]

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

Construct the layout based on a string which will be parsed to determine the value of the layout.

Parameters
expressionString to parse

◆ Layout() [3/4]

tgui::Layout::Layout ( const std::string &  expression)

Construct the layout based on a string which will be parsed to determine the value of the layout.

Parameters
expressionString to parse

◆ Layout() [4/4]

tgui::Layout::Layout ( const Layout copy)

Copy constructor.

Parameters
copyInstance to copy

Member Function Documentation

◆ getValue()

float tgui::Layout::getValue ( ) const

Return the cached value of the layout.

Returns
Value of the layout

◆ operator=()

Layout& tgui::Layout::operator= ( const Layout right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

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