Structure that holds the parameters that TextConceptImpl::prepareTextFormat() needs. More...

#include <kanzi/ui/node/concept/text_concept.hpp>

Public Attributes
string	overflowText
	The characters that represent the clipped text when the text string to be rendered is too long to fit in the node.

bool	removeSideBearingsEnabled
	Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.

float	textFormatHeight
	The available text height.

float	textFormatWidth
	The available text width.

TextFormat::TextHorizontalAlignment	textHorizontalAlignment
	The horizontal alignment of the text.

TextFormat::TextVerticalAlignment	textVerticalAlignment
	The vertical alignment of the text.

TextFormat::Truncation	truncation
	Truncation boundary type for the text that does not fit.

TextFormat::TruncationDirection	truncationDirection
	Truncation direction of the text.

TextFormat::WhitespacePolicy	whitespacePolicy
	The policy applied on trailing or leading whitespaces.

bool	wordWrap
	Whether to break long text lines to multiple lines to make the text fit within the boundaries of the node.

Detailed Description

Structure that holds the parameters that TextConceptImpl::prepareTextFormat() needs.

Member Data Documentation

◆ textFormatWidth

float kanzi::TextConcept::TextFormatParameters::textFormatWidth

The available text width.

◆ textFormatHeight

float kanzi::TextConcept::TextFormatParameters::textFormatHeight

The available text height.

◆ textHorizontalAlignment

TextFormat::TextHorizontalAlignment kanzi::TextConcept::TextFormatParameters::textHorizontalAlignment

The horizontal alignment of the text.

◆ textVerticalAlignment

TextFormat::TextVerticalAlignment kanzi::TextConcept::TextFormatParameters::textVerticalAlignment

The vertical alignment of the text.

◆ whitespacePolicy

TextFormat::WhitespacePolicy kanzi::TextConcept::TextFormatParameters::whitespacePolicy

The policy applied on trailing or leading whitespaces.

◆ removeSideBearingsEnabled

bool kanzi::TextConcept::TextFormatParameters::removeSideBearingsEnabled

Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.

◆ overflowText

string kanzi::TextConcept::TextFormatParameters::overflowText

The characters that represent the clipped text when the text string to be rendered is too long to fit in the node.

◆ wordWrap

bool kanzi::TextConcept::TextFormatParameters::wordWrap

Whether to break long text lines to multiple lines to make the text fit within the boundaries of the node.

◆ truncationDirection

TextFormat::TruncationDirection kanzi::TextConcept::TextFormatParameters::truncationDirection

Truncation direction of the text.

◆ truncation

TextFormat::Truncation kanzi::TextConcept::TextFormatParameters::truncation

Truncation boundary type for the text that does not fit.

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

kanzi/ui/node/concept/text_concept.hpp

Public Attributes