EPOC   SDK Home Glossary Indexes Previous Next Up

CParserPropertyValueAlarm class


Contents


CParserPropertyValueAlarm class — Audio reminder property value

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behaviour.

CParserPropertyValue

Abstract: Base class for all property values.

CParserTimePropertyValue

Abstract: Base class for all date and time property values.

Defined in

vcal.h

Link against

versit.lib

Description

This class 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.


Construction and destruction


CParserPropertyValueAlarm() — C++ constructor with a CVersitAlarm

CParserPropertyValueAlarm(CVersitAlarm* aValue);

Description

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

Arguments

CVersitAlarm* aValue

Pointer to the specification for the audio reminder. The property value takes ownership of the pointer.


~CParserPropertyValueAlarm() — Destructor

~CParserPropertyValueAlarm();

Description

The destructor frees all resources owned by the property value, prior to its destruction.


Date/time conversion


ConvertAllDateTimesToUTCL() — Convert alarm time to universal time

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

Description

This function 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.

Arguments

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.


ConvertAllUTCDateTimesToMachineLocalL() — Convert alarm time to local time

void ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds& aIncrement);

Description

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

It does this by adding the increment specified to the audio reminder's alarm time.

Arguments

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.


Property value


Value() — Get the audio reminder property value

CVersitAlarm* Value() const;

Description

Retrieves a pointer to the audio reminder property value.

Return value

CVersitAlarm*

Pointer to the audio reminder property value.

EPOC       SDK Home Glossary Indexes Previous Next Up