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. More...
Standard_Boolean	More () const
	Returns TRUE if iterator points to a valid item. More...
Standard_Boolean	HasNext () const
	Returns TRUE if next item exists. More...
Standard_Utf32Char	Symbol () const
	Returns current symbol. More...
Standard_Utf32Char	SymbolNext () const
	Returns the next symbol if exists. More...
Standard_Integer	SymbolPosition () const
	Returns current symbol position. More...
Standard_Integer	SymbolPositionNext () const
	Returns the next symbol position. More...
void	Next ()
	Moves to the next item. More...

Protected Member Functions
Standard_Integer	readNextSymbol (const Standard_Integer theSymbolStartingFrom, Standard_Utf32Char &theSymbolChar)
	Finds index of the next symbol. More...

Protected Attributes
IterationFilter	myFilter
	possibility to filter not-necessary symbols More...
NCollection_Utf8Iter	myIter
	the next symbol iterator value over the text formatter string More...
Standard_Integer	mySymbolPosition
	the current position More...
Standard_Utf32Char	mySymbolChar
	the current symbol More...
Standard_Integer	mySymbolNext
	position of the next symbol in iterator, if zero, the iterator is finished More...
Standard_Utf32Char	mySymbolCharNext
	the current symbol More...

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()

Standard_Boolean Font_TextFormatter::Iterator::HasNext ( ) const

inline

Returns TRUE if next item exists.

More()

Standard_Boolean Font_TextFormatter::Iterator::More ( void  ) const

inline

Returns TRUE if iterator points to a valid item.

Next()

void Font_TextFormatter::Iterator::Next ( void  )

inline

Moves to the next item.

readNextSymbol()

Standard_Integer Font_TextFormatter::Iterator::readNextSymbol ( const Standard_Integer  theSymbolStartingFrom, Standard_Utf32Char &  theSymbolChar  )

inlineprotected

Finds index of the next symbol.

Symbol()

Standard_Utf32Char Font_TextFormatter::Iterator::Symbol ( ) const

inline

Returns current symbol.

SymbolNext()

Standard_Utf32Char Font_TextFormatter::Iterator::SymbolNext ( ) const

inline

Returns the next symbol if exists.

SymbolPosition()

Standard_Integer Font_TextFormatter::Iterator::SymbolPosition ( ) const

inline

Returns current symbol position.

SymbolPositionNext()

Standard_Integer 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_Utf8Iter Font_TextFormatter::Iterator::myIter

protected

the next symbol iterator value over the text formatter string

mySymbolChar

Standard_Utf32Char Font_TextFormatter::Iterator::mySymbolChar

protected

the current symbol

mySymbolCharNext

Standard_Utf32Char Font_TextFormatter::Iterator::mySymbolCharNext

protected

the current symbol

mySymbolNext

Standard_Integer Font_TextFormatter::Iterator::mySymbolNext

protected

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

mySymbolPosition

Standard_Integer Font_TextFormatter::Iterator::mySymbolPosition

protected

the current position

---

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

• Font_TextFormatter.hxx