TouchGFX
touchgfx::Font::getStringWidth() const is only used within TouchGFX.
 
Symbols
loading...
Files
loading...
CodeScopeSTM32 Libraries and SamplesTouchGFXtouchgfx::Font::getStringWidth() const

touchgfx::Font::getStringWidth() const method

@fn virtual uint16_t Font::getStringWidth(const Unicode::UnicodeChar* text, ...) const; Gets the width in pixels of the specified string. Gets the width in pixels of the specified string. If the string contains multiple lines, the width of the widest line is found. Please note that the correct number of arguments must be given if the text contains wildcards. It is recommended to use the getStringWidth() implementation with the TextDirection parameter to ensure correct calculation of the width. Kerning could result in different results depending on the TextDirection. This method assumes TextDirection to be TEXT_DIRECTION_LTR.

Syntax

virtual uint16_t getStringWidth(const Unicode::UnicodeChar* text, ...) const;

Arguments

text

A zero-terminated unicode string with arguments to insert if the text contains wildcards.

Return value

The width in pixels of the longest line of the specified string.

References

LocationReferrerScopeText
Font.hpp:246
virtual uint16_t getStringWidth(const Unicode::UnicodeChar* text, ...) const;
Font.hpp:273
virtual uint16_t getStringWidth(TextDirection textDirection, const Unicode::UnicodeChar* text, ...) const;
TextAreaWithWildcard.hpp:169touchgfx::TextAreaWithOneWildcard::getTextWidth() consttouchgfx::TextAreaWithOneWildcard
return typedText.hasValidId() ? typedText.getFont()->getStringWidth(typedText.getTextDirection(), typedText.getText(), wildcard) : 0;
TextAreaWithWildcard.hpp:323touchgfx::TextAreaWithTwoWildcards::getTextWidth() consttouchgfx::TextAreaWithTwoWildcards
return typedText.hasValidId() ? typedText.getFont()->getStringWidth(typedText.getTextDirection(), typedText.getText(), wc1, wc2) : 0;

Call Tree

Functions calling touchgfx::Font::getStringWidth() const
all items filtered out
touchgfx::Font::getStringWidth() const
Type of touchgfx::Font::getStringWidth() const
touchgfx::Font::getStringWidth() const
uint16_t
all items filtered out