epoc32/include/xml/dom/xmlengdomimplementation.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2008 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 "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 *
    16 */
    17 
    18 /** @file
    19 @publishedAll
    20 @released
    21 */
    22 #ifndef XMLENGDOMIMPLEMENTATION_H
    23 #define XMLENGDOMIMPLEMENTATION_H
    24 
    25 #include <e32base.h>
    26 
    27 /**
    28 The RXmlEngDOMImplementation interface provides a number of methods for performing 
    29 operations that are independent of any particular instance of the document object model. 
    30    
    31 http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#ID-102161490
    32 */
    33 class RXmlEngDOMImplementation
    34 {
    35   public:
    36     
    37     
    38 	/**
    39 	Open method needed to initialize the DOM library and should be called
    40 	before using any class/function from this library.  The initialization is
    41 	required in every client thread in which it used. Calling this method
    42 	multiple times in a thread is allowed. There should be a call to Close()
    43 	for every call to Open, per thread.
    44 
    45 	@param aHeap This argument not used at present and is ignored in the
    46 	implementation.
    47 	@leave - One of the system-wide error codes
    48     */
    49     IMPORT_C void OpenL( RHeap* aHeap = NULL );
    50 
    51 	/**
    52 	Close method. It cleans up resources used by the DOM library. Clients
    53 	should call this method at the end of library usage. The library should not
    54 	be used after this call. If needed, clients can initialize the library
    55 	again by calling the Open() method. 
    56 	
    57     @param aReserved This parameter is not used
    58     */
    59     IMPORT_C void Close(TBool aReserved);
    60 
    61 	/**
    62 	Close method. It cleans up resources used by the DOM library. Clients
    63 	should call this method at the end of library usage. The library should not
    64 	be used after this call. If needed, clients can initialize the library
    65 	again by calling the Open() method. 
    66 	*/	
    67     IMPORT_C void Close();
    68 };
    69 
    70 #endif /* XMLENGDOMIMPLEMENTATION_H */
    71