| class CVersitRecurrenceYearlyByMonth : public CVersitRecurrence |
Defines a list of months when a 'yearly by month' recurrence is to repeat.
Used by a repeating event (a vCalendar event or to-do) to define the months in which it is to occur. The months on which the event occurs are identified by their number in the year (between 1 and 12 inclusive).
A pointer to this object may be owned by a CParserPropertyValueRecurrence object.
| Public Member Functions | |
|---|---|
| CVersitRecurrenceYearlyByMonth ( TInt , TInt , TVersitDateTime *, CArrayFix < TMonth > *) | |
| ~CVersitRecurrenceYearlyByMonth () | |
| IMPORT_C void | ExternalizeOccurrenceListsL ( RWriteStream &) |
| Inherited Enumerations | |
|---|---|
| CVersitRecurrence:TType | |
| Public Attributes | |
|---|---|
| CArrayFix < TMonth > * | iArrayOfMonthsInYearOccurrences |
| Inherited Attributes | |
|---|---|
| CVersitRecurrence::iDuration | |
| CVersitRecurrence::iEndDate | |
| CVersitRecurrence::iInterval | |
| CVersitRecurrence::iRepeatType | |
| IMPORT_C | CVersitRecurrenceYearlyByMonth | ( | TInt | aInterval, |
| TInt | aDuration, | |||
| TVersitDateTime * | aEndDate, | |||
| CArrayFix < TMonth > * | aArrayOfMonthsInYearOccurrences | |||
| ) | ||||
Constructs the CVersitRecurrenceYearlyByMonth object.
Sets the repeat type to CVersitRecurrence::EYearlyByMonth .
If a duration and an end date are both specified, the end date takes precedence.
| 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 < TMonth > * aArrayOfMonthsInYearOccurrences | Pointer to an array of month values. The object takes ownership of this pointer. |
| IMPORT_C | ~CVersitRecurrenceYearlyByMonth | ( | ) |
Frees all resources owned by the object, prior to its destruction.
| IMPORT_C void | ExternalizeOccurrenceListsL | ( | RWriteStream & | aStream | ) | const [virtual] |
Writes the months of the year, as month numbers, in which the event occurs to the output stream.
For example, if the event occurs from September to December inclusive, the string written to aStream would be "9 10 11 12 ".
| RWriteStream & aStream | The stream to which the occurrence list is to be written. |
| CArrayFix < TMonth > * | iArrayOfMonthsInYearOccurrences |
Pointer to an array of month values.
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.