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