Symbian^3 Product Developer Library >

CESMRRecurrenceInfoHandler Class Reference

class CESMRRecurrenceInfoHandler : public CBase

CESMRRecurrenceInfoHandler is responsible for handling recurrence related issues.

esmrservices.lib

Inherits from

  • CESMRRecurrenceInfoHandler
Public Member Functions
~CESMRRecurrenceInfoHandler()
IMPORT_C voidAddExceptionL(TCalTime, TCalTime)
IMPORT_C voidCopyRecurrenceInformationFromL(const CCalEntry &)
IMPORT_C voidCopyRecurrenceInformationToL(CCalEntry &)
IMPORT_C voidGetFirstInstanceTimeL(TCalTime &, TCalTime &)
IMPORT_C voidGetNextInstanceTimeL(TCalTime &, TCalTime &, TTime)
IMPORT_C voidGetPreviousInstanceTimeL(TCalTime &, TCalTime &, TTime)
IMPORT_C voidGetRecurrenceL(TESMRRecurrenceValue &, TTime &)
IMPORT_C CESMRRecurrenceInfoHandler *NewL(CCalEntry &)
IMPORT_C CESMRRecurrenceInfoHandler *NewL(CCalEntry &, MESMRCalDbMgr *)
IMPORT_C CESMRRecurrenceInfoHandler *NewLC(CCalEntry &)
IMPORT_C CESMRRecurrenceInfoHandler *NewLC(CCalEntry &, MESMRCalDbMgr *)
IMPORT_C voidRemoveInstanceL(TCalTime)
IMPORT_C voidSetRecurrenceL(TESMRRecurrenceValue, TTime)
Private Member Functions
CESMRRecurrenceInfoHandler(CCalEntry &, MESMRCalDbMgr *)
voidCalculateRecurrenceUntilDateL(TESMRRecurrenceValue, TTime &, TCalRRule &, const CCalEntry &)
voidConstructL()
TTime GetNextInstanceForRepeatOtherL(CCalEntry &, const CalCommon::TCalTimeRange &)
TTime GetPreviousInstanceForRepeatOtherL(CCalEntry &, const CalCommon::TCalTimeRange &)
voidHandleDailyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)
voidHandleMonthlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)
voidHandleWeeklyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)
voidHandleYearlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)
TBool NeedToSetRecurrenceL(TESMRRecurrenceValue, TTime)
TESMRRecurrenceValue RepeatIndexL(const CCalEntry &)
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
MESMRCalDbMgr *iCalDb
CCalEntry &iEntry

Constructor & Destructor Documentation

CESMRRecurrenceInfoHandler(CCalEntry &, MESMRCalDbMgr *)

CESMRRecurrenceInfoHandler(CCalEntry &aEntry,
MESMRCalDbMgr *aCalDb
)[private, inline]

Parameters

CCalEntry & aEntry
MESMRCalDbMgr * aCalDb

~CESMRRecurrenceInfoHandler()

IMPORT_C~CESMRRecurrenceInfoHandler()

C++ Destructor.

Member Functions Documentation

AddExceptionL(TCalTime, TCalTime)

IMPORT_C voidAddExceptionL(TCalTimeaNewInstanceTime,
TCalTimeaOrginalInstanceTime
)

Removes calendar instance from entry.

Parameters

TCalTime aNewInstanceTimeNew instance time
TCalTime aOrginalInstanceTimeOrginal instance time

CalculateRecurrenceUntilDateL(TESMRRecurrenceValue, TTime &, TCalRRule &, const CCalEntry &)

voidCalculateRecurrenceUntilDateL(TESMRRecurrenceValueaRecurrenceType,
TTime &aUntil,
TCalRRule &aRule,
const CCalEntry &aEntry
)const [private]

Parameters

TESMRRecurrenceValue aRecurrenceType
TTime & aUntil
TCalRRule & aRule
const CCalEntry & aEntry

ConstructL()

voidConstructL()[private]

CopyRecurrenceInformationFromL(const CCalEntry &)

IMPORT_C voidCopyRecurrenceInformationFromL(const CCalEntry &aSource)

Copies recurrence information from entry given as parameter.

Parameters

const CCalEntry & aSourceReference to source calendar entry

CopyRecurrenceInformationToL(CCalEntry &)

IMPORT_C voidCopyRecurrenceInformationToL(CCalEntry &aDestination)

Copies recurrence information to entry given as parameter.

Parameters

CCalEntry & aDestinationReference to destination calendar entry

GetFirstInstanceTimeL(TCalTime &, TCalTime &)

IMPORT_C voidGetFirstInstanceTimeL(TCalTime &aStart,
TCalTime &aEnd
)

Gets first instances start and end time.

Parameters

TCalTime & aStartReference to start time.
TCalTime & aEndReference to end time.

GetNextInstanceForRepeatOtherL(CCalEntry &, const CalCommon::TCalTimeRange &)

TTime GetNextInstanceForRepeatOtherL(CCalEntry &aEntry,
const CalCommon::TCalTimeRange &timeRange
)[private]

Parameters

CCalEntry & aEntry
const CalCommon::TCalTimeRange & timeRange

GetNextInstanceTimeL(TCalTime &, TCalTime &, TTime)

