|
1 /* |
|
2 * Copyright (c) 2002-2004 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: Class represents an ODT (Object Description Tree) of Xuikon. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef XNODT_H |
|
20 #define XNODT_H |
|
21 |
|
22 #include <e32base.h> |
|
23 |
|
24 class RWriteStream; |
|
25 class RReadStream; |
|
26 class CXnDomDocument; |
|
27 class CXnResource; |
|
28 class CXnDomNode; |
|
29 |
|
30 /** |
|
31 * @ingroup group_xnodt |
|
32 * Class represents an Object Description Tree of Xuikon. |
|
33 * ODT is cabable of marshaling itself into HBufC8 descriptor and unmarshaling |
|
34 * from descriptor stream. |
|
35 * |
|
36 * @lib XnODT.lib |
|
37 * @since S60 3.1 |
|
38 */ |
|
39 class CXnODT : public CBase |
|
40 { |
|
41 public: // Constructors and destructor |
|
42 |
|
43 /** |
|
44 * Two-phased constructor. |
|
45 */ |
|
46 IMPORT_C static CXnODT* NewL(); |
|
47 |
|
48 /** |
|
49 * Destructor. |
|
50 */ |
|
51 virtual ~CXnODT(); |
|
52 |
|
53 public: // New functions |
|
54 |
|
55 /** |
|
56 * Internalizes the ODT header. |
|
57 * @since S60 5.1 |
|
58 * @param aStream The read stream |
|
59 * @return void |
|
60 */ |
|
61 IMPORT_C static void InternalizeHeaderL( RReadStream& aStream ); |
|
62 |
|
63 /** |
|
64 * Internalizes the Resource List. |
|
65 * @since S60 5.1 |
|
66 * @param aStream The read stream |
|
67 * @return resource list, ownership is passed to the caller |
|
68 */ |
|
69 IMPORT_C static CArrayPtrSeg< CXnResource >* InternalizeResourceListL( |
|
70 RReadStream& aStream ); |
|
71 |
|
72 /** |
|
73 * Internalizes the dom document. |
|
74 * @since S60 5.1 |
|
75 * @param aStream The read stream |
|
76 * @return dom document's root node |
|
77 */ |
|
78 IMPORT_C CXnDomNode* InternalizeDomDocumentL( |
|
79 RReadStream& aStream ); |
|
80 |
|
81 /** |
|
82 * Get the DomDocument. |
|
83 * @since S60 3.1 |
|
84 * @return CXnDomDocument& Dom document |
|
85 */ |
|
86 IMPORT_C CXnDomDocument& DomDocument() const; |
|
87 |
|
88 private: |
|
89 |
|
90 /** |
|
91 * C++ default constructor. |
|
92 */ |
|
93 CXnODT(); |
|
94 |
|
95 /** |
|
96 * By default Symbian 2nd phase constructor is private. |
|
97 */ |
|
98 void ConstructL(); |
|
99 |
|
100 private: // Data |
|
101 CXnDomDocument* iDomDocument; |
|
102 }; |
|
103 |
|
104 #endif // XNODT_H |
|
105 |
|
106 // End of File |