CParserPropertyValueExtendedAlarm Class Reference

#include <app/vcal.h>

Link against: vcal.lib

class CParserPropertyValueExtendedAlarm : public CParserTimePropertyValue

Inherits from

Public Member Functions
CParserPropertyValueExtendedAlarm(CVersitExtendedAlarm *)
~CParserPropertyValueExtendedAlarm()
virtual IMPORT_C voidConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &, const CVersitDaylight *)
virtual IMPORT_C voidConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &)
virtual IMPORT_C voidExternalizeL(RWriteStream &, const Versit::TEncodingAndCharset &, TInt)
virtual IMPORT_C TBoolIsAsciiCharacterSetSufficient()
CVersitExtendedAlarm *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

Detailed Description

An extended alarm property value parser for a vCalendar entity.

An alarm action can be attached with a vEvent or a vTodo. The value for the alarm action is stored as a CVersitExtendedAlarm object.

Note: The UID for an extended alarm property value is KVCalPropertyExtendedAlarmUid.

Constructor & Destructor Documentation

CParserPropertyValueExtendedAlarm ( CVersitExtendedAlarm * )

IMPORT_CCParserPropertyValueExtendedAlarm(CVersitExtendedAlarm *aValue)

Constructs a new extended alarm property value with a pointer to a CVersitExtendedAlarm.

ParameterDescription
aValuePointer to the alarm. The property value takes ownership of the pointer.

~CParserPropertyValueExtendedAlarm ( )

IMPORT_C~CParserPropertyValueExtendedAlarm()

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

Member Function Documentation

ConvertAllDateTimesToUTCL ( const TTimeIntervalSeconds &, const CVersitDaylight * )

IMPORT_C voidConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &aIncrement,
const CVersitDaylight *aDaylight
)[virtual]

Reimplemented from CParserTimePropertyValue::ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &,const CVersitDaylight *)

Converts the extended alarm time into universal time.

Deprecatedsince 9.1

ParameterDescription
aIncrementA 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.
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]

Reimplemented from CParserTimePropertyValue::ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &)

Converts the extended alarm time to machine-local time.

Deprecatedsince 9.1

ParameterDescription
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]

Reimplemented from CParserPropertyValue::ExternalizeL(RWriteStream &,const Versit::TEncodingAndCharset &,TInt)

Externalises the extended alarm property value into aStream.

ParameterDescription
aStreamStream to which the value should be externalised.
aEncodingCharsetContains the character set and encoding into which the property value should be converted.
aLengthOutputThe 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.

IsAsciiCharacterSetSufficient ( )

IMPORT_C TBoolIsAsciiCharacterSetSufficient()[virtual]

Reimplemented from CParserPropertyValue::IsAsciiCharacterSetSufficient()

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

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

Value ( )

CVersitExtendedAlarm *Value()const [inline]

Gets a pointer to the extended alarm property value.

Returns: Pointer to the extended alarm property value.