TAgnRpt Class Reference

class TAgnRpt

Abstract base class for the agenda model repeat types.

Stores the repeat details common to all agenda model repeat types. The common repeat details are the until time of the repeat and the interval between repeats. If an instance repeats forever, then its end date will be TCalTime::MaxTime().. An instance of a TAgnRpt-derived class is owned by a repeat definition (CAgnRptDef), which also contains the repeat exceptions list. It is set using CAgnRptDef::SetDaily(), SetWeekly() etc.

Public Member Functions
TAgnRpt(CAgnRptDef &)
TAgnRpt(const TAgnRpt &, CAgnRptDef &)
voidClearAll()
IMPORT_C TIntCount()
voidExternalizeL(RWriteStream &)
IMPORT_C TTimeFindRptUntilTimeLocalL(TUint)
TTime FindRptUntilTimeRptLocalL(TUint)
TUint InstanceCountL()
voidInternalizeL(RReadStream &)
IMPORT_C TUint16Interval()
TInt InvariantL()
TBool IsAlignedRptLocalL(const TTime &)
TBool IsAlignedUtcL(const TTime &)
TTime NudgeNextInstanceUtcL(const TTime &)
TTime NudgePreviousInstanceUtcL(const TTime &)
voidResetCachedStartTimeOffset()
voidResetCachedUntilTimeOffset()
IMPORT_C voidSetCount(TInt)
IMPORT_C voidSetInterval(TUint16)
voidSetUntilTime(const TAgnCalendarTime &)
const TAgnCalendarTime &StartTime()
TTime StartTimeAsRptLocalL()
TType Type()
TTime UntilTimeAsRptLocalL()
IMPORT_C const TAgnCalendarTime &UntilTimeL()
TBool operator!=(const TAgnRpt &)
TBool operator==(const TAgnRpt &)
Protected Member Functions
TTime ConvertFromRepeatLocalToSystemLocalL(const TTime &)
TTime ConvertFromRepeatLocalToUtcL(const TTime &)
TTime ConvertFromSystemLocalToRepeatLocalL(const TTime &)
TTime ConvertFromUtcToRepeatLocalL(const TTime &)
voidGetTimeAsRptLocalL(const TAgnCalendarTime &, TTime &, TInt16 &)
TBool HourAndMinutesDifferentFromStartTimeL(const TTime &)
TUint MapDateToBits(TUint)
TUint MapDayToBits(TDay)
TTime NudgeNextAlignedStartTimeL(const TTime &)
TTime NudgePreviousAlignedStartTimeL(const TTime &)
MAgnCalendarTimeMode::TTimeMode TimeMode()
Private Member Functions
TAgnRpt(const TAgnRpt &)
voidoperator=(const TAgnRpt &)
Public Member Enumerations
enumTType {
EDaily = 1, EWeekly, EMonthlyByDates, EMonthlyByDays, EYearlyByDate, EYearlyByDay
}
enumTWeekInMonth { EFirst = 0, ESecond, EThird, EFourth, ELast }
Protected Attributes
TInt iCount
TUint16 iInterval
CAgnRptDef &iOwningRptDef
TInt16 iStartTimeRptLocalOffset
TAgnCalendarTime iUntilTime
TInt16 iUntilTimeRptLocalOffset
TBool iUntiltimeHasBeenSet

Constructor & Destructor Documentation

TAgnRpt(CAgnRptDef &)

TAgnRpt(CAgnRptDef &aOwningRptDef)

Parameters

CAgnRptDef & aOwningRptDef

TAgnRpt(const TAgnRpt &, CAgnRptDef &)

TAgnRpt(const TAgnRpt &aRpt,
CAgnRptDef &aOwningRptDef
)

Parameters

const TAgnRpt & aRpt
CAgnRptDef & aOwningRptDef

TAgnRpt(const TAgnRpt &)

TAgnRpt(const TAgnRpt &)[private]

Parameters

const TAgnRpt &

Member Functions Documentation

ClearAll()

voidClearAll()

ConvertFromRepeatLocalToSystemLocalL(const TTime &)

TTime ConvertFromRepeatLocalToSystemLocalL(const TTime &aRptLocalTime)const [protected]

Parameters

const TTime & aRptLocalTime

ConvertFromRepeatLocalToUtcL(const TTime &)

TTime ConvertFromRepeatLocalToUtcL(const TTime &aRptLocalDate)const [protected]

Parameters

const TTime & aRptLocalDate

ConvertFromSystemLocalToRepeatLocalL(const TTime &)

TTime ConvertFromSystemLocalToRepeatLocalL(const TTime &aSysLocalTime)const [protected]

Parameters

const TTime & aSysLocalTime

ConvertFromUtcToRepeatLocalL(const TTime &)

TTime ConvertFromUtcToRepeatLocalL(const TTime &aUtcDate)const [protected]

Parameters

const TTime & aUtcDate

Count()

IMPORT_C TIntCount()const

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const [virtual]

Parameters

RWriteStream & aStream

FindRptUntilTimeLocalL(TUint)

IMPORT_C TTimeFindRptUntilTimeLocalL(TUintaCount)const

Parameters

TUint aCount

FindRptUntilTimeRptLocalL(TUint)

TTime FindRptUntilTimeRptLocalL(TUintaCount)const [pure virtual]

