Class CParserPropertyValueCDesCArray

class CParserPropertyValueCDesCArray : public CParserPropertyValue;

Description

A property value parser which stores an array of descriptors.

Can be used by both vCards and vCalendars, for example to store a postal address or information about an organisation.

The UID for a descriptor array property value is KVersitPropertyCDesCArrayUid.

Derivation

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

• CParserPropertyValue - Abstract base class for all property values

• CParserPropertyValueCDesCArray - A property value parser which stores an array of descriptors

Members

Defined in CParserPropertyValueCDesCArray:
CParserPropertyValueCDesCArray(), ExternalizeL(), IsAsciiCharacterSetSufficient(), IsPresent(), Value(), iValue, ~CParserPropertyValueCDesCArray()

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

Inherited from CParserPropertyValue:
Append(), EncodeL(), FoldAndWriteValueToStreamL(), FoldEncodeAndWriteValueToStreamL(), PlugIn(), SetPlugIn(), SupportsInterface(), Uid()

IMPORT_C CParserPropertyValueCDesCArray(CDesCArray *aValue);

Description

Constructs a new descriptor array property value with the array pointed to by aValue.

Sets the property value's UID to KVersitPropertyCDesCArrayUid.

The property value takes ownership of aValue.

Called by CVersitParser::MakePropertyValueL() when internalising from a stream.

Parameters

CDesCArray *aValue Pointer to the descriptor array.

IMPORT_C ~CParserPropertyValueCDesCArray();

Description

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

inline CDesCArray *Value() const;

Description

Gets the property value.

Return value

CDesCArray * Pointer to the array of descriptors owned by the property value object.

IMPORT_C TBool IsPresent(const TDesC &aValue) const;

Description

Tests whether a specified value is present in the array of descriptors owned by the property value object.

Not used internally.

Parameters

const TDesC &aValue The value of interest.

Return value

TBool ETrue if the value specified is present in the descriptor array. EFalse if not.

virtual IMPORT_C TBool IsAsciiCharacterSetSufficient();

Description

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

Tests every item in the array and returns ETrue only if all items contain only 7-bit characters.

Return value

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

See also:

• VersitUtils::DescriptorContainsOnlySevenBitCharacters()

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

Description

Externalizes the descriptor array property value into aStream.

Uses the character set and encoding format specified in aEncodingCharset.

Called by CParserProperty::ExternalizeL().

Parameters

RWriteStream &aStream Stream into which the value is to be externalised. const Versit::TEncodingAndCharset &aEncodingCharset Specifies the character set and encoding information. TInt aLengthOutput The amount of text that has been output so far on the line (for the property name), which needs to be taken into account when calculating if and where any line break should occur.

protected: CDesCArray * iValue;

Description