SLCGlyphNodeList Class Reference

#include <SLCGlyphNodeList.h>

Public Member Functions
SLCGlyphNode *	CreateGlyphNode (IComposeScanner *composeScanner, IDrawingStyle *drawingStyle, TextIndex startingIndex, const PMReal &xOffset)
void	Clear (void)
int32	Length (void) const
void	Remove (int32 index)
SLCGlyphNode *	operator[] (int32 index) const
virtual int32	GetTextSpan (int32 fromIndex=0) const
PMReal	GetWidth (int32 fromIndex) const
PMReal	GetTrailingWhiteSpaceWidth (int32 fromIndex) const
void	FitTrailingWhiteSpace (int32 fromIndex, const PMReal &widthScaleFactor)
virtual void	Dump (int32 fromIndex=0, const char *msg="") const

Detailed Description

Intermediate representation of composed text in the line maintained as a list of pointers to glyph nodes (SLCGlyphNode).

See Also

SLCGlyphNode

Member Function Documentation

void SLCGlyphNodeList::Clear

(

void

)

Clear the list.

SLCGlyphNode * SLCGlyphNodeList::CreateGlyphNode	(	IComposeScanner *	composeScanner,
		IDrawingStyle *	drawingStyle,
		TextIndex	startingIndex,
		const PMReal &	xOffset
	)

Create a new glyph node and add it to the list. The type of node to be created is determined by the type of character at the given startingIndex.

Parameters

composeScanner	IN for the story.
drawingStyle	IN for the run of text.
startingIndex	IN into the text model of the first character in the run.
xOffset	IN relative to the left edge of the wax line.

Returns

pointer to new SLCGlyphNode object, the list retains ownership of the object.

void SLCGlyphNodeList::Dump ( int32  fromIndex = 0, const char *  msg = ""  ) const

virtual

Trace the nodes.

void SLCGlyphNodeList::FitTrailingWhiteSpace	(	int32	fromIndex,
		const PMReal &	widthScaleFactor
	)

Adjust the width of any trailing white space in the node by the given scale factor.

Parameters

fromIndex	IN fit from the end of the list to this index.
widthScaleFactor	IN The scaling factor of the trailing white space.

See Also

SLCGlyphNode::FitTrailingWhiteSpace

int32 SLCGlyphNodeList::GetTextSpan ( int32  fromIndex = 0 ) const

virtual

Return the number of characters in the nodes in the list from the given index to last node in the list.

Parameters

fromIndex

of node at which to start.

Returns

the number of characters in the nodes.

PMReal SLCGlyphNodeList::GetTrailingWhiteSpaceWidth

(

int32

fromIndex

)

const

Return the width of the trailing white space.

Parameters

fromIndex

search back from the end of the list to this index.

Returns

the width of the trailing white space characters.

PMReal SLCGlyphNodeList::GetWidth

(

int32

fromIndex

)

const

Return the width of the characters in the nodes.

Parameters

fromIndex

of node at which to start.

Returns

the width of the characters in the nodes.

int32 SLCGlyphNodeList::Length ( void  ) const

inline

Returns

the number of SLCGlyphNode's in the list.

SLCGlyphNode* SLCGlyphNodeList::operator[] ( int32  index ) const

inline

Parameters

index

of required node.

Returns

pointer to the requested SLCGlyphNode.

void SLCGlyphNodeList::Remove ( int32  index )

inline

Delete the indicated SLCGlyphNode.

Parameters

index

of node to be deleted.