CSenDomFragment Class Reference

API published in: S60 3rd Ed

Link against: senxml.lib

Capability Information

Required Capabilities

None

#include <sendomfragment.h>

Inherits CSenBaseFragment.

Inherited by CSenXmlServiceDescription.

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.


Public Member Functions

virtual IMPORT_C ~CSenDomFragment ()
 Destructor.
virtual IMPORT_C void ExpandL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs)
 Initiates the parsing chain where new delegate will be created with given parameters and parsing will be delegated to it.
IMPORT_C void ResumeParsingFromL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName)
 Resumes the parsing.
virtual IMPORT_C void ParseWithL (CSenXmlReader &aReader)
 Sets the reader for this fragment and sets this to be the content handler of the following SAX events.
virtual IMPORT_C void SetAttributesL (const RAttributeArray &aAttrs)
 Sets the attributes for the fragment.

Static Public Member Functions

static IMPORT_C CSenDomFragment * NewL ()
 Basic contructor.
static IMPORT_C CSenDomFragment * NewL (const CSenElement &aElement)
 Basic constructor.
static IMPORT_C CSenDomFragment * NewL (const TDesC8 &aLocalName)
 Basic constructor.
static IMPORT_C CSenDomFragment * NewL (const TDesC8 &aNsUri, const TDesC8 &aLocalName)
 Basic constructor.
static IMPORT_C CSenDomFragment * NewL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName)
 Basic constructor.
static IMPORT_C CSenDomFragment * NewL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs)
 Basic constructor.
static IMPORT_C CSenDomFragment * NewL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs, CSenElement &aParent)
 Basic constructor.

Protected Member Functions

IMPORT_C CSenDomFragment ()
 C++ default constructor.
IMPORT_C void BaseConstructL (const CSenElement &aElement)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (const TDesC8 &aLocalName)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (const TDesC8 &aNsUri, const TDesC8 &aLocalName)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs, CSenElement &aParent)
 "ConstructL" method for calling the base classes ones.
IMPORT_C void BaseConstructL (CSenXmlReader &aReader)
 "ConstructL" method for calling the base classes ones.
virtual IMPORT_C void StartElementL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs)
virtual IMPORT_C void CharactersL (const TDesC8 &aChars, TInt aStart, TInt aLength)
 Callback functions which implement the XML content handler interface.
IMPORT_C void WriteStartElementL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttrs)
 Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).
IMPORT_C void WriteEndElementL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName)
 Overriding content writing from CSenBaseFragment to do nothing in DOM fragment (because the tree is expanded).

Protected Attributes

CSenDomFragment * ipDomDelegate

Constructor & Destructor Documentation

virtual IMPORT_C CSenDomFragment::~CSenDomFragment (   )  [virtual]
 

Destructor.

IMPORT_C CSenDomFragment::CSenDomFragment (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C void CSenDomFragment::BaseConstructL ( CSenXmlReader &  aReader  )  [protected]
 

"ConstructL" method for calling the base classes ones.

Parameters:
aReader is the XML reader for this fragment.

Reimplemented from CSenBaseFragment.

IMPORT_C void CSenDomFragment::BaseConstructL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName,
const RAttributeArray &  aAttrs,
CSenElement &  aParent
)  [protected]
 

"ConstructL" method for calling the base classes ones.

Parameters:
aNsUri The namespace URI of the element
aLocalName The local name of the element
aQName The qualified name of the element
aAttrs The attributes of the element
aParent The parent of the element

Reimplemented from CSenBaseFragment.

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

"ConstructL" method for calling the base classes ones.

Parameters:
aNsUri The namespace URI of the element
aLocalName The local name of the element
aQName The qualified name of the element
aAttrs The attributes of the element

Reimplemented from CSenBaseFragment.

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

"ConstructL" method for calling the base classes ones.

Parameters:
aNsUri The namespace URI of the element
aLocalName The local name of the element
aQName The qualified name of the element

Reimplemented from CSenBaseFragment.

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

"ConstructL" method for calling the base classes ones.

Parameters:
aNsUri The namespace URI of the element
aLocalName The local name of the element

Reimplemented from CSenBaseFragment.

Reimplemented in CSenServicePattern.

IMPORT_C void CSenDomFragment::BaseConstructL ( const TDesC8 &  aLocalName  )  [protected]
 

"ConstructL" method for calling the base classes ones.

Parameters:
aLocalName The local name of the element

Reimplemented from CSenBaseFragment.

Reimplemented in CSenServicePattern.

IMPORT_C void CSenDomFragment::BaseConstructL ( const CSenElement &  aElement  )  [protected]
 

"ConstructL" method for calling the base classes ones.

Parameters:
aElement is the XML element of this fragment.

