Collapse all Symbian^3 Application Developer Library

CCalInstanceIterator Class Reference

class CCalInstanceIterator : public CBase

A calendar instance iterator

This class defines an interface for iterating through calendar instances and can be created by calling the appropriate methods on CCalInstanceView. Please see the coments on those APIs for the details of which instances will be iterated though.

Inherits from

CCalInstanceIterator
- CBase

Public Member Functions
	~CCalInstanceIterator ()
TInt	Count ()
TBool	HasMore ()
CCalInstance *	NextL ()
CCalInstance *	PreviousL ()

Protected Member Functions
	CCalInstanceIterator (const CCalInstanceViewImpl &)

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

Protected Attributes
const CCalInstanceViewImpl &	iInstanceViewImpl
CCalSessionImpl &	iSessionImpl

Constructor & Destructor Documentation

CCalInstanceIterator(const CCalInstanceViewImpl &)

CCalInstanceIterator

(

const CCalInstanceViewImpl &

aInstanceViewImpl

)

[protected]

Instance iterator constructor

Parameters

const CCalInstanceViewImpl & aInstanceViewImpl

~CCalInstanceIterator()

IMPORT_C

~CCalInstanceIterator

(

)

Instance iterator destructor

Member Functions Documentation

Count()

TInt

Count

(

)

const [pure virtual]

Returns the total number of instances the iterator will iterate through, including the starting instance if one was provided.

Note that it is best to avoid using this API if possible because it will be slow to calculate the count, if the iterator contains a lot of instances.

capability: None

HasMore()

TBool

HasMore

(

)

const [pure virtual]

Checks to see if there are any more results in the iterator to be returned by calling NextL.

capability: None

NextL()

CCalInstance *

NextL

(

)

[pure virtual]

Fetches the next instance in the iterator.

leave: KErrNotFound If there is a problem creating the instance because the entry cannot be found.

leave: KErrNotReady If the calendar file is on a drive where the media has been removed. Otherwise any of the system-wide error codes.

capability: ReadUserData

PreviousL()

CCalInstance *

PreviousL

(

)

[pure virtual]

Fetches the previous instance in the iterator.

leave: KErrNotFound If there is a problem creating the instance because the entry cannot be found.

leave: KErrNotReady If the calendar file is on a drive where the media has been removed. Otherwise any of the system-wide error codes.

capability: ReadUserData

Member Data Documentation

const CCalInstanceViewImpl & iInstanceViewImpl

const CCalInstanceViewImpl &

iInstanceViewImpl

[protected]

CCalSessionImpl & iSessionImpl

CCalSessionImpl &

iSessionImpl

[protected]