IMPORT_C voidGetNextInstanceTimeL(TCalTime &aNextStartTime,
TCalTime &aNextEndTime,
TTimeaInstanceDateTime
)

Gets the start and end times of the next instance.

Parameters

TCalTime & aNextStartTime
TCalTime & aNextEndTime
TTime aInstanceDateTime

GetPreviousInstanceForRepeatOtherL(CCalEntry &, const CalCommon::TCalTimeRange &)

TTime GetPreviousInstanceForRepeatOtherL(CCalEntry &aEntry,
const CalCommon::TCalTimeRange &timeRange
)[private]

Parameters

CCalEntry & aEntry
const CalCommon::TCalTimeRange & timeRange

GetPreviousInstanceTimeL(TCalTime &, TCalTime &, TTime)

IMPORT_C voidGetPreviousInstanceTimeL(TCalTime &aPreviousStartTime,
TCalTime &aPreviousEndTime,
TTimeaInstanceDateTime
)

Gets the start and end times of the previous instance.

Parameters

TCalTime & aPreviousStartTime
TCalTime & aPreviousEndTime
TTime aInstanceDateTime

GetRecurrenceL(TESMRRecurrenceValue &, TTime &)

IMPORT_C voidGetRecurrenceL(TESMRRecurrenceValue &aRecurrence,
TTime &aUntil
)const

Fetches entry's recurrence value.

Parameters

TESMRRecurrenceValue & aRecurrenceOn return contains entry's recurrence information
TTime & aUntilOn return contains time in UTC until recurrence is valid.

HandleDailyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

voidHandleDailyRecurrenceL(TESMRRecurrenceValue &aRecurrenceValue,
TCalRRule &aRule
)const [private]

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleMonthlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

voidHandleMonthlyRecurrenceL(TESMRRecurrenceValue &aRecurrenceValue,
TCalRRule &aRule
)const [private]

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleWeeklyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

voidHandleWeeklyRecurrenceL(TESMRRecurrenceValue &aRecurrenceValue,
TCalRRule &aRule
)const [private]

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleYearlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

voidHandleYearlyRecurrenceL(TESMRRecurrenceValue &aRecurrenceValue,
TCalRRule &aRule
)const [private]

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

NeedToSetRecurrenceL(TESMRRecurrenceValue, TTime)

TBool NeedToSetRecurrenceL(TESMRRecurrenceValueaRecurrence,
TTimeaUntil
)const [private]

Parameters

TESMRRecurrenceValue aRecurrence
TTime aUntil

NewL(CCalEntry &)

IMPORT_C CESMRRecurrenceInfoHandler *NewL(CCalEntry &aEntry)[static]

Two-phased constructor. Creates and initializes CESMRRecurrenceInfoHandler object. Ownership transferred to caller.

Parameters

CCalEntry & aEntryReference to calendar entry.

NewL(CCalEntry &, MESMRCalDbMgr *)

IMPORT_C CESMRRecurrenceInfoHandler *NewL(CCalEntry &aEntry,
MESMRCalDbMgr *aCalDb
)[static]

Two-phased constructor. Creates and initializes CESMRRecurrenceInfoHandler object. Ownership transferred to caller. Created object is left to cleanup stack.

Parameters

CCalEntry & aEntryReference to calendar entry.
MESMRCalDbMgr * aCalDbPointer to caldb manager. Ownership not transferred.

NewLC(CCalEntry &)

IMPORT_C CESMRRecurrenceInfoHandler *NewLC(CCalEntry &aEntry)[static]

Two-phased constructor. Creates and initializes CESMRRecurrenceInfoHandler object. Ownership transferred to caller.

Parameters

CCalEntry & aEntryReference to calendar entry.

NewLC(CCalEntry &, MESMRCalDbMgr *)

IMPORT_C CESMRRecurrenceInfoHandler *NewLC(CCalEntry &aEntry,
MESMRCalDbMgr *aCalDb
)[static]

Two-phased constructor. Creates and initializes CESMRRecurrenceInfoHandler object. Ownership transferred to caller. Created object is left to cleanup stack.

Parameters

CCalEntry & aEntryReference to calendar entry.
MESMRCalDbMgr * aCalDbReference to caldb manager

RemoveInstanceL(TCalTime)

IMPORT_C voidRemoveInstanceL(TCalTimeaInstanceTime)

Removes instance from series.

Parameters

TCalTime aInstanceTimeInstance to be removed

RepeatIndexL(const CCalEntry &)

TESMRRecurrenceValue RepeatIndexL(const CCalEntry &aEntry)[private]

Parameters

const CCalEntry & aEntry

SetRecurrenceL(TESMRRecurrenceValue, TTime)

IMPORT_C voidSetRecurrenceL(TESMRRecurrenceValueaRecurrence,
TTimeaUntil
)

Sets recurrence to ES MR entry. If until time is not set (i.e, it is null time), then until time is implementation dependent.

When recurrence is set to ERecurrenceNot, then aUntil parameter is ignored.

Parameters

TESMRRecurrenceValue aRecurrence
TTime aUntilRecurrence valid until in UTC format.

Member Data Documentation

MESMRCalDbMgr * iCalDb

MESMRCalDbMgr *iCalDb[private]

CCalEntry & iEntry

CCalEntry &iEntry[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.