TSglQueIter< T > Class Template Reference

A templated class that provides the behaviour for iterating through a set of singly linked list elements. More...

#include <e32std.h>

Inheritance diagram for TSglQueIter< T >:

Public Member Functions
	TSglQueIter (TSglQueBase &aQue)
	Constructs the iterator for the specified singly linked list.
void	Set (T &aLink)
	Sets the iterator to point to a specific element in the list.
	operator T* ()
	Gets a pointer to the iterator s current element.
T *	operator++ (TInt)
	Gets a pointer to the iterator's current element and then sets the iterator to point to the next element.
Public Member Functions inherited from TSglQueIterBase
IMPORT_C void	SetToFirst ()
	Sets the iterator to point to the first element in the singly linked list.

Additional Inherited Members
Protected Member Functions inherited from TSglQueIterBase
IMPORT_C	TSglQueIterBase (TSglQueBase &aQue)
IMPORT_C TAny *	DoPostInc ()
IMPORT_C TAny *	DoCurrent ()
IMPORT_C void	DoSet (TAny *aLink)
Protected Attributes inherited from TSglQueIterBase
TInt	iOffset
TSglQueLink *	iHead
TSglQueLink *	iNext

Detailed Description

template<class T>
class TSglQueIter< T >

A templated class that provides the behaviour for iterating through a set of singly linked list elements.

The template parameter defines the type of element that forms the singly linked list. The class defined in the template parameter contains the link object.

API status

Published to all clients. Released API.

Definition at line 620 of file e32std.h.

Constructor & Destructor Documentation

TSglQueIter()

template<class T >

TSglQueIter< T >::TSglQueIter ( TSglQueBase &  aQue )

inline

Constructs the iterator for the specified singly linked list.

The iterator can be constructed whether or not the list contains any elements.

If the list does contain elements, the iterator pointer is set to the first one.

If the list has no elements, the iterator pointer is not set and the conversion operator T*() and the post increment operator ++ subsequently return NULL. Once elements have been added to the list, use either the TSglQueIter::Set() function or the TSglQueIterBase::SetToFirst() function to set the iterator pointer.

TSglQueIter::Set TSglQueIterBase::SetToFirst

Parameters

aQue	A reference to a singly linked list header.

(generated from Symbian Developer Library)

Member Function Documentation

operator T*()

template<class T >

TSglQueIter< T >::operator T* ( )

inline

Gets a pointer to the iterator s current element.

The operator is normally used implicitly; e.g. some member functions of the list header class TSglQue require a pointer to an element (of type class T) as a parameter, but in practice an iterator is often passed instead. This operator performs the necessary conversion.

(generated from Symbian Developer Library)

operator++()

template<class T >

T * TSglQueIter< T >::operator++ ( TInt  )

inline

Gets a pointer to the iterator's current element and then sets the iterator to point to the next element.

Repeated use of this operator allows successive elements to be accessed.

(generated from Symbian Developer Library)

Set()

template<class T >

void TSglQueIter< T >::Set ( T &  aLink )

inline

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

This function can be used to alter the pointer at any time during the iterator's existence. The referenced element must be in the list, otherwise the result is undefined.

Parameters

aLink

A reference to the element from where iteration is to continue.

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• e32std.h
• e32std.h.dox