xmlengelement.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : xmlengelement.h
00004 *  Part of     : XmlEngine / DOM XPath C++ Wrapper
00005 *  Interface   : Domain, XML Engine DOM API
00006 *  Description : Element node functions
00007 *  Version     : %version: 3 %
00008 *
00009 *  Copyright © 2004-2006 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 XMLENGINE_ELEMENT_H_INCLUDED
00022 #define XMLENGINE_ELEMENT_H_INCLUDED
00023 
00024 #include "XmlEngAttr.h"
00025 #include "XmlEngNamespace.h"
00027 template<class T> class RXmlEngNodeList;
00110 class TXmlEngElement : public TXmlEngNode
00111 {
00112   public:
00118     inline TXmlEngElement();
00126     inline TXmlEngElement(void* aInternal);
00154     IMPORT_C void GetAttributes(RXmlEngNodeList<TXmlEngAttr>& aList) const;
00169     IMPORT_C void GetChildElements(RXmlEngNodeList<TXmlEngElement>& aList) const;
00196     IMPORT_C TXmlEngAttr AddNewAttributeL(const TDesC8& aName, const TDesC8& aValue);
00215     IMPORT_C TXmlEngAttr AddNewAttributeL(const TDesC8& aName,
00216                                     const TDesC8& aValue, 
00217                                     const TXmlEngNamespace aNsDef);
00233     IMPORT_C TXmlEngAttr AddNewAttributeL(const TDesC8& aName, 
00234                                     const TDesC8& aValue,
00235                                     const TDesC8& aNsUri, 
00236                                     const TDesC8& aPrefix);
00256     inline   TXmlEngAttr AddNewAttributeSameNsL(const TDesC8& aName, const TDesC8& aValue);
00302     IMPORT_C TXmlEngAttr AddNewAttributeUsePrefixL(const TDesC8& aLocalName, 
00303                                              const TDesC8& aValue, 
00304                                              const TDesC8& aPrefix);
00320     IMPORT_C TXmlEngAttr AddNewAttributeWithNsL(const TDesC8& aLocalName, 
00321                                           const TDesC8& aValue, 
00322                                           const TDesC8& aNsUri);
00338     IMPORT_C TXmlEngAttr AddXmlIdL(const TDesC8& aLocalName,
00339                                        const TDesC8& aValue,
TXmlEngNamespace aNs = TXmlEngNamespace());
00368     IMPORT_C TXmlEngElement AddNewElementL(const TDesC8& aName);
00381     IMPORT_C TXmlEngElement AddNewElementL(const TDesC8& aLocalName, TXmlEngNamespace aNsDecl);
00398     IMPORT_C TXmlEngElement AddNewElementL(const TDesC8& aLocalName, 
00399                                      const TDesC8& aNsUri, 
00400                                      const TDesC8& aPrefix);
00409     IMPORT_C TXmlEngElement AddNewElementSameNsL(const TDesC8& aLocalName);
00425     IMPORT_C TXmlEngElement AddNewElementUsePrefixL(const TDesC8& aLocalName, const TDesC8& aPrefix);
00441     IMPORT_C TXmlEngElement AddNewElementWithNsL(const TDesC8& aLocalName, const TDesC8& aNsUri);
00466     IMPORT_C TXmlEngElement AddNewElementAutoPrefixL(const TDesC8& aLocalName, 
00467                                                const TDesC8& aNsUri, 
TXmlEngElement aNsDeclTarget);
00483     IMPORT_C TPtrC8 Text() const;
00494     IMPORT_C void  AddTextL(const TDesC8& aString);
00506     IMPORT_C void  SetTextL(const TDesC8& aString);
00516     IMPORT_C void  SetEscapedTextL(const TDesC8& aEscapedString);
00528     IMPORT_C void SetTextNoEncL(const TDesC8& aNotEncString);
00540         IMPORT_C void AppendTextNoEncL(const TDesC8& aNotEncString);   
00569     IMPORT_C TXmlEngNamespace AddNamespaceDeclarationL(const TDesC8& aNsUri, const TDesC8& aPrefix);
00582     IMPORT_C TXmlEngNamespace SetDefaultNamespaceL(const TDesC8& aNsUri);
00616     IMPORT_C void SetNoDefaultNamespaceL();
00630     IMPORT_C TXmlEngNamespace LookupNamespaceByPrefixL(const TDesC8& aPrefix) const;
00717     IMPORT_C TXmlEngNamespace LookupNamespaceByUriL(const TDesC8& aUri) const;
00741     IMPORT_C TXmlEngNamespace TheXMLNamespaceL() const;
00754     inline   TXmlEngNamespace DefaultNamespaceL() const;
00771     IMPORT_C TXmlEngNamespace FindOrCreateNsDeclL(const TDesC8& aNsUri, const TDesC8& aPrefix);
00783     IMPORT_C TXmlEngNamespace FindOrCreateNsDeclL(const TDesC8& aNsUri);
00794     IMPORT_C TBool HasNsDeclarationForPrefixL(const TDesC8& aPrefix) const;
00806     IMPORT_C TXmlEngElement ElementCopyNoChildrenL(TBool preserveNsContext) const;
00814     inline   TXmlEngElement CopyL() const;
00821     IMPORT_C void RemoveChildren();
00828     IMPORT_C void RemoveAttributes();
00838     IMPORT_C void RemoveNamespaceDeclarations();
00847     inline   void ClearElement();
00862     IMPORT_C void CopyAttributesL(TXmlEngElement aSrc);
00875     IMPORT_C void CopyChildrenL(TXmlEngElement aSrc);
00885     IMPORT_C void RemoveChildElementsL(const TDesC8& aLocalName,const TDesC8& aNamespaceUri);
00907     IMPORT_C TPtrC8 AttributeValueL(const TDesC8& aLocalName, 
00908                                     const TDesC8& aNamespaceUri = KNullDesC8) const;
00920     IMPORT_C void  GetElementsByTagNameL(RXmlEngNodeList<TXmlEngElement>& aList, 
00921                                          const TDesC8& aLocalName, 
00922                                          const TDesC8& aNamespaceUri = KNullDesC8) const;
00937     IMPORT_C void  SetAttributeL(const TDesC8& aLocalName, 
00938                                  const TDesC8& aValue, 
00939                                  const TDesC8& aNamespaceUri = KNullDesC8, 
00940                                  const TDesC8& aPrefix = KNullDesC8);
00950     IMPORT_C void  RemoveAttributeL(const TDesC8& aLocalName, 
00951                                     const TDesC8& aNamespaceUri = KNullDesC8);
00961     IMPORT_C TXmlEngAttr AttributeNodeL(const TDesC8& aLocalName, 
00962                                   const TDesC8& aNamespaceUri = KNullDesC8) const;
00974     inline     TBool HasAttributeL(const TDesC8& aLocalName, 
00975                                    const TDesC8& aNamespaceUri  = KNullDesC8) const;
00985     IMPORT_C void  SetAttributeNodeL(TXmlEngAttr aNewAttr);
00986 };
00990 #include "xmlengelement.inl"
00992 #endif /* XMLENGINE_ELEMENT_H_INCLUDED */