Dragengine.Utils.StyledText.Converter.StyledTextConverter Class Reference

Create styled text rendering pages from styled text definition. More...

Inheritance diagram for Dragengine.Utils.StyledText.Converter.StyledTextConverter:

Public Member Functions
void	forEachPage (Block ablock)
	Visit pages with block with StyledTextRendering as parameter.
void	generatePages ()
	Generates pages from the a styled text definition.
StyledTextDefinition	getDefinition ()
	Styled text definition.
StyledTextRendering	getPageAt (int number)
	Page at index.
int	getPageCount ()
	Number of pages.
int	getPageHeight ()
	Ppage height.
int	getPageWidth ()
	Page width.
StyledTextConverter	new (StyledTextDefinition definition)
	Create styled text converter.
void	setPageSize (int width, int height)
	Set page size.
void	visitText (STDNText node)

Public Attributes
Array	pBlockers
int	pCurPIPPosY
StyledTextDefinition	pDefinition
StyledTextRendering	pPageInProgress
Array	pPages
STDStyle	pPageStyle
int	pPageWidth
String	pWhiteSpaces

Protected Member Functions
void	beginNewPage ()
	Begin new page.
RectArea	getFreeArea (RectArea area)
	Free area in regard to blockers.
bool	isPunctuation (int char)
	Character is a punctuation character.
bool	isWhiteSpace (int char)
	Character is a white space character.

Detailed Description

Create styled text rendering pages from styled text definition.

Member Function Documentation

beginNewPage()

void Dragengine.Utils.StyledText.Converter.StyledTextConverter.beginNewPage ( )

protected

Begin new page.

forEachPage()

void Dragengine.Utils.StyledText.Converter.StyledTextConverter.forEachPage

(

Block

ablock

)

Visit pages with block with StyledTextRendering as parameter.

generatePages()

void Dragengine.Utils.StyledText.Converter.StyledTextConverter.generatePages

(

)

Generates pages from the a styled text definition.

For each generated page the provided block is invoked.

getDefinition()

StyledTextDefinition Dragengine.Utils.StyledText.Converter.StyledTextConverter.getDefinition

(

)

Styled text definition.

getFreeArea()

RectArea Dragengine.Utils.StyledText.Converter.StyledTextConverter.getFreeArea ( RectArea  area )

protected

Free area in regard to blockers.

getPageAt()

StyledTextRendering Dragengine.Utils.StyledText.Converter.StyledTextConverter.getPageAt

(

int

number

)

Page at index.

getPageCount()

int Dragengine.Utils.StyledText.Converter.StyledTextConverter.getPageCount

(

)

Number of pages.

getPageHeight()

int Dragengine.Utils.StyledText.Converter.StyledTextConverter.getPageHeight

(

)

Ppage height.

getPageWidth()

int Dragengine.Utils.StyledText.Converter.StyledTextConverter.getPageWidth

(

)

Page width.

isPunctuation()

bool Dragengine.Utils.StyledText.Converter.StyledTextConverter.isPunctuation ( int char  )

protected

Character is a punctuation character.

isWhiteSpace()

bool Dragengine.Utils.StyledText.Converter.StyledTextConverter.isWhiteSpace ( int char  )

protected

Character is a white space character.

new()

StyledTextConverter Dragengine.Utils.StyledText.Converter.StyledTextConverter.new

(

StyledTextDefinition

definition

)

Create styled text converter.

setPageSize()

void Dragengine.Utils.StyledText.Converter.StyledTextConverter.setPageSize	(	int	width,
		int	height
	)

Set page size.

visitText()

void Dragengine.Utils.StyledText.Converter.StyledTextConverter.visitText

(

STDNText

node

)

Member Data Documentation

pBlockers

Array Dragengine.Utils.StyledText.Converter.StyledTextConverter.pBlockers

pCurPIPPosY

int Dragengine.Utils.StyledText.Converter.StyledTextConverter.pCurPIPPosY

pDefinition

StyledTextDefinition Dragengine.Utils.StyledText.Converter.StyledTextConverter.pDefinition

pPageInProgress

StyledTextRendering Dragengine.Utils.StyledText.Converter.StyledTextConverter.pPageInProgress

pPages

Array Dragengine.Utils.StyledText.Converter.StyledTextConverter.pPages

pPageStyle

STDStyle Dragengine.Utils.StyledText.Converter.StyledTextConverter.pPageStyle

pPageWidth

int Dragengine.Utils.StyledText.Converter.StyledTextConverter.pPageWidth

pWhiteSpaces

String Dragengine.Utils.StyledText.Converter.StyledTextConverter.pWhiteSpaces

---

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

• StyledTextConverter.ds