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