24
|
1 |
/*
|
|
2 |
* Copyright (c) 2002 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 the License "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 |
|
|
19 |
|
|
20 |
|
|
21 |
|
|
22 |
/**
|
|
23 |
* DO NOT USE THIS API. DEPRECATED AND REMOVED IN S60 5.0. USE SYMBIAN XML FRAMEWORK INSTEAD.
|
|
24 |
*/
|
|
25 |
|
|
26 |
|
|
27 |
|
|
28 |
|
|
29 |
|
|
30 |
|
|
31 |
|
|
32 |
#ifndef __MWBXMLCONTENTHANDLER_H
|
|
33 |
#define __MWBXMLCONTENTHANDLER_H
|
|
34 |
|
|
35 |
#warning The XML API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information
|
|
36 |
|
|
37 |
// INCLUDES
|
|
38 |
#include <e32std.h>
|
|
39 |
|
|
40 |
// CLASS DECLARATION
|
|
41 |
|
|
42 |
/**
|
|
43 |
* Interface for SAX wbxml Parser Callback events.
|
|
44 |
* If an application (client) needs to be informed of basic parsing events,
|
|
45 |
* it implements this interface and registers an instance with the SAX parser using the SetContentHandler() method.
|
|
46 |
* The parser uses the instance to report basic document-related events like the start and end of elements.
|
|
47 |
*
|
|
48 |
* @lib XMLInterface.dll
|
|
49 |
* @since ?Series60_version
|
|
50 |
*/
|
|
51 |
class MWBXMLContentHandler
|
|
52 |
{
|
|
53 |
public:
|
|
54 |
/**
|
|
55 |
* Receive notification of the beginning of a wbxml document.
|
|
56 |
* @since ?Series60_version
|
|
57 |
* @param none
|
|
58 |
* @return 1 if sucess.
|
|
59 |
*/
|
|
60 |
virtual TInt StartDocument() = 0;
|
|
61 |
|
|
62 |
/**
|
|
63 |
* Receive notification of the end of a wbxml document.
|
|
64 |
* @since ?Series60_version
|
|
65 |
* @param none
|
|
66 |
* @return 1 if sucess.
|
|
67 |
*/
|
|
68 |
virtual TInt EndDocument() = 0;
|
|
69 |
|
|
70 |
/**
|
|
71 |
* Receive notification of the beginning of an element.
|
|
72 |
* @since ?Series60_version
|
|
73 |
* @return 1 if sucess.
|
|
74 |
*/
|
|
75 |
inline virtual TInt TagStart(){return 1;}
|
|
76 |
|
|
77 |
/**
|
|
78 |
* Receive notification of the end of an element.
|
|
79 |
* @since ?Series60_version
|
|
80 |
* @param none
|
|
81 |
* @return 1 if sucess.
|
|
82 |
*/
|
|
83 |
inline virtual TInt TagEnd(){return 1;}
|
|
84 |
|
|
85 |
/**
|
|
86 |
* Receive notification of the beginning of a processing instruction.
|
|
87 |
* @since ?Series60_version
|
|
88 |
* @param none
|
|
89 |
* @return 1 if sucess.
|
|
90 |
*/
|
|
91 |
inline virtual TInt ProcessingInstruction(){return 1;}
|
|
92 |
|
|
93 |
/**
|
|
94 |
* Receive notification of the end of a processing instruction.
|
|
95 |
* @since ?Series60_version
|
|
96 |
* @param none
|
|
97 |
* @return 1 if sucess.
|
|
98 |
*/
|
|
99 |
inline virtual TInt ProcessingInstructionEnd(){return 1;}
|
|
100 |
|
|
101 |
/**
|
|
102 |
* Receive notification of a attribute.
|
|
103 |
* @since ?Series60_version
|
|
104 |
* @param none
|
|
105 |
* @return 1 if sucess.
|
|
106 |
*/
|
|
107 |
inline virtual TInt AttributeStart(){return 1;}
|
|
108 |
|
|
109 |
/**
|
|
110 |
* Receive notification of a attribute value.
|
|
111 |
* @since ?Series60_version
|
|
112 |
* @param none
|
|
113 |
* @return 1 if sucess.
|
|
114 |
*/
|
|
115 |
inline virtual TInt AttributeValue(){return 1;}
|
|
116 |
/**
|
|
117 |
* Receive notification of content.
|
|
118 |
* @since ?Series60_version
|
|
119 |
* @param none
|
|
120 |
* @return 1 if sucess.
|
|
121 |
*/
|
|
122 |
inline virtual TInt Content(){return 1;}
|
|
123 |
|
|
124 |
/**
|
|
125 |
* Receive notification of a code page switch in the document.
|
|
126 |
* @since ?Series60_version
|
|
127 |
* @param none
|
|
128 |
* @return 1 if sucess.
|
|
129 |
*/
|
|
130 |
inline virtual TInt CodePageSwitch(){return 1;}
|
|
131 |
|
|
132 |
/**
|
|
133 |
* Receive notification of a extencion.
|
|
134 |
* @since ?Series60_version
|
|
135 |
* @param none
|
|
136 |
* @return 1 if sucess.
|
|
137 |
*/
|
|
138 |
inline virtual TInt Extension(){return 1;}
|
|
139 |
|
|
140 |
// Handle data types
|
|
141 |
|
|
142 |
/**
|
|
143 |
* Receive notification of a Token.
|
|
144 |
* @since ?Series60_version
|
|
145 |
* @param aToken: binary token
|
|
146 |
* @param aString: string representation of aToken
|
|
147 |
* @return 1 if sucess.
|
|
148 |
*/
|
|
149 |
inline virtual TInt Token(TUint8 /*aToken*/, TDesC& /*aString*/){return 1;}
|
|
150 |
/**
|
|
151 |
* Receive notification of a Fully Qualifyed Token.
|
|
152 |
* @since ?Series60_version
|
|
153 |
* @param aToken: binary token
|
|
154 |
* @param aString: string representation of aToken
|
|
155 |
* @return 1 if sucess.
|
|
156 |
*/
|
|
157 |
inline virtual TInt FQToken(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
|
|
158 |
|
|
159 |
/**
|
|
160 |
* Receive notification of a inline string.
|
|
161 |
* @since ?Series60_version
|
|
162 |
* @param aString: the inline string.
|
|
163 |
* @return 1 if sucess.
|
|
164 |
*/
|
|
165 |
inline virtual TInt InlineString(TDesC& /*aString*/){return 1;}
|
|
166 |
|
|
167 |
/**
|
|
168 |
* Receive notification of a table string.
|
|
169 |
* @since ?Series60_version
|
|
170 |
* @param aString: the table string.
|
|
171 |
* @return 1 if sucess.
|
|
172 |
*/
|
|
173 |
inline virtual TInt TableString(TDesC& /*aString*/){return 1;}
|
|
174 |
/**
|
|
175 |
* Receive notification of binary data.
|
|
176 |
* @since ?Series60_version
|
|
177 |
* @param aToken: binary data
|
|
178 |
* @return 1 if sucess.
|
|
179 |
*/
|
|
180 |
inline virtual TInt Binary(TUint32 /*aToken*/){return 1;}
|
|
181 |
|
|
182 |
/**
|
|
183 |
* Receive notification of opaque data.
|
|
184 |
* @since ?Series60_version
|
|
185 |
* @param aToken: binary data
|
|
186 |
* @param aString: the string representation of aToken
|
|
187 |
* @return 1 if sucess.
|
|
188 |
*/
|
|
189 |
inline virtual TInt Opaque(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
|
|
190 |
|
|
191 |
/**
|
|
192 |
* Receive notification of entity.
|
|
193 |
* @since ?Series60_version
|
|
194 |
* @param aToken: the entity
|
|
195 |
* @param aString: the string representation of aToken.
|
|
196 |
* @return 1 if sucess.
|
|
197 |
*/
|
|
198 |
inline virtual TInt Entity(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
|
|
199 |
|
|
200 |
/**
|
|
201 |
* Receive notification of parse error.
|
|
202 |
* @since ?Series60_version
|
|
203 |
* @param
|
|
204 |
* @return 1 if sucess.
|
|
205 |
*/
|
|
206 |
inline virtual TInt Exception(){return 1;}
|
|
207 |
|
|
208 |
};
|
|
209 |
|
|
210 |
|
|
211 |
#endif // __MXMLCONTENTHANDLER_H
|
|
212 |
|
|
213 |
// End of File
|