SenDomFragmentBase.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : SenDomFragmentBase.h
00004 *  Part of     : Web Services Fragment Base
00005 *  Description : Class implements XML DOM fragment using libxml2 classes
00006 *  Version     : 1.0
00007 *
00008 *  Copyright © 2002-2006 Nokia. All rights reserved.
00009 *  This material, including documentation and any related 
00010 *  computer programs, is protected by copyright controlled by 
00011 *  Nokia. All rights are reserved. Copying, including 
00012 *  reproducing, storing, adapting or translating, any 
00013 *  or all of this material requires the prior written consent of 
00014 *  Nokia. This material also contains confidential 
00015 *  information which may not be disclosed to others without the 
00016 *  prior written consent of Nokia.
00017 * ==============================================================================
00018 */
00021 #ifndef SEN_DOM_FRAGMENT_BASE_H
00022 #define SEN_DOM_FRAGMENT_BASE_H
00023 
00024 //  INCLUDES
00025 #include <SenFragmentBase.h>
00027 // FORWARD DECLARATIONS
00028 class RFileLogger;
00030 // CLASS DECLARATION
00044 class CSenDomFragmentBase : public CSenFragmentBase
00045     {
00046     public:  // Constructors and destructor
00054         IMPORT_C static CSenDomFragmentBase* NewL();
00061         IMPORT_C static CSenDomFragmentBase* NewL(
00062             const TXmlEngElement& aElement);
00069         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aLocalName);
00077         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aNsUri,
00078                                               const TDesC8& aLocalName);
00087         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aNsUri,
00088                                               const TDesC8& aLocalName,
00089                                               const TDesC8& aPrefix);
00099         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aNsUri,
00100                                               const TDesC8& aLocalName,
00101                                               const TDesC8& aPrefix,
00102                                               const RAttributeArray& aAttrs);
00113         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aNsUri,
00114                                               const TDesC8& aLocalName,
00115                                               const TDesC8& aPrefix,
00116                                               const RAttributeArray& aAttrs,
TXmlEngElement& aParent);
00130         IMPORT_C static CSenDomFragmentBase* NewL(const TDesC8& aNsUri,
00131                                               const TDesC8& aLocalName,
00132                                               const TDesC8& aPrefix,
00133                                               const RAttributeArray& aAttrs,
TXmlEngElement& aParent,
RSenDocument& aOwnerDocument);
00139         IMPORT_C virtual ~CSenDomFragmentBase();
00141         // New functions
00153         IMPORT_C virtual void ExpandL(const RTagInfo& aElement,
00154                                       const RAttributeArray& aAttributes,
00155                                       TInt aErrorCode);
00157         // Functions from base classes
00159         // From CSenBaseFragment
00169         IMPORT_C virtual void OnResumeParsingFromL(const RTagInfo& aElement,
00170                                            TInt aErrorCode);
00177         IMPORT_C virtual void AddAttributesL(const RAttributeArray& aAttrs);
00184         IMPORT_C virtual HBufC8* AsXmlL();
00192         IMPORT_C virtual void OnStartElementL(const RTagInfo& aElement,
00193                                               const RAttributeArray& aAttributes,
00194                                               TInt aErrorCode);
00202         IMPORT_C virtual void OnContentL(const TDesC8& aBytes,
00203                                          TInt aErrorCode);
00213         IMPORT_C void OnWriteStartElementL(const RTagInfo& aElement, 
00214                                            const RAttributeArray& aAttributes);
00223         IMPORT_C void OnWriteEndElementL(const RTagInfo& aElement);        
00230         IMPORT_C virtual void OnEndElementL(const RTagInfo& aElement, TInt aErrorCode);
00238         IMPORT_C virtual void OnStartDocumentL(const RDocumentParameters& aDocParam, TInt aErrorCode);
00246         IMPORT_C virtual void OnEndDocumentL(TInt aErrorCode);
00254         IMPORT_C virtual void OnStartPrefixMappingL(const RString& aPrefix, const RString& aUri, TInt aErrorCode);
00262         IMPORT_C virtual void OnEndPrefixMappingL(const RString& aPrefix, TInt aErrorCode);
00270         IMPORT_C virtual void OnIgnorableWhiteSpaceL(const TDesC8& aBytes, TInt ErrorCode);
00278         IMPORT_C virtual void OnSkippedEntityL(const RString& aName, TInt aErrorCode);
00286         IMPORT_C virtual void OnProcessingInstructionL(const TDesC8& aTarget, const TDesC8& aData, TInt aErrorCode);
00294         IMPORT_C virtual void OnError(TInt aErrorCode);
00302         IMPORT_C virtual TAny* GetExtendedInterface(const TInt32 aUid);
00304         // From CSenBaseFragment
00305         IMPORT_C virtual TPtrC8 ContentL();
00307         IMPORT_C virtual TXmlEngNamespace Namespace(const TDesC8& aPrefix);
00309 //        IMPORT_C virtual void DetachL();
00311         IMPORT_C virtual void ResetContentL();
00313         IMPORT_C virtual TPtrC8 LocalName() const;
00315         IMPORT_C virtual TPtrC8 NsUri() const;
00317         IMPORT_C virtual TPtrC8 NsPrefix() const;    
00319         IMPORT_C virtual TXmlEngElement AsElementL();
00321         IMPORT_C virtual RSenDocument& AsDocumentL();
00323         IMPORT_C virtual TXmlEngElement ExtractElement();
00325         IMPORT_C virtual void OnDelegateParsingL(CSenFragmentBase& aDelegate);
00327         IMPORT_C virtual void OnDelegateParsingL(const RTagInfo& aElement, 
00328                                                  const RAttributeArray& aAttributes, 
00329                                                  TInt aErrorCode);
00331         IMPORT_C virtual void SetOwner(CSenFragmentBase& aFragment);
00333         IMPORT_C virtual HBufC* AsXmlUnicodeL();
00335         IMPORT_C virtual void WriteAsXMLToL(RWriteStream& aWs);
00337         IMPORT_C virtual TBool ConsistsOfL(CSenFragmentBase& aCandidate);
00339         IMPORT_C void SetContentHandler(CSenFragmentBase& aContentHandler);
00341     protected: // From CSenBaseFragment
00343         void RenameL(const TDesC8& aLocalName, const TDesC8& aPrefix, const TDesC8& aNamespace);
00345         void RenameL(const TDesC8& aLocalName, const TDesC8& aNamespace);
00347         void RenameLocalNameL(const TDesC8& aLocalName);
00349         void RenameNamespaceL(const TDesC8& aNamespace);
00351         void RenamePrefixL(const TDesC8& aPrefix);
00353         void RenameNamespaceL(const TDesC8& aPrefix, const TDesC8& aNamespace);
00355         IMPORT_C TXmlEngElement SetContentOfL(const TDesC8& aLocalName,
00356                                         const TDesC8& aContent);
00358         IMPORT_C TPtrC8 ContentOf(const TDesC8& aLocalName);        
00360         IMPORT_C virtual TBool ConsistsOfL(TXmlEngElement& aElement, TXmlEngElement& aCandidate);
00362         IMPORT_C virtual void AddNamespacesL();
00364     protected:  
00369         IMPORT_C CSenDomFragmentBase();
00375         IMPORT_C void BaseConstructL();
00382         IMPORT_C void BaseConstructL(const TXmlEngElement& aElement);
00389         IMPORT_C void BaseConstructL(const TDesC8& aLocalName);
00397         IMPORT_C void BaseConstructL(const TDesC8& aNsUri,
00398                                      const TDesC8& aLocalName);
00407         IMPORT_C void BaseConstructL(const TDesC8& aNsUri,
00408                                      const TDesC8& aLocalName,
00409                                      const TDesC8& aPrefix);
00419         IMPORT_C void BaseConstructL(const TDesC8& aNsUri,
00420                                      const TDesC8& aLocalName,
00421                                      const TDesC8& aPrefix,
00422                                      const RAttributeArray& aAttrs);
00433         IMPORT_C void BaseConstructL(const TDesC8& aNsUri,
00434                                      const TDesC8& aLocalName,
00435                                      const TDesC8& aPrefix,
00436                                      const RAttributeArray& aAttrs,
TXmlEngElement& aParent);
00450         IMPORT_C void BaseConstructL(const TDesC8& aNsUri,
00451                                      const TDesC8& aLocalName,
00452                                      const TDesC8& aPrefix,
00453                                      const RAttributeArray& aAttrs,
TXmlEngElement& aParent,
RSenDocument& aOwnerDocument);
00462         // From CSenBaseFragment 
00464     protected: // Data
00465         CSenDomFragmentBase* ipDomDelegate;
00466     };
00468 #endif //SEN_DOM_FRAGMENT_BASE_H
00469 
00470 // End of File