Class CParserVCal

class CParserVCal : public CVersitParser;

Description

A vCalendar parser.

Adds support for parsing vToDos and vEvents, and associated alarms (see CParserPropertyValueAlarm) to the functionality of CVersitParser.

Adds a constructor and overrides CVersitParser::InternalizeL() for streams, ExternalizeL() for streams, RecognizeToken(), RecognizeEntityName() and MakeEntityL().

The vCalendar data is read from or written to a stream or file, using the InternalizeL() and ExternalizeL() functions. Most users of this class will only need to use these functions.

Note: if you are sequentially creating and destroying multiple parsers, a major performance improvement may be achieved by using thread local storage to store an instance of CVersitUnicodeUtils which persists and can be used by all of the parsers.

See CVersitTlsData for more information.

Derivation

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

• CVersitParser - A generic Versit parser

• CParserVCal - A vCalendar parser

Members

Defined in CParserVCal:
ExternalizeL(), InternalizeL(), MakeEntityL(), NewL(), RecognizeEntityName(), RecognizeToken(), Reserved1(), Reserved2()

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

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(), IsValidLabel(), IsValidParameterValue(), LineCharSet(), LineCharSetId(), LineEncoding(), LineEncodingId(), LoadBinaryValuesFromFilesL(), MakePropertyL(), MakePropertyValueCDesCArrayL(), MakePropertyValueDaylightL(), MakePropertyValueL(), MakePropertyValueMultiDateTimeL(), Observer(), ParseBeginL(), ParseEndL(), ParseEntityL(), ParseParamL(), ParsePropertiesL(), ParsePropertyL(), PlugIn(), PropertyL(), ReadLineAndDecodeParamsLC(), ReadMultiLineValueL(), 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 CParserVCal *NewL();

Description

Allocates and constructs a vCalendar parser.

Return value

CParserVCal * Pointer to the newly created vCalendar parser.

virtual IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a vCalendar entity from a read stream.

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

Parameters

RReadStream &aStream Stream from which the vCalendar should be internalised.

See also:

• CVersitParser::InternalizeL()

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream);

Description

Externalises a vCalendar entity (and all sub-entities) to a write stream.

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

Adds a version property to the start of the current entity's array of properties if the entity supports this. (If there isn't an array of properties then one is made).

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 vCalendar should be externalised.

See also:

• CVersitParser::ExternalizeL()

protected: virtual IMPORT_C CVersitParser *MakeEntityL(TInt aEntityUid, HBufC *aEntityName);

Description

Parameters

TInt aEntityUid HBufC *aEntityName

Return value

CVersitParser *

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

Description

Returns a UID that identifies a specified token's type.

For example, if aToken contains the property name DAYLIGHT the function returns KVersitPropertyDaylightUid. If the token is not recognized as vCalendar-specific, the function calls CVersitParser::RecognizeToken(), which recognizes generic Versit tokens.

Parameters

const TDesC8 &aToken The token to be recognized.

Return value

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

virtual IMPORT_C TInt RecognizeEntityName() const;

Description

Tests the current value to see if it a vEvent or vTodo entity.

Return value

TInt KVCalEntityUidVEvent if it is a vEvent entity; KVersitVarTokenVTODO if it is a vTodo entity; zero if there is no current property or it has no value.

private: virtual IMPORT_C void Reserved1();

Description

private: virtual IMPORT_C void Reserved2();

Description