Collapse all Symbian^3 Product Developer Library

CMDXMLEntityConverter Class Reference

class CMDXMLEntityConverter : public CBase

This class represents a generic entity converter for an XML parser or composer. It is responsible for converting entity references to text and vice-versa.

Inherits from

CMDXMLEntityConverter
- CBase

Public Member Functions
	CMDXMLEntityConverter()
	~CMDXMLEntityConverter()
TInt	EntityToTextL(TDes &)
IMPORT_C TInt	OutputComposedTextL(CMDXMLComposer *, const TDesC &)

Protected Member Functions
TInt	DTDEntityToText(TDes &)

Private Member Functions
TInt	ConvertEntityRefL(TDes &)

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()

Constructor & Destructor Documentation

CMDXMLEntityConverter()

IMPORT_C

CMDXMLEntityConverter

(

)

Constructor

~CMDXMLEntityConverter()

IMPORT_C

~CMDXMLEntityConverter

(

)

[virtual]

Destructor.

Member Functions Documentation

ConvertEntityRefL(TDes &)

TInt

ConvertEntityRefL

(

TDes &

aTextToConvert

)

[private]

Replaces the built in entity reference with its replacement text.

Parameters

TDes & aTextToConvert

An entity reference to convert. This should begin with & and end with ;.

DTDEntityToText(TDes &)

TInt

DTDEntityToText

(

TDes &

aTextToConvert

)

[protected, virtual]

DTD Specific entity to text converter Takes a block of text and converts any entity references found to the appropriate text. We hope that this can happen in-situ.

Parameters

TDes & aTextToConvert

Text to be converted - replacement text goes out in the same

EntityToTextL(TDes &)

TInt

EntityToTextL

(

TDes &

aTextToConvert

)

Takes a block of text and converts any entity references found to the appropriate text. Because built-in and character entity references are longer than the replacement text, this takes place in-situ.

Parameters

TDes & aTextToConvert

Text to be converted - replacement text goes out in the same

OutputComposedTextL(CMDXMLComposer *, const TDesC &)

IMPORT_C TInt	OutputComposedTextL	(	CMDXMLComposer *	aComposer,
			const TDesC &	aTextToConvert
		)	[virtual]

Outputs a block of text to a composer with offending characters replaced by entity references.

leave: can Leave due to OOM

Parameters

CMDXMLComposer * aComposer	the composer to be used for output
const TDesC & aTextToConvert	The text to be converted.