SenElement.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : SenElement.h
00004 *  Part of     : Web Services Xml
00005 *  Interface   : Abstract class definition of XML element
00006 *  Description : Central place for debug-type macros
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 SEN_ELEMENT_H
00022 #define SEN_ELEMENT_H
00023 
00024 //  INCLUDES
00025 #include <e32base.h>
00026 #include <s32strm.h>
00027 #include <xml\Attribute.h>
00028 #include <stringpool.h>
00030 #include <MSenElement.h>
00032 using namespace Xml;
00034 // CLASS DECLARATION
00041 class CSenElement : public CBase, public MSenElement
00042     {
00043     public: // Functions from base classes
00045         // From MSenElement 
00052         virtual const TDesC8& LocalName() const = 0;
00059         virtual const TDesC8& NamespaceURI() const = 0;
00066         virtual void SetNamespaceL(const TDesC8& aNsUri) = 0;
00074         virtual void SetNamespaceL( const TDesC8& aNsPrefix,
00075                                     const TDesC8& aNsUri) = 0;
00084         virtual const CSenNamespace* AddNamespaceL( const TDesC8& aPrefix,
00085                                                     const TDesC8& aUri) = 0;
00093         virtual const CSenNamespace* Namespace() = 0;
00102         virtual const CSenNamespace* Namespace(const TDesC8& aNsPrefix) = 0;
00114         virtual const CSenNamespace* Namespace( const TDesC8& aNsPrefix,
00115                                                 const TDesC8& aUri) = 0;
00128         virtual const CSenNamespace* Namespace( const TDesC8& aNsPrefix,
00129                                                 const TBool aCheckInParent) = 0;
00136         virtual const TDesC8& NsPrefix() const = 0;
00143         virtual void SetPrefixL(const TDesC8& aPrefix) = 0;
00150         virtual TBool HasContent() const = 0;
00157         virtual TPtrC8 Content() const = 0;
00164         virtual HBufC* ContentUnicodeL() const = 0;
00172         virtual TPtrC8 SetContentL(const TDesC8& aContent) = 0;
00181         virtual RWriteStream& ContentWriteStreamL() = 0;
00193         virtual TBool ConsistsOfL(MSenElement& aCandidate) = 0;
00205         virtual TInt ElementsL(RPointerArray<CSenElement>& aElementArray,
00206                                 const TDesC8& aNsUri,
00207                                 const TDesC8& aLocalName) = 0;
00218         virtual TInt ElementsL(RPointerArray<CSenElement>& aElementArray,
00219                                 const TDesC8& aLocalName) = 0;
00227         virtual RPointerArray<CSenElement>& ElementsL() = 0;
00239         virtual const CSenNamespace* AddNamespaceL(CSenNamespace& aNewNamespace,
00240                                                     TBool aCheckInParent) = 0;
00249         virtual const TDesC8* AttrValue(const TDesC8& aName) = 0;
00258         virtual void AddAttrL(const TDesC8& aName, const TDesC8& aValue) = 0;
00266         virtual RPointerArray<CSenBaseAttribute>& AttributesL() = 0;
00274         virtual RPointerArray<CSenNamespace>& NamespacesL() = 0;
00282         virtual CSenElement* Parent() = 0;
00294         virtual CSenElement* SetParent(CSenElement* apParent) = 0;
00305         virtual CSenElement* DetachL() = 0;
00314         virtual CSenElement* Child(TInt aIndex) = 0;
00321         virtual MSenElement& Root() = 0;
00331         virtual CSenElement* Element(const TDesC8& aLocalName) = 0;
00341         virtual CSenElement* Element(const TDesC8& aNsUri,
00342                                      const TDesC8& aLocalName) = 0;
00357         virtual CSenElement* CreateElementL(const TDesC8& aNsPrefix,
00358                                             const TDesC8& aLocalName) = 0;
00373         virtual CSenElement& InsertElementL(CSenElement& aInsertedElement,
00374                                             const CSenElement& aBeforeElement) = 0;
00383         virtual CSenElement& AddElementL(CSenElement& aElement) = 0;
00396         virtual CSenElement& AddElementL(   const TDesC8& aNsUri,
00397                                             const TDesC8& aLocalName) = 0;
00414         virtual CSenElement& AddElementL(const TDesC8& aNsUri,
00415                                          const TDesC8& aLocalName,
00416                                          const TDesC8& aQName) = 0;
00433         virtual CSenElement& AddElementL(const TDesC8& aLocalName) = 0;
00443         virtual CSenElement* RemoveElement(CSenElement& aElement) = 0;
00454         virtual CSenElement* RemoveElement( const TDesC8& aNsUri,
00455                                             const TDesC8& aLocalName) = 0;
00466         virtual CSenElement* RemoveElement(const TDesC8& aLocalName) = 0;
00481         virtual CSenElement* ReplaceElementL(CSenElement& aElement) = 0;
00489         virtual HBufC8* AsXmlL() = 0;
00497         virtual HBufC* AsXmlUnicodeL() = 0;
00505         virtual void WriteAsXMLToL(RWriteStream& aWriteStream) = 0;
00513         virtual void WriteNamespacesToL(RWriteStream& aWriteStream) = 0;
00521         virtual MSenElement* AsElement() = 0;
00529         virtual void CopyFromL(CSenElement& aSource) = 0;
00542         virtual void Set(const TDesC8& aNamespaceURI, const TDesC8& aLocalName, const TDesC8& aQName) = 0;
00549         virtual void AddAttributesL(const RAttributeArray& apAttrs) = 0;
00550     };
00552 #endif //SEN_ELEMENT_H
00553 
00554 // End of File