Dragengine.Utils.StyledText.Definition.StyledTextDefinition Class Reference

Styled text definition. More...

Inheritance diagram for Dragengine.Utils.StyledText.Definition.StyledTextDefinition:

Public Member Functions
void	addNode (STDNode node)
	Add node.
void	addStyle (STDStyle style)
	Add style replacing style with same name if present.
void	forEachNode (Block ablock)
	Visit nodes with block with STDNode as parameter.
void	forEachStyle (Block ablock)
	Visit styles with block with STDStyle as parameter.
STDStyle	getDefaultStyle ()
	Style to use for nodes not having a style set.
Point	getPageSize ()
	Optimal page size in pixels.
STDStyle	getPageStyle ()
	Page style.
STDStyle	getStyleNamed (String name)
	Style with name or null if absent.
bool	hasStyleNamed (String name)
	Style with name is present.
StyledTextDefinition	new ()
	Create styled text definition.
StyledTextDefinition	new (StyledTextDefinition definition)
	Create copy of styled text definition.
StyledTextDefinition	new (StyledTextDefinition definition, bool deepCopy)
	Create copy of styled text definition.
void	removeAllNodes ()
	Remove all nodes.
void	removeAllStyles ()
	Remove all styles.
void	setDefaultStyle (STDStyle style)
	Set style to use for nodes not having a style set.
void	setPageSize (Point pageSize)
	Set optimal page size in pixels.
void	setPageStyle (STDStyle style)
	Set page style.
void	visitNodes (STDNodeVisitor visitor)
	Visit nodes with visitor.

Public Attributes
STDStyle	pDefaultStyle
Array	pNodes
Point	pPageSize
STDStyle	pPageStyle
Dictionary	pStyles

Detailed Description

Styled text definition.

Member Function Documentation

addNode()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.addNode

(

STDNode

node

)

Add node.

addStyle()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.addStyle

(

STDStyle

style

)

Add style replacing style with same name if present.

forEachNode()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.forEachNode

(

Block

ablock

)

Visit nodes with block with STDNode as parameter.

forEachStyle()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.forEachStyle

(

Block

ablock

)

Visit styles with block with STDStyle as parameter.

getDefaultStyle()

STDStyle Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getDefaultStyle

(

)

Style to use for nodes not having a style set.

getPageSize()

Point Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getPageSize

(

)

Optimal page size in pixels.

Using this page size results in an optimal document layout.

getPageStyle()

STDStyle Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getPageStyle

(

)

Page style.

getStyleNamed()

STDStyle Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getStyleNamed

(

String

name

)

Style with name or null if absent.

hasStyleNamed()

bool Dragengine.Utils.StyledText.Definition.StyledTextDefinition.hasStyleNamed

(

String

name

)

Style with name is present.

new() [1/3]

StyledTextDefinition Dragengine.Utils.StyledText.Definition.StyledTextDefinition.new

(

)

Create styled text definition.

new() [2/3]

StyledTextDefinition Dragengine.Utils.StyledText.Definition.StyledTextDefinition.new

(

StyledTextDefinition

definition

)

Create copy of styled text definition.

new() [3/3]

StyledTextDefinition Dragengine.Utils.StyledText.Definition.StyledTextDefinition.new	(	StyledTextDefinition	definition,
		bool	deepCopy
	)

Create copy of styled text definition.

Version

1.29

removeAllNodes()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.removeAllNodes

(

)

Remove all nodes.

removeAllStyles()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.removeAllStyles

(

)

Remove all styles.

setDefaultStyle()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.setDefaultStyle

(

STDStyle

style

)

Set style to use for nodes not having a style set.

setPageSize()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.setPageSize

(

Point

pageSize

)

Set optimal page size in pixels.

Using this page size results in an optimal document layout.

setPageStyle()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.setPageStyle

(

STDStyle

style

)

Set page style.

visitNodes()

void Dragengine.Utils.StyledText.Definition.StyledTextDefinition.visitNodes

(

STDNodeVisitor

visitor

)

Visit nodes with visitor.

Member Data Documentation

pDefaultStyle

STDStyle Dragengine.Utils.StyledText.Definition.StyledTextDefinition.pDefaultStyle

pNodes

Array Dragengine.Utils.StyledText.Definition.StyledTextDefinition.pNodes

pPageSize

Point Dragengine.Utils.StyledText.Definition.StyledTextDefinition.pPageSize

pPageStyle

STDStyle Dragengine.Utils.StyledText.Definition.StyledTextDefinition.pPageStyle

pStyles

Dictionary Dragengine.Utils.StyledText.Definition.StyledTextDefinition.pStyles

---

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

• StyledTextDefinition.ds