class TCalRRule |
Class representing iCal repeat types.
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.
Public Member Functions | |
---|---|
TCalRRule() | |
TCalRRule(TType) | |
IMPORT_C TUint | Count() |
IMPORT_C TCalTime | DtStart() |
IMPORT_C void | GetByDayL(RArray< TDay > &) |
IMPORT_C void | GetByDayL(RArray< TDayOfMonth > &) |
IMPORT_C void | GetByMonthDayL(RArray< TInt > &) |
IMPORT_C void | GetByMonthL(RArray< TMonth > &) |
IMPORT_C TInt | Interval() |
IMPORT_C void | SetByDay(const RArray< TDay > &) |
IMPORT_C void | SetByDay(const RArray< TDayOfMonth > &) |
IMPORT_C void | SetByMonth(const RArray< TMonth >) |
IMPORT_C void | SetByMonthDay(const RArray< TInt > &) |
IMPORT_C void | SetCount(TUint) |
IMPORT_C void | SetDtStart(const TCalTime &) |
IMPORT_C void | SetInterval(TInt) |
IMPORT_C void | SetType(TType) |
IMPORT_C void | SetUntil(const TCalTime &) |
void | SetUntilAndCount(const TCalTime &, TUint) |
IMPORT_C void | SetWkSt(TDay) |
IMPORT_C TType | Type() |
IMPORT_C TCalTime | Until() |
IMPORT_C TDay | WkSt() |
Private Member Functions | |
---|---|
TBool | GetNthBit(TUint) |
void | InitialiseData() |
TUint | MapToBitsWeekdays(TDay) |
void | SetNthBit(TUint) |
Public Member Enumerations | |
---|---|
enum | TType { EInvalid = 0, EDaily, EWeekly, EMonthly, EYearly } |
Private Attributes | |
---|---|
TUint64 | iBuffer |
TInt | iCount |
TCalTime | iDtStart |
TUint8 | iInterval |
TInt32 | iReserved |
TInt32 | iReserved2 |
TType | iType |
TCalTime | iUntil |
TDay | iWkSt |
IMPORT_C void | GetByDayL | ( | RArray< TDayOfMonth > & | aDays | ) | const |
RArray< TDayOfMonth > & aDays |
IMPORT_C void | SetByDay | ( | const RArray< TDayOfMonth > & | aDays | ) |
const RArray< TDayOfMonth > & aDays |
IMPORT_C void | SetDtStart | ( | const TCalTime & | aTime | ) |
const TCalTime & aTime |
IMPORT_C void | SetUntil | ( | const TCalTime & | aTime | ) |
const TCalTime & aTime |
Types of repeat rule.
EInvalid = 0 |
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. |
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.