← Back to branch summary

~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.XML.XMLHandlerBase.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
eric/Documentation/Source/eric4.XML.XMLHandlerBase.html
 
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>eric4.XML.XMLHandlerBase</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.XML.XMLHandlerBase</h1>
 
24
<p>
 
25
Module implementing a base class for all of eric4s XML handlers.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#XMLHandlerBase">XMLHandlerBase</a></td>
 
31
<td>Class implementing the base class for al of eric4s XML handlers.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="XMLHandlerBase" ID="XMLHandlerBase"></a>
 
40
<h2>XMLHandlerBase</h2>
 
41
<p>
 
42
    Class implementing the base class for al of eric4s XML handlers.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
ContentHandler
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#XMLHandlerBase.__init__">XMLHandlerBase</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#XMLHandlerBase._prepareBasics">_prepareBasics</a></td>
 
53
<td>Protected method to prepare the parsing of XML for basic python types.</td>
 
54
</tr><tr>
 
55
<td><a href="#XMLHandlerBase.characters">characters</a></td>
 
56
<td>Handler called for ordinary text.</td>
 
57
</tr><tr>
 
58
<td><a href="#XMLHandlerBase.defaultEndElement">defaultEndElement</a></td>
 
59
<td>Handler method for the common end tags.</td>
 
60
</tr><tr>
 
61
<td><a href="#XMLHandlerBase.defaultStartElement">defaultStartElement</a></td>
 
62
<td>Handler method for common start tags.</td>
 
63
</tr><tr>
 
64
<td><a href="#XMLHandlerBase.endBool">endBool</a></td>
 
65
<td>Handler method for the "bool" end tag.</td>
 
66
</tr><tr>
 
67
<td><a href="#XMLHandlerBase.endComplex">endComplex</a></td>
 
68
<td>Handler method for the "complex" end tag.</td>
 
69
</tr><tr>
 
70
<td><a href="#XMLHandlerBase.endDictionary">endDictionary</a></td>
 
71
<td>Handler method for the "dictionary" end tag.</td>
 
72
</tr><tr>
 
73
<td><a href="#XMLHandlerBase.endElement">endElement</a></td>
 
74
<td>Handler called, when an ending tag is found.</td>
 
75
</tr><tr>
 
76
<td><a href="#XMLHandlerBase.endFloat">endFloat</a></td>
 
77
<td>Handler method for the "float" end tag.</td>
 
78
</tr><tr>
 
79
<td><a href="#XMLHandlerBase.endInt">endInt</a></td>
 
80
<td>Handler method for the "int" end tag.</td>
 
81
</tr><tr>
 
82
<td><a href="#XMLHandlerBase.endList">endList</a></td>
 
83
<td>Handler method for the "list" end tag.</td>
 
84
</tr><tr>
 
85
<td><a href="#XMLHandlerBase.endLong">endLong</a></td>
 
86
<td>Handler method for the "long" end tag.</td>
 
87
</tr><tr>
 
88
<td><a href="#XMLHandlerBase.endNone">endNone</a></td>
 
89
<td>Handler method for the "none" end tag.</td>
 
90
</tr><tr>
 
91
<td><a href="#XMLHandlerBase.endPickle">endPickle</a></td>
 
92
<td>Handler method for the "pickle" end tag.</td>
 
93
</tr><tr>
 
94
<td><a href="#XMLHandlerBase.endString">endString</a></td>
 
95
<td>Handler method for the "string" end tag.</td>
 
96
</tr><tr>
 
97
<td><a href="#XMLHandlerBase.endTuple">endTuple</a></td>
 
98
<td>Handler method for the "tuple" end tag.</td>
 
99
</tr><tr>
 
100
<td><a href="#XMLHandlerBase.endUnicode">endUnicode</a></td>
 
101
<td>Handler method for the "unicode" end tag.</td>
 
102
</tr><tr>
 
103
<td><a href="#XMLHandlerBase.startDictionary">startDictionary</a></td>
 
