CSenDomFragmentBase Class Reference

#include <mw/SenDomFragmentBase.h>

Link against: SenFragment.dll

class CSenDomFragmentBase : public CSenFragmentBase

Inherits from

CSenDomFragmentBase
- CSenFragmentBase

Protected Attributes
CSenDomFragmentBase *	ipDomDelegate

Public Member Functions
virtual	~CSenDomFragmentBase()
virtual IMPORT_C void	AddAttributesL(const RAttributeArray &)
virtual IMPORT_C RSenDocument &	AsDocumentL()
virtual IMPORT_C TXmlEngElement	AsElementL()
virtual IMPORT_C HBufC8 *	AsXmlL()
virtual IMPORT_C HBufC *	AsXmlUnicodeL()
virtual IMPORT_C TBool	ConsistsOfL(CSenFragmentBase &)
virtual IMPORT_C TPtrC8	ContentL()
virtual IMPORT_C void	ExpandL(const RTagInfo &, const RAttributeArray &, TInt)
virtual IMPORT_C TXmlEngElement	ExtractElement()
virtual IMPORT_C TAny *	GetExtendedInterface(const TInt32)
virtual IMPORT_C TPtrC8	LocalName()
virtual IMPORT_C TXmlEngNamespace	Namespace(const TDesC8 &)
IMPORT_C CSenDomFragmentBase *	NewL()
IMPORT_C CSenDomFragmentBase *	NewL(const TXmlEngElement &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &, const TDesC8 &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &)
IMPORT_C CSenDomFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument &)
virtual IMPORT_C TPtrC8	NsPrefix()
virtual IMPORT_C TPtrC8	NsUri()
virtual IMPORT_C void	OnContentL(const TDesC8 &, TInt)
virtual IMPORT_C void	OnDelegateParsingL(CSenFragmentBase &)
virtual IMPORT_C void	OnDelegateParsingL(const RTagInfo &, const RAttributeArray &, TInt)
virtual IMPORT_C void	OnEndDocumentL(TInt)
virtual IMPORT_C void	OnEndElementL(const RTagInfo &, TInt)
virtual IMPORT_C void	OnEndPrefixMappingL(const RString &, TInt)
virtual IMPORT_C void	OnError(TInt)
virtual IMPORT_C void	OnIgnorableWhiteSpaceL(const TDesC8 &, TInt)
virtual IMPORT_C void	OnProcessingInstructionL(const TDesC8 &, const TDesC8 &, TInt)
virtual IMPORT_C void	OnResumeParsingFromL(const RTagInfo &, TInt)
virtual IMPORT_C void	OnSkippedEntityL(const RString &, TInt)
virtual IMPORT_C void	OnStartDocumentL(const RDocumentParameters &, TInt)
virtual IMPORT_C void	OnStartElementL(const RTagInfo &, const RAttributeArray &, TInt)
virtual IMPORT_C void	OnStartPrefixMappingL(const RString &, const RString &, TInt)
IMPORT_C void	OnWriteEndElementL(const RTagInfo &)
IMPORT_C void	OnWriteStartElementL(const RTagInfo &, const RAttributeArray &)
virtual IMPORT_C void	ResetContentL()
IMPORT_C void	SetContentHandler(CSenFragmentBase &)
virtual IMPORT_C void	SetOwner(CSenFragmentBase &)
virtual IMPORT_C void	WriteAsXMLToL(RWriteStream &)

Protected Member Functions
	CSenDomFragmentBase()
virtual IMPORT_C void	AddNamespacesL()
IMPORT_C void	BaseConstructL()
IMPORT_C void	BaseConstructL(const TXmlEngElement &)
IMPORT_C void	BaseConstructL(const TDesC8 &)
IMPORT_C void	BaseConstructL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &)
IMPORT_C void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument &)
virtual IMPORT_C TBool	ConsistsOfL(TXmlEngElement &, TXmlEngElement &)
IMPORT_C TPtrC8	ContentOf(const TDesC8 &)
void	RenameL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
void	RenameL(const TDesC8 &, const TDesC8 &)
void	RenameLocalNameL(const TDesC8 &)
void	RenameNamespaceL(const TDesC8 &)
void	RenameNamespaceL(const TDesC8 &, const TDesC8 &)
void	RenamePrefixL(const TDesC8 &)
IMPORT_C TXmlEngElement	SetContentOfL(const TDesC8 &, const TDesC8 &)

