Xml::MContentHandler Class Reference

#include <xml/contenthandler.h>

class Xml::MContentHandler

Public Member Functions
pure virtual TAny *	GetExtendedInterface(const TInt32)
pure virtual void	OnContentL(const TDesC8 &, TInt)
pure virtual void	OnEndDocumentL(TInt)
pure virtual void	OnEndElementL(const RTagInfo &, TInt)
pure virtual void	OnEndPrefixMappingL(const RString &, TInt)
pure virtual void	OnError(TInt)
pure virtual void	OnIgnorableWhiteSpaceL(const TDesC8 &, TInt)
pure virtual void	OnProcessingInstructionL(const TDesC8 &, const TDesC8 &, TInt)
pure virtual void	OnSkippedEntityL(const RString &, TInt)
pure virtual void	OnStartDocumentL(const RDocumentParameters &, TInt)
pure virtual void	OnStartElementL(const RTagInfo &, const RAttributeArray &, TInt)
pure virtual void	OnStartPrefixMappingL(const RString &, const RString &, TInt)

Detailed Description

This class defines the interface required by a client of the xml framework. It allows a client to be placed in a chain with other clients, i.e. a Parser, a Validator, or a User, and therefore allows the flow of information between these links. It provides callbacks analogous to that of the SAX 2.0 interface.

Member Function Documentation

GetExtendedInterface ( const TInt32 )

TAny *

GetExtendedInterface

(

const TInt32

aUid

)

[pure virtual]

This method obtains the interface matching the specified uid.

Parameters
aUid	the uid identifying the required interface.

Return Value: 0 if no interface matching the uid is found. Otherwise, the this pointer cast to that interface.

OnContentL ( const TDesC8 &, TInt )

void	OnContentL	(	const TDesC8 &	aBytes,
			TInt	aErrorCode
		)	[pure virtual]

This method is a callback that sends the content of the element. Not all the content may be returned in one go. The data may be sent in chunks. When an OnEndElementL is received this means there is no more content to be sent.

Parameters
aBytes	is the raw content data for the element. The client is responsible for converting the data to the required character set if necessary. In some instances the content may be binary and must not be converted.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnEndDocumentL ( TInt )

void

OnEndDocumentL

(

TInt

aErrorCode

)

[pure virtual]

This method is a callback to indicate the end of the document.

Parameters
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnEndElementL ( const RTagInfo &, TInt )

void	OnEndElementL	(	const RTagInfo &	aElement,
			TInt	aErrorCode
		)	[pure virtual]

This method is a callback to indicate the end of the element has been reached.

Parameters
aElement	is a handle to the element's details.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnEndPrefixMappingL ( const RString &, TInt )

void	OnEndPrefixMappingL	(	const RString &	aPrefix,
			TInt	aErrorCode
		)	[pure virtual]

This method is a notification of the end of the scope of a prefix-URI mapping. This method is called after the corresponding DoEndElementL method.

Parameters
aPrefix	is the Namespace prefix that was mapped.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnError ( TInt )

void

OnError

(

TInt

aErrorCode

)

[pure virtual]

This method indicates an error has occurred.

Parameters
aErrorCode	is the error code

OnIgnorableWhiteSpaceL ( const TDesC8 &, TInt )

void	OnIgnorableWhiteSpaceL	(	const TDesC8 &	aBytes,
			TInt	aErrorCode
		)	[pure virtual]

This method is a notification of ignorable whitespace in element content.

Parameters
aBytes	are the ignored bytes from the document being parsed.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnProcessingInstructionL ( const TDesC8 &, const TDesC8 &, TInt )

void	OnProcessingInstructionL	(	const TDesC8 &	aTarget,
			const TDesC8 &	aData,
			TInt	aErrorCode
		)	[pure virtual]

This method is a receive notification of a processing instruction.

Parameters
aTarget	is the processing instruction target.
aData	is the processing instruction data. If empty none was supplied.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnSkippedEntityL ( const RString &, TInt )

void	OnSkippedEntityL	(	const RString &	aName,
			TInt	aErrorCode
		)	[pure virtual]

This method is a notification of a skipped entity. If the parser encounters an external entity it does not need to expand it - it can return the entity as aName for the client to deal with.

Parameters
aName	is the name of the skipped entity.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartDocumentL ( const RDocumentParameters &, TInt )

void	OnStartDocumentL	(	const RDocumentParameters &	aDocParam,
			TInt	aErrorCode
		)	[pure virtual]

This method is a callback to indicate the start of the document.

Parameters
aDocParam	Specifies the various parameters of the document.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartElementL ( const RTagInfo &, const RAttributeArray &, TInt )

void	OnStartElementL	(	const RTagInfo &	aElement,
			const RAttributeArray &	aAttributes,
			TInt	aErrorCode
		)	[pure virtual]

This method is a callback to indicate an element has been parsed.

Parameters
aElement	is a handle to the element's details.
aAttributes	contains the attributes for the element.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.

OnStartPrefixMappingL ( const RString &, const RString &, TInt )

void	OnStartPrefixMappingL	(	const RString &	aPrefix,
			const RString &	aUri,
			TInt	aErrorCode
		)	[pure virtual]

This method is a notification of the beginning of the scope of a prefix-URI Namespace mapping. This method is always called before the corresponding OnStartElementL method.

Parameters
aPrefix	is the Namespace prefix being declared.
aUri	is the Namespace URI the prefix is mapped to.
aErrorCode	is the error code. If this is not KErrNone then special action may be required.