Class CVersitRecurrenceYearlyByDay

class CVersitRecurrenceYearlyByDay : public CVersitRecurrence;

Description

Defines a list of days when a 'yearly by day' recurrence is to be repeated.

Used by a repeating event (a vCalendar event or to-do) to define when it is to occur.

The days on which the repeat occurs are identified by their day number in the year (between 1 and 366 inclusive).

A pointer to this object may be owned by a CParserPropertyValueRecurrence object.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CVersitRecurrence - Abstract base class for all recurrence property value classes

• CVersitRecurrenceYearlyByDay - Defines a list of days when a 'yearly by day' recurrence is to be repeated

Members

Defined in CVersitRecurrenceYearlyByDay:
CVersitRecurrenceYearlyByDay(), ExternalizeOccurrenceListsL(), iArrayOfDaysInYearOccurrences, ~CVersitRecurrenceYearlyByDay()

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

Inherited from CVersitRecurrence:
EDaily, EMonthlyByDay, EMonthlyByPos, EWeekly, EYearlyByDay, EYearlyByMonth, TType, iDuration, iEndDate, iInterval, iRepeatType

IMPORT_C CVersitRecurrenceYearlyByDay(TInt aInterval, TInt aDuration, TVersitDateTime *aEndDate, CArrayFix< TInt > *aArrayOfDaysInYearOccurrences);

Description

Constructs the CVersitRecurrenceYearlyByDay object.

Sets the repeat type to EYearlyByDay.

If a duration and an end date are both specified, the end date takes precedence.

Parameters

TInt aInterval The number of years between repeats. TInt aDuration The duration, in years, for which the event should recur. A value of zero indicates the repeat should continue forever. TVersitDateTime *aEndDate Optional pointer to the end date for the repeat event. The object takes ownership of this pointer. CArrayFix< TInt > *aArrayOfDaysInYearOccurrences Pointer to an array of integers between 1 and 366 inclusive. Each integer represents a day on which the repeat event occurs. The object takes ownership of this pointer.

IMPORT_C ~CVersitRecurrenceYearlyByDay();

Description

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

virtual IMPORT_C void ExternalizeOccurrenceListsL(RWriteStream &aStream) const;

Description

Writes the days of the year on which the event occurs to the output stream, aStream.

For example, the function might write the string "10 11 12 13 14 15 ".

Parameters

RWriteStream &aStream The stream to which the occurrence list is to be written.

CArrayFix< TInt > * iArrayOfDaysInYearOccurrences;

Description

Pointer to an array of integers between 1 and 366 inclusive.

Each integer represents a day on which the repeat event occurs.