|
1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #ifndef __MWAPPLUGINSP_H__ |
|
17 #define __MWAPPLUGINSP_H__ |
|
18 |
|
19 // System includes |
|
20 // |
|
21 #include <e32def.h> |
|
22 |
|
23 // Forward class declarations |
|
24 // |
|
25 class CDocumentNode; |
|
26 class CNode; |
|
27 class CDTDNode; |
|
28 class CXmlElement; |
|
29 class CAttributeLookupTable; |
|
30 |
|
31 |
|
32 typedef TAny CWmlLibrary; |
|
33 |
|
34 |
|
35 //##ModelId=3B666FA402F4 |
|
36 class MWapPluginSP |
|
37 /** |
|
38 @publishedAll |
|
39 @deprecated |
|
40 */ |
|
41 { |
|
42 public: |
|
43 |
|
44 /** |
|
45 Intended Usage : Resets the content data pointers in the given document |
|
46 node and any dependents. This could also reset the data pointer in an |
|
47 associated data dictionary node and its client document nodes. |
|
48 @since 6.0 |
|
49 @param aDocumentNode The pointer to the document root node |
|
50 @param aDataPtr The pointer to the new data content |
|
51 @pre None |
|
52 @post The data pointers in the specified document node and |
|
53 dependents have been set to the new data |
|
54 */ |
|
55 //##ModelId=3B666FA40331 |
|
56 virtual void ResetDocumentNodeData(CDocumentNode* aDocumentNode, TAny* aDataPtr) const =0; |
|
57 |
|
58 /** |
|
59 Intended Usage : Gets hold of the actual node that holds the data for the |
|
60 specified document node. The document data may actually be shared amongst |
|
61 several document nodes and actually held in the data dictionary. |
|
62 @since 6.0 |
|
63 @param aDocumentNode The pointer to a document node |
|
64 @return A pointer to node that actual holds the data. |
|
65 */ |
|
66 //##ModelId=3B666FA4032C |
|
67 virtual CNode& DataStorageNode(const CDocumentNode* aDocumentNode) const =0; |
|
68 |
|
69 /** |
|
70 Intended Usage : Preload the specified DTD for validating recieved WML |
|
71 and WMLC decks. The document data handler needs to call this as soon as it |
|
72 knows what type of DTD the document is using. When the document completes, |
|
73 this DTD will be used to validate it before the 100% complete message is |
|
74 passed up to the engine observer. |
|
75 @since 6.0 |
|
76 @param aDocType The specified DTD type |
|
77 @param aDTDURL The URL of the DTD to be fetched |
|
78 @param aDocRootNode The root node of the document to be validated |
|
79 @return A pointer to the DTD if the specified DTD is available, |
|
80 otherwise NULL. |
|
81 @todo Add the pre and post conditions. |
|
82 @pre None |
|
83 @post Unspecified |
|
84 */ |
|
85 //##ModelId=3B666FA40328 |
|
86 virtual const CDTDNode* PrepareDTDL(const TDesC& aDocType, |
|
87 const TDesC& aDTDURL, |
|
88 const CDocumentNode* aDocRootNode) =0; |
|
89 |
|
90 /** |
|
91 Intended Usage : Provide a CWmlLibrary object. This object is ready to |
|
92 process data and build a document tree to the given root node. |
|
93 @since 6.0 |
|
94 @warning The CWmlLibrary object is owned by the WAP Engine. |
|
95 @param aDocRootNode A pointer to the root node where the document |
|
96 tree is to be built. |
|
97 @return A pointer the CWmlLibrary object. |
|
98 */ |
|
99 //##ModelId=3B666FA40326 |
|
100 virtual CWmlLibrary* WmlLibL(CXmlElement* aDocRootNode) =0; |
|
101 |
|
102 /** |
|
103 Intended Usage : Gets the Attribute Look Up Table. |
|
104 @since 6.0 |
|
105 @return A reference to the Attribute Look Up Table. |
|
106 */ |
|
107 //##ModelId=3B666FA4031C |
|
108 virtual CAttributeLookupTable& AttributeLUT() =0; |
|
109 |
|
110 }; |
|
111 |
|
112 #endif // __MWAPPLUGINSP_H__ |