Symbian^3 Application Developer Library >

CMessageIterator Class Reference

class CMessageIterator : public CBase

Message Iterator Utility Class Typically used by message editors to implement next and previous message menu options. Class is an observer of the parent of the current entry, so it does handle changes in the children list. Class does not handle other external events e.g. deletion of parent.

Inherits from

Public Member Functions
~CMessageIterator ()
IMPORT_C const TMsvEntry & CurrentMessage ()
IMPORT_C TInt CurrentMessageIndex ()
IMPORT_C const TMsvEntry & CurrentParent ()
void HandleEntryEventL (TMsvEntryEvent, TAny *, TAny *, TAny *)
IMPORT_C TInt MessagesInFolder ()
IMPORT_C CMessageIterator * NewL ( CMsvSession &, const TMsvEntry &)
IMPORT_C TBool NextMessageExists ()
IMPORT_C CMsvOperation * OpenCurrentMessageL ( TRequestStatus &, TBool )
IMPORT_C TBool PreviousMessageExists ()
IMPORT_C void SetCurrentMessageL (const TMsvEntry &)
IMPORT_C void SetMessageIteratorObserver ( MMessageIteratorObserver *)
IMPORT_C TInt SetNextMessage ()
IMPORT_C TInt SetPreviousMessage ()
Private Member Functions
CMessageIterator ()
void ConstructL ( CMsvSession &, const TMsvEntry &)
void UpdateChildrenOfParentL ( TMsvId )
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CMsvEntrySelection * iChildrenOfParent
TInt iCurrentIndex
TBool iEntryObserver
MMessageIteratorObserver * iMessageIteratorObserver
CMsvEntry * iParentOfCurrent

Constructor & Destructor Documentation

CMessageIterator()

CMessageIterator ( ) [private]

C++ constuctor

~CMessageIterator()

IMPORT_C ~CMessageIterator ( )

Destructor

Member Functions Documentation

ConstructL(CMsvSession &, const TMsvEntry &)

void ConstructL ( CMsvSession & aSession,
const TMsvEntry & aStartMessage
) [private]

Symbian OS constructor

Parameters

CMsvSession & aSession
const TMsvEntry & aStartMessage

CurrentMessage()

IMPORT_C const TMsvEntry & CurrentMessage ( ) const

CurrentMessageIndex()

IMPORT_C TInt CurrentMessageIndex ( ) const

CurrentParent()

IMPORT_C const TMsvEntry & CurrentParent ( ) const

HandleEntryEventL(TMsvEntryEvent, TAny *, TAny *, TAny *)

void HandleEntryEventL ( TMsvEntryEvent aEvent,
TAny * aArg1,
TAny * aArg2,
TAny * aArg3
)

From MMsvEntryObserver

Parameters

TMsvEntryEvent aEvent
TAny * aArg1
TAny * aArg2
TAny * aArg3

MessagesInFolder()

IMPORT_C TInt MessagesInFolder ( ) const

NewL(CMsvSession &, const TMsvEntry &)

IMPORT_C CMessageIterator * NewL ( CMsvSession & aSession,
const TMsvEntry & aCurrentMessage
) [static]

Two-phased constructor.

Parameters

CMsvSession & aSession
const TMsvEntry & aCurrentMessage

NextMessageExists()

IMPORT_C TBool NextMessageExists ( ) const

OpenCurrentMessageL(TRequestStatus &, TBool)

IMPORT_C CMsvOperation * OpenCurrentMessageL ( TRequestStatus & aStatus,
TBool aEmbed = ETrue
)

Opens current message

Parameters

TRequestStatus & aStatus
TBool aEmbed = ETrue

PreviousMessageExists()

IMPORT_C TBool PreviousMessageExists ( ) const

SetCurrentMessageL(const TMsvEntry &)

IMPORT_C void SetCurrentMessageL ( const TMsvEntry & aCurrentMessage )

Parameters

const TMsvEntry & aCurrentMessage

SetMessageIteratorObserver(MMessageIteratorObserver *)

IMPORT_C void SetMessageIteratorObserver ( MMessageIteratorObserver * aObserver )

Set iterator observer.

Parameters

MMessageIteratorObserver * aObserver

SetNextMessage()

IMPORT_C TInt SetNextMessage ( )

Changes current message to next

SetPreviousMessage()

IMPORT_C TInt SetPreviousMessage ( )

Changes current message to previous

UpdateChildrenOfParentL(TMsvId)

void UpdateChildrenOfParentL ( TMsvId aCurrentMessageId ) [private]

internal

Parameters

TMsvId aCurrentMessageId

Member Data Documentation

CMsvEntrySelection * iChildrenOfParent

CMsvEntrySelection * iChildrenOfParent [private]

TInt iCurrentIndex

TInt iCurrentIndex [private]

TBool iEntryObserver

TBool iEntryObserver [private]

MMessageIteratorObserver * iMessageIteratorObserver

MMessageIteratorObserver * iMessageIteratorObserver [private]

CMsvEntry * iParentOfCurrent

CMsvEntry * iParentOfCurrent [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.