104
<td>Handler method for the "dictionary" start tag.</td>
 
105
</tr><tr>
 
106
<td><a href="#XMLHandlerBase.startDocument">startDocument</a></td>
 
107
<td>Handler called, when the document parsing is started.</td>
 
108
</tr><tr>
 
109
<td><a href="#XMLHandlerBase.startElement">startElement</a></td>
 
110
<td>Handler called, when a starting tag is found.</td>
 
111
</tr><tr>
 
112
<td><a href="#XMLHandlerBase.startList">startList</a></td>
 
113
<td>Handler method for the "list" start tag.</td>
 
114
</tr><tr>
 
115
<td><a href="#XMLHandlerBase.startPickle">startPickle</a></td>
 
116
<td>Handler method for the "pickle" start tag.</td>
 
117
</tr><tr>
 
118
<td><a href="#XMLHandlerBase.startTuple">startTuple</a></td>
 
119
<td>Handler method for the "tuple" start tag.</td>
 
120
</tr><tr>
 
121
<td><a href="#XMLHandlerBase.unescape">unescape</a></td>
 
122
<td>Public method used to unescape certain characters.</td>
 
123
</tr><tr>
 
124
<td><a href="#XMLHandlerBase.utf8_to_code">utf8_to_code</a></td>
 
125
<td>Public method to convert a string to unicode and encode it for XML.</td>
 
126
</tr>
 
127
</table>
 
128
<p><a NAME="XMLHandlerBase.__init__" ID="XMLHandlerBase.__init__"></a>
 
129
<h4>XMLHandlerBase (Constructor)</h4>
 
130
<b>XMLHandlerBase</b>(<i></i>)
 
131
<p>
 
132
        Constructor
 
133
</p><a NAME="XMLHandlerBase._prepareBasics" ID="XMLHandlerBase._prepareBasics"></a>
 
134
<h4>XMLHandlerBase._prepareBasics</h4>
 
135
<b>_prepareBasics</b>(<i></i>)
 
136
<p>
 
137
        Protected method to prepare the parsing of XML for basic python types.
 
138
</p><a NAME="XMLHandlerBase.characters" ID="XMLHandlerBase.characters"></a>
 
139
<h4>XMLHandlerBase.characters</h4>
 
140
<b>characters</b>(<i>chars</i>)
 
141
<p>
 
142
        Handler called for ordinary text.
 
143
</p><dl>
 
144
<dt><i>chars</i></dt>
 
145
<dd>
 
146
the scanned text (string)
 
147
</dd>
 
148
</dl><a NAME="XMLHandlerBase.defaultEndElement" ID="XMLHandlerBase.defaultEndElement"></a>
 
149
<h4>XMLHandlerBase.defaultEndElement</h4>
 
150
<b>defaultEndElement</b>(<i></i>)
 
151
<p>
 
152
        Handler method for the common end tags.
 
153
</p><a NAME="XMLHandlerBase.defaultStartElement" ID="XMLHandlerBase.defaultStartElement"></a>
 
154
<h4>XMLHandlerBase.defaultStartElement</h4>
 
155
<b>defaultStartElement</b>(<i>attrs</i>)
 
156
<p>
 
157
        Handler method for common start tags.
 
158
</p><dl>
 
159
<dt><i>attrs</i></dt>
 
160
<dd>
 
161
list of tag attributes
 
162
</dd>
 
163
</dl><a NAME="XMLHandlerBase.endBool" ID="XMLHandlerBase.endBool"></a>
 
164
<h4>XMLHandlerBase.endBool</h4>
 
165
<b>endBool</b>(<i></i>)
 
166
<p>
 
167
        Handler method for the "bool" end tag.
 
168
</p><a NAME="XMLHandlerBase.endComplex" ID="XMLHandlerBase.endComplex"></a>
 
169
<h4>XMLHandlerBase.endComplex</h4>
 
