Collapse all Symbian^3 Application Developer Library

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

CParserPropertyValueAlarm
- CParserTimePropertyValue
  - CParserPropertyValue
    - CBase

Public Member Functions
	CParserPropertyValueAlarm ( CVersitAlarm *)
	CParserPropertyValueAlarm ()
	~CParserPropertyValueAlarm ()
IMPORT_C void	ConvertAllDateTimesToUTCL (const TTimeIntervalSeconds &, const CVersitDaylight *)
IMPORT_C void	ConvertAllUTCDateTimesToMachineLocalL (const TTimeIntervalSeconds &)
IMPORT_C void	ExternalizeL ( RWriteStream &, const Versit::TEncodingAndCharset &, TInt )
IMPORT_C TBool	IsAsciiCharacterSetSufficient ()
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_C

CParserPropertyValueAlarm

(

CVersitAlarm *

aValue

)

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.

CParserPropertyValueAlarm()

IMPORT_C

CParserPropertyValueAlarm

(

)

~CParserPropertyValueAlarm()

IMPORT_C

~CParserPropertyValueAlarm

(

)

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

Member Functions Documentation

ConvertAllDateTimesToUTCL(const TTimeIntervalSeconds &, const CVersitDaylight *)

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

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.

since 9.1

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).

ConvertAllUTCDateTimesToMachineLocalL(const TTimeIntervalSeconds &)

IMPORT_C void

ConvertAllUTCDateTimesToMachineLocalL

(

const TTimeIntervalSeconds &

aIncrement

)

[virtual]

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.

since 9.1

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.

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

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

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.

IsAsciiCharacterSetSufficient()

IMPORT_C TBool

IsAsciiCharacterSetSufficient

(

)

[virtual]

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

Value()

CVersitAlarm *

Value

(

)

const [inline]

Gets a pointer to the alarm property value.

Member Data Documentation

CVersitAlarm * iValue

CVersitAlarm *

iValue

[private]