Class: TTransliterateRulesIterator

Declaration: Transliterate.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TTransliterateRulesIterator is used to iterate over a set of TTransliterateRule instances. It is intended to be used by the rules viewer/editor. The iterators provide the standard functions of First and Next. Iterating backwards is not supported. This class is not multi-task safe; that is, if the rules list is modified during iteration, the iterator becomes invalid.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TTransliterateRulesIterator is a concrete class designed to be used directly. It should not be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTransliterateRulesIterator::TTransliterateRulesIterator

TTransliterateRulesIterator ()
TTransliterateRulesIterator (const TTransliterateRulesList * list)

Interface Category:

API.

Purpose:

Default constructor.
Constructs an iterator for the argument list. Does not own the list.

Calling Context:

This function is designed to be called directly and has no special requirements.

Parameters:

Takes no parameters.
const TTransliterateRulesList * list -The list of transliteration rules.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TTransliterateRulesIterator::~TTransliterateRulesIterator

virtual ~ TTransliterateRulesIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

This function is designed to be called directly and has no special requirements.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransliterateRulesIterator::First

virtual TTransliterateRule * First ()

Interface Category:

API.

Purpose:

Returns the first rule in the list.

Calling Context:

This function is designed to be called directly and has no special requirements.

Parameters:

Takes no parameters.

Return Value:

TTransliterateRule * -The first rule in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TTransliterateRulesIterator::Next

virtual TTransliterateRule * Next ()

Interface Category:

API.

Purpose:

Returns the next rule in the list.

Calling Context:

This function is designed to be called directly and has no special requirements.

Parameters:

Takes no parameters.

Return Value:

TTransliterateRule * -The next rule in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Click the icon to mail questions or corrections about this material to Taligent personnel.