Inherited Attributes
	CSenFragmentBase::iDocument
	CSenFragmentBase::iElement
	CSenFragmentBase::iState
	CSenFragmentBase::ipContentBuf
	CSenFragmentBase::ipContentWriteStream
	CSenFragmentBase::ipDelegate
	CSenFragmentBase::ipNamespaceArray
	CSenFragmentBase::ipOwner
	CSenFragmentBase::ipParser

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()
	CSenFragmentBase::AddAttributesL(const RAttributeArray &)
	CSenFragmentBase::AddAttributesToElementL(TXmlEngElement,const RAttributeArray &)
	CSenFragmentBase::AddContentL(const TDesC8 &)
	CSenFragmentBase::BaseConstructL(TXmlEngElement &,RSenDocument &)
	CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &)
	CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &)
	CSenFragmentBase::CSenFragmentBase()
	CSenFragmentBase::NewL(TXmlEngElement &,RSenDocument &)
	CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &)
	CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &)
	CSenFragmentBase::OnDelegateParsingL(const RTagInfo &,const RAttributeArray &,TInt)
	CSenFragmentBase::OnEndElementL(const RTagInfo &,TInt)
	CSenFragmentBase::OnResumeParsingFromL(const RTagInfo &,TInt)
	CSenFragmentBase::OnStartElementL(const RTagInfo &,const RAttributeArray &,TInt)
	CSenFragmentBase::OnWriteEndElementL(const RTagInfo &)
	CSenFragmentBase::OnWriteStartElementL(const RTagInfo &,const RAttributeArray &)
	CSenFragmentBase::SetContentL(const TDesC8 &)
	CSenFragmentBase::SetDocument(RSenDocument &)
	CSenFragmentBase::StartSavingContent()
	CSenFragmentBase::~CSenFragmentBase()

Detailed Description

Class implements DOM fragment functionality The implementation further extends CSenBaseFragment functionality. In DOM fragment, all child elements are parsed into separate element objects. This makes it possible to reference any child which offer methods declared in XML element interface. Any such element can also be easily extracted (detached) from this root DOM fragment.

Since: Series60 4.0

Member Attribute Documentation

ipDomDelegate

CSenDomFragmentBase *

ipDomDelegate

[protected]

Callback functions which implement the XML content handler interface. Inheriting classes can override these.

Constructor & Destructor Documentation

CSenDomFragmentBase ( )

IMPORT_C

CSenDomFragmentBase

(

)

[protected]

C++ default constructor.

~CSenDomFragmentBase ( )

IMPORT_C

~CSenDomFragmentBase

(

)

[virtual]

Destructor.

Member Function Documentation

AddAttributesL ( const RAttributeArray & )

IMPORT_C void

AddAttributesL

(

const RAttributeArray &

aAttrs

)

[virtual]

Sets the attributes for the fragment.

Since: Series60 4.0

AddNamespacesL ( )

IMPORT_C void

AddNamespacesL

(

)

[protected, virtual]

Reimplemented from CSenFragmentBase::AddNamespacesL()

Adds namespaces from internal array for the fragment.

Since: Series60 4.0

AsDocumentL ( )

IMPORT_C RSenDocument &

AsDocumentL

(

)

[virtual]

Reimplemented from CSenFragmentBase::AsDocumentL()

Returns the current XML element of this fragment. If element has not been set, this method will initialize new, un-initialized element. Method leaves with if there is not enough memory (OOM)

Returns: reference to the element of this fragment

AsElementL ( )

IMPORT_C TXmlEngElement

AsElementL

(

)

[virtual]

Reimplemented from CSenFragmentBase::AsElementL()

Returns the current XML element of this fragment. If element has not been set, this method will initialize new, un-initialized element. Method leaves with if there is not enough memory (OOM)

Returns: reference to the element of this fragment

AsXmlL ( )

IMPORT_C HBufC8 *

AsXmlL

(

)

[virtual]

