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