CVersitRecurrenceMonthlyByPos Class Reference

#include <app/vrecur.h>

Link against: vcal.lib

class CVersitRecurrenceMonthlyByPos : public CVersitRecurrence

Inherits from

CVersitRecurrenceMonthlyByPos
- CVersitRecurrence

Nested Classes and Structures

CVersitRecurrenceMonthlyByPos::CMonthPosition

Public Attributes
CArrayPtrFlat< CMonthPosition > *	iMonthPositions

Public Member Functions
	CVersitRecurrenceMonthlyByPos(TInt, TInt, TVersitDateTime , CArrayPtrFlat< CMonthPosition > )
	~CVersitRecurrenceMonthlyByPos()
virtual IMPORT_C void	ExternalizeOccurrenceListsL(RWriteStream &)

Inherited Attributes
	CVersitRecurrence::iDuration
	CVersitRecurrence::iEndDate
	CVersitRecurrence::iInterval
	CVersitRecurrence::iRepeatType

Inherited Enumerations
	CVersitRecurrence:TType

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CVersitRecurrence::CVersitRecurrence(TInt,TInt,TVersitDateTime *)
	CVersitRecurrence::~CVersitRecurrence()

Detailed Description

Defines a list of days when a 'monthly by position' 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 event occurs are identified by their relative position within the month, for example the second Monday or the last Friday.

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

Note: The CMonthPosition class, defined within this class, is used to define the positions of days within the month.

Member Attribute Documentation

iMonthPositions

CArrayPtrFlat< CMonthPosition > *

iMonthPositions

Array of 'month positions' which define the days on which the event occurs.

Constructor & Destructor Documentation

CVersitRecurrenceMonthlyByPos ( TInt, TInt, TVersitDateTime , CArrayPtrFlat< CMonthPosition > )

IMPORT_C	CVersitRecurrenceMonthlyByPos	(	TInt	aInterval,
			TInt	aDuration,
			TVersitDateTime *	aEndDate,
			CArrayPtrFlat< CMonthPosition > *	aMonthPositions
		)

Constructs the CVersitRecurrenceMonthlyByPos object.

Sets the interval, the duration, optionally, an end date for the repeat and a pointer to an array of 'month positions', which specify when the event occurs. Also sets the repeat type to EMonthlyByPos.

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

Parameter	Description
aInterval	The number of months between repeats.
aDuration	The duration, in months, for which the event should recur. A value of zero indicates the repeat should continue forever.
aEndDate	Pointer to the end date for the repeat event. The object takes ownership of this pointer.
aMonthPositions	Pointer to an array of the positions of days within the month. The object takes ownership of this pointer.