CParserPropertyValueAlarm Class Reference

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.

Inherits from

Public Member Functions
CParserPropertyValueAlarm(CVersitAlarm *)
CParserPropertyValueAlarm()
~CParserPropertyValueAlarm()
IMPORT_C voidConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &, const CVersitDaylight *)
IMPORT_C voidConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &)
IMPORT_C voidExternalizeL(RWriteStream &, const Versit::TEncodingAndCharset &, TInt)
IMPORT_C TBoolIsAsciiCharacterSetSufficient()
CVersitAlarm *Value()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CParserPropertyValue::Append(TDes16 &,TDesC8 &)
CParserPropertyValue::CParserPropertyValue(const TUid &)
CParserPropertyValue::EncodeL(CBufBase *,const TDesC8 &,const TUid &)const
CParserPropertyValue::FoldAndWriteValueToStreamL(RWriteStream &,const TDesC &,const Versit::TEncodingAndCharset &,TInt &)const
CParserPropertyValue::FoldEncodeAndWriteValueToStreamL(RWriteStream &,const CDesCArray *,const Versit::TEncodingAndCharset &,TInt &)const
CParserPropertyValue::FoldEncodeAndWriteValueToStreamL(RWriteStream &,const TDesC &,const Versit::TEncodingAndCharset &,TInt &)const
CParserPropertyValue::PlugIn()
CParserPropertyValue::SetPlugIn(MVersitPlugIn *)
CParserPropertyValue::Uid()const
CParserTimePropertyValue::CParserTimePropertyValue(const TUid &)
CParserTimePropertyValue::ConvertDateTime(TDateTime &,const TTimeIntervalSeconds &,const CVersitDaylight *,TBool)
CParserTimePropertyValue::ConvertDateTime(TDateTime *,const TTimeIntervalSeconds &,const CVersitDaylight *)
CParserTimePropertyValue::EncodeTimePeriodL(TDes8 &,const TTime &)const
CParserTimePropertyValue::EncodeVersitDateTimeL(TDes8 &,const TVersitDateTime &,TBool)const
CParserTimePropertyValue::SupportsInterface(const TUid &)const
Private Attributes
CVersitAlarm *iValue

Constructor & Destructor Documentation

CParserPropertyValueAlarm(CVersitAlarm *)

IMPORT_CCParserPropertyValueAlarm(CVersitAlarm *aValue)

Parameters

CVersitAlarm * aValue

CParserPropertyValueAlarm()

IMPORT_CCParserPropertyValueAlarm()

~CParserPropertyValueAlarm()

IMPORT_C~CParserPropertyValueAlarm()

Member Functions Documentation

ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &, const CVersitDaylight *)

IMPORT_C voidConvertAllDateTimesToUTCL(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

Parameters

const TTimeIntervalSeconds & aIncrementA time interval in seconds which represents the time zone's offset from universal time.
const CVersitDaylight * aDaylightPointer 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).

ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &)

IMPORT_C voidConvertAllUTCDateTimesToMachineLocalL(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

Parameters

const TTimeIntervalSeconds & aIncrementA 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.

ExternalizeL(RWriteStream &, const Versit::TEncodingAndCharset &, TInt)

IMPORT_C voidExternalizeL(RWriteStream &aStream,
const Versit::TEncodingAndCharset &aEncodingCharset,
TIntaLengthOutput
)[virtual]

Externalises the property value to a write stream.

Implementations of this function are invoked by the parser's ExternalizeL() function.

Parameters

RWriteStream & aStreamStream to which the property value is externalised.
const Versit::TEncodingAndCharset & aEncodingCharsetThe character set and encoding information.
TInt aLengthOutputThe 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.

IsAsciiCharacterSetSufficient()

IMPORT_C TBoolIsAsciiCharacterSetSufficient()[virtual]

Value()

CVersitAlarm *Value()const [inline]

Gets a pointer to the alarm property value.

Pointer to the alarm property value.

Member Data Documentation

CVersitAlarm * iValue

CVersitAlarm *iValue[private]