Reimplemented from CSenBaseFragment.

virtual IMPORT_C void CSenDomFragment::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.

Parameters:
aChars The content characters.
aStart The starting index
aLength The length of the characters.

Reimplemented from CSenBaseFragment.

virtual IMPORT_C void CSenDomFragment::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.

Parameters:
aNsUri The namespace URI of the new element
aLocalName The local name of the new element
aQName The qualified name of the new element
aAttrs The attributes of the new element
static IMPORT_C CSenDomFragment* CSenDomFragment::NewL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName,
const RAttributeArray &  aAttrs,
CSenElement &  aParent
)  [static]
 

Basic constructor.

Parameters:
aNsUri is the XML namespace of this fragment
aLocalName is the XML localname of this fragment
aQName is the qualifiedname of this fragment
aAttrs are the XML attributes of this fragment
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.

Reimplemented from CSenBaseFragment.

static IMPORT_C CSenDomFragment* CSenDomFragment::NewL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName,
const RAttributeArray &  aAttrs
)  [static]
 

Basic constructor.

Parameters:
aNsUri is the XML namespace of this fragment
aLocalName is the XML localname of this fragment
aQName is the qualifiedname of this fragment
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.

Reimplemented from CSenBaseFragment.

static IMPORT_C CSenDomFragment* CSenDomFragment::NewL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName
)  [static]
 

Basic constructor.

Parameters:
aNsUri is the XML namespace user of this fragment
aLocalName is the XML localname of this fragment
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.

Reimplemented from CSenBaseFragment.

Reimplemented in CSenIdentityProvider.

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

Basic constructor.

Parameters:
aNsUri is the XML namespace user of this fragment
aLocalName is the XML localname of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName is zero length.

Reimplemented from CSenBaseFragment.

Reimplemented in CSenIdentityProvider, CSenServicePattern, and CSenXmlServiceDescription.

static IMPORT_C CSenDomFragment* CSenDomFragment::NewL ( const TDesC8 &  aLocalName  )  [static]
 

Basic constructor.

Parameters:
aLocalName is the XML localname of this fragment Leave codes: KErrSenInvalidCharacters if aLocalName contains illegal characters. KErrSenZeroLengthDescriptor if aLocalName is zero length.

Reimplemented from CSenBaseFragment.

Reimplemented in CSenIdentityProvider, CSenServicePattern, and CSenXmlServiceDescription.

static IMPORT_C CSenDomFragment* CSenDomFragment::NewL ( const CSenElement &  aElement  )  [static]
 

Basic constructor.

Parameters:
aElement Element to copy construction data from.

Reimplemented from CSenBaseFragment.

static IMPORT_C CSenDomFragment* 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.

Reimplemented in CSenServicePattern, and CSenXmlServiceDescription.

virtual IMPORT_C void CSenDomFragment::ParseWithL ( CSenXmlReader &  aReader  )  [virtual]
 

Sets the reader for this fragment and sets this to be the content handler of the following SAX events.

Parameters:
aReader,: Reader to be used.

Reimplemented from CSenBaseFragment.

IMPORT_C void CSenDomFragment::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().

Parameters:
aNsUri The namespace URI of the current element
aLocalName The local name of the current element
aQName The qualified name of the current element

Reimplemented from CSenBaseFragment.

Reimplemented in CSenXmlServiceDescription.

virtual IMPORT_C void CSenDomFragment::SetAttributesL ( const RAttributeArray &  aAttrs  )  [virtual]
 

Sets the attributes for the fragment.

Parameters:
aAttrs the array of attributes.

Reimplemented from CSenBaseFragment.

Reimplemented in CSenXmlServiceDescription.

virtual IMPORT_C void CSenDomFragment::StartElementL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName,
const RAttributeArray &  aAttrs
)  [protected, virtual]
 
Parameters:
aNsUri The namespace URI of the element
aLocalName The local name of the element
aQName The qualified name of the element
aAttrs The attributes of the element

Reimplemented from CSenBaseFragment.

Reimplemented in CSenServicePattern, and CSenXmlServiceDescription.

IMPORT_C void CSenDomFragment::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).

Parameters:
aNsUri not used
aLocalName not used
aQName not used

Reimplemented from CSenBaseFragment.

IMPORT_C void CSenDomFragment::WriteStartElementL ( const TDesC8 &  aNsUri,
const TDesC8 &  aLocalName,
const TDesC8 &  aQName,
const RAttributeArray &  aAttrs
)  [protected, virtual]
 

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

Parameters:
aNsUri not used
aLocalName not used
aQName not used
aAttrs not used

Reimplemented from CSenBaseFragment.

Field Documentation

CSenDomFragment* CSenDomFragment::ipDomDelegate [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top