Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5XML.XMLStreamReaderBase.html

eric6/Documentation/Source/eric6.E5XML.XMLStreamReaderBase.html

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

Mercurial Repository: eric

eric ide

mercurial