Class CParserPropertyValueAlarm

CParserPropertyValueAlarm

Support

Supported from 5.0

Description

Defines an audio reminder property value for a vCalendar entity. An audio reminder is an alarm that is sounded for a vEvent, or for a vTodo. The value for the audio reminder is stored as a CVersitAlarm.

To find out the property value type, use Uid() defined in the base class CParserPropertyValue. An alarm property UID has the value KVCalPropertyAlarmUid.

Derivation

CBase Base class for all classes to be instantiated on the heap CParserPropertyValue Abstract base class for all property values CParserPropertyValueAlarm Defines an audio reminder property value for a vCalendar entity CParserTimePropertyValue Abstract base class for all of the date/time property value classes (CParserPropertyValueAlarm, CParserPropertyValueDate, CParserPropertyValueDateTime, CParserPropertyValueMultiDateTime, CParserPropertyValueDaylight, CParserPropertyValueRecurrence)

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

Inherited from CBase:
operator new()

Inherited from CParserPropertyValue:
EncodeL(), ExternalizeL(), IsAsciiCharacterSetSufficient(), Uid()

Inherited from CParserTimePropertyValue:
SupportsInterface()

CParserPropertyValueAlarm(CVersitAlarm* aValue);

Description

Constructs a new audio reminder property value with a pointer to a CVersitAlarm.

Parameters

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

~CParserPropertyValueAlarm();

Description

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

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

Description

Converts the audio reminder's alarm time value into universal time. The function has no effect if the value is already stored as universal time.

The number of seconds specified in aIncrement is added to the alarm time, then the resulting value is modified by the daylight saving offset specified in aDaylight, if applicable.

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 audio reminder's alarm time value is within the period for daylight saving, the value is modified by the daylight saving offset.

void ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds& aIncrement);

Description

Converts the audio reminder's alarm time value from universal time into the local time for the target machine.

Parameters

const TTimeIntervalSeconds& aIncrement A time interval in seconds to add to the audio reminder's alarm time value. This should normally be the universal time offset for the machine's locale.

CVersitAlarm* Value() const;

Description

Gets a pointer to the alarm property value.

Return value

CVersitAlarm* Pointer to the alarm property value.