1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/xml/dom/xmlengdomimplementation.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,70 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:       DOM implementation functions
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +#ifndef XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED
    1.28 +#define XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED
    1.29 +
    1.30 +#include <e32base.h>
    1.31 +
    1.32 +/**
    1.33 + * The RXmlEngDOMImplementation interface provides a number of methods for performing 
    1.34 + * operations that are independent of any particular instance of the document object model. 
    1.35 + *    
    1.36 + * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-102161490
    1.37 + *
    1.38 + * @lib XmlEngineDOM.lib
    1.39 + * @since S60 v3.1
    1.40 + */
    1.41 +class RXmlEngDOMImplementation
    1.42 +{
    1.43 +  public:
    1.44 +    
    1.45 +    
    1.46 +	/**
    1.47 +     * Open method needed to initialize the XmlEngineDOM library and should be called before using any
    1.48 +     * class/function from this library. The initialization is required in every client thread in which
    1.49 +     * it used. Calling this method multiple times in a thread is allowed. There should be a call to Close()
    1.50 +     * for every call to Open, per thread.
    1.51 +     *
    1.52 +     * @since S60 v3.2
    1.53 +     * @param aHeap - pointer to client created heap. If aHeap argument is NULL (by default) 
    1.54 +     *                client thread's default heap is used.- NOT IMPLEMENTED YET
    1.55 +     * @return Document handle
    1.56 +     */
    1.57 +    IMPORT_C void OpenL( RHeap* aHeap = NULL );
    1.58 +
    1.59 +    /**
    1.60 +     * Close method. It does cleanup of resources used by XmlengineDOM library. Client should call this
    1.61 +     * method at the end of library usage. The library should not be used after this call. If needed, client
    1.62 +     * can initialize the library again by calling Open() method. Libxml2 uses Symbian implementation of POSIX
    1.63 +     * standard libraries. During closure of XmlEngineDOM library, the standard library is also closed by default.
    1.64 +     * User can choose not to close standard libraries when XmlEngine shuts down, by specifying FALSE in aCloseStdLib flag.
    1.65 +     * 
    1.66 +     * @since S60 v3.2
    1.67 +     * @param aCloseStdLib A flag, if TRUE will close the STDLIB resources belonging to this thread.
    1.68 +     *                     else STDLIB is not closed.
    1.69 +     */
    1.70 +    IMPORT_C void Close(TBool aCloseStdLib = ETrue);
    1.71 +};
    1.72 +
    1.73 +#endif /* XMLENGINE_DOMIMPLEMENTATION_H_INCLUDED */