170
<b>endComplex</b>(<i></i>)
 
171
<p>
 
172
        Handler method for the "complex" end tag.
 
173
</p><a NAME="XMLHandlerBase.endDictionary" ID="XMLHandlerBase.endDictionary"></a>
 
174
<h4>XMLHandlerBase.endDictionary</h4>
 
175
<b>endDictionary</b>(<i></i>)
 
176
<p>
 
177
        Handler method for the "dictionary" end tag.
 
178
</p><a NAME="XMLHandlerBase.endElement" ID="XMLHandlerBase.endElement"></a>
 
179
<h4>XMLHandlerBase.endElement</h4>
 
180
<b>endElement</b>(<i>name</i>)
 
181
<p>
 
182
        Handler called, when an ending tag is found.
 
183
</p><dl>
 
184
<dt><i>name</i></dt>
 
185
<dd>
 
186
name of the tag (string)
 
187
</dd>
 
188
</dl><a NAME="XMLHandlerBase.endFloat" ID="XMLHandlerBase.endFloat"></a>
 
189
<h4>XMLHandlerBase.endFloat</h4>
 
190
<b>endFloat</b>(<i></i>)
 
191
<p>
 
192
        Handler method for the "float" end tag.
 
193
</p><a NAME="XMLHandlerBase.endInt" ID="XMLHandlerBase.endInt"></a>
 
194
<h4>XMLHandlerBase.endInt</h4>
 
195
<b>endInt</b>(<i></i>)
 
196
<p>
 
197
        Handler method for the "int" end tag.
 
198
</p><a NAME="XMLHandlerBase.endList" ID="XMLHandlerBase.endList"></a>
 
199
<h4>XMLHandlerBase.endList</h4>
 
200
<b>endList</b>(<i></i>)
 
201
<p>
 
202
        Handler method for the "list" end tag.
 
203
</p><a NAME="XMLHandlerBase.endLong" ID="XMLHandlerBase.endLong"></a>
 
204
<h4>XMLHandlerBase.endLong</h4>
 
205
<b>endLong</b>(<i></i>)
 
206
<p>
 
207
        Handler method for the "long" end tag.
 
208
</p><a NAME="XMLHandlerBase.endNone" ID="XMLHandlerBase.endNone"></a>
 
209
<h4>XMLHandlerBase.endNone</h4>
 
210
<b>endNone</b>(<i></i>)
 
211
<p>
 
212
        Handler method for the "none" end tag.
 
213
</p><a NAME="XMLHandlerBase.endPickle" ID="XMLHandlerBase.endPickle"></a>
 
214
<h4>XMLHandlerBase.endPickle</h4>
 
215
<b>endPickle</b>(<i></i>)
 
216
<p>
 
217
        Handler method for the "pickle" end tag.
 
218
</p><a NAME="XMLHandlerBase.endString" ID="XMLHandlerBase.endString"></a>
 
219
<h4>XMLHandlerBase.endString</h4>
 
220
<b>endString</b>(<i></i>)
 
221
<p>
 
222
        Handler method for the "string" end tag.
 
223
</p><a NAME="XMLHandlerBase.endTuple" ID="XMLHandlerBase.endTuple"></a>
 
224
<h4>XMLHandlerBase.endTuple</h4>
 
225
<b>endTuple</b>(<i></i>)
 
226
<p>
 
227
        Handler method for the "tuple" end tag.
 
228
</p><a NAME="XMLHandlerBase.endUnicode" ID="XMLHandlerBase.endUnicode"></a>
 
229
<h4>XMLHandlerBase.endUnicode</h4>
 
230
<b>endUnicode</b>(<i></i>)
 
231
<p>
 
232
        Handler method for the "unicode" end tag.
 
233
</p><a NAME="XMLHandlerBase.startDictionary" ID="XMLHandlerBase.startDictionary"></a>
 
234
<h4>XMLHandlerBase.startDictionary</h4>
 
