CVersitRecurrenceMonthlyByDay Class Reference

#include <app/vrecur.h>

Link against: vcal.lib

class CVersitRecurrenceMonthlyByDay : public CVersitRecurrence

Inherits from

Detailed Description

Defines a list of days when a 'monthly by day' recurrence is to repeat.

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

The days on which the event occurs are identified by a number, counting either from the start or the end of the month.

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

Member Attribute Documentation

iArrayOfOccurrencesInDaysFromEndOfMonth

CArrayFix< TInt > *iArrayOfOccurrencesInDaysFromEndOfMonth

Array of days, counting from the end of the month, on which the event occurs.

iArrayOfOccurrencesInDaysFromStartOfMonth

CArrayFix< TInt > *iArrayOfOccurrencesInDaysFromStartOfMonth

Array of days, counting from the start of the month, on which the event occurs.

iLastDay

TBool iLastDay

Identifies whether the event occurs on the last day of the month.

Constructor & Destructor Documentation

CVersitRecurrenceMonthlyByDay ( TInt, TInt, TVersitDateTime *, CArrayFix< TInt > *, CArrayFix< TInt > *, TBool )

IMPORT_CCVersitRecurrenceMonthlyByDay(TIntaInterval,
TIntaDuration,
TVersitDateTime *aEndDate,
CArrayFix< TInt > *aArrayOfOccurrencesInDaysFromStartOfMonth,
CArrayFix< TInt > *aArrayOfOccurrencesInDaysFromEndOfMonth,
TBoolaLastDay
)

Constructs the CVersitRecurrenceMonthlyByDay object.

Sets the repeat type to CVersitRecurrence::EMonthlyByDay. Note: if a duration and an end date are both specified, the end date takes precedence.

ParameterDescription
aIntervalThe number of months between repeats.
aDurationThe duration, in months, for which the event should recur. A value of zero indicates the repeat should continue forever.
aEndDateOptional pointer to the end date for the repeat event. The object takes ownership of this pointer.
aArrayOfOccurrencesInDaysFromEndOfMonthOptional pointer to an array of numbers, each of which can have a value between 1 and 31 inclusive, which identify the days, counting from the end of the month, on which the repeat event occurs. (The last day of the month is represented by 1). The object takes ownership of this pointer.
aLastDayOptional - ETrue if the event occurs on the last day of the month. This day can then be represented in the output stream using the LD recurrence value. EFalse if not.

~CVersitRecurrenceMonthlyByDay ( )

IMPORT_C~CVersitRecurrenceMonthlyByDay()

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

Member Function Documentation

ExternalizeOccurrenceListsL ( RWriteStream & )

IMPORT_C voidExternalizeOccurrenceListsL(RWriteStream &aStream)const [virtual]

Reimplemented from CVersitRecurrence::ExternalizeOccurrenceListsL(RWriteStream &)const

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

For days counted from the beginning of the month, the string written to aStream might be "1+ 2+ 16+ 17+ ", with the plus sign indicating that the day is counted from the start of the month.

For days counted from the end of the month, the string written to aStream might be "1- 3- 4- LD ", with "LD" signifying that the event occurs on the last day of the month.

ParameterDescription
aStreamThe stream to which the occurrence list is to be written.