Reimplemented from CSenFragmentBase::AsXmlL()

Gets the fragment data as an UTF-8 form XML.

Since: Series60 4.0

Returns: fragment as XML. Caller takes ownership.

AsXmlUnicodeL ( )

IMPORT_C HBufC *

AsXmlUnicodeL

(

)

[virtual]

Reimplemented from CSenFragmentBase::AsXmlUnicodeL()

Gets the fragment data as an unicode XML.

Since: Series60 4.0

Returns: fragment as XML. Caller takes ownership.

BaseConstructL ( )

IMPORT_C void

BaseConstructL

(

)

[protected]

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

BaseConstructL ( const TXmlEngElement & )

IMPORT_C void

BaseConstructL

(

const TXmlEngElement &

aElement

)

[protected]

Reimplemented from CSenFragmentBase::BaseConstructL(const TXmlEngElement &)

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aElement	is the XML element of this fragment.

BaseConstructL ( const TDesC8 & )

IMPORT_C void

BaseConstructL

(

const TDesC8 &

aLocalName

)

[protected]

Reimplemented from CSenFragmentBase::BaseConstructL(const TDesC8 &)

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aLocalName	The local name of the element

BaseConstructL ( const TDesC8 &, const TDesC8 & )

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName
		)	[protected]

Reimplemented from CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &)

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aNsUri	The namespace URI of the element
aLocalName	The local name of the element

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix
		)	[protected]

Reimplemented from CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &)

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aNsUri	The namespace URI of the element
aLocalName	The local name of the element
aPrefix	The prefix of the element

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs
		)	[protected]

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aNsUri	The namespace URI of the element
aLocalName	The local name of the element
aPrefix	The prefix of the element
aAttrs	The attributes of the element

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement & )

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs,
			TXmlEngElement &	aParent
		)	[protected]

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aNsUri	The namespace URI of the element
aLocalName	The local name of the element
aPrefix	The prefix of the element
aAttrs	The attributes of the element
aParent	The parent of the element

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument & )

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs,
			TXmlEngElement &	aParent,
			RSenDocument &	aOwnerDocument
		)	[protected]

"ConstructL" method for calling the base classes ones.

Since: Series60 4.0

Parameter	Description
aNsUri	The namespace URI of the element
aLocalName	The local name of the element
aPrefix	The prefix of the element
aAttrs	The attributes of the element
aParent	The parent of the element
aOwnerDocument	The document which will be the owner of the elements of this fragment

ConsistsOfL ( CSenFragmentBase & )

IMPORT_C TBool

ConsistsOfL

(

CSenFragmentBase &

aCandidate

)

[virtual]

Reimplemented from CSenFragmentBase::ConsistsOfL(CSenFragmentBase &)

Checks if fragment matches to another fragment by its content and child elements. Fragment can contain more data than the given candidate.

Since: Series60 4.0

Parameter	Description
aCandidate	The pattern to be matched. Must contain same or less data for match to come true.

Returns: ETrue if content and possible children match exactly to given pattern. EFalse otherwise.

ConsistsOfL ( TXmlEngElement &, TXmlEngElement & )

IMPORT_C TBool	ConsistsOfL	(	TXmlEngElement &	aElement,
			TXmlEngElement &	aCandidate
		)	[protected, virtual]

Reimplemented from CSenFragmentBase::ConsistsOfL(TXmlEngElement &,TXmlEngElement &)

ContentL ( )

IMPORT_C TPtrC8

ContentL

(

)

[virtual]

Reimplemented from CSenFragmentBase::ContentL()

Getter for the content,which is returned as UTF-8 form XML.

Since: Series60 4.0

Returns: content as UTF-8 form XML.

ContentOf ( const TDesC8 & )

IMPORT_C TPtrC8

ContentOf

(

const TDesC8 &

aLocalName

)

[protected]

Reimplemented from CSenFragmentBase::ContentOf(const TDesC8 &)

Gets the content of a given element.

Since: Series60 4.0

Parameter	Description
aLocalName	The local name of the element which content is asked

Returns: the content which was asked

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

