CCalendarAPIexampleEngine Class Reference

Inherits MCalendarEngineCommandsInterface.

Public Member Functions
virtual	~CCalendarAPIexampleEngine ()
void	AddAnniversaryL (CCalEntry *aAnniv)
void	UpdateAnniversaryL (CCalEntry *aAnniv)
void	DeleteAnniversaryL (CCalEntry *aAnniv)
void	GetAnniversariesL (const TDateTime &aFrom, const TDateTime &aTo, RPointerArray< CCalInstance > &aAnniversaries)
TInt	EntryCount () const
CCalHelperEntry &	Entry (const TInt &aIndex)
void	DoSearchL (const TSearchType &aType)
void	DoAddL ()
TInt	ModifyIndex () const
void	SetModifyIndex (const TInt &aIndex)
void	CreateEntryForModificationL (TBool &aModify)
void	SaveL ()
void	DoSaveL ()
void	DeleteEntryL (const TInt &aIndex)
TBool	SetValuesToNewEntry (const TDesC &aName, const TDateTime &aDate, const TBool &aAlarm, const TDateTime &aAlarmTime, const TInt &aSynchronizationMethod)
void	GetValuesToSet (TDes &aName, TTime &aDate, TBool &aAlarm, TTime &aAlarmTime, TInt &aSync)
void	ExecuteDeletionL ()
Static Public Member Functions
static CCalendarAPIexampleEngine *	NewL (MCalenderEngineObserverUI &aAppUi)

Detailed Description

CCalendarAPIexampleEngine engine class. Provides support for the following features:

Add anniversaries
Update anniversaries
Delete anniversaries
Finds anniversaries

Definition at line 103 of file CalendarAPIexampleEngine.h.

Constructor & Destructor Documentation

CCalendarAPIexampleEngine::~CCalendarAPIexampleEngine ( ) [virtual]

Destructor.

Definition at line 69 of file CalendarAPIexampleEngine.cpp.

Member Function Documentation

CCalendarAPIexampleEngine * CCalendarAPIexampleEngine::NewL ( MCalenderEngineObserverUI & aAppUi ) [static]

Two-phased constructor.

Definition at line 111 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::AddAnniversaryL ( CCalEntry * aAnniv )

AddAnniversaryL()

Adds an anniversary to the agenda file. param aAnniv - CCalEntry object that is added to the agenda file

Definition at line 242 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::UpdateAnniversaryL ( CCalEntry * aAnniv )

UpdateAnniversaryL()

Updates an anniversarys data to the agenda file. param aAnniv - CCalEntry object that is updated

Definition at line 277 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::DeleteAnniversaryL ( CCalEntry * aAnniv )

DeleteAnniversaryL()

Deletes an anniversary from the agenda file. param aAnniv - CCalEntry object that is deleted from the agenda file

void CCalendarAPIexampleEngine::GetAnniversariesL	(	const TDateTime &	aFrom,
		const TDateTime &	aTo,
		RPointerArray< CCalInstance > &	aAnniversaries
	)

GetAnniversariesL()

Finds all anniversaries within given time interval. param aFrom - date where the searching begins param aTo - date where the search ends param aAnniversaries - found anniversaries are put to this array.

TInt CCalendarAPIexampleEngine::EntryCount ( ) const [virtual]

EntryCount()

Returns the number of found anniversaries.

Implements MCalendarEngineCommandsInterface.

Definition at line 598 of file CalendarAPIexampleEngine.cpp.

CCalHelperEntry & CCalendarAPIexampleEngine::Entry ( const TInt & aIndex ) [virtual]

Entry()

Returns a reference to an entry. param aIndex - index of the wanted entry.

Implements MCalendarEngineCommandsInterface.

Definition at line 653 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::DoSearchL ( const TSearchType & aType ) [virtual]

DoSearchL()

Finds all anniversaries in given time interval. param aType - search interval (week, month...)

Implements MCalendarEngineCommandsInterface.

Definition at line 313 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::DoAddL ( ) [virtual]

DoAddL()

Activates the proper view for adding entries.

Implements MCalendarEngineCommandsInterface.

Definition at line 452 of file CalendarAPIexampleEngine.cpp.

TInt CCalendarAPIexampleEngine::ModifyIndex ( ) const [virtual]

ModifyIndex()

Returns the modify index.

Implements MCalendarEngineCommandsInterface.

Definition at line 673 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::SetModifyIndex ( const TInt & aIndex ) [virtual]

SetModifyIndex()

Sets the modify index to given index. Modify index is used when calling CreateEntryForModificationL. param aIndex - modify index is set to this index

Implements MCalendarEngineCommandsInterface.

Definition at line 552 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::CreateEntryForModificationL ( TBool & aModify ) [virtual]

CreateEntryForModificationL()

Returns a reference to an entry. If iModifyIndex is negative, a new entry is created, otherwise a reference to an existing entry (defined by iModifyIndex) is returned. param aModify - is set to EFalse if a new entry was created and ETrue if existing entry was returned.

Implements MCalendarEngineCommandsInterface.

Definition at line 574 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::SaveL ( )

SaveL()

Adds or updates the current entry to the agenda file. Current entry is defined by calling CreateEntryForModificationL().

void CCalendarAPIexampleEngine::DoSaveL ( ) [virtual]

DoSaveL() Called from the views when there's a need to save data.

Implements MCalendarEngineCommandsInterface.

Definition at line 467 of file CalendarAPIexampleEngine.cpp.

void CCalendarAPIexampleEngine::DeleteEntryL ( const TInt & aIndex ) [virtual]

DeleteEntryL()

Deletes an entry from the agenda file. param aIndex - index of which entry is deleted.

Implements MCalendarEngineCommandsInterface.

Definition at line 397 of file CalendarAPIexampleEngine.cpp.

TBool CCalendarAPIexampleEngine::SetValuesToNewEntry	(	const TDesC &	aName,
		const TDateTime &	aDate,
		const TBool &	aAlarm,
		const TDateTime &	aAlarmTime,
		const TInt &	aSynchronizationMethod
	)			`[virtual]`