Class: TDropDownTextControlIterator

Declaration: DropDownTextControl.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TStandardDropTextControlIterator -an internal class that TStandardDropDownListControl uses.

Purpose:

This is an abstract class for creating an iterator. An iterator created from this class is used to iterate through a MDropDownListControlState list object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to create list iterators for specific internal lists.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDropDownTextControlIterator::TDropDownTextControlIterator

TDropDownTextControlIterator ()
TDropDownTextControlIterator (const TDropDownTextControlIterator & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Called to copy an object.

Parameters:

Takes no parameters.
const TDropDownTextControlIterator & copy -The object that is to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDropDownTextControlIterator::~TDropDownTextControlIterator

virtual ~ TDropDownTextControlIterator ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TDropDownTextControlIterator::First

virtual TText * First ()

Interface Category:

API.

Purpose:

Returns the first item in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the text of the first list item.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDropDownTextControlIterator::Next

virtual TText * Next ()

Interface Category:

API.

Purpose:

Returns the next item in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the text object for the next sequential item in the list, as referenced by the list iterator.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDropDownTextControlIterator::Previous

virtual TText * Previous ()

Interface Category:

API.

Purpose:

Returns the previous item in the list, relative to the list iterator.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the text of the previous list item, as referenced by the list iterator.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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