IMPORT_C void	ExpandL	(	const RTagInfo &	aElement,
			const RAttributeArray &	aAttributes,
			TInt	aErrorCode
		)	[virtual]

Initiates the parsing chain where new delegate will be created with given parameters and parsing will be delegated to it. Should not be called externally.

Since: Series60 4.0

Parameter	Description
aElement	The RTagInfo class holding information that describes the element.
aAttributes	The attributes of the new element
aErrorCode	Error code

ExtractElement ( )

IMPORT_C TXmlEngElement

ExtractElement

(

)

[virtual]

Reimplemented from CSenFragmentBase::ExtractElement()

Etracts the XML element from the fragment, leaving the fragment empty. Note(!): the return value (CSenElement) STRONGLY suggests that subclasses INHERIT CSenFragment in order properly comply the requirement of the ExtractElement() implementation.

Since: Series60 4.0

Returns: the current object as element. May return NULL. Ownership IS TRANSFERRED to the caller.

GetExtendedInterface ( const TInt32 )

IMPORT_C TAny *

GetExtendedInterface

(

const TInt32

aUid

)

[virtual]

Reimplemented from CSenFragmentBase::GetExtendedInterface(const TInt32)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

LocalName ( )

IMPORT_C TPtrC8

LocalName

(

)

const [virtual]

Reimplemented from CSenFragmentBase::LocalName()const

Since: Series60 4.0

Returns: the localname of this fragment as UTF-8 form descriptor

Namespace ( const TDesC8 & )

IMPORT_C TXmlEngNamespace

Namespace

(

const TDesC8 &

aPrefix

)

[virtual]

Reimplemented from CSenFragmentBase::Namespace(const TDesC8 &)

Gets the namespace object with a given prefix.

Since: Series60 4.0

Returns: namespace with the given prefix. If not found or given prefix is zero length, will return NULL.

NewL ( )

IMPORT_C CSenDomFragmentBase *

NewL

(

)

[static]

Basic contructor. Should be used only for parsing new fragments etc. Constructing DomFragments for other use should be done with at least localname parameter.

Since: Series60 4.0

NewL ( const TXmlEngElement & )

IMPORT_C CSenDomFragmentBase *

NewL

(

const TXmlEngElement &

aElement

)

[static]

Reimplemented from CSenFragmentBase::NewL(const TXmlEngElement &)

Basic constructor.

Since: Series60 4.0

Parameter	Description
aElement	Element to copy construction data from.

NewL ( const TDesC8 & )

IMPORT_C CSenDomFragmentBase *

NewL

(

const TDesC8 &

aLocalName

)

[static]

Reimplemented from CSenFragmentBase::NewL(const TDesC8 &)

Basic constructor.

Since: Series60 4.0

Parameter	Description
aLocalName	is the XML localname of this fragment

NewL ( const TDesC8 &, const TDesC8 & )

IMPORT_C CSenDomFragmentBase *	NewL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName
		)	[static]

Reimplemented from CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &)

Basic constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	is the XML namespace user of this fragment
aLocalName	is the XML localname of this fragment

NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C CSenDomFragmentBase *	NewL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix
		)	[static]

Reimplemented from CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &)

Basic constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	is the XML namespace user of this fragment
aLocalName	is the XML localname of this fragment
aPrefix	is the XML prefix of this fragment

NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C CSenDomFragmentBase *	NewL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs
		)	[static]

Basic constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	is the XML namespace of this fragment
aLocalName	is the XML localname of this fragment
aPrefix	is the prefix of this fragment
aAttrs	are the XML attributes of this fragment

NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement & )

IMPORT_C CSenDomFragmentBase *	NewL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs,
			TXmlEngElement &	aParent
		)	[static]

Basic constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	is the XML namespace of this fragment
aLocalName	is the XML localname of this fragment
aPrefix	is the prefix of this fragment
aAttrs	are the XML attributes of this fragment
aParent	is the parent XML element of this fragment

NewL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument & )

IMPORT_C CSenDomFragmentBase *	NewL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const RAttributeArray &	aAttrs,
			TXmlEngElement &	aParent,
			RSenDocument &	aOwnerDocument
		)	[static]

