Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: VRECUR.H
Link against: vcal.lib

Class CVersitRecurrence

class CVersitRecurrence : public CBase;

Description

Abstract base class for all recurrence property value classes.

A pointer to a derived recurrence property value class instance is owned by the CParserPropertyValueRecurrence class.

Implementations of this class define when an event is to repeat.

Derivation

Members

Defined in CVersitRecurrence:
CVersitRecurrence(), EDaily, EMonthlyByDay, EMonthlyByPos, EWeekly, EYearlyByDay, EYearlyByMonth, ExternalizeOccurrenceListsL(), TType, iDuration, iEndDate, iInterval, iRepeatType, ~CVersitRecurrence()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


CVersitRecurrence()

IMPORT_C CVersitRecurrence(TInt aInterval, TInt aDuration, TVersitDateTime *aEndDate);

Description

Constructs the CVersitRecurrence object.

Initialises the interval (iInterval), duration (iDuration) and optionally, the end date (iEndDate).

This is invoked by the constructor of a derived class.

Parameters

TInt aInterval

The interval between repeats.

TInt aDuration

The duration for the recurrence.

TVersitDateTime *aEndDate

A pointer to the end date. The object takes ownership of this pointer.


~CVersitRecurrence()

IMPORT_C ~CVersitRecurrence();

Description

Frees all resources owned by the CVersitRecurrence object, prior to its destruction.

[Top]


Member functions


ExternalizeOccurrenceListsL()

virtual void ExternalizeOccurrenceListsL(RWriteStream &aStream) const=0;

Description

Externalises an occurrence list to aStream.

Parameters

RWriteStream &aStream

The stream to which the occurrence list is to be externalised.

[Top]


Member enumerations


Enum TType

TType

Description

Repeat type.

EDaily

Daily repeat.

EWeekly

Weekly repeat.

EMonthlyByPos

Monthly repeat, by relative position within the month.

EMonthlyByDay

Monthly repeat, by day number within the month.

EYearlyByMonth

Yearly repeat, by specific months within the year.

EYearlyByDay

Yearly repeat, by specific days within the year.

[Top]


Member data


iRepeatType

TType iRepeatType;

Description

The type of repeat (daily, weekly etc.).


iInterval

TInt iInterval;

Description

The interval between repeats: a number of days, weeks, months or years, depending on the repeat type.


iDuration

TInt iDuration;

Description

The duration in days, weeks, months or years (depending on the repeat type) for the repeat.

A value of zero indicates the repeat should continue forever.


iEndDate

TVersitDateTime * iEndDate;

Description

Specification for the date at which the repeat will end. If a duration and an end date are both specified, the end date takes precedence.