MRRecurrenceRule Class Reference
Nested Classes and Structures
| Public Member Enumerations |
|---|
| enum | TMRRecurrenceMonth {
EMRRecurrenceJanuary = 1, EMRRecurrenceFebryary, EMRRecurrenceMarch, EMRRecurrenceApril, EMRRecurrenceMay, EMRRecurrenceJune, EMRRecurrenceJuly, EMRRecurrenceAugust, EMRRecurrenceSeptember, EMRRecurrenceOctober, EMRRecurrenceNovember, EMRRecurrenceDecember
} |
| enum | TMRRecurrenceType {
EMRRecurrenceInvalid, EMRRecurrenceDaily, EMRRecurrenceWeekly, EMRRecurrenceMonthly, EMRRecurrenceMonthlyByDay, EMRRecurrenceYearly, EMRRecurrenceYearlyByDay
} |
| enum | TMRRecurrenceWeek { EMRRecurrenceLastWeekOfMonth = -1, EMRRecurrenceFirstWeekOfMonth = 1, EMRRecurrenceSecondWeekOfMonth = 2, EMRRecurrenceThirdWeekOfMonth = 3, EMRRecurrenceFourthWeekOfMonth = 4 } |
| enum | TMRRecurrentDay {
EMRRecurrenceMonday, EMRRecurrenceTuesday, EMRRecurrenceWednesday, EMRRecurrenceThursday, EMRRecurrenceFriday, EMRRecurrenceSaturday, EMRRecurrenceSunday
} |
Constructor & Destructor Documentation
~MRRecurrenceRule()
| ~MRRecurrenceRule | ( | ) | [inline, virtual] |
Member Functions Documentation
RecurrenceStartTime()
|
TTime
| RecurrenceStartTime | ( | ) | const [pure virtual] |
Fetches the recurrence start time. Time information is returned in utc.
RecurrentCount()
|
TUint
| RecurrentCount | ( | ) | const [pure virtual] |
Fetches the number of recurrences.
RecurrentInterval()
|
TInt
| RecurrentInterval | ( | ) | const [pure virtual] |
Fetches the recurrent interval. Interval is a number of days for a daily repeat, a number of weeks for a weekly repeat, etc.
RecurrentMonthDays()
| const RArray< TInt > & | RecurrentMonthDays | ( | ) | const [pure virtual] |
Fetches all days in the month on which this rule is repeated. The returned array is empty if this is not a monthly or yearly recurrence.
RecurrentMonths()
Fetches the months of the year for this repeat rule. This function will do nothing if this is not a yearly repeat rule.
RecurrentUntil()
|
TTime
| RecurrentUntil | ( | ) | const [pure virtual] |
Fetches the date on which this repeat rule finishes. Time information is returned in utc.
RecurrentWeekDays()
Fetches all weekdays on which this rule is repeated. The returned array is empty if this is not a weekly recurrence.
SetRecurrenceStartTimeL(TTime)
| void | SetRecurrenceStartTimeL | ( | TTime | aStartTime | ) | [pure virtual] |
Sets the recurrence start time.
Parameters
| TTime aStartTime | Recurrence start time as utc. |
SetRecurrenceTypeL(TMRRecurrenceType)
Sets recurrence type. Calling this method will clear the previously set recurrence rules.
- Exceptions
-
SetRecurrenceUntilL(TTime)
| void | SetRecurrenceUntilL | ( | TTime | aStartTime | ) | [pure virtual] |
Sets the recurrence until time.
Parameters
| TTime aStartTime | Recurrence until time in utc. |
SetRecurrentCountL(TInt)
| void | SetRecurrentCountL | ( | TInt | aCount | ) | [pure virtual] |
Sets recurrent count.
- Exceptions
| Normal |
system wide error code.
|
SetRecurrentDaysofMonthL(RArray< TRecurrentDaysofMonth > &)
SetRecurrentInterval(TInt)
| void | SetRecurrentInterval | ( | TInt | aInterval | ) | [pure virtual] |
Sets recurrent rule interval.
- Exceptions
| Normal |
system wide error code.
|
Parameters
| TInt aInterval | Recurrent rule interval. |
SetRecurrentMonthDaysL(RArray< TInt > &)
| void | SetRecurrentMonthDaysL | ( | RArray< TInt > & | aDays | ) | [pure virtual] |
Sets the days in the month on which this rule is repeated. Calling this method has no effect if recurrence rule type is not monthly or yearly.
- Exceptions
| Normal |
system wide error code.
|
Parameters
| RArray< TInt > & aDays | Days in the month on which this rule is repeated. |
SetRecurrentMonthsL(RArray< TMRRecurrenceMonth > &)
Sets the months of the year for this repeat rule. Calling this method has no effect if recurrence rule type is not yearly.
- Exceptions
| Normal |
system wide error code.
|
SetRecurrentWeekDaysL(RArray< TMRRecurrentDay > &)
Sets the all weekdays on which this rule is repeated. Calling this method has no effect if recurrence rule type is not weekly.
- Exceptions
| Normal |
system wide error code.
|
Member Enumerations Documentation
Enum TMRRecurrenceMonth
Definition for recurrence months
Enumerators
| EMRRecurrenceJanuary = 1 | |
| EMRRecurrenceFebryary | |
| EMRRecurrenceMarch | |
| EMRRecurrenceApril | |
| EMRRecurrenceMay | |
| EMRRecurrenceJune | |
| EMRRecurrenceJuly | |
| EMRRecurrenceAugust | |
| EMRRecurrenceSeptember | |
| EMRRecurrenceOctober | |
| EMRRecurrenceNovember | |
| EMRRecurrenceDecember | |
Enum TMRRecurrenceType
Enumerators
| EMRRecurrenceInvalid |
The type has not yet been defined
|
| EMRRecurrenceDaily |
Rule which repeats based on a number of days.
|
| EMRRecurrenceWeekly |
Rule which repeats based on a number of weeks
|
| EMRRecurrenceMonthly |
Rule which repeats based on a number of months
|
| EMRRecurrenceMonthlyByDay | |
| EMRRecurrenceYearly |
Rule which repeats based on a number of years
|
| EMRRecurrenceYearlyByDay | |
Enum TMRRecurrenceWeek
Definition for recurrent week
Enumerators
| EMRRecurrenceLastWeekOfMonth = -1 | |
| EMRRecurrenceFirstWeekOfMonth = 1 | |
| EMRRecurrenceSecondWeekOfMonth = 2 | |
| EMRRecurrenceThirdWeekOfMonth = 3 | |
| EMRRecurrenceFourthWeekOfMonth = 4 | |
Enum TMRRecurrentDay
Definition for recurrent day
Enumerators
| EMRRecurrenceMonday | |
| EMRRecurrenceTuesday | |
| EMRRecurrenceWednesday | |
| EMRRecurrenceThursday | |
| EMRRecurrenceFriday | |
| EMRRecurrenceSaturday | |
| EMRRecurrenceSunday | |
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.