Basic constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	is the XML namespace of this fragment
aLocalName	is the XML localname of this fragment
aPrefix	is the prefix of this fragment
aAttrs	are the XML attributes of this fragment
aParent	is the parent XML element of this fragment
aOwnerDocument	is the document which will be the owner of the elements of this fragment

NsPrefix ( )

IMPORT_C TPtrC8

NsPrefix

(

)

const [virtual]

Reimplemented from CSenFragmentBase::NsPrefix()const

Getter for namespace prefix of this fragment.

Since: Series60 4.0

Returns: namespace prefix or KNullDesC if not set.

NsUri ( )

IMPORT_C TPtrC8

NsUri

(

)

const [virtual]

Reimplemented from CSenFragmentBase::NsUri()const

Getter for Fragment's namespace URI..

Since: Series60 4.0

Returns: Namespace URI or KNullDesC if not set.

OnContentL ( const TDesC8 &, TInt )

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

Reimplemented from CSenFragmentBase::OnContentL(const TDesC8 &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnDelegateParsingL ( CSenFragmentBase & )

IMPORT_C void

OnDelegateParsingL

(

CSenFragmentBase &

aDelegate

)

[virtual]

Reimplemented from CSenFragmentBase::OnDelegateParsingL(CSenFragmentBase &)

Let the delegate MSenFragment handle the following SAX events. This fragment is made the owner of the delegate and the delegate is expected to make this MSenFragment the receiver of SAX events once it has seen the end element for itself.

Since: Series60 4.0

Parameter	Description
aDelegate	is the fragment to start handling the SAX events.

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

IMPORT_C void	OnDelegateParsingL	(	const RTagInfo &	aElement,
			const RAttributeArray &	aAttributes,
			TInt	aErrorCode
		)	[virtual]

OnEndDocumentL ( TInt )

IMPORT_C void

OnEndDocumentL

(

TInt

aErrorCode

)

[virtual]

Reimplemented from CSenFragmentBase::OnEndDocumentL(TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnEndElementL ( const RTagInfo &, TInt )

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

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnEndPrefixMappingL ( const RString &, TInt )

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

Reimplemented from CSenFragmentBase::OnEndPrefixMappingL(const RString &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnError ( TInt )

IMPORT_C void

OnError

(

TInt

aErrorCode

)

[virtual]

Reimplemented from CSenFragmentBase::OnError(TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnIgnorableWhiteSpaceL ( const TDesC8 &, TInt )

IMPORT_C void	OnIgnorableWhiteSpaceL	(	const TDesC8 &	aBytes,
			TInt	ErrorCode
		)	[virtual]

Reimplemented from CSenFragmentBase::OnIgnorableWhiteSpaceL(const TDesC8 &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

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

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

Reimplemented from CSenFragmentBase::OnProcessingInstructionL(const TDesC8 &,const TDesC8 &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnResumeParsingFromL ( const RTagInfo &, TInt )

IMPORT_C void	OnResumeParsingFromL	(	const RTagInfo &	aElement,
			TInt	aErrorCode
		)	[virtual]

Resumes the parsing. Usually called by the delegate fragment which was parsing itself after DelegateParsingL().

Since: Series60 4.0

Parameter	Description
aElement	The RTagInfo class holding information that describes the element.
aErrorCode	Error code

OnSkippedEntityL ( const RString &, TInt )

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

Reimplemented from CSenFragmentBase::OnSkippedEntityL(const RString &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnStartDocumentL ( const RDocumentParameters &, TInt )

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

Reimplemented from CSenFragmentBase::OnStartDocumentL(const RDocumentParameters &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

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

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

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

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

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

Reimplemented from CSenFragmentBase::OnStartPrefixMappingL(const RString &,const RString &,TInt)

Callback function implementing the XML content handler interface. Inheriting classes can override these.

Since: Series60 4.0

See also: MContentHandler

OnWriteEndElementL ( const RTagInfo & )

IMPORT_C void

OnWriteEndElementL

(

const RTagInfo &

aElement

)

Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).

Since: Series60 4.0

Parameter	Description
aElement	The RTagInfo class holding information that describes the element.

OnWriteStartElementL ( const RTagInfo &, const RAttributeArray & )

IMPORT_C void	OnWriteStartElementL	(	const RTagInfo &	aElement,
			const RAttributeArray &	aAttributes
		)

Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).

Since: Series60 4.0

Parameter	Description
aElement	The RTagInfo class holding information that describes the element.
aAttributes	The attributes of the new element

RenameL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

void	RenameL	(	const TDesC8 &	aLocalName,
			const TDesC8 &	aPrefix,
			const TDesC8 &	aNamespace
		)	[protected]

Reimplemented from CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &,const TDesC8 &)

Method renames the XML properties of this fragment.

Parameter	Description
aLocalName	XML localname for this fragment
aPrefix	XML namespace prefix for this fragment
aNamespace	XML namespace URI for this fragment Method leaves with if there is not enough memory (OOM)

RenameL ( const TDesC8 &, const TDesC8 & )

void	RenameL	(	const TDesC8 &	aLocalName,
			const TDesC8 &	aNamespace
		)	[protected]

Reimplemented from CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &)

Method renames the XML properties of this fragment.

Parameter	Description
aLocalName	XML localname for this fragment
aNamespace	XML namespace URI for this fragment Method leaves with if there is not enough memory (OOM)

RenameLocalNameL ( const TDesC8 & )

void

RenameLocalNameL

(

const TDesC8 &

aLocalName

)

[protected]

Reimplemented from CSenFragmentBase::RenameLocalNameL(const TDesC8 &)

Renames local name for this XML fragment.

Parameter	Description
aLocalName	XML localname for this fragment Method leaves with if there is not enough memory (OOM)

RenameNamespaceL ( const TDesC8 & )

void

RenameNamespaceL

(

const TDesC8 &

aNamespace

)

[protected]

Reimplemented from CSenFragmentBase::RenameNamespaceL(const TDesC8 &)

Renames namespace URI for this XML fragment.

Parameter	Description
aNamespace	XML namespace URI for this fragment Method leaves with if there is not enough memory(OOM)

RenameNamespaceL ( const TDesC8 &, const TDesC8 & )

void	RenameNamespaceL	(	const TDesC8 &	aPrefix,
			const TDesC8 &	aNamespace
		)	[protected]

Reimplemented from CSenFragmentBase::RenameNamespaceL(const TDesC8 &,const TDesC8 &)

Renames namespace prefix and namespace URI for this XML fragment.

Parameter	Description
aPrefix	XML namespace prefix for this fragment
aNamespace	XML namespace URI for this fragment Method leaves with if there is not enough memory (OOM)

RenamePrefixL ( const TDesC8 & )

void

RenamePrefixL

(

const TDesC8 &

aPrefix

)

[protected]

Reimplemented from CSenFragmentBase::RenamePrefixL(const TDesC8 &)

Renames namespace prefix for this XML fragment.

Parameter	Description
aPrefix	XML namespace prefix for this fragment Method leaves with if there is not enough memory (OOM)

ResetContentL ( )

IMPORT_C void

ResetContentL

(

)

[virtual]

Reimplemented from CSenFragmentBase::ResetContentL()

Since: Series60 4.0

Since: Series60 4.0

Returns: Detaches this fragment from its owner. All namespace references from possible parent fragments are declared in the scope of this fragment prior detaching. Resets the content of the fragment, and resets the namespaces.

SetContentHandler ( CSenFragmentBase & )

IMPORT_C void

SetContentHandler

(

CSenFragmentBase &

aContentHandler

)

Reimplemented from CSenFragmentBase::SetContentHandler(CSenFragmentBase &)

SetContentOfL ( const TDesC8 &, const TDesC8 & )

IMPORT_C TXmlEngElement	SetContentOfL	(	const TDesC8 &	aLocalName,
			const TDesC8 &	aContent
		)	[protected]

Reimplemented from CSenFragmentBase::SetContentOfL(const TDesC8 &,const TDesC8 &)

Sets content to a child element. If no element with given local name is not found, new one is added and content is set to that one.

Since: Series60 4.0

Parameter	Description
aLocalName	The local name of element which content is about to be set
aContent	Content to be set.

Returns: the element where content was set. Leave codes: KErrSenInvalidCharacters if aLocalName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName is zero length.