1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: LexicalHandler Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>LexicalHandler Class Reference</h1><!-- doxytag: class="LexicalHandler" -->Receive notification of lexical events.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for LexicalHandler:</div>
<div class="dynsection">
<p><center><img src="classLexicalHandler.png" usemap="#LexicalHandler_map" border="0" alt=""></center>
<map name="LexicalHandler_map">
<area href="classDefaultHandler.html" alt="DefaultHandler" shape="rect" coords="0,56,97,80">
</map>
</div>
<p>
<a href="classLexicalHandler-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#355f99e04837f54f0041a29c86530fa0">LexicalHandler</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#355f99e04837f54f0041a29c86530fa0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#9a69c15cea4160ec8b555959c4e8cde5">~LexicalHandler</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#9a69c15cea4160ec8b555959c4e8cde5"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">The virtual document handler interface</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#fa118e57acd501eeb68502418a3f7d29">comment</a> (const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const chars, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> length)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of comments. <a href="#fa118e57acd501eeb68502418a3f7d29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#8609c86c920f8c4e0d194f82d9a4087d">endCDATA</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of a CDATA section. <a href="#8609c86c920f8c4e0d194f82d9a4087d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#1cb667e6f9070cb3570d44c1025d9792">endDTD</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of the DTD declarations. <a href="#1cb667e6f9070cb3570d44c1025d9792"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#1cb805a2bd1c80320a7cdc54a99e03a0">endEntity</a> (const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the end of an entity. <a href="#1cb805a2bd1c80320a7cdc54a99e03a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#7eee2fa16d2eb2b7fa0accf4cce68442">startCDATA</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of a CDATA section. <a href="#7eee2fa16d2eb2b7fa0accf4cce68442"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#0d4c4c6e8cd2a1d459c54e3bb644f3b7">startDTD</a> (const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const name, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const publicId, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const systemId)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of the DTD declarations. <a href="#0d4c4c6e8cd2a1d459c54e3bb644f3b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexicalHandler.html#f9038d10ebb57009523aebd73781d1b2">startEntity</a> (const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive notification of the start of an entity. <a href="#f9038d10ebb57009523aebd73781d1b2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Receive notification of lexical events.
<p>
This is an extension handler for that provides lexical information about an XML document. It does not provide information about document content. For those events, an application must register an instance of a <a class="el" href="classContentHandler.html" title="Receive notification of general document events.">ContentHandler</a>.<p>
The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, <a class="el" href="classLexicalHandler.html#0d4c4c6e8cd2a1d459c54e3bb644f3b7" title="Receive notification of the start of the DTD declarations.">startDTD()</a> and <a class="el" href="classLexicalHandler.html#1cb667e6f9070cb3570d44c1025d9792" title="Receive notification of the end of the DTD declarations.">endDTD()</a> events will occur before the first element in the document.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classSAX2XMLReader.html#397fd37a21987186c6e4e63211f5d118" title="Allow an application to register a lexical event handler.">SAX2XMLReader::setLexicalHandler</a> <p>
<a class="el" href="classSAX2XMLReader.html#a1885becac34443e9648ccaeeed733f5" title="Allow an application to register a document event handler.">SAX2XMLReader::setContentHandler</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="355f99e04837f54f0041a29c86530fa0"></a><!-- doxytag: member="LexicalHandler::LexicalHandler" ref="355f99e04837f54f0041a29c86530fa0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LexicalHandler::LexicalHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="9a69c15cea4160ec8b555959c4e8cde5"></a><!-- doxytag: member="LexicalHandler::~LexicalHandler" ref="9a69c15cea4160ec8b555959c4e8cde5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual LexicalHandler::~LexicalHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fa118e57acd501eeb68502418a3f7d29"></a><!-- doxytag: member="LexicalHandler::comment" ref="fa118e57acd501eeb68502418a3f7d29" args="(const XMLCh *const chars, const XMLSize_t length)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::comment </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of comments.
<p>
The <a class="el" href="classParser.html" title="Basic interface for SAX (Simple API for XML) parsers.">Parser</a> will call this method to report each occurrence of a comment in the XML document.<p>
The application must not attempt to read from the array outside of the specified range.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>chars</em> </td><td>The characters from the XML document. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>The number of characters to read from the array. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#caef2cb8e680ae7a4a356f8e253ae401">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="8609c86c920f8c4e0d194f82d9a4087d"></a><!-- doxytag: member="LexicalHandler::endCDATA" ref="8609c86c920f8c4e0d194f82d9a4087d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::endCDATA </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the end of a CDATA section.
<p>
The SAX parser will invoke this method at the end of each CDATA parsed.<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#f35a07e77f5f22f4118fa9af93e41664">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="1cb667e6f9070cb3570d44c1025d9792"></a><!-- doxytag: member="LexicalHandler::endDTD" ref="1cb667e6f9070cb3570d44c1025d9792" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::endDTD </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the end of the DTD declarations.
<p>
The SAX parser will invoke this method at the end of the DTD<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#d5c97eedfa56518b329ba5fabfc6d947">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="1cb805a2bd1c80320a7cdc54a99e03a0"></a><!-- doxytag: member="LexicalHandler::endEntity" ref="1cb805a2bd1c80320a7cdc54a99e03a0" args="(const XMLCh *const name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::endEntity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the end of an entity.
<p>
The SAX parser will invoke this method at the end of an entity<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the entity that is ending. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#f8878dc6a70b85d2b697570392293874">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="7eee2fa16d2eb2b7fa0accf4cce68442"></a><!-- doxytag: member="LexicalHandler::startCDATA" ref="7eee2fa16d2eb2b7fa0accf4cce68442" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::startCDATA </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the start of a CDATA section.
<p>
The SAX parser will invoke this method at the start of each CDATA parsed.<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#3d563ab646fb550e6c041c584f52cc60">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="0d4c4c6e8cd2a1d459c54e3bb644f3b7"></a><!-- doxytag: member="LexicalHandler::startDTD" ref="0d4c4c6e8cd2a1d459c54e3bb644f3b7" args="(const XMLCh *const name, const XMLCh *const publicId, const XMLCh *const systemId)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::startDTD </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>publicId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>systemId</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the start of the DTD declarations.
<p>
The SAX parser will invoke this method at the start of the DTD<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The document type name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>publicId</em> </td><td>The declared public identifier for the external DTD subset, or null if none was declared. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>systemId</em> </td><td>The declared system identifier for the external DTD subset, or null if none was declared. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#0356f7c9aa7416eec0918d885896d74c">DefaultHandler</a>.</p>
</div>
</div><p>
<a class="anchor" name="f9038d10ebb57009523aebd73781d1b2"></a><!-- doxytag: member="LexicalHandler::startEntity" ref="f9038d10ebb57009523aebd73781d1b2" args="(const XMLCh *const name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LexicalHandler::startEntity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive notification of the start of an entity.
<p>
The SAX parser will invoke this method at the start of an entity<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the entity that is starting. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSAXException.html" title="Encapsulate a general SAX error or warning.">SAXException</a></em> </td><td>Any SAX exception, possibly wrapping another exception. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classDefaultHandler.html#4906bc9239e3fce1fab572d02c616004">DefaultHandler</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LexicalHandler_8hpp-source.html">LexicalHandler.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 21 17:55:50 2010 for Xerces-C++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
