STLL::CodepointAttributes_c Class Reference

this structure contains all attributes that a single glyph can get assigned More...

Classes
class	Shadow_c
	one element of the shadow More...

Public Member Functions
	CodepointAttributes_c (void)
	create an empty attribute, no font, no language, no flags, no inlay, no baseline shift More...
bool	operator== (const CodepointAttributes_c &rhs) const
	comparison operator More...
CodepointAttributes_c	operator+= (const CodepointAttributes_c &rhs)
	this operator is required for the interval container within the attributeIndex_c class, do not use it More...

Public Attributes
Color_c	c
	colour of the letter More...
Font_c	font
	font of the letter More...
std::string	lang
	current language at this letter More...
uint8_t	flags
	some flags for the glyph, use FL_xxx constants to change the value More...
std::vector< Shadow_c >	shadows
	the shadows to draw behind the real glyph. The shadows are drawn in the order within this vector and on top of that the real glyph will be drawn inlays will have no shadow More...
std::shared_ptr< TextLayout_c >	inlay
	sometimes you want to place something different instead of a glyph (e.g. an image). This can be done with an inlay. More...
int32_t	baseline_shift
	do you want to move the baseline of this character or inlay relative to the baseline of the line? A positive value means to move it up. It is given in units of 1/64th pixel. More...
size_t	link
	which link does this letter belong to More...

Static Public Attributes
static const uint8_t	FL_UNDERLINE = 1
	bit for the flags variable, if set the glyph will be underlined More...

Detailed Description

this structure contains all attributes that a single glyph can get assigned

Constructor & Destructor Documentation

STLL::CodepointAttributes_c::CodepointAttributes_c ( void  )

inline

create an empty attribute, no font, no language, no flags, no inlay, no baseline shift

Member Function Documentation

CodepointAttributes_c STLL::CodepointAttributes_c::operator+= ( const CodepointAttributes_c &  rhs )

inline

this operator is required for the interval container within the attributeIndex_c class, do not use it

Note

the interval container wants to accumulate information but as we can not do that here, we simply replace the old values

bool STLL::CodepointAttributes_c::operator== ( const CodepointAttributes_c &  rhs ) const

inline

comparison operator

Member Data Documentation

int32_t STLL::CodepointAttributes_c::baseline_shift

do you want to move the baseline of this character or inlay relative to the baseline of the line? A positive value means to move it up. It is given in units of 1/64th pixel.

Color_c STLL::CodepointAttributes_c::c

colour of the letter

const uint8_t STLL::CodepointAttributes_c::FL_UNDERLINE = 1

static

bit for the flags variable, if set the glyph will be underlined

uint8_t STLL::CodepointAttributes_c::flags

some flags for the glyph, use FL_xxx constants to change the value

Font_c STLL::CodepointAttributes_c::font

font of the letter

std::shared_ptr<TextLayout_c> STLL::CodepointAttributes_c::inlay

sometimes you want to place something different instead of a glyph (e.g. an image). This can be done with an inlay.

The inlay is a layout that will be placed instead of an actual glyph. If you define the inlay, the font information will be ignored. How the inlay interacts with line breaks depends on the character that is given as the place holder. Line breaks are done as if there was the given place holder character and not the inlay.

The vertical alignment of the inlay is controlled by baseline_shift. If baseline_shift is 0 the inlay is placed on the baseline.

std::string STLL::CodepointAttributes_c::lang

current language at this letter

size_t STLL::CodepointAttributes_c::link

which link does this letter belong to

To specify the link use the links array in the layoutProperties class. This value is an index into that vector, the value 0 means no link, all the others are reduced by one to represent the link

std::vector<Shadow_c> STLL::CodepointAttributes_c::shadows

the shadows to draw behind the real glyph. The shadows are drawn in the order within this vector and on top of that the real glyph will be drawn inlays will have no shadow

---

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

• layouter.h