Symbian^3 Application Developer Library >

CESMRRecurrenceInfoHandler Class Reference

class CESMRRecurrenceInfoHandler : public CBase

CESMRRecurrenceInfoHandler is responsible for handling recurrence related issues.

esmrservices.lib

Inherits from

Public Member Functions
~CESMRRecurrenceInfoHandler ()
IMPORT_C void AddExceptionL ( TCalTime , TCalTime )
IMPORT_C void CopyRecurrenceInformationFromL (const CCalEntry &)
IMPORT_C void CopyRecurrenceInformationToL ( CCalEntry &)
IMPORT_C void GetFirstInstanceTimeL ( TCalTime &, TCalTime &)
IMPORT_C void GetNextInstanceTimeL ( TCalTime &, TCalTime &, TTime )
IMPORT_C void GetPreviousInstanceTimeL ( TCalTime &, TCalTime &, TTime )
IMPORT_C void GetRecurrenceL ( 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 void RemoveInstanceL ( TCalTime )
IMPORT_C void SetRecurrenceL ( TESMRRecurrenceValue , TTime )
Private Member Functions
CESMRRecurrenceInfoHandler ( CCalEntry &, MESMRCalDbMgr *)
void CalculateRecurrenceUntilDateL ( TESMRRecurrenceValue , TTime &, TCalRRule &, const CCalEntry &)
void ConstructL ()
TTime GetNextInstanceForRepeatOtherL ( CCalEntry &, const CalCommon::TCalTimeRange &)
TTime GetPreviousInstanceForRepeatOtherL ( CCalEntry &, const CalCommon::TCalTimeRange &)
void HandleDailyRecurrenceL ( TESMRRecurrenceValue &, TCalRRule &)
void HandleMonthlyRecurrenceL ( TESMRRecurrenceValue &, TCalRRule &)
void HandleWeeklyRecurrenceL ( TESMRRecurrenceValue &, TCalRRule &)
void HandleYearlyRecurrenceL ( 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 void AddExceptionL ( TCalTime aNewInstanceTime,
TCalTime aOrginalInstanceTime
)

Removes calendar instance from entry.

Parameters

TCalTime aNewInstanceTime New instance time
TCalTime aOrginalInstanceTime Orginal instance time

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

void CalculateRecurrenceUntilDateL ( TESMRRecurrenceValue aRecurrenceType,
TTime & aUntil,
TCalRRule & aRule,
const CCalEntry & aEntry
) const [private]

Parameters

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

ConstructL()

void ConstructL ( ) [private]

CopyRecurrenceInformationFromL(const CCalEntry &)

IMPORT_C void CopyRecurrenceInformationFromL ( const CCalEntry & aSource )

Copies recurrence information from entry given as parameter.

Parameters

const CCalEntry & aSource Reference to source calendar entry

CopyRecurrenceInformationToL(CCalEntry &)

IMPORT_C void CopyRecurrenceInformationToL ( CCalEntry & aDestination )

Copies recurrence information to entry given as parameter.

Parameters

CCalEntry & aDestination Reference to destination calendar entry

GetFirstInstanceTimeL(TCalTime &, TCalTime &)

IMPORT_C void GetFirstInstanceTimeL ( TCalTime & aStart,
TCalTime & aEnd
)

Gets first instances start and end time.

Parameters

TCalTime & aStart Reference to start time.
TCalTime & aEnd Reference 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 void GetNextInstanceTimeL ( TCalTime & aNextStartTime,
TCalTime & aNextEndTime,
TTime aInstanceDateTime
)

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 void GetPreviousInstanceTimeL ( TCalTime & aPreviousStartTime,
TCalTime & aPreviousEndTime,
TTime aInstanceDateTime
)

Gets the start and end times of the previous instance.

Parameters

TCalTime & aPreviousStartTime
TCalTime & aPreviousEndTime
TTime aInstanceDateTime

GetRecurrenceL(TESMRRecurrenceValue &, TTime &)

IMPORT_C void GetRecurrenceL ( TESMRRecurrenceValue & aRecurrence,
TTime & aUntil
) const

Fetches entry's recurrence value.

Parameters

TESMRRecurrenceValue & aRecurrence On return contains entry's recurrence information
TTime & aUntil On return contains time in UTC until recurrence is valid.

HandleDailyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

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

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleMonthlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

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

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleWeeklyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

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

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

HandleYearlyRecurrenceL(TESMRRecurrenceValue &, TCalRRule &)

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

Parameters

TESMRRecurrenceValue & aRecurrenceValue
TCalRRule & aRule

NeedToSetRecurrenceL(TESMRRecurrenceValue, TTime)

TBool NeedToSetRecurrenceL ( TESMRRecurrenceValue aRecurrence,
TTime aUntil
) 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 & aEntry Reference 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 & aEntry Reference to calendar entry.
MESMRCalDbMgr * aCalDb Pointer 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 & aEntry Reference 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 & aEntry Reference to calendar entry.
MESMRCalDbMgr * aCalDb Reference to caldb manager

RemoveInstanceL(TCalTime)

IMPORT_C void RemoveInstanceL ( TCalTime aInstanceTime )

Removes instance from series.

Parameters

TCalTime aInstanceTime Instance to be removed

RepeatIndexL(const CCalEntry &)

TESMRRecurrenceValue RepeatIndexL ( const CCalEntry & aEntry ) [private]

Parameters

const CCalEntry & aEntry

SetRecurrenceL(TESMRRecurrenceValue, TTime)

IMPORT_C void SetRecurrenceL ( TESMRRecurrenceValue aRecurrence,
TTime aUntil
)

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 aUntil Recurrence 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.