Class: TLocaleItemIterator

Declaration: Localization.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TLocaleItemIterator allows the user to iterate through a set of items contained by a locale. The iterator returns a TText item name for each item in the locale. The item names can then be used to retrieve the actual items from the locale. It is necessary, however, to know the type of the object corresponding to each item name.

Instantiation:

Allocate on the heap or the stack. Although TLocaleItemIterator has public constructors, clients will find it easiest to create one by calling TLocale::CreateLocaleItemIterator.

Deriving Classes:

This class is designed to be used directly. Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TLocaleItemIterator::TLocaleItemIterator

TLocaleItemIterator ()
TLocaleItemIterator (TSetOf < TStandardText > * itemNames)

Interface Category:

API.

Purpose:

Default constructor.
Constructs an iterator with a collection of item names.

Calling Context:

Called by the stream-in operators.
Call by clients.

Parameters:

Takes no parameters.
TSetOf < TStandardText > * itemNames -The collection of item names.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleItemIterator::~TLocaleItemIterator

virtual ~ TLocaleItemIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleItemIterator::First

virtual TText * First ()

Interface Category:

API.

Purpose:

Returns the name of the first item in the locale.

Calling Context:

Call to get the name of the first item in the locale.

Parameters:

Takes no parameters.

Return Value:

The name of the first item in the locale.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleItemIterator::Next

virtual TText * Next ()

Interface Category:

API.

Purpose:

Returns the name of the next item in the locale.

Calling Context:

Call to get the name of the next item in the locale.

Parameters:

Takes no parameters.

Return Value:

The name of the next item in the locale.

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.