Class CParserVCalEntity

class CParserVCalEntity : public CRecurrenceParser;

Description

A parser for vCalendar sub-entities.

A vCalendar sub-entity is a vEvent or vToDo contained in a vCalendar. vEvents and vToDos are derived from CRecurrenceParser, which provides recurrence functionality.

vEvents and vTodos may have alarm properties (see CParserPropertyValueAlarm).

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CVersitParser - A generic Versit parser

• CRecurrenceParser - Base class used in the derivation of CParserVCalEntity

• CParserVCalEntity - A parser for vCalendar sub-entities

Members

Defined in CParserVCalEntity:
DecodeDisposition(), ExternalizeL(), MakePropertyValueAlarmL(), MakePropertyValueExtendedAlarmL(), MakePropertyValueExtendedAlarmL(), MakePropertyValueL(), NewL(), RecognizeToken(), Reserved1(), Reserved2(), ~CParserVCalEntity()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CRecurrenceParser:
MakePropertyValueRecurrenceL()

Inherited from CVersitParser:
AddEntityL(), AddPropertyL(), AdjustAllPropertyDateTimesToMachineLocalL(), AnalysesEncodingCharset(), AppendBeginL(), AppendEndL(), ArrayOfEntities(), ArrayOfProperties(), BufPtr(), ClearSupportsVersion(), ConstructL(), ConvertAllPropertyDateTimesToMachineLocalL(), ConvertFromUnicodeToISOL(), ConvertToUnicodeFromISOL(), DecodeDateTimeL(), DecodePropertyValueL(), DecodeTimePeriodL(), DecodeTimeZoneL(), DefaultCharSet(), DefaultCharSetId(), DefaultEncoding(), DoAddPropertyL(), ECarriageReturn, ECharSetIdentified, EHTab, EImportSyncML, ELineFeed, ENoVersionProperty, ESpace, ESupportsVersion, EUseAutoDetection, EUseDefaultCharSetForAllProperties, EntityL(), EntityName(), FindFirstField(), FindRemainingField(), GetNumberL(), GetPropertyParamsLC(), InternalizeL(), IsValidLabel(), IsValidParameterValue(), LineCharSet(), LineCharSetId(), LineEncoding(), LineEncodingId(), LoadBinaryValuesFromFilesL(), MakeEntityL(), MakePropertyL(), MakePropertyValueCDesCArrayL(), MakePropertyValueDaylightL(), MakePropertyValueMultiDateTimeL(), Observer(), ParseBeginL(), ParseEndL(), ParseEntityL(), ParseParamL(), ParsePropertiesL(), ParsePropertyL(), PlugIn(), PropertyL(), ReadLineAndDecodeParamsLC(), ReadMultiLineValueL(), RecognizeEntityName(), ResetAndDestroyArrayOfDateTimes(), ResetAndDestroyArrayOfEntities(), ResetAndDestroyArrayOfParams(), ResetAndDestroyArrayOfProperties(), RestoreLineCodingDetailsToDefault(), SaveBinaryValuesToFilesL(), SetAutoDetect(), SetCharacterConverter(), SetDefaultCharSet(), SetDefaultCharSetId(), SetDefaultEncoding(), SetEntityNameL(), SetFlags(), SetLineCharacterSet(), SetLineCharacterSetId(), SetLineCoding(), SetLineEncoding(), SetObserver(), SetPlugIn(), SetSupportsVersion(), SupportsVersion(), TCharCodes, TParserCodingDetails, TVersitParserFlags, UnicodeUtils(), Val(), iArrayOfEntities, iArrayOfProperties, iAutoDetectCharSets, iCurrentProperty, iCurrentPropertyCodingDetails, iDecodedValue, iDefaultCodingDetails, iDefaultVersion, iEntityName, iFlags, iLargeDataBuf, iLineReader, iObserver, iOwnedLineReader, iPlugIn, iStaticUtils, iWriteStream

static IMPORT_C CParserVCalEntity *NewL();

Description

Allocates and constructs a vCalendar sub-entity parser.

Return value

CParserVCalEntity * A pointer to the new vCalendar sub-entity parser.

IMPORT_C ~CParserVCalEntity();

Description

The destructor is empty.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream);

Description

Externalises a vTodo or vEvent to a write stream.

Sets the entity's name to KVersitVarTokenVEVENT if it hasn't already been set.

Converts all date/time values from machine-local into universal time.

The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RWriteStream &aStream Stream to which the vTodo or vEvent should be externalised.

protected: virtual IMPORT_C CParserPropertyValue *MakePropertyValueL(const TUid &aPropertyUid, HBufC16 *&aValue);

Description

Parameters

const TUid &aPropertyUid HBufC16 *&aValue

Return value

CParserPropertyValue *

protected: IMPORT_C CVersitAlarm *MakePropertyValueAlarmL(TPtr16 aAlarmValue);

Description

Parameters

TPtr16 aAlarmValue

Return value

CVersitAlarm *

protected: IMPORT_C CVersitExtendedAlarm *MakePropertyValueExtendedAlarmL(TPtr16 aAlarmValue);

Description

Create a new extended alarm from a stream. The MIME type is set to the creating object's MIME type. The disposition is set to the creating object's disposition.

Parameters

TPtr16 aAlarmValue a pointer to a buffer containing the assocaited data for the alarm. Should not point to an empty descriptor.

Return value

CVersitExtendedAlarm * The newly created extended alarm.

protected: IMPORT_C CVersitExtendedAlarm *MakePropertyValueExtendedAlarmL(CBufSeg &aAlarmValue);

Description

Create a new extended alarm from a buffer. The MIME type is set to the creating object's MIME type. The disposition is set to the creating object's disposition.

Parameters

CBufSeg &aAlarmValue a reference to a buffer containing the assocaited data for the alarm. Should not be an empty buffer.

Return value

CVersitExtendedAlarm * The newly created extended alarm.

protected: IMPORT_C CVersitExtendedAlarm::TDisposition DecodeDisposition(const TDesC8 &aContentDispositionToken) const;

Description

Used to find the type of the content disposition: inline, URL, or unknown. Converts content-value-type token field to content-value-type enum.

Parameters

const TDesC8 &aContentDispositionToken The disposition of the data for the alarm action.

Return value

CVersitExtendedAlarm::TDisposition decoded disposition type

protected: virtual IMPORT_C TUid RecognizeToken(const TDesC8 &aToken) const;

Description

Returns a UID for the specified token.

This function only recognizes generic Versit tokens. For example, if aToken contains the property name KVersitTokenBEGIN, the function returns KVersitTokenBeginUid. More specific recognition should occur in derived classes which implement this function, using this as the base recogniser.

Parameters

const TDesC8 &aToken The token to be recognized.

Return value

TUid A defined UID value if the token has been recognized; KVersitTokenUnknownUid otherwise.

private: virtual IMPORT_C void Reserved1();

Description

private: virtual IMPORT_C void Reserved2();

Description