Class CParserPropertyValueAlarm

class CParserPropertyValueAlarm : public CParserTimePropertyValue;

Description

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CParserPropertyValue - Abstract base class for all property values

• CParserTimePropertyValue - Abstract base class for all of the date/time property value classes

• CParserPropertyValueAlarm - An alarm property value parser for a vCalendar entity

Members

Defined in CParserPropertyValueAlarm:
CParserPropertyValueAlarm(), CParserPropertyValueAlarm(), ConvertAllDateTimesToUTCL(), ConvertAllUTCDateTimesToMachineLocalL(), ExternalizeL(), IsAsciiCharacterSetSufficient(), Value(), ~CParserPropertyValueAlarm()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CParserPropertyValue:
Append(), EncodeL(), FoldAndWriteValueToStreamL(), FoldEncodeAndWriteValueToStreamL(), PlugIn(), SetPlugIn(), Uid()

Inherited from CParserTimePropertyValue:
ConvertDateTime(), EncodeTimePeriodL(), EncodeVersitDateTimeL(), SupportsInterface()

IMPORT_C CParserPropertyValueAlarm(CVersitAlarm *aValue);

Description

Constructs a new alarm property value with a pointer to a CVersitAlarm.

Parameters

CVersitAlarm *aValue Pointer to the alarm. The property value takes ownership of the pointer.

IMPORT_C CParserPropertyValueAlarm();

Description

IMPORT_C ~CParserPropertyValueAlarm();

Description

Frees all resources owned by the property value, prior to its destruction.

inline CVersitAlarm *Value() const;

Description

Gets a pointer to the alarm property value.

Return value

CVersitAlarm * Pointer to the alarm property value.

virtual IMPORT_C void ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &aIncrement, const CVersitDaylight *aDaylight);

Description

Converts the alarm time into universal time.

The date/time of the alarm 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 the value is already stored as universal time.

If aDaylight is a NULL pointer then aIncrement is used.

Parameters

const TTimeIntervalSeconds &aIncrement A time interval in seconds which represents the negative of the time zone of the originating machine. For instance, if the time zone is +04:30, aIncrement should be set to -04:30. 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).

virtual IMPORT_C void ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &aIncrement);

Description

Converts the alarm time to machine-local time.

This involves adjusting the alarm's date/time by the offset in aIncrement.

The function has no effect if the value is already stored as machine-local time.

Parameters

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.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream, const Versit::TEncodingAndCharset &aEncodingCharset, TInt aLengthOutput);

Description

Externalises the alarm property value into aStream.

Parameters

RWriteStream &aStream Stream to which the value should be externalised. const Versit::TEncodingAndCharset &aEncodingCharset Contains the character set and encoding into which the property value should be converted. TInt aLengthOutput The amount of text that has been outputted on the line so far, which needs to be taken into account when calculating if and where any line break should occur.

virtual IMPORT_C TBool IsAsciiCharacterSetSufficient();

Description

Tests whether the property value can be represented using the ASCII character set.

Return value

TBool ETrue if the property value can be represented using the ASCII character set. If not, EFalse.