Symbian^3 Application Developer Library >

CSenDomFragment Class Reference

class CSenDomFragment : public CSenBaseFragment
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. SenXML.dll
Since
Series60 3.0

Inherits from

Public Member Functions
~CSenDomFragment ()
IMPORT_C void ExpandL (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 &)
IMPORT_C void ParseWithL ( CSenXmlReader &)
IMPORT_C void ResumeParsingFromL (const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void SetAttributesL (const RAttributeArray &)
Protected Member Functions
CSenDomFragment ()
IMPORT_C void BaseConstructL (const CSenElement &)
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 &, CSenElement &)
IMPORT_C void BaseConstructL ( CSenXmlReader &)
IMPORT_C void CharactersL (const TDesC8 &, TInt , TInt )
IMPORT_C void StartElementL (const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
IMPORT_C void WriteEndElementL (const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void WriteStartElementL (const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
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()
Protected Attributes
CSenDomFragment * ipDomDelegate
Inherited Attributes
CSenBaseFragment::iState
CSenBaseFragment::iWs
CSenBaseFragment::iXmlReader
CSenBaseFragment::ipElement
CSenBaseFragment::ipOwner

Constructor & Destructor Documentation

CSenDomFragment()

IMPORT_C CSenDomFragment ( ) [protected]

C++ default constructor.

~CSenDomFragment()

IMPORT_C ~CSenDomFragment ( ) [virtual]

Destructor.

Member Functions Documentation

BaseConstructL(const CSenElement &)

IMPORT_C void BaseConstructL ( const CSenElement & aElement ) [protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0

Parameters

const CSenElement & 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 3.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 3.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 & aQName
) [protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aQName The qualified name of the element

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

IMPORT_C void BaseConstructL ( 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aQName The qualified name of the element
const RAttributeArray & aAttrs The attributes of the element

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

IMPORT_C void BaseConstructL ( 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aQName The qualified name of the element
const RAttributeArray & aAttrs The attributes of the element
CSenElement & aParent The parent of the element

BaseConstructL(CSenXmlReader &)

IMPORT_C void BaseConstructL ( CSenXmlReader & aReader ) [protected]
"ConstructL" method for calling the base classes ones.
Since
Series60 3.0

Parameters

CSenXmlReader & aReader is the XML reader for this fragment.

CharactersL(const TDesC8 &, TInt, TInt)

IMPORT_C void CharactersL ( const TDesC8 & aChars,
TInt aStart,
TInt aLength
) [protected, virtual]
Callback functions which implement the XML content handler interface. This one is called when content is starting.
Since
Series60 3.0

Parameters

const TDesC8 & aChars The content characters.
TInt aStart The starting index
TInt aLength The length of the characters.

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

IMPORT_C void ExpandL ( 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

Parameters

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

Parameters

const CSenElement & aElement Element to copy construction data from.

NewL(const TDesC8 &)

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

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

const TDesC8 & aNsUri is the XML namespace of this fragment
const TDesC8 & aLocalName is the XML localname of this fragment
const TDesC8 & aQName is the qualifiedname of this fragment
const RAttributeArray & aAttrs are the XML attributes of this fragment
CSenElement & aParent is 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 void ParseWithL ( 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

Parameters

CSenXmlReader & aReader

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

IMPORT_C void ResumeParsingFromL ( 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

Parameters

const TDesC8 & aNsUri The namespace URI of the current element
const TDesC8 & aLocalName The local name of the current element
const TDesC8 & aQName The qualified name of the current element

SetAttributesL(const RAttributeArray &)

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

Parameters

const RAttributeArray & aAttrs the array of attributes.

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

IMPORT_C void StartElementL ( 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

Parameters

const TDesC8 & aNsUri The namespace URI of the element
const TDesC8 & aLocalName The local name of the element
const TDesC8 & aQName The qualified name of the element
const RAttributeArray & aAttrs The attributes of the element

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

IMPORT_C void WriteEndElementL ( 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

Parameters

const TDesC8 & aNsUri not used
const TDesC8 & aLocalName not used
const TDesC8 & aQName not used

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

IMPORT_C void WriteStartElementL ( 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

Parameters

const TDesC8 & aNsUri not used
const TDesC8 & aLocalName not used
const TDesC8 & aQName not used
const RAttributeArray & aAttrs not used

Member Data Documentation

CSenDomFragment * ipDomDelegate

CSenDomFragment * ipDomDelegate [protected]

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.