Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.E5XML.XMLHandlerBase.html

Documentation/Source/eric5.E5XML.XMLHandlerBase.html

changeset 609
463fc2891cbf
parent 608
d8fea1e76975
child 613
5a6ee2af8ec0
equal deleted inserted replaced
608:d8fea1e76975 609:463fc2891cbf
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.E5XML.XMLHandlerBase</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.E5XML.XMLHandlerBase</h1>
24 <p>
25 Module implementing a base class for all of eric5s XML handlers.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#XMLHandlerBase">XMLHandlerBase</a></td>
35 <td>Class implementing the base class for al of eric5s XML handlers.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="XMLHandlerBase" ID="XMLHandlerBase"></a>
44 <h2>XMLHandlerBase</h2>
45 <p>
46 Class implementing the base class for al of eric5s XML handlers.
47 </p>
48 <h3>Derived from</h3>
49 ContentHandler
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#XMLHandlerBase.__init__">XMLHandlerBase</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#XMLHandlerBase._prepareBasics">_prepareBasics</a></td>
61 <td>Protected method to prepare the parsing of XML for basic python types.</td>
62 </tr><tr>
63 <td><a href="#XMLHandlerBase.characters">characters</a></td>
64 <td>Handler called for ordinary text.</td>
65 </tr><tr>
66 <td><a href="#XMLHandlerBase.decodedNewLines">decodedNewLines</a></td>
67 <td>Public method to decode newlines and paragraph breaks.</td>
68 </tr><tr>
69 <td><a href="#XMLHandlerBase.defaultEndElement">defaultEndElement</a></td>
70 <td>Handler method for the common end tags.</td>
71 </tr><tr>
72 <td><a href="#XMLHandlerBase.defaultStartElement">defaultStartElement</a></td>
73 <td>Handler method for common start tags.</td>
74 </tr><tr>
75 <td><a href="#XMLHandlerBase.endBool">endBool</a></td>
76 <td>Handler method for the "bool" end tag.</td>
77 </tr><tr>
78 <td><a href="#XMLHandlerBase.endBytearray">endBytearray</a></td>
79 <td>Handler method for the "bytearray" end tag.</td>
80 </tr><tr>
81 <td><a href="#XMLHandlerBase.endBytes">endBytes</a></td>
82 <td>Handler method for the "bytes" end tag.</td>
83 </tr><tr>
84 <td><a href="#XMLHandlerBase.endComplex">endComplex</a></td>
85 <td>Handler method for the "complex" end tag.</td>
86 </tr><tr>
87 <td><a href="#XMLHandlerBase.endDictionary">endDictionary</a></td>
88 <td>Handler method for the "dictionary" end tag.</td>
89 </tr><tr>
90 <td><a href="#XMLHandlerBase.endElement">endElement</a></td>
91 <td>Handler called, when an ending tag is found.</td>
92 </tr><tr>
93 <td><a href="#XMLHandlerBase.endFloat">endFloat</a></td>
94 <td>Handler method for the "float" end tag.</td>
95 </tr><tr>
96 <td><a href="#XMLHandlerBase.endFrozenset">endFrozenset</a></td>
97 <td>Handler method for the "frozenset" end tag.</td>
98 </tr><tr>
99 <td><a href="#XMLHandlerBase.endInt">endInt</a></td>
100 <td>Handler method for the "int" end tag.</td>
101 </tr><tr>
102 <td><a href="#XMLHandlerBase.endList">endList</a></td>
103 <td>Handler method for the "list" end tag.</td>
104 </tr><tr>
105 <td><a href="#XMLHandlerBase.endNone">endNone</a></td>
106 <td>Handler method for the "none" end tag.</td>
107 </tr><tr>
108 <td><a href="#XMLHandlerBase.endPickle">endPickle</a></td>
109 <td>Handler method for the "pickle" end tag.</td>
110 </tr><tr>
111 <td><a href="#XMLHandlerBase.endSet">endSet</a></td>
112 <td>Handler method for the "set" end tag.</td>
113 </tr><tr>
114 <td><a href="#XMLHandlerBase.endString">endString</a></td>
115 <td>Handler method for the "string" end tag.</td>
116 </tr><tr>
117 <td><a href="#XMLHandlerBase.endTuple">endTuple</a></td>
118 <td>Handler method for the "tuple" end tag.</td>
119 </tr><tr>
120 <td><a href="#XMLHandlerBase.startDictionary">startDictionary</a></td>
121 <td>Handler method for the "dictionary" start tag.</td>
122 </tr><tr>
123 <td><a href="#XMLHandlerBase.startDocument">startDocument</a></td>
124 <td>Handler called, when the document parsing is started.</td>
125 </tr><tr>
126 <td><a href="#XMLHandlerBase.startElement">startElement</a></td>
127 <td>Handler called, when a starting tag is found.</td>
128 </tr><tr>
129 <td><a href="#XMLHandlerBase.startFrozenset">startFrozenset</a></td>
130 <td>Handler method for the "frozenset" start tag.</td>
131 </tr><tr>
132 <td><a href="#XMLHandlerBase.startList">startList</a></td>
133 <td>Handler method for the "list" start tag.</td>
134 </tr><tr>
135 <td><a href="#XMLHandlerBase.startPickle">startPickle</a></td>
136 <td>Handler method for the "pickle" start tag.</td>
137 </tr><tr>
138 <td><a href="#XMLHandlerBase.startSet">startSet</a></td>
139 <td>Handler method for the "set" start tag.</td>
140 </tr><tr>
141 <td><a href="#XMLHandlerBase.startTuple">startTuple</a></td>
142 <td>Handler method for the "tuple" start tag.</td>
143 </tr><tr>
144 <td><a href="#XMLHandlerBase.unescape">unescape</a></td>
145 <td>Public method used to unescape certain characters.</td>
146 </tr>
147 </table>
148 <a NAME="XMLHandlerBase.__init__" ID="XMLHandlerBase.__init__"></a>
149 <h4>XMLHandlerBase (Constructor)</h4>
150 <b>XMLHandlerBase</b>(<i></i>)
151 <p>
152 Constructor
153 </p><a NAME="XMLHandlerBase._prepareBasics" ID="XMLHandlerBase._prepareBasics"></a>
154 <h4>XMLHandlerBase._prepareBasics</h4>
155 <b>_prepareBasics</b>(<i></i>)
156 <p>
157 Protected method to prepare the parsing of XML for basic python types.
158 </p><a NAME="XMLHandlerBase.characters" ID="XMLHandlerBase.characters"></a>
159 <h4>XMLHandlerBase.characters</h4>
160 <b>characters</b>(<i>chars</i>)
161 <p>
162 Handler called for ordinary text.
163 </p><dl>
164 <dt><i>chars</i></dt>
165 <dd>
166 the scanned text (string)
167 </dd>
168 </dl><a NAME="XMLHandlerBase.decodedNewLines" ID="XMLHandlerBase.decodedNewLines"></a>
169 <h4>XMLHandlerBase.decodedNewLines</h4>
170 <b>decodedNewLines</b>(<i>text</i>)
171 <p>
172 Public method to decode newlines and paragraph breaks.
173 </p><dl>
174 <dt><i>text</i></dt>
175 <dd>
176 text to decode (string)
177 </dd>
178 </dl><a NAME="XMLHandlerBase.defaultEndElement" ID="XMLHandlerBase.defaultEndElement"></a>
179 <h4>XMLHandlerBase.defaultEndElement</h4>
180 <b>defaultEndElement</b>(<i></i>)
181 <p>
182 Handler method for the common end tags.
183 </p><a NAME="XMLHandlerBase.defaultStartElement" ID="XMLHandlerBase.defaultStartElement"></a>
184 <h4>XMLHandlerBase.defaultStartElement</h4>
185 <b>defaultStartElement</b>(<i>attrs</i>)
186 <p>
187 Handler method for common start tags.
188 </p><dl>
189 <dt><i>attrs</i></dt>
190 <dd>
191 list of tag attributes
192 </dd>
193 </dl><a NAME="XMLHandlerBase.endBool" ID="XMLHandlerBase.endBool"></a>
194 <h4>XMLHandlerBase.endBool</h4>
195 <b>endBool</b>(<i></i>)
196 <p>
197 Handler method for the "bool" end tag.
198 </p><a NAME="XMLHandlerBase.endBytearray" ID="XMLHandlerBase.endBytearray"></a>
199 <h4>XMLHandlerBase.endBytearray</h4>
200 <b>endBytearray</b>(<i></i>)
201 <p>
202 Handler method for the "bytearray" end tag.
203 </p><a NAME="XMLHandlerBase.endBytes" ID="XMLHandlerBase.endBytes"></a>
204 <h4>XMLHandlerBase.endBytes</h4>
205 <b>endBytes</b>(<i></i>)
206 <p>
207 Handler method for the "bytes" end tag.
208 </p><a NAME="XMLHandlerBase.endComplex" ID="XMLHandlerBase.endComplex"></a>
209 <h4>XMLHandlerBase.endComplex</h4>
210 <b>endComplex</b>(<i></i>)
211 <p>
212 Handler method for the "complex" end tag.
213 </p><a NAME="XMLHandlerBase.endDictionary" ID="XMLHandlerBase.endDictionary"></a>
214 <h4>XMLHandlerBase.endDictionary</h4>
215 <b>endDictionary</b>(<i></i>)
216 <p>
217 Handler method for the "dictionary" end tag.
218 </p><a NAME="XMLHandlerBase.endElement" ID="XMLHandlerBase.endElement"></a>
219 <h4>XMLHandlerBase.endElement</h4>
220 <b>endElement</b>(<i>name</i>)
221 <p>
222 Handler called, when an ending tag is found.
223 </p><dl>
224 <dt><i>name</i></dt>
225 <dd>
226 name of the tag (string)
227 </dd>
228 </dl><a NAME="XMLHandlerBase.endFloat" ID="XMLHandlerBase.endFloat"></a>
229 <h4>XMLHandlerBase.endFloat</h4>
230 <b>endFloat</b>(<i></i>)
231 <p>
232 Handler method for the "float" end tag.
233 </p><a NAME="XMLHandlerBase.endFrozenset" ID="XMLHandlerBase.endFrozenset"></a>
234 <h4>XMLHandlerBase.endFrozenset</h4>
235 <b>endFrozenset</b>(<i></i>)
236 <p>
237 Handler method for the "frozenset" end tag.
238 </p><a NAME="XMLHandlerBase.endInt" ID="XMLHandlerBase.endInt"></a>
239 <h4>XMLHandlerBase.endInt</h4>
240 <b>endInt</b>(<i></i>)
241 <p>
242 Handler method for the "int" end tag.
243 </p><a NAME="XMLHandlerBase.endList" ID="XMLHandlerBase.endList"></a>
244 <h4>XMLHandlerBase.endList</h4>
245 <b>endList</b>(<i></i>)
246 <p>
247 Handler method for the "list" end tag.
248 </p><a NAME="XMLHandlerBase.endNone" ID="XMLHandlerBase.endNone"></a>
249 <h4>XMLHandlerBase.endNone</h4>
250 <b>endNone</b>(<i></i>)
251 <p>
252 Handler method for the "none" end tag.
253 </p><a NAME="XMLHandlerBase.endPickle" ID="XMLHandlerBase.endPickle"></a>
254 <h4>XMLHandlerBase.endPickle</h4>
255 <b>endPickle</b>(<i></i>)
256 <p>
257 Handler method for the "pickle" end tag.
258 </p><a NAME="XMLHandlerBase.endSet" ID="XMLHandlerBase.endSet"></a>
259 <h4>XMLHandlerBase.endSet</h4>
260 <b>endSet</b>(<i></i>)
261 <p>
262 Handler method for the "set" end tag.
263 </p><a NAME="XMLHandlerBase.endString" ID="XMLHandlerBase.endString"></a>
264 <h4>XMLHandlerBase.endString</h4>
265 <b>endString</b>(<i></i>)
266 <p>
267 Handler method for the "string" end tag.
268 </p><a NAME="XMLHandlerBase.endTuple" ID="XMLHandlerBase.endTuple"></a>
269 <h4>XMLHandlerBase.endTuple</h4>
270 <b>endTuple</b>(<i></i>)
271 <p>
272 Handler method for the "tuple" end tag.
273 </p><a NAME="XMLHandlerBase.startDictionary" ID="XMLHandlerBase.startDictionary"></a>
274 <h4>XMLHandlerBase.startDictionary</h4>
275 <b>startDictionary</b>(<i>attrs</i>)
276 <p>
277 Handler method for the "dictionary" start tag.
278 </p><dl>
279 <dt><i>attrs</i></dt>
280 <dd>
281 list of tag attributes
282 </dd>
283 </dl><a NAME="XMLHandlerBase.startDocument" ID="XMLHandlerBase.startDocument"></a>
284 <h4>XMLHandlerBase.startDocument</h4>
285 <b>startDocument</b>(<i></i>)
286 <p>
287 Handler called, when the document parsing is started.
288 </p><a NAME="XMLHandlerBase.startElement" ID="XMLHandlerBase.startElement"></a>
289 <h4>XMLHandlerBase.startElement</h4>
290 <b>startElement</b>(<i>name, attrs</i>)
291 <p>
292 Handler called, when a starting tag is found.
293 </p><dl>
294 <dt><i>name</i></dt>
295 <dd>
296 name of the tag (string)
297 </dd><dt><i>attrs</i></dt>
298 <dd>
299 list of tag attributes
300 </dd>
301 </dl><a NAME="XMLHandlerBase.startFrozenset" ID="XMLHandlerBase.startFrozenset"></a>
302 <h4>XMLHandlerBase.startFrozenset</h4>
303 <b>startFrozenset</b>(<i>attrs</i>)
304 <p>
305 Handler method for the "frozenset" start tag.
306 </p><dl>
307 <dt><i>attrs</i></dt>
308 <dd>
309 list of tag attributes
310 </dd>
311 </dl><a NAME="XMLHandlerBase.startList" ID="XMLHandlerBase.startList"></a>
312 <h4>XMLHandlerBase.startList</h4>
313 <b>startList</b>(<i>attrs</i>)
314 <p>
315 Handler method for the "list" start tag.
316 </p><dl>
317 <dt><i>attrs</i></dt>
318 <dd>
319 list of tag attributes
320 </dd>
321 </dl><a NAME="XMLHandlerBase.startPickle" ID="XMLHandlerBase.startPickle"></a>
322 <h4>XMLHandlerBase.startPickle</h4>
323 <b>startPickle</b>(<i>attrs</i>)
324 <p>
325 Handler method for the "pickle" start tag.
326 </p><dl>
327 <dt><i>attrs</i></dt>
328 <dd>
329 list of tag attributes
330 </dd>
331 </dl><a NAME="XMLHandlerBase.startSet" ID="XMLHandlerBase.startSet"></a>
332 <h4>XMLHandlerBase.startSet</h4>
333 <b>startSet</b>(<i>attrs</i>)
334 <p>
335 Handler method for the "set" start tag.
336 </p><dl>
337 <dt><i>attrs</i></dt>
338 <dd>
339 list of tag attributes
340 </dd>
341 </dl><a NAME="XMLHandlerBase.startTuple" ID="XMLHandlerBase.startTuple"></a>
342 <h4>XMLHandlerBase.startTuple</h4>
343 <b>startTuple</b>(<i>attrs</i>)
344 <p>
345 Handler method for the "tuple" start tag.
346 </p><dl>
347 <dt><i>attrs</i></dt>
348 <dd>
349 list of tag attributes
350 </dd>
351 </dl><a NAME="XMLHandlerBase.unescape" ID="XMLHandlerBase.unescape"></a>
352 <h4>XMLHandlerBase.unescape</h4>
353 <b>unescape</b>(<i>text, attribute = False</i>)
354 <p>
355 Public method used to unescape certain characters.
356 </p><dl>
357 <dt><i>text</i></dt>
358 <dd>
359 the text to unescape (string)
360 </dd><dt><i>attribute</i></dt>
361 <dd>
362 flag indicating unescaping is done for an attribute
363 </dd>
364 </dl>
365 <div align="right"><a href="#top">Up</a></div>
366 <hr />
367 </body></html>

Mercurial Repository: eric

eric ide

mercurial