Drag[en]gine Script Module DragonScript  1.23
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. More...
 
void addStyle (STDStyle style)
 Add style replacing style with same name if present. More...
 
void forEachNode (Block ablock)
 Visit nodes with block with STDNode as parameter. More...
 
void forEachStyle (Block ablock)
 Visit styles with block with STDStyle as parameter. More...
 
STDStyle getDefaultStyle ()
 Style to use for nodes not having a style set. More...
 
STDNode getNodeAt (int index)
 Node at index. More...
 
int getNodeCount ()
 Number of nodes. More...
 
Point getPageSize ()
 Optimal page size in pixels. More...
 
int getStyleCount ()
 Number of styles. More...
 
STDStyle getStyleNamed (String name)
 Style with name or null if absent. More...
 
bool hasStyleNamed (String name)
 Style with name is present. More...
 
StyledTextDefinition new ()
 Create styled text definition. More...
 
StyledTextDefinition new (StyledTextDefinition definition)
 Create copy of styled text definition. More...
 
void removeAllNodes ()
 Remove all nodes. More...
 
void removeAllStyles ()
 Remove all styles. More...
 
void setDefaultStyle (STDStyle style)
 Set style to use for nodes not having a style set. More...
 
void setPageSize (Point pageSize)
 Set optimal page size in pixels. More...
 
void setPageStyle (STDStyle style)
 Set page style. More...
 

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.

◆ getNodeAt()

STDNode Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getNodeAt ( int  index)

Node at index.

◆ getNodeCount()

int Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getNodeCount ( )

Number of nodes.

◆ getPageSize()

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

Optimal page size in pixels.

Using this page size results in an optimal document layout.

◆ getStyleCount()

int Dragengine.Utils.StyledText.Definition.StyledTextDefinition.getStyleCount ( )

Number of styles.

◆ 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/2]

StyledTextDefinition Dragengine.Utils.StyledText.Definition.StyledTextDefinition.new ( )

Create styled text definition.

◆ new() [2/2]

StyledTextDefinition Dragengine.Utils.StyledText.Definition.StyledTextDefinition.new ( StyledTextDefinition  definition)

Create copy of styled text definition.

◆ 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.


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