TDblQueIterBase Class Reference

class TDblQueIterBase

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.

Public Member Functions
IMPORT_C void SetToFirst ()
IMPORT_C void SetToLast ()
Protected Member Functions
TDblQueIterBase ( TDblQueBase &)
IMPORT_C TAny * DoCurrent ()
IMPORT_C TAny * DoPostDec ()
IMPORT_C TAny * DoPostInc ()
IMPORT_C void DoSet ( TAny *)
Protected Attributes
TDblQueLinkBase * iHead
TDblQueLinkBase * iNext
TInt iOffset

Constructor & Destructor Documentation

TDblQueIterBase(TDblQueBase &)

IMPORT_C TDblQueIterBase ( TDblQueBase & aQue ) [protected]

Constructs the iterator for the specified doubly linked list.

Parameters

TDblQueBase & aQue A reference to a doubly linked list header.

Member Functions Documentation

DoCurrent()

IMPORT_C TAny * DoCurrent ( ) [protected]

Gets the current item in the queue.

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

TDblQueIter::operator T*

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

TDblQueIter::operator--

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

TDblQueIter::operator++

DoSet(TAny *)

IMPORT_C void DoSet ( TAny * aLink ) [protected]

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

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

TDblQueIter::Set

Parameters

TAny * aLink A pointer to the current list element.

SetToFirst()

IMPORT_C void SetToFirst ( )

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

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.

Member Data Documentation

TDblQueLinkBase * iHead

TDblQueLinkBase * iHead [protected]

Pointer to the anchor for the list.

TDblQueLinkBase * iNext

TDblQueLinkBase * iNext [protected]

Pointer to the current element.

TInt iOffset

TInt iOffset [protected]

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