STLL  0.0
Simple Text Layouting Library
STLL::LayoutProperties_c Class Reference

this structure contains information for the layouter how to layout the text More...

Public Types

enum  {
  ALG_LEFT, ALG_RIGHT, ALG_CENTER, ALG_JUSTIFY_LEFT,
  ALG_JUSTIFY_RIGHT
}
 

Public Attributes

enum STLL::LayoutProperties_c:: { ... }  align = ALG_LEFT
 alignment that the text is supposed to have More...
 
int32_t indent = 0
 indentation of the first line in pixel More...
 
bool ltr = true
 is the base direction of the text left to right? More...
 
Font_c underlineFont
 The font that defines the underline parameters. More...
 
std::vector< std::string > links
 link URLs for the links used in the CodepointAttribute_c More...
 
bool optimizeLinebreaks = true
 Choose between fast and optimizing linebreak algorithm. More...
 
bool hyphenate = true
 automatically find hyphenation points More...
 

Detailed Description

this structure contains information for the layouter how to layout the text

Member Enumeration Documentation

anonymous enum
Enumerator
ALG_LEFT 

layout left adjusted

ALG_RIGHT 

layout right adjusted

ALG_CENTER 

layout centred

ALG_JUSTIFY_LEFT 

layout justified and the last line left adjusted

ALG_JUSTIFY_RIGHT 

layout justified and the last line right adjusted

Member Data Documentation

enum { ... } STLL::LayoutProperties_c::align

alignment that the text is supposed to have

bool STLL::LayoutProperties_c::hyphenate = true

automatically find hyphenation points

This requires a bit of time but will increase text layout quality dramatically. Only words that don't contain a shy will be consiedered The attribute must contain language information or no hyphenation will take place

int32_t STLL::LayoutProperties_c::indent = 0

indentation of the first line in pixel

std::vector<std::string> STLL::LayoutProperties_c::links

link URLs for the links used in the CodepointAttribute_c

bool STLL::LayoutProperties_c::ltr = true

is the base direction of the text left to right?

bool STLL::LayoutProperties_c::optimizeLinebreaks = true

Choose between fast and optimizing linebreak algorithm.

The fast linebreak algorithm simply breaks a line as soon as the next part doesn't fit onto the line. The optimizing algorithm tries to limit raggedness of the lines and tries to avoid hyphenating words

Font_c STLL::LayoutProperties_c::underlineFont

The font that defines the underline parameters.

When underlines need to be placed they will be placed according to this font. That way you get the same font, regardless of size of text or font.

When not set, the underline will use the parameters of the font of each glyph.


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