1 /*

     2 * Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * 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

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:       DOM implementation functions

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 

    22 

    23 

    24 #ifndef XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED

    25 #define XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED

    26 

    27 #include <e32base.h>

    28 

    29 /**

    30  * The RXmlEngDOMImplementation interface provides a number of methods for performing 

    31  * operations that are independent of any particular instance of the document object model. 

    32  *    

    33  * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-102161490

    34  *

    35  * @lib XmlEngineDOM.lib

    36  * @since S60 v3.1

    37  */

    38 class RXmlEngDOMImplementation

    39 {

    40   public:

    41     

    42     

    43 	/**

    44      * Open method needed to initialize the XmlEngineDOM library and should be called before using any

    45      * class/function from this library. The initialization is required in every client thread in which

    46      * it used. Calling this method multiple times in a thread is allowed. There should be a call to Close()

    47      * for every call to Open, per thread.

    48      *

    49      * @since S60 v3.2

    50      * @param aHeap - pointer to client created heap. If aHeap argument is NULL (by default) 

    51      *                client thread's default heap is used.- NOT IMPLEMENTED YET

    52      * @return Document handle

    53      */

    54     IMPORT_C void OpenL( RHeap* aHeap = NULL );

    55 

    56     /**

    57      * Close method. It does cleanup of resources used by XmlengineDOM library. Client should call this

    58      * method at the end of library usage. The library should not be used after this call. If needed, client

    59      * can initialize the library again by calling Open() method. Libxml2 uses Symbian implementation of POSIX

    60      * standard libraries. During closure of XmlEngineDOM library, the standard library is also closed by default.

    61      * User can choose not to close standard libraries when XmlEngine shuts down, by specifying FALSE in aCloseStdLib flag.

    62      * 

    63      * @since S60 v3.2

    64      * @param aCloseStdLib A flag, if TRUE will close the STDLIB resources belonging to this thread.

    65      *                     else STDLIB is not closed.

    66      */

    67     IMPORT_C void Close(TBool aCloseStdLib = ETrue);

    68 };

    69 

    70 #endif /* XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED */