CPbkContactIter Class Reference

class CPbkContactIter : public CBase

Phonebook contact iterator. Only iterates through recognised Phonebook contact cards, not groups or templates. NextL jumps over any other contacts.

Inherits from

Constructor & Destructor Documentation

CPbkContactIter(CPbkContactEngine &, TBool)

CPbkContactIter ( CPbkContactEngine & aEngine,
TBool aUseMinimalRead
) [private, inline]

Constructor.

Parameters

CPbkContactEngine & aEngine Phonebook engine whose contacts to iterate.
TBool aUseMinimalRead

~CPbkContactIter()

~CPbkContactIter ( )

Destructor.

Member Functions Documentation

CurrentL()

IMPORT_C CPbkContactItem * CurrentL ( ) const

Returns the current Phonebook contact, NULL if none.

FirstL()

IMPORT_C TContactItemId FirstL ( )

Intializes the iterator to the first Phonebook contact.

GetCurrentL()

IMPORT_C CPbkContactItem * GetCurrentL ( ) const

Returns the current Phonebook contact, NULL if none. Caller is responsible for deleting the contact, thus ownership of the contact item is passed to the client.

NewL(CPbkContactEngine &, TBool)

IMPORT_C CPbkContactIter * NewL ( CPbkContactEngine & aEngine,
TBool aUseMinimalRead = EFalse
) [static]

Creates a new instace of this class.

Parameters

CPbkContactEngine & aEngine Phonebook engine whose contacts to iterate.
TBool aUseMinimalRead = EFalse Use ReadMinimalContactL instead of ReadContactL to read the contacts.

NewLC(CPbkContactEngine &, TBool)

IMPORT_C CPbkContactIter * NewLC ( CPbkContactEngine & aEngine,
TBool aUseMinimalRead = EFalse
) [static]

Same as NewL but leaves the created object on the cleanup stack. Creates a new instace of this class.

Parameters

CPbkContactEngine & aEngine Phonebook engine whose contacts to iterate.
TBool aUseMinimalRead = EFalse Use ReadMinimalContactL instead of ReadContactL to read the contacts.

NextL()

IMPORT_C TContactItemId NextL ( )

Advances the iterator to the next Phonebook contact.

ReadPhonebookContactL(TContactItemId)

CContactItem * ReadPhonebookContactL ( TContactItemId aId ) [private]

Reads aId to a CContactItem and returns it if it is a standard contact card.

Parameters

TContactItemId aId

Reset()

IMPORT_C void Reset ( )

Resets the iterator to null state.

Member Data Documentation

__DECLARE_TEST

__DECLARE_TEST

TContactIter iCmIter

TContactIter iCmIter [private]

CContactItem * iCurrentItem

CContactItem * iCurrentItem [private]

CPbkContactItem * iCurrentPbkItem

CPbkContactItem * iCurrentPbkItem [private]

CPbkContactEngine & iEngine

CPbkContactEngine & iEngine [private]

const TBool iUseMinimalRead

const TBool iUseMinimalRead [private]