CSenFragmentBase Class Reference

#include <mw/SenFragmentBase.h>

Link against: SenFragment.dll

class CSenFragmentBase : public CBase

Inherits from

CSenFragmentBase

Protected Attributes
RSenDocument	iDocument
TXmlEngElement	iElement
TInt	iState
CBufFlat *	ipContentBuf
RBufWriteStream *	ipContentWriteStream
CSenFragmentBase *	ipDelegate
RPointerArray< CSenNamespaceData > *	ipNamespaceArray
CSenFragmentBase *	ipOwner
CSenParser *	ipParser

Public Member Functions
virtual	~CSenFragmentBase()
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 TXmlEngElement	ExtractElement()
virtual IMPORT_C TAny *	GetExtendedInterface(const TInt32)
virtual IMPORT_C TPtrC8	LocalName()
virtual IMPORT_C TXmlEngNamespace	Namespace(const TDesC8 &)
IMPORT_C CSenFragmentBase *	NewL(const TXmlEngElement &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &, const TDesC8 &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &)
IMPORT_C CSenFragmentBase *	NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument &)
IMPORT_C CSenFragmentBase *	NewL(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 &)
IMPORT_C void	SetDocument(RSenDocument &)
virtual IMPORT_C void	SetOwner(CSenFragmentBase &)
virtual IMPORT_C void	WriteAsXMLToL(RWriteStream &)

Protected Member Functions
	CSenFragmentBase()
virtual IMPORT_C void	AddAttributesL(const RAttributeArray &)
virtual IMPORT_C void	AddAttributesToElementL(TXmlEngElement, const RAttributeArray &)
virtual IMPORT_C void	AddContentL(const TDesC8 &)
virtual IMPORT_C void	AddNamespacesL()
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 &)
IMPORT_C void	BaseConstructL(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 &)
virtual IMPORT_C void	SetContentL(const TDesC8 &)
IMPORT_C TXmlEngElement	SetContentOfL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	StartSavingContent()

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

Detailed Description

Class implements basic functionality of an XML fragment Typically base fragment is used to parse certain part of some XML document. The element is identified by local name (or qualified name) and namespace. All child elements between start tag and and end tag defined this fragment will become content of this BaseFragment. In other words, BaseFragment has all data inside a single element. BaseFragment will parse only namespace (xmlns) attributes from a document and rest of the attributes are to be handled by subclasses, which should overwrite SetAttributesL() method to achieve this. The CSenFragmentReader class will do the actual parsing and this class will act as content handler for XML parser SAX events.

Since: Series60 4.0

Member Attribute Documentation

iDocument

RSenDocument

iDocument

[protected]

iElement

TXmlEngElement

iElement

[protected]

iState

TInt

iState

[protected]

ipContentBuf

CBufFlat *

ipContentBuf

[protected]

ipContentWriteStream

RBufWriteStream *

ipContentWriteStream

[protected]

ipDelegate

CSenFragmentBase *

ipDelegate

[protected]

ipNamespaceArray

RPointerArray< CSenNamespaceData > *

ipNamespaceArray

[protected]

ipOwner

CSenFragmentBase *

ipOwner

[protected]

ipParser

CSenParser *

ipParser

[protected]

Constructor & Destructor Documentation

CSenFragmentBase ( )

IMPORT_C

CSenFragmentBase

(

)

[protected]

C++ default constructor.

~CSenFragmentBase ( )

IMPORT_C

~CSenFragmentBase

(

)

[virtual]

Destructor.

Member Function Documentation

AddAttributesL ( const RAttributeArray & )

IMPORT_C void

AddAttributesL

(

const RAttributeArray &

apAttrs

)

[protected, virtual]

Adds new XML attributes to this fragment. Can be overridden to replace old attributes.

AddAttributesToElementL ( TXmlEngElement, const RAttributeArray & )

IMPORT_C void	AddAttributesToElementL	(	TXmlEngElement	element,
			const RAttributeArray &	apAttrs
		)	[protected, virtual]

Adds new XML attributes to specified element. Can be overridden to replace old attributes.

