Symbian^3 Application Developer Library >

CSenDomFragmentBase Class Reference

class CSenDomFragmentBase : public CSenFragmentBase
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. SenFragment.dll
Since
Series60 4.0

Inherits from

Public Member Functions
~CSenDomFragmentBase ()
IMPORT_C void AddAttributesL (const RAttributeArray &)
IMPORT_C RSenDocument & AsDocumentL ()
IMPORT_C TXmlEngElement AsElementL ()
IMPORT_C HBufC8 * AsXmlL ()
IMPORT_C HBufC * AsXmlUnicodeL ()
IMPORT_C TBool ConsistsOfL ( CSenFragmentBase &)
IMPORT_C TPtrC8 ContentL ()
IMPORT_C void ExpandL (const RTagInfo &, const RAttributeArray &, TInt )
IMPORT_C TXmlEngElement ExtractElement ()
IMPORT_C TAny * GetExtendedInterface (const TInt32 )
IMPORT_C TPtrC8 LocalName ()
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 &)
IMPORT_C TPtrC8 NsPrefix ()
IMPORT_C TPtrC8 NsUri ()
IMPORT_C void OnContentL (const TDesC8 &, TInt )
IMPORT_C void OnDelegateParsingL ( CSenFragmentBase &)
IMPORT_C void OnDelegateParsingL (const RTagInfo &, const RAttributeArray &, TInt )
IMPORT_C void OnEndDocumentL ( TInt )
IMPORT_C void OnEndElementL (const RTagInfo &, TInt )
IMPORT_C void OnEndPrefixMappingL (const RString &, TInt )
IMPORT_C void OnError ( TInt )
IMPORT_C void OnIgnorableWhiteSpaceL (const TDesC8 &, TInt )
IMPORT_C void OnProcessingInstructionL (const TDesC8 &, const TDesC8 &, TInt )
IMPORT_C void OnResumeParsingFromL (const RTagInfo &, TInt )
IMPORT_C void OnSkippedEntityL (const RString &, TInt )
IMPORT_C void OnStartDocumentL (const RDocumentParameters &, TInt )
IMPORT_C void OnStartElementL (const RTagInfo &, const RAttributeArray &, TInt )
IMPORT_C void OnStartPrefixMappingL (const RString &, const RString &, TInt )
IMPORT_C void OnWriteEndElementL (const RTagInfo &)
IMPORT_C void OnWriteStartElementL (const RTagInfo &, const RAttributeArray &)
IMPORT_C void ResetContentL ()
IMPORT_C void SetContentHandler ( CSenFragmentBase &)
IMPORT_C void SetOwner ( CSenFragmentBase &)
IMPORT_C void WriteAsXMLToL ( RWriteStream &)
Protected Member Functions
CSenDomFragmentBase ()
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 &)
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 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()
Protected Attributes
CSenDomFragmentBase * ipDomDelegate
Inherited Attributes
CSenFragmentBase::iDocument
CSenFragmentBase::iElement
CSenFragmentBase::iState
CSenFragmentBase::ipContentBuf
CSenFragmentBase::ipContentWriteStream
CSenFragmentBase::ipDelegate
CSenFragmentBase::ipNamespaceArray
CSenFragmentBase::ipOwner
CSenFragmentBase::ipParser

Constructor & Destructor Documentation

CSenDomFragmentBase()

IMPORT_C CSenDomFragmentBase ( ) [protected]

C++ default constructor.

~CSenDomFragmentBase()

IMPORT_C ~CSenDomFragmentBase ( ) [virtual]

Destructor.

Member Functions Documentation

AddAttributesL(const RAttributeArray &)

IMPORT_C void AddAttributesL ( const RAttributeArray & aAttrs ) [virtual]
Sets the attributes for the fragment.
Since
Series60 4.0

Parameters

const RAttributeArray & aAttrs

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)

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)

AsXmlL()

IMPORT_C HBufC8 * AsXmlL ( ) [virtual]
Gets the fragment data as an UTF-8 form XML.
Since
Series60 4.0