235
<b>startDictionary</b>(<i>attrs</i>)
 
236
<p>
 
237
        Handler method for the "dictionary" start tag.
 
238
</p><dl>
 
239
<dt><i>attrs</i></dt>
 
240
<dd>
 
241
list of tag attributes
 
242
</dd>
 
243
</dl><a NAME="XMLHandlerBase.startDocument" ID="XMLHandlerBase.startDocument"></a>
 
244
<h4>XMLHandlerBase.startDocument</h4>
 
245
<b>startDocument</b>(<i></i>)
 
246
<p>
 
247
        Handler called, when the document parsing is started.
 
248
</p><a NAME="XMLHandlerBase.startElement" ID="XMLHandlerBase.startElement"></a>
 
249
<h4>XMLHandlerBase.startElement</h4>
 
250
<b>startElement</b>(<i>name, attrs</i>)
 
251
<p>
 
252
        Handler called, when a starting tag is found.
 
253
</p><dl>
 
254
<dt><i>name</i></dt>
 
255
<dd>
 
256
name of the tag (string)
 
257
</dd><dt><i>attrs</i></dt>
 
258
<dd>
 
259
list of tag attributes
 
260
</dd>
 
261
</dl><a NAME="XMLHandlerBase.startList" ID="XMLHandlerBase.startList"></a>
 
262
<h4>XMLHandlerBase.startList</h4>
 
263
<b>startList</b>(<i>attrs</i>)
 
264
<p>
 
265
        Handler method for the "list" start tag.
 
266
</p><dl>
 
267
<dt><i>attrs</i></dt>
 
268
<dd>
 
269
list of tag attributes
 
270
</dd>
 
271
</dl><a NAME="XMLHandlerBase.startPickle" ID="XMLHandlerBase.startPickle"></a>
 
272
<h4>XMLHandlerBase.startPickle</h4>
 
273
<b>startPickle</b>(<i>attrs</i>)
 
274
<p>
 
275
        Handler method for the "pickle" start tag.
 
276
</p><dl>
 
277
<dt><i>attrs</i></dt>
 
278
<dd>
 
279
list of tag attributes
 
280
</dd>
 
281
</dl><a NAME="XMLHandlerBase.startTuple" ID="XMLHandlerBase.startTuple"></a>
 
282
<h4>XMLHandlerBase.startTuple</h4>
 
283
<b>startTuple</b>(<i>attrs</i>)
 
284
<p>
 
285
        Handler method for the "tuple" start tag.
 
286
</p><dl>
 
287
<dt><i>attrs</i></dt>
 
288
<dd>
 
289
list of tag attributes
 
290
</dd>
 
291
</dl><a NAME="XMLHandlerBase.unescape" ID="XMLHandlerBase.unescape"></a>
 
292
<h4>XMLHandlerBase.unescape</h4>
 
293
<b>unescape</b>(<i>text, attribute = False</i>)
 
294
<p>
 
295
        Public method used to unescape certain characters.
 
296
</p><dl>
 
297
<dt><i>text</i></dt>
 
298
<dd>
 
299
the text to unescape (string)
 
300
</dd><dt><i>attribute</i></dt>
 
301
<dd>
 
302
flag indicating unescaping is done for an attribute
 
303
</dd>
 
304
</dl><a NAME="XMLHandlerBase.utf8_to_code" ID="XMLHandlerBase.utf8_to_code"></a>
 
305
<h4>XMLHandlerBase.utf8_to_code</h4>
 
306
<b>utf8_to_code</b>(<i>text</i>)
 
307
<p>
 
308
        Public method to convert a string to unicode and encode it for XML.
 
309
</p><dl>
 
310
<dt><i>text</i></dt>
 
311
<dd>
 
312
the text to encode (string)
 
313
</dd>
 
314
</dl></p>
 
315
<div align="right"><a href="#top">Up</a></div>
 
316
<hr />
 
317
</body></html>
 
 
b'\\ No newline at end of file'