Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10423
299802979277
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricXML.XMLStreamReaderBase</h1> 9 <h1>eric7.EricXML.XMLStreamReaderBase</h1>
10
11 <p> 10 <p>
12 Module implementing a base class for all of eric7s XML stream writers. 11 Module implementing a base class for all of eric7s XML stream writers.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td> 22 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td>
25 <td>Class implementing a base class for all of eric7s XML stream readers.</td> 23 <td>Class implementing a base class for all of eric7s XML stream readers.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a> 34 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a>
36 <h2>XMLStreamReaderBase</h2> 35 <h2>XMLStreamReaderBase</h2>
37
38 <p> 36 <p>
39 Class implementing a base class for all of eric7s XML stream readers. 37 Class implementing a base class for all of eric7s XML stream readers.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QXmlStreamReader 41 QXmlStreamReader
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td> 55 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
113 <tr> 110 <tr>
114 <td><a href="#XMLStreamReaderBase.toBool">toBool</a></td> 111 <td><a href="#XMLStreamReaderBase.toBool">toBool</a></td>
115 <td>Public method to convert the given value to bool.</td> 112 <td>Public method to convert the given value to bool.</td>
116 </tr> 113 </tr>
117 </table> 114 </table>
115
118 <h3>Static Methods</h3> 116 <h3>Static Methods</h3>
119 117 <table>
120 <table> 118 <tr><td>None</td></tr>
121 <tr><td>None</td></tr> 119 </table>
122 </table> 120
123 121
124 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a> 122 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a>
125 <h4>XMLStreamReaderBase (Constructor)</h4> 123 <h4>XMLStreamReaderBase (Constructor)</h4>
126 <b>XMLStreamReaderBase</b>(<i>device</i>) 124 <b>XMLStreamReaderBase</b>(<i>device</i>)
127
128 <p> 125 <p>
129 Constructor 126 Constructor
130 </p> 127 </p>
128
131 <dl> 129 <dl>
132 130
133 <dt><i>device</i> (QIODevice)</dt> 131 <dt><i>device</i> (QIODevice)</dt>
134 <dd> 132 <dd>
135 reference to the I/O device to read from 133 reference to the I/O device to read from
136 </dd> 134 </dd>
137 </dl> 135 </dl>
138 <a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a> 136 <a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
139 <h4>XMLStreamReaderBase.__readDict</h4> 137 <h4>XMLStreamReaderBase.__readDict</h4>
140 <b>__readDict</b>(<i></i>) 138 <b>__readDict</b>(<i></i>)
141
142 <p> 139 <p>
143 Private method to read a Python dictionary. 140 Private method to read a Python dictionary.
144 </p> 141 </p>
142
145 <dl> 143 <dl>
146 <dt>Return:</dt> 144 <dt>Return:</dt>
147 <dd> 145 <dd>
148 Python dictionary 146 Python dictionary
149 </dd> 147 </dd>
155 </dd> 153 </dd>
156 </dl> 154 </dl>
157 <a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a> 155 <a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
158 <h4>XMLStreamReaderBase.__readFrozenset</h4> 156 <h4>XMLStreamReaderBase.__readFrozenset</h4>
159 <b>__readFrozenset</b>(<i></i>) 157 <b>__readFrozenset</b>(<i></i>)
160
161 <p> 158 <p>
162 Private method to read a Python frozenset. 159 Private method to read a Python frozenset.
163 </p> 160 </p>
161
164 <dl> 162 <dl>
165 <dt>Return:</dt> 163 <dt>Return:</dt>
166 <dd> 164 <dd>
167 Python frozenset 165 Python frozenset
168 </dd> 166 </dd>
174 </dd> 172 </dd>
175 </dl> 173 </dl>
176 <a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a> 174 <a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
177 <h4>XMLStreamReaderBase.__readList</h4> 175 <h4>XMLStreamReaderBase.__readList</h4>
178 <b>__readList</b>(<i></i>) 176 <b>__readList</b>(<i></i>)
179
180 <p> 177 <p>
181 Private method to read a Python list. 178 Private method to read a Python list.
182 </p> 179 </p>
180
183 <dl> 181 <dl>
184 <dt>Return:</dt> 182 <dt>Return:</dt>
185 <dd> 183 <dd>
186 Python list 184 Python list
187 </dd> 185 </dd>
193 </dd> 191 </dd>
194 </dl> 192 </dl>
195 <a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a> 193 <a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
196 <h4>XMLStreamReaderBase.__readSet</h4> 194 <h4>XMLStreamReaderBase.__readSet</h4>
197 <b>__readSet</b>(<i></i>) 195 <b>__readSet</b>(<i></i>)
198
199 <p> 196 <p>
200 Private method to read a Python set. 197 Private method to read a Python set.
201 </p> 198 </p>
199
202 <dl> 200 <dl>
203 <dt>Return:</dt> 201 <dt>Return:</dt>
204 <dd> 202 <dd>
205 Python set 203 Python set
206 </dd> 204 </dd>
212 </dd> 210 </dd>
213 </dl> 211 </dl>
214 <a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a> 212 <a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
215 <h4>XMLStreamReaderBase.__readTuple</h4> 213 <h4>XMLStreamReaderBase.__readTuple</h4>
216 <b>__readTuple</b>(<i></i>) 214 <b>__readTuple</b>(<i></i>)
217
218 <p> 215 <p>
219 Private method to read a Python tuple. 216 Private method to read a Python tuple.
220 </p> 217 </p>
218
221 <dl> 219 <dl>
222 <dt>Return:</dt> 220 <dt>Return:</dt>
223 <dd> 221 <dd>
224 Python tuple 222 Python tuple
225 </dd> 223 </dd>
231 </dd> 229 </dd>
232 </dl> 230 </dl>
233 <a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a> 231 <a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
234 <h4>XMLStreamReaderBase._readBasics</h4> 232 <h4>XMLStreamReaderBase._readBasics</h4>
235 <b>_readBasics</b>(<i></i>) 233 <b>_readBasics</b>(<i></i>)
236
237 <p> 234 <p>
238 Protected method to read an object of a basic Python type. 235 Protected method to read an object of a basic Python type.
239 </p> 236 </p>
237
240 <dl> 238 <dl>
241 <dt>Return:</dt> 239 <dt>Return:</dt>
242 <dd> 240 <dd>
243 Python object read 241 Python object read
244 </dd> 242 </dd>
250 </dd> 248 </dd>
251 </dl> 249 </dl>
252 <a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a> 250 <a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
253 <h4>XMLStreamReaderBase._skipUnknownElement</h4> 251 <h4>XMLStreamReaderBase._skipUnknownElement</h4>
254 <b>_skipUnknownElement</b>(<i></i>) 252 <b>_skipUnknownElement</b>(<i></i>)
255
256 <p> 253 <p>
257 Protected method to skip over all unknown elements. 254 Protected method to skip over all unknown elements.
258 </p> 255 </p>
256
259 <a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a> 257 <a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
260 <h4>XMLStreamReaderBase.attribute</h4> 258 <h4>XMLStreamReaderBase.attribute</h4>
261 <b>attribute</b>(<i>name, default=""</i>) 259 <b>attribute</b>(<i>name, default=""</i>)
262
263 <p> 260 <p>
264 Public method to read the given attribute of the current tag. 261 Public method to read the given attribute of the current tag.
265 </p> 262 </p>
263
266 <dl> 264 <dl>
267 265
268 <dt><i>name</i> (str)</dt> 266 <dt><i>name</i> (str)</dt>
269 <dd> 267 <dd>
270 name of the attribute 268 name of the attribute
287 </dd> 285 </dd>
288 </dl> 286 </dl>
289 <a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a> 287 <a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
290 <h4>XMLStreamReaderBase.raiseBadValue</h4> 288 <h4>XMLStreamReaderBase.raiseBadValue</h4>
291 <b>raiseBadValue</b>(<i>value</i>) 289 <b>raiseBadValue</b>(<i>value</i>)
292
293 <p> 290 <p>
294 Public method to raise an error for a bad value. 291 Public method to raise an error for a bad value.
295 </p> 292 </p>
293
296 <dl> 294 <dl>
297 295
298 <dt><i>value</i> (str)</dt> 296 <dt><i>value</i> (str)</dt>
299 <dd> 297 <dd>
300 bad value 298 bad value
301 </dd> 299 </dd>
302 </dl> 300 </dl>
303 <a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a> 301 <a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
304 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4> 302 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4>
305 <b>raiseUnexpectedStartTag</b>(<i>tag</i>) 303 <b>raiseUnexpectedStartTag</b>(<i>tag</i>)
306
307 <p> 304 <p>
308 Public method to raise an error for an unexpected start tag. 305 Public method to raise an error for an unexpected start tag.
309 </p> 306 </p>
307
310 <dl> 308 <dl>
311 309
312 <dt><i>tag</i> (str)</dt> 310 <dt><i>tag</i> (str)</dt>
313 <dd> 311 <dd>
314 name of the unexpected tag 312 name of the unexpected tag
315 </dd> 313 </dd>
316 </dl> 314 </dl>
317 <a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a> 315 <a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
318 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4> 316 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4>
319 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>) 317 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>)
320
321 <p> 318 <p>
322 Public method to raise an error for an unsupported file format version. 319 Public method to raise an error for an unsupported file format version.
323 </p> 320 </p>
321
324 <dl> 322 <dl>
325 323
326 <dt><i>version</i> (str)</dt> 324 <dt><i>version</i> (str)</dt>
327 <dd> 325 <dd>
328 unsupported version 326 unsupported version
329 </dd> 327 </dd>
330 </dl> 328 </dl>
331 <a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a> 329 <a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
332 <h4>XMLStreamReaderBase.readXML</h4> 330 <h4>XMLStreamReaderBase.readXML</h4>
333 <b>readXML</b>(<i></i>) 331 <b>readXML</b>(<i></i>)
334
335 <p> 332 <p>
336 Public method to read and parse the XML document. 333 Public method to read and parse the XML document.
337 </p> 334 </p>
335
338 <a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a> 336 <a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
339 <h4>XMLStreamReaderBase.showErrorMessage</h4> 337 <h4>XMLStreamReaderBase.showErrorMessage</h4>
340 <b>showErrorMessage</b>(<i></i>) 338 <b>showErrorMessage</b>(<i></i>)
341
342 <p> 339 <p>
343 Public method to show an error message. 340 Public method to show an error message.
344 </p> 341 </p>
342
345 <a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a> 343 <a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
346 <h4>XMLStreamReaderBase.toBool</h4> 344 <h4>XMLStreamReaderBase.toBool</h4>
347 <b>toBool</b>(<i>value</i>) 345 <b>toBool</b>(<i>value</i>)
348
349 <p> 346 <p>
350 Public method to convert the given value to bool. 347 Public method to convert the given value to bool.
351 </p> 348 </p>
349
352 <dl> 350 <dl>
353 351
354 <dt><i>value</i> (str)</dt> 352 <dt><i>value</i> (str)</dt>
355 <dd> 353 <dd>
356 value to be converted ("True", "False", "1", "0") 354 value to be converted ("True", "False", "1", "0")

Mercurial Repository: eric

eric ide

mercurial