AddContentL ( const TDesC8 & )

IMPORT_C void

AddContentL

(

const TDesC8 &

aContent

)

[protected, virtual]

Adds the content.

Since: Series60 4.0

Parameter	Description
aContent	Content to be set.

AddNamespacesL ( )

IMPORT_C void

AddNamespacesL

(

)

[protected, virtual]

Adds namespaces from internal array for the fragment.

Since: Series60 4.0

AsDocumentL ( )

IMPORT_C RSenDocument &

AsDocumentL

(

)

[virtual]

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]

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]

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]

Gets the fragment data as an unicode XML.

Since: Series60 4.0

Returns: fragment as XML. Caller takes ownership.

BaseConstructL ( const TXmlEngElement & )

IMPORT_C void

BaseConstructL

(

const TXmlEngElement &

aSrc

)

[protected]

Following BaseConstructL methods should be called from ConstructL() methods of some deriving (fragment) class. BaseConstructL, where an element is given as initializer.

Since: Series60 4.0

BaseConstructL ( const TDesC8 & )

IMPORT_C void

BaseConstructL

(

const TDesC8 &

aLocalName

)

[protected]

BaseConstructL setting XML localname for this fragment.

Since: Series60 4.0

Parameter	Description
aLocalName	XML localname for this fragment

BaseConstructL ( const TDesC8 &, const TDesC8 & )

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

BaseConstructL offering possibility to set XML namespace and localname.

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI for this fragment
aLocalName	XML localname for this fragment

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

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

Base constructor

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI for this fragment
aLocalName	XML localname for this fragment

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]

Base constructor

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI for this fragment
aLocalName	XML localname for this fragment
aAttrs	XML attributes for this fragment

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]

Base constructor

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI for this fragment
aLocalName	XML localname for this fragment
aAttrs	XML attributes for this fragment
aParent	parent to be set for this fragmemt

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]

Base constructor

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI for this fragment
aLocalName	XML localname for this fragment
aAttrs	XML attributes for this fragment
aParent	Parent to be set for this fragmemt
aOwnerDocument	The document which will be the owner of the elements of this fragment

BaseConstructL ( TXmlEngElement &, RSenDocument & )

IMPORT_C void	BaseConstructL	(	TXmlEngElement &	aRootElement,
			RSenDocument &	aOwnerDocument
		)	[protected]

Base constructor

Since: Series60 4.0

Parameter	Description
aRootElement	The element which will be the root element of this fragment
aOwnerDocument	The document which will be the owner of the elements of this fragment

ConsistsOfL ( CSenFragmentBase & )

IMPORT_C TBool

ConsistsOfL

(

CSenFragmentBase &

aCandidate

)

[virtual]

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]

ContentL ( )

IMPORT_C TPtrC8

ContentL

(

)

[virtual]

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]

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

ExtractElement ( )

IMPORT_C TXmlEngElement

ExtractElement

(

)

[virtual]

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]

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

Since: Series60 3.1

See also: MContentHandler

LocalName ( )

IMPORT_C TPtrC8

LocalName

(

)

const [virtual]

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]

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 ( const TXmlEngElement & )

IMPORT_C CSenFragmentBase *

NewL

(

const TXmlEngElement &

aElement

)

[static]

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aElement	is the element where construction data will be copied from.

NewL ( const TDesC8 & )

IMPORT_C CSenFragmentBase *

NewL

(

const TDesC8 &

aLocalName

)

[static]

Standard 2 phase constructor.

Since: Series60 4.0

NewL ( const TDesC8 &, const TDesC8 & )

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

Standard 2 phase constructor.

Since: Series60 4.0

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

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

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI
aLocalName	XML localname
aPrefix	XML prefix

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

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

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI
aLocalName	XML localname
aPrefix	XML prefix
apAttrs	XML attributes

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

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

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI
aLocalName	XML localname
aPrefix	XML prefix
apAttrs	XML attributes
aParent	Parent element

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

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

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aNsUri	XML namespace URI
aLocalName	XML localname
aPrefix	XML prefix
apAttrs	XML attributes
aParent	Parent element
aOwnerDocument	The document which will be the owner of the elements of this fragment