AsXmlUnicodeL()

IMPORT_C HBufC * AsXmlUnicodeL ( ) [virtual]
Gets the fragment data as an unicode XML.
Since
Series60 4.0

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]
"ConstructL" method for calling the base classes ones.
Since
Series60 4.0

Parameters

const TXmlEngElement & aElement is the XML element of this fragment.

BaseConstructL(const TDesC8 &)

IMPORT_C void BaseConstructL ( const TDesC8 & aLocalName ) [protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 4.0

Parameters

const TDesC8 & aLocalName The local name of the element

BaseConstructL(const TDesC8 &, const TDesC8 &)

IMPORT_C void BaseConstructL ( const TDesC8 & aNsUri,
const TDesC8 & aLocalName
) [protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 4.0

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & 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]
"ConstructL" method for calling the base classes ones.
Since
Series60 4.0

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aPrefix The prefix of the element
const RAttributeArray & 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aPrefix The prefix of the element
const RAttributeArray & aAttrs The attributes of the element
TXmlEngElement & 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aPrefix The prefix of the element
const RAttributeArray & aAttrs The attributes of the element
TXmlEngElement & aParent The parent of the element
RSenDocument & 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

Parameters

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

ConsistsOfL(TXmlEngElement &, TXmlEngElement &)

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

Parameters

TXmlEngElement & aElement
TXmlEngElement & aCandidate

ContentL()

IMPORT_C TPtrC8 ContentL ( ) [virtual]
Getter for the content,which is returned as UTF-8 form XML.
Since
Series60 4.0

ContentOf(const TDesC8 &)

IMPORT_C TPtrC8 ContentOf ( const TDesC8 & aLocalName ) [protected]
Gets the content of a given element.
Since
Series60 4.0

Parameters

const TDesC8 & aLocalName The local name of the element which content is 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

Parameters

const RTagInfo & aElement The RTagInfo class holding information that describes the element.
const RAttributeArray & aAttributes The attributes of the new element
TInt aErrorCode Error code

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

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 4.0
MContentHandler

Parameters

const TInt32 aUid

LocalName()

IMPORT_C TPtrC8 LocalName ( ) const [virtual]
Since
Series60 4.0

Namespace(const TDesC8 &)

IMPORT_C TXmlEngNamespace Namespace ( const TDesC8 & aPrefix ) [virtual]
Gets the namespace object with a given prefix.
Since
Series60 4.0

Parameters

const TDesC8 & aPrefix

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]
Basic constructor.
Since
Series60 4.0

Parameters

const TXmlEngElement & aElement Element to copy construction data from.

NewL(const TDesC8 &)

IMPORT_C CSenDomFragmentBase * NewL ( const TDesC8 & aLocalName ) [static]
Basic constructor.
Since
Series60 4.0

Parameters

const TDesC8 & aLocalName is the XML localname of this fragment

NewL(const TDesC8 &, const TDesC8 &)

IMPORT_C CSenDomFragmentBase * NewL ( const TDesC8 & aNsUri,
const TDesC8 & aLocalName
) [static]
Basic constructor.
Since
Series60 4.0

Parameters

const TDesC8 & aNsUri is the XML namespace user of this fragment
const TDesC8 & 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]
Basic constructor.
Since
Series60 4.0

Parameters

const TDesC8 & aNsUri is the XML namespace user of this fragment
const TDesC8 & aLocalName is the XML localname of this fragment
const TDesC8 & 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

Parameters

const TDesC8 & aNsUri is the XML namespace of this fragment
const TDesC8 & aLocalName is the XML localname of this fragment
const TDesC8 & aPrefix is the prefix of this fragment
const RAttributeArray & 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

Parameters

const TDesC8 & aNsUri is the XML namespace of this fragment
const TDesC8 & aLocalName is the XML localname of this fragment
const TDesC8 & aPrefix is the prefix of this fragment
const RAttributeArray & aAttrs are the XML attributes of this fragment
TXmlEngElement & 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

Parameters

