MSenElement.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : MSenElement.h
00004 *  Part of     : Web Services Xml
00005 *  Interface   : 
00006 *  Description : The abstract interface of an XML element
00007 *  Version     : 
00008 *
00009 *  Copyright © 2002-2005 Nokia. All rights reserved.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia. All rights are reserved. Copying, including 
00013 *  reproducing, storing, adapting or translating, any 
00014 *  or all of this material requires the prior written consent of 
00015 *  Nokia. This material also contains confidential 
00016 *  information which may not be disclosed to others without the 
00017 *  prior written consent of Nokia.
00018 * ==============================================================================
00019 */
00021 #ifndef M_SEN_ELEMENT_H
00022 #define M_SEN_ELEMENT_H
00023 
00024 //  INCLUDES
00025 #include <e32base.h>
00026 #include <s32strm.h>
00027 #include <xml\Attribute.h>
00029 // FORWARD DECLARATIONS
00030 class CSenElement;
00031 class CSenBaseAttribute;
00032 class CSenNamespace;
00034 using namespace Xml;
00036 // CLASS DECLARATION
00043 class MSenElement
00044     {
00045     public: // New functions
00051         virtual const TDesC8& LocalName() const = 0;
00057         virtual const TDesC8& NamespaceURI() const = 0;
00063         virtual void SetNamespaceL(const TDesC8& aNsUri) = 0;
00070         virtual void SetNamespaceL( const TDesC8& aNsPrefix,
00071                                     const TDesC8& aNsUri) = 0;
00079         virtual const CSenNamespace* AddNamespaceL( const TDesC8& aPrefix,
00080                                                     const TDesC8& aUri) = 0;
00091         virtual const CSenNamespace* AddNamespaceL( CSenNamespace& aNewNamespace,
00092                                                     TBool aCheckInParent) = 0;
00098         virtual const CSenNamespace* Namespace() = 0;
00106         virtual const CSenNamespace* Namespace( const TDesC8& aNsPrefix) = 0;
00117         virtual const CSenNamespace* Namespace( const TDesC8& aNsPrefix,
00118                                                 const TDesC8& aUri) = 0;
00132         virtual const CSenNamespace* Namespace( const TDesC8& aNsPrefix,
00133                                                 const TBool aCheckInParent) = 0;
00139         virtual const TDesC8& NsPrefix() const = 0;
00145         virtual void SetPrefixL(const TDesC8& aPrefix) = 0;
00151         virtual TBool HasContent() const = 0;
00157         virtual TPtrC8 Content() const = 0;
00163         virtual HBufC* ContentUnicodeL() const = 0;
00170         virtual TPtrC8 SetContentL(const TDesC8& aContent) = 0;
00178         virtual RWriteStream& ContentWriteStreamL() = 0;
00190         virtual TBool ConsistsOfL(MSenElement& aCandidate) = 0;
00198         virtual RPointerArray<CSenElement>& ElementsL() = 0;
00206         virtual CSenElement* Child(TInt aIndex) = 0;
00214         virtual const TDesC8* AttrValue(const TDesC8& aName) = 0;
00222         virtual void AddAttrL(const TDesC8& aName, const TDesC8& aValue) = 0;
00229         virtual RPointerArray<CSenBaseAttribute>& AttributesL() = 0;
00236         virtual RPointerArray<CSenNamespace>& NamespacesL() = 0;
00243         virtual CSenElement* Parent() = 0;
00252         virtual CSenElement* SetParent(CSenElement* apParent) = 0;
00262         virtual CSenElement* DetachL() = 0;
00268         virtual MSenElement& Root() = 0;
00276         virtual CSenElement* Element(const TDesC8& aLocalName) = 0;
00283         virtual CSenElement* Element(const TDesC8& aNsUri,
00284                                      const TDesC8& aLocalName) = 0;
00299         virtual CSenElement* CreateElementL(const TDesC8& aNsPrefix,
00300                                             const TDesC8& aLocalName) = 0;
00314         virtual CSenElement& InsertElementL(CSenElement& aInsertedElement,
00315                                             const CSenElement& aBeforeElement) = 0;
00323         virtual CSenElement& AddElementL(CSenElement& aElement) = 0;
00335         virtual CSenElement& AddElementL(const TDesC8& aNsUri,
00336                                          const TDesC8& aLocalName) = 0;
00350         virtual CSenElement& AddElementL(const TDesC8& aNsUri,
00351                                          const TDesC8& aLocalName,
00352                                          const TDesC8& aQName) = 0;
00366         virtual CSenElement& AddElementL(const TDesC8& aLocalName) = 0;
00375         virtual CSenElement* RemoveElement(CSenElement& aElement) = 0;
00385         virtual CSenElement* RemoveElement( const TDesC8& aNsUri,
00386                                             const TDesC8& aLocalName) = 0;
00395         virtual CSenElement* RemoveElement(const TDesC8& aLocalName) = 0;
00408         virtual CSenElement* ReplaceElementL(CSenElement& aElement) = 0;
00414         virtual HBufC8* AsXmlL() = 0;
00422         virtual HBufC* AsXmlUnicodeL() = 0;
00429         virtual void WriteAsXMLToL(RWriteStream& aWriteStream) = 0;
00437         virtual void WriteNamespacesToL(RWriteStream& aWriteStream) = 0;
00445         virtual MSenElement* AsElement() = 0;
00452         virtual void CopyFromL(CSenElement& aSource) = 0;
00466         virtual void Set(const TDesC8& aNamespaceURI,
00467                          const TDesC8& aLocalName,
00468                          const TDesC8& aQName) = 0;
00474         virtual void AddAttributesL(const RAttributeArray& aAttrs) = 0;
00476 };
00478 #endif // M_SEN_ELEMENT_H
00479 
00480 // End of File