Collapse all Symbian^3 Application Developer Library

CParserPropertyValueHBufC Class Reference

class CParserPropertyValueHBufC : public CParserPropertyValue

A heap descriptor property value parser.

Many properties are stored using this class. Examples are vCard e-mails and vCalendar locations.

The UID for a heap descriptor property value is KVersitPropertyHBufCUid.

Inherits from

CParserPropertyValueHBufC
- CParserPropertyValue
  - CBase

Public Member Functions
	CParserPropertyValueHBufC ( HBufC16 *)
	~CParserPropertyValueHBufC ()
IMPORT_C void	ExternalizeL ( RWriteStream &, const Versit::TEncodingAndCharset &, TInt )
IMPORT_C TBool	IsAsciiCharacterSetSufficient ()
IMPORT_C CParserPropertyValueHBufC *	NewL (const TDesC &)
IMPORT_C HBufC *	TakeValueOwnership ()
IMPORT_C CParserPropertyValueCDesCArray *	TreatAsArrayPropertyLC (const CParserProperty &)
IMPORT_C TPtrC	Value ()

Private Member Functions
	CParserPropertyValueHBufC ()
void	ConstructL (const TDesC &)

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()
	CParserPropertyValue::Append(TDes16 &,TDesC8 &)
	CParserPropertyValue::CParserPropertyValue(const TUid &)
	CParserPropertyValue::EncodeL(CBufBase *,const TDesC8 &,const TUid &)const
	CParserPropertyValue::FoldAndWriteValueToStreamL(RWriteStream &,const TDesC &,const Versit::TEncodingAndCharset &,TInt &)const
	CParserPropertyValue::FoldEncodeAndWriteValueToStreamL(RWriteStream &,const CDesCArray *,const Versit::TEncodingAndCharset &,TInt &)const
	CParserPropertyValue::FoldEncodeAndWriteValueToStreamL(RWriteStream &,const TDesC &,const Versit::TEncodingAndCharset &,TInt &)const
	CParserPropertyValue::PlugIn()
	CParserPropertyValue::SetPlugIn(MVersitPlugIn *)
	CParserPropertyValue::SupportsInterface(const TUid &)const
	CParserPropertyValue::Uid()const

Protected Attributes
HBufC *	iValue

Constructor & Destructor Documentation

CParserPropertyValueHBufC(HBufC16 *)

IMPORT_C

CParserPropertyValueHBufC

(

HBufC16 *

aValue

)

Parameters

HBufC16 * aValue

CParserPropertyValueHBufC()

CParserPropertyValueHBufC

(

)

[private]

~CParserPropertyValueHBufC()

IMPORT_C

~CParserPropertyValueHBufC

(

)

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

Member Functions Documentation

ConstructL(const TDesC &)

void

ConstructL

(

const TDesC &

aValue

)

[private]

Parameters

const TDesC & aValue

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

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

Externalizes the descriptor property value into aStream.

This function is invoked by the parser's ExternalizeL() function.

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, which needs to be taken into account when calculating if and where any line break should occur.

IsAsciiCharacterSetSufficient()

IMPORT_C TBool

IsAsciiCharacterSetSufficient

(

)

[virtual]

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

NewL(const TDesC &)

IMPORT_C CParserPropertyValueHBufC *

NewL

(

const TDesC &

aValue

)

[static]

Allocates and constructs a new heap descriptor property value with a descriptor.

Sets the property value's UID to KVersitPropertyHBufCUid.

Parameters

const TDesC & aValue

The property value.

TakeValueOwnership()

IMPORT_C HBufC *

TakeValueOwnership

(

)

Take ownership of the heap descriptor property value.

The property value previously owned by the object is deleted.

TreatAsArrayPropertyLC(const CParserProperty &)

IMPORT_C CParserPropertyValueCDesCArray *

TreatAsArrayPropertyLC

(

const CParserProperty &

aOwningProperty

)

const

Treats this HBufC-based property value as a possible array-based property.

This function was added for compatibility reasons to support array-based SOUND property values. This does not alter the representation of this parser property value.

If the underlying HBufC value cannot be parsed into any array elements, then this method returns an array containing only a single item. Otherwise, the HBufC is split into its constituent elements and returned as an array.

Parameters

const CParserProperty & aOwningProperty

The property that contains this property value.

Value()

IMPORT_C TPtrC

Value

(

)

const

Retrieves the property value.

Member Data Documentation

HBufC * iValue

HBufC *

iValue

[protected]