TGUI  0.10-beta

Public Member Functions

 Text ()
 Default constructor.
 
 Text (const Text &)
 
 Text (Text &&) noexcept=default
 
Textoperator= (const Text &)
 
Textoperator= (Text &&) noexcept=default
 
void setPosition (Vector2f position)
 Sets the position of the text. More...
 
Vector2f getPosition () const
 Returns the position of the text. More...
 
Vector2f getSize () const
 Returns the size of the text. More...
 
void setString (const String &string)
 Changes the text. More...
 
const StringgetString () const
 Returns the text. More...
 
void setCharacterSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getCharacterSize () const
 Returns the character size of the text. More...
 
void setColor (Color color)
 Changes the text fill color. More...
 
Color getColor () const
 Returns the text fill color. More...
 
void setOpacity (float opacity)
 Changes the opacity of the text. More...
 
float getOpacity () const
 Returns the opacity of the text. More...
 
void setFont (Font font)
 Changes the font used for the text. More...
 
Font getFont () const
 Returns the font of the text. More...
 
void setStyle (TextStyles style)
 Changes the style of the text. More...
 
TextStyles getStyle () const
 Returns the style of the text. More...
 
void setOutlineColor (Color color)
 Changes the text outline color. More...
 
Color getOutlineColor () const
 Returns the text outline color. More...
 
void setOutlineThickness (float thickness)
 Changes the text outline thickness. More...
 
float getOutlineThickness () const
 Returns the text outline thickness. More...
 
Vector2f findCharacterPos (std::size_t index) const
 Return the position of the index-th character. More...
 
float getExtraHorizontalPadding () const
 Returns a small distance that text should be placed from the side of a widget as padding. More...
 
float getExtraHorizontalOffset () const
 Returns an extra distance that text should be placed from the side of a widget as padding. More...
 
float getLineHeight () const
 Returns the height of a single line of text.
 
float getLineWidth () const
 Returns the width of a single line of text.
 
std::shared_ptr< BackendTextgetBackendText () const
 Returns the internal text. More...
 

Static Public Member Functions

static float getExtraHorizontalPadding (Font font, unsigned int characterSize, TextStyles textStyle={})
 Returns a small distance that text should be placed from the side of a widget as padding. More...
 
static float getExtraHorizontalOffset (Font font, unsigned int characterSize, TextStyles textStyle={})
 Returns an extra distance that text should be placed from the side of a widget as padding. More...
 
static float getExtraVerticalPadding (unsigned int characterSize)
 Returns the distance that text should be placed from the bottom of the widget as padding.
 
static float getLineHeight (Font font, unsigned int characterSize, TextStyles textStyle={})
 Returns the height of a single line of text.
 
static float getLineWidth (const String &text, Font font, unsigned int characterSize, TextStyles textStyle={})
 Returns the width of a single line of text.
 
static unsigned int findBestTextSize (Font font, float height, int fit=0)
 Finds the best character size for the text. More...
 
static float calculateExtraVerticalSpace (Font font, unsigned int characterSize, TextStyles style={})
 
static String wordWrap (float maxWidth, const String &text, Font font, unsigned int textSize, bool bold, bool dropLeadingSpace=true)
 

Member Function Documentation

◆ calculateExtraVerticalSpace()

static float tgui::Text::calculateExtraVerticalSpace ( Font  font,
unsigned int  characterSize,
TextStyles  style = {} 
)
static

The line spacing of a font gives the distance between two lines. There may however be an overlap between the highest character on the bottom line and the smallest one on the top line. This function calculates that distance.

◆ findBestTextSize()

static unsigned int tgui::Text::findBestTextSize ( Font  font,
float  height,
int  fit = 0 
)
static

Finds the best character size for the text.

Parameters
fontFont of the text
heightHeight that the text should fill
fit0 to choose best fit, 1 to select font of at least that height, -1 to select font of maximum that height

◆ findCharacterPos()

Vector2f tgui::Text::findCharacterPos ( std::size_t  index) const

Return the position of the index-th character.

If index is out of range, the position of the end of the string is returned.

Parameters
indexIndex of the character
Returns
Position of the character
Warning
Unlike the function in sf::Text, this function does not take global transformations into account.

◆ getBackendText()

std::shared_ptr< BackendText > tgui::Text::getBackendText ( ) const

Returns the internal text.

Returns
Backend text that is used internally

◆ getCharacterSize()