NewL ( TXmlEngElement &, RSenDocument & )

IMPORT_C CSenFragmentBase *	NewL	(	TXmlEngElement &	aRootElement,
			RSenDocument &	aOwnerDocument
		)	[static]

Standard 2 phase constructor.

Since: Series60 4.0

Parameter	Description
aRootElement	The element which will be the root element of this fragment.
aOwnerDocument	The document which will be the owner of the elements of this fragment

NsPrefix ( )

IMPORT_C TPtrC8

NsPrefix

(

)

const [virtual]

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]

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]

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

Since: Series60 3.1

See also: MContentHandler

OnDelegateParsingL ( CSenFragmentBase & )

IMPORT_C void

OnDelegateParsingL

(

CSenFragmentBase &

aDelegate

)

[virtual]

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]

Creates a new fragment and lets the created MSenFragment handle the following SAX events. This fragment is made the owner of the delegate and the delegate is expected to make this MSenFragment act as receiver for SAX events (callbacks) once it has seen the end element for itself.

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

OnEndDocumentL ( TInt )

IMPORT_C void

OnEndDocumentL

(

TInt

aErrorCode

)

[virtual]

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

Since: Series60 3.1

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 3.1

See also: MContentHandler

OnEndPrefixMappingL ( const RString &, TInt )

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

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

Since: Series60 3.1

See also: MContentHandler

OnError ( TInt )

IMPORT_C void

OnError

(

TInt

aErrorCode

)

[virtual]

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

Since: Series60 3.1

See also: MContentHandler

OnIgnorableWhiteSpaceL ( const TDesC8 &, TInt )

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

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

Since: Series60 3.1

See also: MContentHandler

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

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

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

Since: Series60 3.1

See also: MContentHandler

OnResumeParsingFromL ( const RTagInfo &, TInt )

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

Leave codes: Resumes parsing to be handled by this fragment. Usually called by some delegate fragment which was set to be content handler because this fragment called 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]

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

Since: Series60 3.1

See also: MContentHandler

OnStartDocumentL ( const RDocumentParameters &, TInt )

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

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

Since: Series60 3.1

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 3.1

See also: MContentHandler

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

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

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

Since: Series60 3.1

See also: MContentHandler

OnWriteEndElementL ( const RTagInfo & )

IMPORT_C void

OnWriteEndElementL

(

const RTagInfo &

aElement

)

Writes the end element tag to the content stream. Derivants can override the basic usage used in BaseFragment.

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
		)

Sets the attributes for the fragment. BaseFragment parses only namespace (xmlns) attributes from the document. Subclasses should override this method if they are intrested of handling any other XML attributes and their corresponding values.

Since: Series60 4.0

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]

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]

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]

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]

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]

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]

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]

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

)

SetContentL ( const TDesC8 & )

IMPORT_C void

SetContentL

(

const TDesC8 &

aContent

)

[protected, virtual]

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
aContent	Content to be set.

SetContentOfL ( const TDesC8 &, const TDesC8 & )

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

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.

SetDocument ( RSenDocument & )

IMPORT_C void

SetDocument

(

RSenDocument &

aDocument

)

Sets the RSenDocument

SetOwner ( CSenFragmentBase & )

IMPORT_C void

SetOwner

(

CSenFragmentBase &

aFragment

)

[virtual]

Sets a new parent for this fragment.

Since: Series60 4.0

StartSavingContent ( )

IMPORT_C void

StartSavingContent

(

)

[protected]

StartSavingContent changes the internal SAX parsing state of this fragment to KSenStateSave, which means that next call to OnStartElementL is treated as data, and not ignored (in DOM fragment implementation, it would be "extended" into a DOM object).

WriteAsXMLToL ( RWriteStream & )

IMPORT_C void

WriteAsXMLToL

(

RWriteStream &

aWs

)

[virtual]

Invokes AsElement().WriteAsXMLToL(aWs);

Since: Series60 4.0

Parameter	Description
aWs	is the stream into which the UTF-8 form XML will be written.