TGUI  0.9-beta
tgui::TextStyles Class Reference

Wrapper for text styles. More...

#include <TGUI/TextStyle.hpp>

Public Member Functions

TGUI_CONSTEXPR TextStyles ()
 Creates the object without a text style. More...
 
TGUI_CONSTEXPR TextStyles (unsigned int style)
 Creates the object from one or more tgui::TextStyle::Style enum members. More...
 
 TextStyles (const String &string)
 Creates the object from a string representing the text styles. More...
 
 TextStyles (const char *string)
 Creates the object from a string representing the text styles. More...
 
TGUI_CONSTEXPR bool isSet () const
 Checks if a style was set. More...
 
TGUI_CONSTEXPR operator unsigned int () const
 Converts this object into an unsigned int. More...
 

Detailed Description

Wrapper for text styles.

The class is used for 2 purposes:

  • Implicit converter for parameters. A function taking a TextStyles as parameter can be given either a tgui::TextStyle (or multiple combined with | operator) or a string representation as argument.
  • Storing no style at all. Some style settings may be optionally set and can thus remain unspecified.

Constructor & Destructor Documentation

◆ TextStyles() [1/4]

TGUI_CONSTEXPR tgui::TextStyles::TextStyles ( )
inline

Creates the object without a text style.

The isSet function will return false when the object was created using this constructor.

◆ TextStyles() [2/4]

TGUI_CONSTEXPR tgui::TextStyles::TextStyles ( unsigned int  style)
inline

Creates the object from one or more tgui::TextStyle::Style enum members.

Parameters
styleText style to set
TextStyles style{tgui::TextStyle::Italic | tgui::TextStyle::Bold};

◆ TextStyles() [3/4]

tgui::TextStyles::TextStyles ( const String string)

Creates the object from a string representing the text styles.

Parameters
stringString to be deserialized as text styles

◆ TextStyles() [4/4]

tgui::TextStyles::TextStyles ( const char *  string)

Creates the object from a string representing the text styles.

Parameters
stringString to be deserialized as text styles
TextStyles style{"Italic | Bold"};

Member Function Documentation

◆ isSet()

TGUI_CONSTEXPR bool tgui::TextStyles::isSet ( ) const
inline

Checks if a style was set.

Returns
True if a text style was passed to the constructor, false when the default constructor was used

◆ operator unsigned int()

TGUI_CONSTEXPR tgui::TextStyles::operator unsigned int ( ) const
inline

Converts this object into an unsigned int.

Returns
The text styles stored in this object, or tgui::TextStyle::Regular if no style was set

The documentation for this class was generated from the following file:
TGUI_CONSTEXPR TextStyles()
Creates the object without a text style.
Definition: TextStyle.hpp:66