Parameters

TUint aCount

GetTimeAsRptLocalL(const TAgnCalendarTime &, TTime &, TInt16 &)

voidGetTimeAsRptLocalL(const TAgnCalendarTime &aCalendarTime,
TTime &aTimeAsRptLocal,
TInt16 &aCachedOffset
)const [protected]

Parameters

const TAgnCalendarTime & aCalendarTime
TTime & aTimeAsRptLocal
TInt16 & aCachedOffset

HourAndMinutesDifferentFromStartTimeL(const TTime &)

TBool HourAndMinutesDifferentFromStartTimeL(const TTime &aDate)const [protected]

Parameters

const TTime & aDate

InstanceCountL()

TUint InstanceCountL()const [pure virtual]

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[virtual]

Parameters

RReadStream & aStream

Interval()

IMPORT_C TUint16Interval()const

InvariantL()

TInt InvariantL()const [virtual]

IsAlignedRptLocalL(const TTime &)

TBool IsAlignedRptLocalL(const TTime &aRptLocalDate)const [pure virtual]

Parameters

const TTime & aRptLocalDate

IsAlignedUtcL(const TTime &)

TBool IsAlignedUtcL(const TTime &aUtcDate)const [pure virtual]

Parameters

const TTime & aUtcDate

MapDateToBits(TUint)

TUint MapDateToBits(TUintaDate)const [protected]

Parameters

TUint aDate

MapDayToBits(TDay)

TUint MapDayToBits(TDayaDay)const [protected]

Parameters

TDay aDay

NudgeNextAlignedStartTimeL(const TTime &)

TTime NudgeNextAlignedStartTimeL(const TTime &aRptLocalDate)const [protected]

Parameters

const TTime & aRptLocalDate

NudgeNextInstanceUtcL(const TTime &)

TTime NudgeNextInstanceUtcL(const TTime &aDay)const [pure virtual]

Parameters

const TTime & aDay

NudgePreviousAlignedStartTimeL(const TTime &)

TTime NudgePreviousAlignedStartTimeL(const TTime &aRptLocalDate)const [protected]

Parameters

const TTime & aRptLocalDate

NudgePreviousInstanceUtcL(const TTime &)

TTime NudgePreviousInstanceUtcL(const TTime &aDay)const [pure virtual]

Parameters

const TTime & aDay

ResetCachedStartTimeOffset()

voidResetCachedStartTimeOffset()

ResetCachedUntilTimeOffset()

voidResetCachedUntilTimeOffset()

SetCount(TInt)

IMPORT_C voidSetCount(TIntaRepCount)

Parameters

TInt aRepCount

SetInterval(TUint16)

IMPORT_C voidSetInterval(TUint16aInterval)

Parameters

TUint16 aInterval

SetUntilTime(const TAgnCalendarTime &)

voidSetUntilTime(const TAgnCalendarTime &aUntilTime)

Parameters

const TAgnCalendarTime & aUntilTime

StartTime()

const TAgnCalendarTime &StartTime()const

StartTimeAsRptLocalL()

TTime StartTimeAsRptLocalL()const

TimeMode()

MAgnCalendarTimeMode::TTimeMode TimeMode()const [protected]

Type()

TType Type()const [pure virtual]

UntilTimeAsRptLocalL()

TTime UntilTimeAsRptLocalL()const

UntilTimeL()

IMPORT_C const TAgnCalendarTime &UntilTimeL()const

operator!=(const TAgnRpt &)

TBool operator!=(const TAgnRpt &aRpt)const

Parameters

const TAgnRpt & aRpt

operator=(const TAgnRpt &)

voidoperator=(const TAgnRpt &)[private]

Parameters

const TAgnRpt &

operator==(const TAgnRpt &)

TBool operator==(const TAgnRpt &aRpt)const

Parameters

const TAgnRpt & aRpt

Member Enumerations Documentation

Enum TType

Enumerators

EDaily = 1

Repeat every x days

EWeekly

Repeat every x weeks on days, e.g. every Monday and Thursday every other week - first day of week affects this

EMonthlyByDates

Repeat every x months, e.g. on the 3rd, 5th and 9th

EMonthlyByDays

Repeat every x months, e.g. on the 1st Tuesday of the month and 3rd Wednesday

EYearlyByDate

Repeat every x years, e.g on the 3rd of October

EYearlyByDay

Repeat every x years, e.g. on the 4th Wednesday of November

Enum TWeekInMonth

Enumerators

EFirst = 0

The first week in the month. Implementation requires this to be 0.

ESecond

The second week in the month

EThird

The third week in the month

EFourth

The fourth week in the month

ELast

The last week in the month

Member Data Documentation

TInt iCount

TInt iCount[protected]

TUint16 iInterval

TUint16 iInterval[protected]

CAgnRptDef & iOwningRptDef

CAgnRptDef &iOwningRptDef[protected]

TInt16 iStartTimeRptLocalOffset

TInt16 iStartTimeRptLocalOffset[protected]

TAgnCalendarTime iUntilTime

TAgnCalendarTime iUntilTime[protected]

TInt16 iUntilTimeRptLocalOffset

TInt16 iUntilTimeRptLocalOffset[protected]

TBool iUntiltimeHasBeenSet

TBool iUntiltimeHasBeenSet[protected]