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