TCalRRule Class Reference

#include <app/calrrule.h>

Link against: esmrservices.lib

class TCalRRule

Nested Classes and Structures

Public Member Enumerations
enumTType { EInvalid, EDaily, EWeekly, EMonthly, EYearly }
Public Member Functions
TCalRRule()
TCalRRule(TType)
IMPORT_C TUintCount()
IMPORT_C TCalTimeDtStart()
IMPORT_C voidGetByDayL(RArray< TDay > &)
IMPORT_C voidGetByDayL(RArray< TDayOfMonth > &)
IMPORT_C voidGetByMonthDayL(RArray< TInt > &)
IMPORT_C voidGetByMonthL(RArray< TMonth > &)
IMPORT_C TIntInterval()
IMPORT_C voidSetByDay(const RArray< TDay > &)
IMPORT_C voidSetByDay(const RArray< TDayOfMonth > &)
IMPORT_C voidSetByMonth(const RArray< TMonth >)
IMPORT_C voidSetByMonthDay(const RArray< TInt > &)
IMPORT_C voidSetCount(TUint)
IMPORT_C voidSetDtStart(const TCalTime &)
IMPORT_C voidSetInterval(TInt)
IMPORT_C voidSetType(TType)
IMPORT_C voidSetUntil(const TCalTime &)
voidSetUntilAndCount(const TCalTime &, TUint)
IMPORT_C voidSetWkSt(TDay)
IMPORT_C TTypeType()
IMPORT_C TCalTimeUntil()
IMPORT_C TDayWkSt()

Detailed Description

Class representing iCal repeat types.

This supports the following standard iCal properties:
  • FREQ (rule type),

  • DTSTART (start date),

  • UNTIL (end date),

  • COUNT (number of instances),

  • INTERVAL (interval between instances),

  • BYDAY,

  • BYMONTHDAY,

  • BYYEARDAY,

  • WKST (start day of week).

Note that the repeat rule type (FREQ) must be set before any of the following properties can be set, since their behaviour is dependent on the rule type: BYDAY, BYMONTHDAY, BYYEARDAY

The WKST parameter is only significant in weekly repeat rules with an interval of greater than 1.

The repeat rule type may not be changed once it has been set.

If the start date of the entry does not match an instance of its repeat rule then the entry's start date will be moved forward to the first matching instance. For example, if the rule repeats every Wednesday but the start date of the entry is Monday, then the start date will be changed to the Wednesday.

Member Enumeration Documentation

Enum TType

Types of repeat rule.

EnumeratorValueDescription
EInvalid0

The type has not yet been defined.

EDaily

Rule which repeats based on a number of days.

EWeekly

Rule which repeats based on a number of weeks.

EMonthly

Rule which repeats based on a number of months.

EYearly

Rule which repeats based on a number of years.

Constructor & Destructor Documentation

TCalRRule ( )

IMPORT_CTCalRRule()

TCalRRule ( TType )

IMPORT_CTCalRRule(TTypeaType)

Member Function Documentation

Count ( )

IMPORT_C TUintCount()const

DtStart ( )

IMPORT_C TCalTimeDtStart()const

GetByDayL ( RArray< TDay > & )

IMPORT_C voidGetByDayL(RArray< TDay > &aDays)const

GetByDayL ( RArray< TDayOfMonth > & )

IMPORT_C voidGetByDayL(RArray< TDayOfMonth > &aDays)const

GetByMonthDayL ( RArray< TInt > & )

IMPORT_C voidGetByMonthDayL(RArray< TInt > &aMonthDays)const

GetByMonthL ( RArray< TMonth > & )

IMPORT_C voidGetByMonthL(RArray< TMonth > &aMonths)const

Interval ( )

IMPORT_C TIntInterval()const

SetByDay ( const RArray< TDay > & )

IMPORT_C voidSetByDay(const RArray< TDay > &aDays)

SetByDay ( const RArray< TDayOfMonth > & )

IMPORT_C voidSetByDay(const RArray< TDayOfMonth > &aDays)

SetByMonth ( const RArray< TMonth > )

IMPORT_C voidSetByMonth(const RArray< TMonth >aMonths)

SetByMonthDay ( const RArray< TInt > & )

IMPORT_C voidSetByMonthDay(const RArray< TInt > &aMonthDays)

SetCount ( TUint )

IMPORT_C voidSetCount(TUintaCount)

SetDtStart ( const TCalTime & )

IMPORT_C voidSetDtStart(const TCalTime &aTime)

SetInterval ( TInt )

IMPORT_C voidSetInterval(TIntaInterval)

SetType ( TType )

IMPORT_C voidSetType(TTypeaType)

SetUntil ( const TCalTime & )

IMPORT_C voidSetUntil(const TCalTime &aTime)

SetUntilAndCount ( const TCalTime &, TUint )

voidSetUntilAndCount(const TCalTime &aTime,
TUintaCount
)

SetWkSt ( TDay )

IMPORT_C voidSetWkSt(TDayaDay)

Type ( )

IMPORT_C TTypeType()const

Until ( )

IMPORT_C TCalTimeUntil()const

WkSt ( )

IMPORT_C TDayWkSt()const