CParserPropertyValueCDesCArray Class Reference

#include <app/vprop.h>

Link against: versit.lib

class CParserPropertyValueCDesCArray : public CParserPropertyValue

Inherits from

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

Member Attribute Documentation

iValue

CDesCArray *iValue[protected]

Constructor & Destructor Documentation

CParserPropertyValueCDesCArray ( CDesCArray * )

IMPORT_CCParserPropertyValueCDesCArray(CDesCArray *aValue)

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.

ParameterDescription
aValuePointer to the descriptor array.

~CParserPropertyValueCDesCArray ( )

IMPORT_C~CParserPropertyValueCDesCArray()

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

Member Function Documentation

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

IMPORT_C voidExternalizeL(RWriteStream &aStream,
const Versit::TEncodingAndCharset &aEncodingCharset,
TIntaLengthOutput
)[virtual]

Externalizes the descriptor array property value into aStream.

Uses the character set and encoding format specified in aEncodingCharset.

Called by CParserProperty::ExternalizeL().

ParameterDescription
aStreamStream into which the value is to be externalised.
aEncodingCharsetSpecifies the character set and encoding information.
aLengthOutputThe 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.

IsAsciiCharacterSetSufficient ( )

IMPORT_C TBoolIsAsciiCharacterSetSufficient()[virtual]

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.

See also: VersitUtils::DescriptorContainsOnlySevenBitCharacters()

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

IsPresent ( const TDesC & )

IMPORT_C TBoolIsPresent(const TDesC &aValue)const

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

Not used internally.

ParameterDescription
aValueThe value of interest.

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

Value ( )

CDesCArray *Value()const [inline]

Gets the property value.

Returns: Pointer to the array of descriptors owned by the property value object.