williamr@2: /*
williamr@2: * Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:       DOM implementation functions
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED
williamr@2: #define XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: 
williamr@2: /**
williamr@2:  * The RXmlEngDOMImplementation interface provides a number of methods for performing 
williamr@2:  * operations that are independent of any particular instance of the document object model. 
williamr@2:  *    
williamr@2:  * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-102161490
williamr@2:  *
williamr@2:  * @lib XmlEngineDOM.lib
williamr@2:  * @since S60 v3.1
williamr@2:  */
williamr@2: class RXmlEngDOMImplementation
williamr@2: {
williamr@2:   public:
williamr@2:     
williamr@2:     
williamr@2: 	/**
williamr@2:      * Open method needed to initialize the XmlEngineDOM library and should be called before using any
williamr@2:      * class/function from this library. The initialization is required in every client thread in which
williamr@2:      * it used. Calling this method multiple times in a thread is allowed. There should be a call to Close()
williamr@2:      * for every call to Open, per thread.
williamr@2:      *
williamr@2:      * @since S60 v3.2
williamr@2:      * @param aHeap - pointer to client created heap. If aHeap argument is NULL (by default) 
williamr@2:      *                client thread's default heap is used.- NOT IMPLEMENTED YET
williamr@2:      * @return Document handle
williamr@2:      */
williamr@2:     IMPORT_C void OpenL( RHeap* aHeap = NULL );
williamr@2: 
williamr@2:     /**
williamr@2:      * Close method. It does cleanup of resources used by XmlengineDOM library. Client should call this
williamr@2:      * method at the end of library usage. The library should not be used after this call. If needed, client
williamr@2:      * can initialize the library again by calling Open() method. Libxml2 uses Symbian implementation of POSIX
williamr@2:      * standard libraries. During closure of XmlEngineDOM library, the standard library is also closed by default.
williamr@2:      * User can choose not to close standard libraries when XmlEngine shuts down, by specifying FALSE in aCloseStdLib flag.
williamr@2:      * 
williamr@2:      * @since S60 v3.2
williamr@2:      * @param aCloseStdLib A flag, if TRUE will close the STDLIB resources belonging to this thread.
williamr@2:      *                     else STDLIB is not closed.
williamr@2:      */
williamr@2:     IMPORT_C void Close(TBool aCloseStdLib = ETrue);
williamr@2: };
williamr@2: 
williamr@2: #endif /* XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED */