Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.EricXML.XMLStreamReaderBase.html

eric7/Documentation/Source/eric7.EricXML.XMLStreamReaderBase.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricXML.XMLStreamReaderBase</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.EricXML.XMLStreamReaderBase</h1>
24
25 <p>
26 Module implementing a base class for all of eric7s XML stream writers.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td>
39 <td>Class implementing a base class for all of eric7s XML stream readers.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a>
50 <h2>XMLStreamReaderBase</h2>
51
52 <p>
53 Class implementing a base class for all of eric7s XML stream readers.
54 </p>
55 <h3>Derived from</h3>
56 QXmlStreamReader
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#XMLStreamReaderBase.__readDict">__readDict</a></td>
77 <td>Private method to read a Python dictionary.</td>
78 </tr>
79 <tr>
80 <td><a href="#XMLStreamReaderBase.__readFrozenset">__readFrozenset</a></td>
81 <td>Private method to read a Python set.</td>
82 </tr>
83 <tr>
84 <td><a href="#XMLStreamReaderBase.__readList">__readList</a></td>
85 <td>Private method to read a Python list.</td>
86 </tr>
87 <tr>
88 <td><a href="#XMLStreamReaderBase.__readSet">__readSet</a></td>
89 <td>Private method to read a Python set.</td>
90 </tr>
91 <tr>
92 <td><a href="#XMLStreamReaderBase.__readTuple">__readTuple</a></td>
93 <td>Private method to read a Python tuple.</td>
94 </tr>
95 <tr>
96 <td><a href="#XMLStreamReaderBase._readBasics">_readBasics</a></td>
97 <td>Protected method to read an object of a basic Python type.</td>
98 </tr>
99 <tr>
100 <td><a href="#XMLStreamReaderBase._skipUnknownElement">_skipUnknownElement</a></td>
101 <td>Protected method to skip over all unknown elements.</td>
102 </tr>
103 <tr>
104 <td><a href="#XMLStreamReaderBase.attribute">attribute</a></td>
105 <td>Public method to read the given attribute of the current tag.</td>
106 </tr>
107 <tr>
108 <td><a href="#XMLStreamReaderBase.raiseBadValue">raiseBadValue</a></td>
109 <td>Public method to raise an error for a bad value.</td>
110 </tr>
111 <tr>
112 <td><a href="#XMLStreamReaderBase.raiseUnexpectedStartTag">raiseUnexpectedStartTag</a></td>
113 <td>Public method to raise an error for an unexpected start tag.</td>
114 </tr>
115 <tr>
116 <td><a href="#XMLStreamReaderBase.raiseUnsupportedFormatVersion">raiseUnsupportedFormatVersion</a></td>
117 <td>Public method to raise an error for an unsupported file format version.</td>
118 </tr>
119 <tr>
120 <td><a href="#XMLStreamReaderBase.readXML">readXML</a></td>
121 <td>Public method to read and parse the XML document.</td>
122 </tr>
123 <tr>
124 <td><a href="#XMLStreamReaderBase.showErrorMessage">showErrorMessage</a></td>
125 <td>Public method to show an error message.</td>
126 </tr>
127 <tr>
128 <td><a href="#XMLStreamReaderBase.toBool">toBool</a></td>
129 <td>Public method to convert the given value to bool.</td>
130 </tr>
131 </table>
132 <h3>Static Methods</h3>
133
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137
138 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a>
139 <h4>XMLStreamReaderBase (Constructor)</h4>
140 <b>XMLStreamReaderBase</b>(<i>device</i>)
141
142 <p>
143 Constructor
144 </p>
145 <dl>
146
147 <dt><i>device</i></dt>
148 <dd>
149 reference to the I/O device to read from (QIODevice)
150 </dd>
151 </dl>
152 <a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
153 <h4>XMLStreamReaderBase.__readDict</h4>
154 <b>__readDict</b>(<i></i>)
155
156 <p>
157 Private method to read a Python dictionary.
158 </p>
159 <dl>
160 <dt>Return:</dt>
161 <dd>
162 Python dictionary
163 </dd>
164 </dl>
165 <a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
166 <h4>XMLStreamReaderBase.__readFrozenset</h4>
167 <b>__readFrozenset</b>(<i></i>)
168
169 <p>
170 Private method to read a Python set.
171 </p>
172 <dl>
173 <dt>Return:</dt>
174 <dd>
175 Python set
176 </dd>
177 </dl>
178 <a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
179 <h4>XMLStreamReaderBase.__readList</h4>
180 <b>__readList</b>(<i></i>)
181
182 <p>
183 Private method to read a Python list.
184 </p>
185 <dl>
186 <dt>Return:</dt>
187 <dd>
188 Python list
189 </dd>
190 </dl>
191 <a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
192 <h4>XMLStreamReaderBase.__readSet</h4>
193 <b>__readSet</b>(<i></i>)
194
195 <p>
196 Private method to read a Python set.
197 </p>
198 <dl>
199 <dt>Return:</dt>
200 <dd>
201 Python set
202 </dd>
203 </dl>
204 <a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
205 <h4>XMLStreamReaderBase.__readTuple</h4>
206 <b>__readTuple</b>(<i></i>)
207
208 <p>
209 Private method to read a Python tuple.
210 </p>
211 <dl>
212 <dt>Return:</dt>
213 <dd>
214 Python tuple
215 </dd>
216 </dl>
217 <a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
218 <h4>XMLStreamReaderBase._readBasics</h4>
219 <b>_readBasics</b>(<i></i>)
220
221 <p>
222 Protected method to read an object of a basic Python type.
223 </p>
224 <dl>
225 <dt>Return:</dt>
226 <dd>
227 Python object read
228 </dd>
229 </dl>
230 <a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
231 <h4>XMLStreamReaderBase._skipUnknownElement</h4>
232 <b>_skipUnknownElement</b>(<i></i>)
233
234 <p>
235 Protected method to skip over all unknown elements.
236 </p>
237 <a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
238 <h4>XMLStreamReaderBase.attribute</h4>
239 <b>attribute</b>(<i>name, default=""</i>)
240
241 <p>
242 Public method to read the given attribute of the current tag.
243 </p>
244 <dl>
245
246 <dt><i>name</i></dt>
247 <dd>
248 name of the attribute (string)
249 </dd>
250 <dt><i>default</i></dt>
251 <dd>
252 default value (string)
253 </dd>
254 </dl>
255 <dl>
256 <dt>Return:</dt>
257 <dd>
258 value of the requested tag attribute (string)
259 </dd>
260 </dl>
261 <a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
262 <h4>XMLStreamReaderBase.raiseBadValue</h4>
263 <b>raiseBadValue</b>(<i>value</i>)
264
265 <p>
266 Public method to raise an error for a bad value.
267 </p>
268 <dl>
269
270 <dt><i>value</i></dt>
271 <dd>
272 bad value (string)
273 </dd>
274 </dl>
275 <a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
276 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4>
277 <b>raiseUnexpectedStartTag</b>(<i>tag</i>)
278
279 <p>
280 Public method to raise an error for an unexpected start tag.
281 </p>
282 <dl>
283
284 <dt><i>tag</i></dt>
285 <dd>
286 name of the unexpected tag (string)
287 </dd>
288 </dl>
289 <a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
290 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4>
291 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>)
292
293 <p>
294 Public method to raise an error for an unsupported file format version.
295 </p>
296 <dl>
297
298 <dt><i>version</i></dt>
299 <dd>
300 unsupported version (string)
301 </dd>
302 </dl>
303 <a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
304 <h4>XMLStreamReaderBase.readXML</h4>
305 <b>readXML</b>(<i></i>)
306
307 <p>
308 Public method to read and parse the XML document.
309 </p>
310 <a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
311 <h4>XMLStreamReaderBase.showErrorMessage</h4>
312 <b>showErrorMessage</b>(<i></i>)
313
314 <p>
315 Public method to show an error message.
316 </p>
317 <a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
318 <h4>XMLStreamReaderBase.toBool</h4>
319 <b>toBool</b>(<i>value</i>)
320
321 <p>
322 Public method to convert the given value to bool.
323 </p>
324 <dl>
325
326 <dt><i>value</i></dt>
327 <dd>
328 value to be converted ("True", "False", "1", "0")
329 </dd>
330 </dl>
331 <dl>
332 <dt>Return:</dt>
333 <dd>
334 converted value (boolean) or None in case of an error
335 </dd>
336 </dl>
337 <div align="right"><a href="#top">Up</a></div>
338 <hr />
339 </body></html>

Mercurial Repository: eric

eric ide

mercurial