CParserPropertyValue Class Reference

class CParserPropertyValue : public CBase

Abstract base class for all property values.

Defines a pure virtual ExternalizeL() function which should write out the property value to a stream.

The type of derived class is returned by the Uid() function; the UID value is specified on construction.

The other functions relate to the character set, encoding format and plug-in used during externalising.

Inherits from

  • CParserPropertyValue
Public Member Functions
IMPORT_C voidEncodeL(CBufBase *, const TDesC8 &, const TUid &)
voidExternalizeL(RWriteStream &, const Versit::TEncodingAndCharset &, TInt)
IMPORT_C TBoolIsAsciiCharacterSetSufficient()
voidSetPlugIn(MVersitPlugIn *)
IMPORT_C TBoolSupportsInterface(const TUid &)
TUid Uid()
Protected Member Functions
CParserPropertyValue(const TUid &)
IMPORT_C voidAppend(TDes16 &, TDesC8 &)
IMPORT_C voidFoldAndWriteValueToStreamL(RWriteStream &, const TDesC &, const Versit::TEncodingAndCharset &, TInt &)
IMPORT_C voidFoldEncodeAndWriteValueToStreamL(RWriteStream &, const TDesC &, const Versit::TEncodingAndCharset &, TInt &)
IMPORT_C voidFoldEncodeAndWriteValueToStreamL(RWriteStream &, const CDesCArray *, const Versit::TEncodingAndCharset &, TInt &)
MVersitPlugIn *PlugIn()
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()
Private Attributes
MVersitPlugIn *iPlugIn
TUid iPropertyValueTypeUid

Constructor & Destructor Documentation

CParserPropertyValue(const TUid &)

IMPORT_CCParserPropertyValue(const TUid &aPropertyValueUid)[protected]

Parameters

const TUid & aPropertyValueUid

Member Functions Documentation

Append(TDes16 &, TDesC8 &)

IMPORT_C voidAppend(TDes16 &aTarget,
TDesC8 &aSource
)[protected, static]

Parameters

TDes16 & aTarget
TDesC8 & aSource

EncodeL(CBufBase *, const TDesC8 &, const TUid &)

IMPORT_C voidEncodeL(CBufBase *aTarget,
const TDesC8 &aSource,
const TUid &aEncoding
)const [virtual]

Parameters

CBufBase * aTarget
const TDesC8 & aSource
const TUid & aEncoding

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

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

Externalises the property value to a write stream.

Implementations of this function are invoked by the parser's ExternalizeL() function.

Parameters

RWriteStream & aStreamStream to which the property value is externalised.
const Versit::TEncodingAndCharset & aEncodingCharsetThe character set and encoding information.
TInt aLengthOutputThe amount of text that has been outputted so far on the line (for the property name), which may need to be taken into account when calculating if and where any line break should occur.

FoldAndWriteValueToStreamL(RWriteStream &, const TDesC &, const Versit::TEncodingAndCharset &, TInt &)

IMPORT_C voidFoldAndWriteValueToStreamL(RWriteStream &aStream,
const TDesC &aValue,
const Versit::TEncodingAndCharset &aEncodingCharset,
TInt &aLengthOutput
)const [protected]

Parameters

RWriteStream & aStream
const TDesC & aValue
const Versit::TEncodingAndCharset & aEncodingCharset
TInt & aLengthOutput

FoldEncodeAndWriteValueToStreamL(RWriteStream &, const TDesC &, const Versit::TEncodingAndCharset &, TInt &)

IMPORT_C voidFoldEncodeAndWriteValueToStreamL(RWriteStream &aStream,
const TDesC &aValue,
const Versit::TEncodingAndCharset &aEncodingCharset,
TInt &aLengthOutput
)const [protected]

Parameters

RWriteStream & aStream
const TDesC & aValue
const Versit::TEncodingAndCharset & aEncodingCharset
TInt & aLengthOutput

FoldEncodeAndWriteValueToStreamL(RWriteStream &, const CDesCArray *, const Versit::TEncodingAndCharset &, TInt &)

IMPORT_C voidFoldEncodeAndWriteValueToStreamL(RWriteStream &aStream,
const CDesCArray *aValueArray,
const Versit::TEncodingAndCharset &aEncodingCharset,
TInt &aLengthOutput
)const [protected]

Parameters

RWriteStream & aStream
const CDesCArray * aValueArray
const Versit::TEncodingAndCharset & aEncodingCharset
TInt & aLengthOutput

IsAsciiCharacterSetSufficient()

IMPORT_C TBoolIsAsciiCharacterSetSufficient()[virtual]

PlugIn()

MVersitPlugIn *PlugIn()[protected, inline]

Gets a pointer to the Versit plug-in

A pointer to the plug-in.

SetPlugIn(MVersitPlugIn *)

voidSetPlugIn(MVersitPlugIn *aPlugIn)[inline]

Assigns a Versit plug-in to the property value.

Allows functions of the MVersitPlugIn class to be used when writing to a stream.

If a plug-in is in use then this function needs to be called with each property value before it is externalised. However, this will be done for you if you add a property using the function CVersitParser::AddPropertyL().

Parameters

MVersitPlugIn * aPlugInA pointer to an MVersitPlugIn instance.

SupportsInterface(const TUid &)

IMPORT_C TBoolSupportsInterface(const TUid &)const [virtual]

Parameters

const TUid &

Uid()

TUid Uid()const [inline]

Returns the property value's UID.

This UID identifies the property value's type and is specified on construction. The values are defined in vuid.h.

The property value's UID.

Member Data Documentation

MVersitPlugIn * iPlugIn

MVersitPlugIn *iPlugIn[private]

TUid iPropertyValueTypeUid

TUid iPropertyValueTypeUid[private]
© Nokia 2010.