const TDesC8 & aNsUri is the XML namespace of this fragment
const TDesC8 & aLocalName is the XML localname of this fragment
const TDesC8 & aPrefix is the prefix of this fragment
const RAttributeArray & aAttrs are the XML attributes of this fragment
TXmlEngElement & aParent is the parent XML element of this fragment
RSenDocument & aOwnerDocument is 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

NsUri()

IMPORT_C TPtrC8 NsUri ( ) const [virtual]
Getter for Fragment's namespace URI..
Since
Series60 4.0

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 4.0
MContentHandler

Parameters

const TDesC8 & aBytes
TInt aErrorCode

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

Parameters

CSenFragmentBase & 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]

Parameters

const RTagInfo & aElement
const RAttributeArray & aAttributes
TInt aErrorCode

OnEndDocumentL(TInt)

IMPORT_C void OnEndDocumentL ( TInt aErrorCode ) [virtual]
Callback function implementing the XML content handler interface. Inheriting classes can override these.
Since
Series60 4.0
MContentHandler

Parameters

TInt aErrorCode

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
MContentHandler

Parameters

const RTagInfo & aElement
TInt aErrorCode

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 4.0
MContentHandler

Parameters

const RString & aPrefix
TInt aErrorCode

OnError(TInt)

IMPORT_C void OnError ( TInt aErrorCode ) [virtual]
Callback function implementing the XML content handler interface. Inheriting classes can override these.
Since
Series60 4.0
MContentHandler

Parameters

TInt aErrorCode

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 4.0
MContentHandler

Parameters

const TDesC8 & aBytes
TInt ErrorCode

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 4.0
MContentHandler

Parameters

const TDesC8 & aTarget
const TDesC8 & aData
TInt aErrorCode

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

Parameters

const RTagInfo & aElement The RTagInfo class holding information that describes the element.
TInt 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 4.0
MContentHandler

Parameters

const RString & aName
TInt aErrorCode

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 4.0
MContentHandler

Parameters

const RDocumentParameters & aDocParam
TInt aErrorCode

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
MContentHandler

Parameters

const RTagInfo & aElement
const RAttributeArray & aAttributes
TInt aErrorCode

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 4.0
MContentHandler

Parameters

const RString & aPrefix
const RString & aUri
TInt aErrorCode

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

Parameters

const RTagInfo & 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

Parameters

const RTagInfo & aElement The RTagInfo class holding information that describes the element.
const RAttributeArray & 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.

Parameters

const TDesC8 & aLocalName XML localname for this fragment
const TDesC8 & aPrefix XML namespace prefix for this fragment
const TDesC8 & 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.

Parameters

const TDesC8 & aLocalName XML localname for this fragment
const TDesC8 & 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.

Parameters

const TDesC8 & 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.

Parameters

const TDesC8 & 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.

Parameters

const TDesC8 & aPrefix XML namespace prefix for this fragment
const TDesC8 & 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.

Parameters

const TDesC8 & 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

SetContentHandler(CSenFragmentBase &)

IMPORT_C void SetContentHandler ( CSenFragmentBase & aContentHandler )

Parameters

CSenFragmentBase & aContentHandler

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

Parameters

const TDesC8 & aLocalName The local name of element which content is about to be set
const TDesC8 & aContent Content to be set.

SetOwner(CSenFragmentBase &)

IMPORT_C void SetOwner ( CSenFragmentBase & aFragment ) [virtual]
Sets a new parent for this fragment.
Since
Series60 4.0

Parameters

CSenFragmentBase & aFragment

WriteAsXMLToL(RWriteStream &)

IMPORT_C void WriteAsXMLToL ( RWriteStream & aWs ) [virtual]
Invokes AsElement().WriteAsXMLToL(aWs);
Since
Series60 4.0

Parameters

RWriteStream & aWs is the stream into which the UTF-8 form XML will be written.

Member Data Documentation

CSenDomFragmentBase * ipDomDelegate

CSenDomFragmentBase * ipDomDelegate [protected]

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

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.