Font_TextFormatter::Iterator Class Reference

Iterator through formatted symbols. It's possible to filter returned symbols to have only significant ones. More...

#include <Font_TextFormatter.hxx>

Public Member Functions
	Iterator (const Font_TextFormatter &theFormatter, IterationFilter theFilter=IterationFilter_None)
	Constructor with initialization.
bool	More () const
	Returns TRUE if iterator points to a valid item.
bool	HasNext () const
	Returns TRUE if next item exists.
char32_t	Symbol () const
	Returns current symbol.
char32_t	SymbolNext () const
	Returns the next symbol if exists.
int	SymbolPosition () const
	Returns current symbol position.
int	SymbolPositionNext () const
	Returns the next symbol position.
void	Next ()
	Moves to the next item.

Protected Member Functions
int	readNextSymbol (const int theSymbolStartingFrom, char32_t &theSymbolChar)
	Finds index of the next symbol.

Protected Attributes
IterationFilter	myFilter
	possibility to filter not-necessary symbols
NCollection_UtfIterator< char >	myIter
	the next symbol iterator value over the text formatter string
int	mySymbolPosition
	the current position
char32_t	mySymbolChar
	the current symbol
int	mySymbolNext
	position of the next symbol in iterator, if zero, the iterator is finished
char32_t	mySymbolCharNext
	the current symbol

Detailed Description

Iterator through formatted symbols. It's possible to filter returned symbols to have only significant ones.

Constructor & Destructor Documentation

Iterator()

Font_TextFormatter::Iterator::Iterator ( const Font_TextFormatter & theFormatter, IterationFilter theFilter = IterationFilter_None )

inline

Constructor with initialization.

Member Function Documentation

HasNext()

bool Font_TextFormatter::Iterator::HasNext ( ) const

inline

Returns TRUE if next item exists.

More()

bool Font_TextFormatter::Iterator::More ( ) const

inline

Returns TRUE if iterator points to a valid item.

Next()

void Font_TextFormatter::Iterator::Next ( )

inline

Moves to the next item.

readNextSymbol()

int Font_TextFormatter::Iterator::readNextSymbol ( const int theSymbolStartingFrom, char32_t & theSymbolChar )

inlineprotected

Finds index of the next symbol.

Symbol()

char32_t Font_TextFormatter::Iterator::Symbol ( ) const

inline

Returns current symbol.

SymbolNext()

char32_t Font_TextFormatter::Iterator::SymbolNext ( ) const

inline

Returns the next symbol if exists.

SymbolPosition()

int Font_TextFormatter::Iterator::SymbolPosition ( ) const

inline

Returns current symbol position.

SymbolPositionNext()

int Font_TextFormatter::Iterator::SymbolPositionNext ( ) const

inline

Returns the next symbol position.

Field Documentation

myFilter

IterationFilter Font_TextFormatter::Iterator::myFilter

protected

possibility to filter not-necessary symbols

myIter

NCollection_UtfIterator<char> Font_TextFormatter::Iterator::myIter

protected

the next symbol iterator value over the text formatter string

mySymbolChar

char32_t Font_TextFormatter::Iterator::mySymbolChar

protected

the current symbol

mySymbolCharNext

char32_t Font_TextFormatter::Iterator::mySymbolCharNext

protected

the current symbol

mySymbolNext

int Font_TextFormatter::Iterator::mySymbolNext

protected

position of the next symbol in iterator, if zero, the iterator is finished

mySymbolPosition

int Font_TextFormatter::Iterator::mySymbolPosition

protected

the current position

---

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

• Font_TextFormatter.hxx