CSenDomFragment Class Reference

#include <mw/SenDomFragment.h>

Link against: SenXML.dll

class CSenDomFragment : public CSenBaseFragment

Inherits from

Protected Attributes
CSenDomFragment *ipDomDelegate
Public Member Functions
virtual ~CSenDomFragment()
virtual IMPORT_C voidExpandL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C CSenDomFragment *NewL()
IMPORT_C CSenDomFragment *NewL(const CSenElement &)
IMPORT_C CSenDomFragment *NewL(const TDesC8 &)
IMPORT_C CSenDomFragment *NewL(const TDesC8 &, const TDesC8 &)
IMPORT_C CSenDomFragment *NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C CSenDomFragment *NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C CSenDomFragment *NewL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, CSenElement &)
virtual IMPORT_C voidParseWithL(CSenXmlReader &)
virtual IMPORT_C voidResumeParsingFromL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
virtual IMPORT_C voidSetAttributesL(const RAttributeArray &)
Protected Member Functions
CSenDomFragment()
IMPORT_C voidBaseConstructL(const CSenElement &)
IMPORT_C voidBaseConstructL(const TDesC8 &)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, CSenElement &)
IMPORT_C voidBaseConstructL(CSenXmlReader &)
virtual IMPORT_C voidCharactersL(const TDesC8 &, TInt, TInt)
virtual IMPORT_C voidStartElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
virtual IMPORT_C voidWriteEndElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C voidWriteStartElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
Inherited Attributes
CSenBaseFragment::iState
CSenBaseFragment::iWs
CSenBaseFragment::iXmlReader
CSenBaseFragment::ipElement
CSenBaseFragment::ipOwner
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()
CSenBaseFragment::AllocContentSaverL()
CSenBaseFragment::AsElement()
CSenBaseFragment::AsXmlL()
CSenBaseFragment::AsXmlUnicodeL()
CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &)
CSenBaseFragment::BuildFrom(const TDesC8 &)
CSenBaseFragment::CSenBaseFragment()
CSenBaseFragment::ConsistsOfL(MSenFragment &)
CSenBaseFragment::Content()
CSenBaseFragment::ContentOf(const TDesC8 &)
CSenBaseFragment::DelegateParsingL(MSenFragment &)
CSenBaseFragment::DelegateParsingL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
CSenBaseFragment::DetachL()
CSenBaseFragment::EndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
CSenBaseFragment::EnsureNamespace(const TDesC8 &)
CSenBaseFragment::ExtractElement()
CSenBaseFragment::LocalName()const
CSenBaseFragment::Namespace(const TDesC8 &)
CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &)
CSenBaseFragment::NsPrefix()const
CSenBaseFragment::NsUri()const
CSenBaseFragment::ParseL(const TDesC8 &)
CSenBaseFragment::Reader()
CSenBaseFragment::ResetContentL()
CSenBaseFragment::SaveNamespacesL(const RAttributeArray &,TBool)
CSenBaseFragment::SetAttributesL(const RAttributeArray &)
CSenBaseFragment::SetContentOfL(const TDesC8 &,const TDesC8 &)
CSenBaseFragment::SetOwner(MSenFragment &)
CSenBaseFragment::SetReader(CSenXmlReader &)
CSenBaseFragment::StartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
CSenBaseFragment::StartEntity(TDesC8 &)
CSenBaseFragment::WriteAsXMLToL(RWriteStream &)
CSenBaseFragment::WriteStartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
CSenBaseFragment::~CSenBaseFragment()

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 fragmet.
Since
Series60 3.0

Member Attribute Documentation

ipDomDelegate

CSenDomFragment *ipDomDelegate[protected]

Constructor & Destructor Documentation

CSenDomFragment ( )

IMPORT_CCSenDomFragment()[protected]

C++ default constructor.

~CSenDomFragment ( )

IMPORT_C~CSenDomFragment()[virtual]

Destructor.

Member Function Documentation

BaseConstructL ( const CSenElement & )

IMPORT_C voidBaseConstructL(const CSenElement &aElement)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aElementis the XML element of this fragment.

BaseConstructL ( const TDesC8 & )

IMPORT_C voidBaseConstructL(const TDesC8 &aLocalName)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aLocalNameThe local name of the element

BaseConstructL ( const TDesC8 &, const TDesC8 & )

IMPORT_C voidBaseConstructL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName
)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the element
aLocalNameThe local name of the element

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

IMPORT_C voidBaseConstructL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName
)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the element
aLocalNameThe local name of the element
aQNameThe qualified name of the element

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

