Collapse all Symbian^3 Product Developer Library

CVersitRecurrence Class Reference

class CVersitRecurrence : public CBase

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.

Inherits from

CVersitRecurrence
- CBase

Public Member Functions
	CVersitRecurrence(TInt, TInt, TVersitDateTime *)
	~CVersitRecurrence()
void	ExternalizeOccurrenceListsL(RWriteStream &)

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()

Public Member Enumerations
enum	TType { EDaily = 1, EWeekly, EMonthlyByPos, EMonthlyByDay, EYearlyByMonth, EYearlyByDay }

Public Attributes
TInt	iDuration
TVersitDateTime *	iEndDate
TInt	iInterval
TType	iRepeatType

Constructor & Destructor Documentation

CVersitRecurrence(TInt, TInt, TVersitDateTime *)

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

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

(

)

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

Member Functions Documentation

ExternalizeOccurrenceListsL(RWriteStream &)

void

ExternalizeOccurrenceListsL

(

RWriteStream &

aStream

)

const [pure virtual]

Externalises an occurrence list to aStream.

Parameters

RWriteStream & aStream

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

Member Enumerations Documentation

Enum TType

Repeat type.

Enumerators

EDaily = 1	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.

Member Data Documentation

TInt iDuration

TInt

iDuration

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.

TVersitDateTime * iEndDate

TVersitDateTime *

iEndDate

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.

TInt iInterval

TInt

iInterval

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

TType iRepeatType

TType

iRepeatType

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