TDblQueIterBase Class Reference

#include <e32std.h>

class TDblQueIterBase
Protected Attributes
TDblQueLinkBase *iHead
TDblQueLinkBase *iNext
TInt iOffset
Public Member Functions
IMPORT_C voidSetToFirst()
IMPORT_C voidSetToLast()
Protected Member Functions
TDblQueIterBase(TDblQueBase &)
IMPORT_C TAny *DoCurrent()
IMPORT_C TAny *DoPostDec()
IMPORT_C TAny *DoPostInc()
IMPORT_C voidDoSet(TAny *)

Detailed Description

A base class that provides implementation for the doubly linked list iterator.

It also encapsulates a pointer to the current link list element.

The class is abstract and is not intended to be instantiated.

Member Attribute Documentation

iHead

TDblQueLinkBase *iHead[protected]

Pointer to the anchor for the list.

iNext

TDblQueLinkBase *iNext[protected]

Pointer to the current element.

iOffset

TInt iOffset[protected]

The offset of a component link object within elements that form the list.

Constructor & Destructor Documentation

TDblQueIterBase ( TDblQueBase & )

IMPORT_CTDblQueIterBase(TDblQueBase &aQue)[protected]

Constructs the iterator for the specified doubly linked list.

Parameters
aQueA reference to a doubly linked list header.

Member Function Documentation

DoCurrent ( )

IMPORT_C TAny *DoCurrent()[protected]

Gets the current item in the queue.

The function is an implementation for TDblQueIter::operator T*().

See also: TDblQueIter::operator T*

Return Value
A pointer to the current list element.

DoPostDec ( )

IMPORT_C TAny *DoPostDec()[protected]

Gets the current item and then moves to the previous item.

The function is an implementation for TDblQueIter::operator--().

See also: TDblQueIter::operator--

Return Value
A pointer to the current list element.

DoPostInc ( )

IMPORT_C TAny *DoPostInc()[protected]

Gets the current item and then moves to the next item.

The function is an implementation for TDblQueIter::operator++().

See also: TDblQueIter::operator++

Return Value
A pointer to the current list element.

DoSet ( TAny * )

IMPORT_C voidDoSet(TAny *aLink)[protected]

Sets the iterator to point to a specific element in the list.

The function is an implementation for TDblQueIter::Set().

See also: TDblQueIter::Set

Parameters
aLinkA pointer to the current list element.

SetToFirst ( )

IMPORT_C voidSetToFirst()

Sets the iterator to point to the first element in the doubly linked list.

The function can be called to re-set the pointer at any time during the iterator's existence.

The function can be called even if the list has no elements.

SetToLast ( )

IMPORT_C voidSetToLast()

Sets the iterator to point to the last element in the doubly linked list. The function can be called to re-set the pointer at any time during the iterator's existence.

The function can be called even if the list has no elements.