CVersitRecurrence Class Reference

#include <app/vrecur.h>

Link against: vcal.lib

class CVersitRecurrence : public CBase

Inherits from

  • CVersitRecurrence
    Public Attributes
    TInt iDuration
    TVersitDateTime *iEndDate
    TInt iInterval
    TType iRepeatType
    Public Member Enumerations
    enumTType { EDaily, EWeekly, EMonthlyByPos, EMonthlyByDay, ..., EYearlyByDay }
    Public Member Functions
    CVersitRecurrence(TInt, TInt, TVersitDateTime *)
    ~CVersitRecurrence()
    pure virtual voidExternalizeOccurrenceListsL(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()

    Detailed Description

    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.

    Member Attribute Documentation

    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.

    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.

    iInterval

    TInt iInterval

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

    iRepeatType

    TType iRepeatType

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

    Member Enumeration Documentation

    Enum TType

    Repeat type.

    EnumeratorValueDescription
    EDaily1

    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.

    Constructor & Destructor Documentation

    CVersitRecurrence ( TInt, TInt, TVersitDateTime * )

    IMPORT_CCVersitRecurrence(TIntaInterval,
    TIntaDuration,
    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.

    ParameterDescription
    aIntervalThe interval between repeats.
    aDurationThe duration for the recurrence.
    aEndDateA 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 Function Documentation

    ExternalizeOccurrenceListsL ( RWriteStream & )

    voidExternalizeOccurrenceListsL(RWriteStream &aStream)const [pure virtual]

    Externalises an occurrence list to aStream.

    ParameterDescription
    aStreamThe stream to which the occurrence list is to be externalised.
    © Nokia 2011.