unsigned int tgui::Text::getCharacterSize ( ) const

Returns the character size of the text.

Returns
The current text size

◆ getColor()

Color tgui::Text::getColor ( ) const

Returns the text fill color.

Returns
text color

◆ getExtraHorizontalOffset() [1/2]

float tgui::Text::getExtraHorizontalOffset ( ) const

Returns an extra distance that text should be placed from the side of a widget as padding.

This distance is slightly larger than getExtraHorizontalPadding.

◆ getExtraHorizontalOffset() [2/2]

static float tgui::Text::getExtraHorizontalOffset ( Font  font,
unsigned int  characterSize,
TextStyles  textStyle = {} 
)
static

Returns an extra distance that text should be placed from the side of a widget as padding.

This distance is slightly larger than getExtraHorizontalPadding.

◆ getExtraHorizontalPadding() [1/2]

float tgui::Text::getExtraHorizontalPadding ( ) const

Returns a small distance that text should be placed from the side of a widget as padding.

This distance is slightly smaller than getExtraHorizontalOffset.

◆ getExtraHorizontalPadding() [2/2]

static float tgui::Text::getExtraHorizontalPadding ( Font  font,
unsigned int  characterSize,
TextStyles  textStyle = {} 
)
static

Returns a small distance that text should be placed from the side of a widget as padding.

This distance is slightly smaller than getExtraHorizontalOffset.

◆ getFont()

Font tgui::Text::getFont ( ) const

Returns the font of the text.

Returns
text font

◆ getOpacity()

float tgui::Text::getOpacity ( ) const

Returns the opacity of the text.

Returns
text opacity

◆ getOutlineColor()

Color tgui::Text::getOutlineColor ( ) const

Returns the text outline color.

Returns
text outline color

◆ getOutlineThickness()

float tgui::Text::getOutlineThickness ( ) const

Returns the text outline thickness.

Returns
text outline thickness

◆ getPosition()

Vector2f tgui::Text::getPosition ( ) const

Returns the position of the text.

Returns
Text position

◆ getSize()

Vector2f tgui::Text::getSize ( ) const

Returns the size of the text.

Returns
Size required for drawing the text

◆ getString()

const String & tgui::Text::getString ( ) const

Returns the text.

Returns
The current text

◆ getStyle()

TextStyles tgui::Text::getStyle ( ) const

Returns the style of the text.

Returns
The current text style

◆ setCharacterSize()

void tgui::Text::setCharacterSize ( unsigned int  size)

Changes the character size of the text.

Parameters
sizeThe new text size

◆ setColor()

void tgui::Text::setColor ( Color  color)

Changes the text fill color.

Parameters
colorThe new text color

◆ setFont()

void tgui::Text::setFont ( Font  font)

Changes the font used for the text.

Parameters
fontThe new font

◆ setOpacity()

void tgui::Text::setOpacity ( float  opacity)

Changes the opacity of the text.

Parameters
opacityThe text opacity

◆ setOutlineColor()

void tgui::Text::setOutlineColor ( Color  color)

Changes the text outline color.

Parameters
colorThe new text outline color

◆ setOutlineThickness()

void tgui::Text::setOutlineThickness ( float  thickness)

Changes the text outline thickness.

Parameters
thicknessThe new text outline thickness

◆ setPosition()

void tgui::Text::setPosition ( Vector2f  position)

Sets the position of the text.

Parameters
positionPosition of the text

◆ setString()

void tgui::Text::setString ( const String string)

Changes the text.

Parameters
stringThe new text

◆ setStyle()

void tgui::Text::setStyle ( TextStyles  style)

Changes the style of the text.

The possible styles can be found in the tgui::TextStyle::Style enum. You can also pass a combination of multiple styles, for example tgui::TextStyle::Bold | tgui::TextStyle::Italic. The default style is tgui::TextStyle::Regular.

Parameters
styleNew text style

◆ wordWrap()

static String tgui::Text::wordWrap ( float  maxWidth,
const String text,
Font  font,
unsigned int  textSize,
bool  bold,
bool  dropLeadingSpace = true 
)
static

Takes a string and inserts newlines into it so that the width does not exceed maxWidth.

Parameters
maxWidthMaximum width of the text
textThe text to wrap
fontFont of the text
textSizeThe text size
boldShould the text be bold?
dropLeadingSpaceShould a single space at the beginning of a line be removed?

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