IMPORT_C voidBaseConstructL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs
)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the element
aLocalNameThe local name of the element
aQNameThe qualified name of the element
aAttrsThe attributes of the element

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

IMPORT_C voidBaseConstructL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs,
CSenElement &aParent
)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the element
aLocalNameThe local name of the element
aQNameThe qualified name of the element
aAttrsThe attributes of the element
aParentThe parent of the element

BaseConstructL ( CSenXmlReader & )

IMPORT_C voidBaseConstructL(CSenXmlReader &aReader)[protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0
ParameterDescription
aReaderis the XML reader for this fragment.

CharactersL ( const TDesC8 &, TInt, TInt )

IMPORT_C voidCharactersL(const TDesC8 &aChars,
TIntaStart,
TIntaLength
)[protected, virtual]
Callback functions which implement the XML content handler interface. This one is called when content is starting.
Since
Series60 3.0
ParameterDescription
aCharsThe content characters.
aStartThe starting index
aLengthThe length of the characters.

ExpandL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C voidExpandL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs
)[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 3.0
ParameterDescription
aNsUriThe namespace URI of the new element
aLocalNameThe local name of the new element
aQNameThe qualified name of the new element
aAttrsThe attributes of the new element

NewL ( )

IMPORT_C CSenDomFragment *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 3.0

NewL ( const CSenElement & )

IMPORT_C CSenDomFragment *NewL(const CSenElement &aElement)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aElementElement to copy construction data from.

NewL ( const TDesC8 & )

IMPORT_C CSenDomFragment *NewL(const TDesC8 &aLocalName)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aLocalNameis the XML localname of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName is zero length.

NewL ( const TDesC8 &, const TDesC8 & )

IMPORT_C CSenDomFragment *NewL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName
)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aNsUriis the XML namespace user of this fragment
aLocalNameis the XML localname of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName is zero length.

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

IMPORT_C CSenDomFragment *NewL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName
)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aNsUriis the XML namespace user of this fragment
aLocalNameis the XML localname of this fragment
aQNameis the XML qualifiedname of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName or aQName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.

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

IMPORT_C CSenDomFragment *NewL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs
)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aNsUriis the XML namespace of this fragment
aLocalNameis the XML localname of this fragment
aQNameis the qualifiedname of this fragment
aAttrsare the XML attributes of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName or aQName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.

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

IMPORT_C CSenDomFragment *NewL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs,
CSenElement &aParent
)[static]
Basic constructor.
Since
Series60 3.0
ParameterDescription
aNsUriis the XML namespace of this fragment
aLocalNameis the XML localname of this fragment
aQNameis the qualifiedname of this fragment
aAttrsare the XML attributes of this fragment
aParentis the parent XML element of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName or aQName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName or aQName is zero length.

ParseWithL ( CSenXmlReader & )

IMPORT_C voidParseWithL(CSenXmlReader &aReader)[virtual]
Sets the reader for this fragment and sets this to be the content handler of the following SAX events.
Since
Series60 3.0

ResumeParsingFromL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C voidResumeParsingFromL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName
)[virtual]
Resumes the parsing. Usually called by the delegate fragment which was parsing itself after DelegateParsingL().
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the current element
aLocalNameThe local name of the current element
aQNameThe qualified name of the current element

SetAttributesL ( const RAttributeArray & )

IMPORT_C voidSetAttributesL(const RAttributeArray &aAttrs)[virtual]
Sets the attributes for the fragment.
Since
Series60 3.0
ParameterDescription
aAttrsthe array of attributes.

StartElementL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C voidStartElementL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs
)[protected, virtual]
Callback functions which implement the XML content handler interface. Inheriting classes can override these.
Since
Series60 3.0
ParameterDescription
aNsUriThe namespace URI of the element
aLocalNameThe local name of the element
aQNameThe qualified name of the element
aAttrsThe attributes of the element

WriteEndElementL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C voidWriteEndElementL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName
)[protected, virtual]
Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).
Since
Series60 3.0
ParameterDescription
aNsUrinot used
aLocalNamenot used
aQNamenot used

WriteStartElementL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C voidWriteStartElementL(const TDesC8 &aNsUri,
const TDesC8 &aLocalName,
const TDesC8 &aQName,
const RAttributeArray &aAttrs
)[protected]
Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).
Since
Series60 3.0
ParameterDescription
aNsUrinot used
aLocalNamenot used
aQNamenot used
aAttrsnot used