| class CParserPropertyValueAlarm : public CParserTimePropertyValue |
An alarm property value parser for a vCalendar entity.
An alarm can be associated with a vEvent or a vTodo. The value for the alarm is stored as a CVersitAlarm.
Note: The UID for an alarm property value is KVCalPropertyAlarmUid.
| Public Member Functions | |
|---|---|
| CParserPropertyValueAlarm(CVersitAlarm *) | |
| CParserPropertyValueAlarm() | |
| ~CParserPropertyValueAlarm() | |
| IMPORT_C void | ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &, const CVersitDaylight *) |
| IMPORT_C void | ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &) |
| IMPORT_C void | ExternalizeL(RWriteStream &, const Versit::TEncodingAndCharset &, TInt) |
| IMPORT_C TBool | IsAsciiCharacterSetSufficient() |
| CVersitAlarm * | Value() |
| Private Attributes | |
|---|---|
| CVersitAlarm * | iValue |
| IMPORT_C | CParserPropertyValueAlarm | ( | CVersitAlarm * | aValue | ) |
| CVersitAlarm * aValue |
| IMPORT_C void | ConvertAllDateTimesToUTCL | ( | const TTimeIntervalSeconds & | aIncrement, |
| const CVersitDaylight * | aDaylight | |||
| ) | [virtual] | |||
This is implemented, where applicable, to convert date/time values into universal time.
The date/time is checked against the daylight saving information provided in aDaylight. If it falls inside the daylight saving period then the daylight saving offset is subtracted from the time to convert it to universal time. Otherwise aIncrement is added to the date/time of the alarm to convert it to universal time.
Note that the daylight savings offset will adjust the time both for the daylight saving and for the time zone.
The function has no effect if it date/times are already stored in universal time.
If aDaylight is a NULL pointer then aIncrement is used.
since 9.1
| const TTimeIntervalSeconds & aIncrement | A time interval in seconds which represents the time zone's offset from universal time. |
| const CVersitDaylight * aDaylight | Pointer to the specification for daylight saving. If the alarm's time value is within the period for daylight saving, the value is modified by the daylight saving offset (which accounts for both the time zone and daylight saving rule). |
| IMPORT_C void | ConvertAllUTCDateTimesToMachineLocalL | ( | const TTimeIntervalSeconds & | aIncrement | ) | [virtual] |
Pure virtual function which is implemented, where applicable, to convert the date/time property value into machine-local time.
This process involves adjusting the date/time value by the offset in aIncrement.
The function has no effect if the value is already stored as machine-local time.
The universal date/times are assumed to have been corrected for any daylight saving rule in effect.
since 9.1
| const TTimeIntervalSeconds & aIncrement | A time interval which represents the number of seconds which is to be added to the date/time value. This should normally be the universal time offset for the machine's locale. |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream, |
| const Versit::TEncodingAndCharset & | aEncodingCharset, | |||
| TInt | aLengthOutput | |||
| ) | [virtual] | |||
Externalises the property value to a write stream.
Implementations of this function are invoked by the parser's ExternalizeL() function.
| RWriteStream & aStream | Stream to which the property value is externalised. |
| const Versit::TEncodingAndCharset & aEncodingCharset | The character set and encoding information. |
| TInt aLengthOutput | The amount of text that has been outputted so far on the line (for the property name), which may need to be taken into account when calculating if and where any line break should occur. |
| CVersitAlarm * | Value | ( | ) | const [inline] |
Gets a pointer to the alarm property value.
Pointer to the alarm property value.