KzuTextLayouter Struct Reference

Structure for text layouting and rendering. More...

#include <kanzi/core.ui/text/kzu_text_layouter.h>

Public Attributes

const struct KzuTextLayouterClasstextLayouterClass
 Class of the text layouter. More...
 
struct KzuFontfont
 Font used for layouting the text. More...
 
TextConcept::TextHorizontalAlignment horizontalAlignment
 Horizontal alignment. More...
 
TextConcept::TextVerticalAlignment verticalAlignment
 Vertical alignment. More...
 
kzFloat maximumWidth
 Maximum width in pixels or KZS_INFINITY if no maximum specified. More...
 
kzUint maximumCharactersPerLine
 Maximum width in characters or KZ_UINT_MAXIMUM if no maximum specified. More...
 
kzFloat maximumHeight
 Maximum height in pixels or KZS_INFINITY if no maximum specified. More...
 
kzUint maximumLines
 Maximum height in lines or KZ_UINT_MAXIMUM if no maximum specified. More...
 
kzFloat lineSpacing
 Line spacing in multiples of line height. More...
 
kzFloat characterSpacing
 Additional spacing that is added between each charater. More...
 
kzBool fixedCharacterWidthEnabled
 Is fixed character width specified. More...
 
kzFloat fixedCharacterWidth
 Fixed character width if it has been enabled. More...
 
kzMutableString terminator
 Terminator string to use if the given text does not fit to the given maximum size. More...
 
kzBool bidiShapingEnabled
 Is BiDi and text shaping enabled or not. More...
 
bool removeSideBearingsEnabled
 If enabled removes side bearings for each line separately making text start right next to the sides. More...
 

Detailed Description

Structure for text layouting and rendering.

Member Data Documentation

const struct KzuTextLayouterClass* KzuTextLayouter::textLayouterClass

Class of the text layouter.

struct KzuFont* KzuTextLayouter::font

Font used for layouting the text.

TextConcept::TextHorizontalAlignment KzuTextLayouter::horizontalAlignment

Horizontal alignment.

TextConcept::TextVerticalAlignment KzuTextLayouter::verticalAlignment

Vertical alignment.

kzFloat KzuTextLayouter::maximumWidth

Maximum width in pixels or KZS_INFINITY if no maximum specified.

kzUint KzuTextLayouter::maximumCharactersPerLine

Maximum width in characters or KZ_UINT_MAXIMUM if no maximum specified.

kzFloat KzuTextLayouter::maximumHeight

Maximum height in pixels or KZS_INFINITY if no maximum specified.

kzUint KzuTextLayouter::maximumLines

Maximum height in lines or KZ_UINT_MAXIMUM if no maximum specified.

kzFloat KzuTextLayouter::lineSpacing

Line spacing in multiples of line height.

kzFloat KzuTextLayouter::characterSpacing

Additional spacing that is added between each charater.

Specified in pixels.

kzBool KzuTextLayouter::fixedCharacterWidthEnabled

Is fixed character width specified.

kzFloat KzuTextLayouter::fixedCharacterWidth

Fixed character width if it has been enabled.

kzMutableString KzuTextLayouter::terminator

Terminator string to use if the given text does not fit to the given maximum size.

kzBool KzuTextLayouter::bidiShapingEnabled

Is BiDi and text shaping enabled or not.

If KZ_FALSE, the basic layouting is used.

bool KzuTextLayouter::removeSideBearingsEnabled

If enabled removes side bearings for each line separately making text start right next to the sides.


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