Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 3673
e26d7d0c1088
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5XML.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><a NAME="top" ID="top"></a>
22 <h1>eric6.E5XML.XMLStreamReaderBase</h1>
23 <p>
24 Module implementing a base class for all of eric6s XML stream writers.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td>
34 <td>Class implementing a base class for all of eric6s XML stream readers.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a>
43 <h2>XMLStreamReaderBase</h2>
44 <p>
45 Class implementing a base class for all of eric6s XML stream readers.
46 </p>
47 <h3>Derived from</h3>
48 QXmlStreamReader
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#XMLStreamReaderBase.__readDict">__readDict</a></td>
64 <td>Private method to read a Python dictionary.</td>
65 </tr><tr>
66 <td><a href="#XMLStreamReaderBase.__readFrozenset">__readFrozenset</a></td>
67 <td>Private method to read a Python set.</td>
68 </tr><tr>
69 <td><a href="#XMLStreamReaderBase.__readList">__readList</a></td>
70 <td>Private method to read a Python list.</td>
71 </tr><tr>
72 <td><a href="#XMLStreamReaderBase.__readSet">__readSet</a></td>
73 <td>Private method to read a Python set.</td>
74 </tr><tr>
75 <td><a href="#XMLStreamReaderBase.__readTuple">__readTuple</a></td>
76 <td>Private method to read a Python tuple.</td>
77 </tr><tr>
78 <td><a href="#XMLStreamReaderBase._readBasics">_readBasics</a></td>
79 <td>Protected method to read an object of a basic Python type.</td>
80 </tr><tr>
81 <td><a href="#XMLStreamReaderBase._skipUnknownElement">_skipUnknownElement</a></td>
82 <td>Protected method to skip over all unknown elements.</td>
83 </tr><tr>
84 <td><a href="#XMLStreamReaderBase.attribute">attribute</a></td>
85 <td>Public method to read the given attribute of the current tag.</td>
86 </tr><tr>
87 <td><a href="#XMLStreamReaderBase.raiseBadValue">raiseBadValue</a></td>
88 <td>Public method to raise an error for a bad value.</td>
89 </tr><tr>
90 <td><a href="#XMLStreamReaderBase.raiseUnexpectedStartTag">raiseUnexpectedStartTag</a></td>
91 <td>Public method to raise an error for an unexpected start tag.</td>
92 </tr><tr>
93 <td><a href="#XMLStreamReaderBase.raiseUnsupportedFormatVersion">raiseUnsupportedFormatVersion</a></td>
94 <td>Public method to raise an error for an unsupported file format version.</td>
95 </tr><tr>
96 <td><a href="#XMLStreamReaderBase.readXML">readXML</a></td>
97 <td>Public method to read and parse the XML document.</td>
98 </tr><tr>
99 <td><a href="#XMLStreamReaderBase.showErrorMessage">showErrorMessage</a></td>
100 <td>Public method to show an error message.</td>
101 </tr><tr>
102 <td><a href="#XMLStreamReaderBase.toBool">toBool</a></td>
103 <td>Public method to convert the given value to bool.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a>
111 <h4>XMLStreamReaderBase (Constructor)</h4>
112 <b>XMLStreamReaderBase</b>(<i>device</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>device</i></dt>
117 <dd>
118 reference to the I/O device to read from (QIODevice)
119 </dd>
120 </dl><a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
121 <h4>XMLStreamReaderBase.__readDict</h4>
122 <b>__readDict</b>(<i></i>)
123 <p>
124 Private method to read a Python dictionary.
125 </p><dl>
126 <dt>Returns:</dt>
127 <dd>
128 Python dictionary
129 </dd>
130 </dl><a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
131 <h4>XMLStreamReaderBase.__readFrozenset</h4>
132 <b>__readFrozenset</b>(<i></i>)
133 <p>
134 Private method to read a Python set.
135 </p><dl>
136 <dt>Returns:</dt>
137 <dd>
138 Python set
139 </dd>
140 </dl><a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
141 <h4>XMLStreamReaderBase.__readList</h4>
142 <b>__readList</b>(<i></i>)
143 <p>
144 Private method to read a Python list.
145 </p><dl>
146 <dt>Returns:</dt>
147 <dd>
148 Python list
149 </dd>
150 </dl><a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
151 <h4>XMLStreamReaderBase.__readSet</h4>
152 <b>__readSet</b>(<i></i>)
153 <p>
154 Private method to read a Python set.
155 </p><dl>
156 <dt>Returns:</dt>
157 <dd>
158 Python set
159 </dd>
160 </dl><a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
161 <h4>XMLStreamReaderBase.__readTuple</h4>
162 <b>__readTuple</b>(<i></i>)
163 <p>
164 Private method to read a Python tuple.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 Python tuple
169 </dd>
170 </dl><a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
171 <h4>XMLStreamReaderBase._readBasics</h4>
172 <b>_readBasics</b>(<i></i>)
173 <p>
174 Protected method to read an object of a basic Python type.
175 </p><dl>
176 <dt>Returns:</dt>
177 <dd>
178 Python object read
179 </dd>
180 </dl><a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
181 <h4>XMLStreamReaderBase._skipUnknownElement</h4>
182 <b>_skipUnknownElement</b>(<i></i>)
183 <p>
184 Protected method to skip over all unknown elements.
185 </p><a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
186 <h4>XMLStreamReaderBase.attribute</h4>
187 <b>attribute</b>(<i>name, default=""</i>)
188 <p>
189 Public method to read the given attribute of the current tag.
190 </p><dl>
191 <dt><i>name</i></dt>
192 <dd>
193 name of the attribute (string)
194 </dd><dt><i>default</i></dt>
195 <dd>
196 default value (string)
197 </dd>
198 </dl><dl>
199 <dt>Returns:</dt>
200 <dd>
201 value of the requested tag attribute (string)
202 </dd>
203 </dl><a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
204 <h4>XMLStreamReaderBase.raiseBadValue</h4>
205 <b>raiseBadValue</b>(<i>value</i>)
206 <p>
207 Public method to raise an error for a bad value.
208 </p><dl>
209 <dt><i>value</i></dt>
210 <dd>
211 bad value (string)
212 </dd>
213 </dl><a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
214 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4>
215 <b>raiseUnexpectedStartTag</b>(<i>tag</i>)
216 <p>
217 Public method to raise an error for an unexpected start tag.
218 </p><dl>
219 <dt><i>tag</i></dt>
220 <dd>
221 name of the unexpected tag (string)
222 </dd>
223 </dl><a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
224 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4>
225 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>)
226 <p>
227 Public method to raise an error for an unsupported file format version.
228 </p><dl>
229 <dt><i>version</i></dt>
230 <dd>
231 unsupported version (string)
232 </dd>
233 </dl><a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
234 <h4>XMLStreamReaderBase.readXML</h4>
235 <b>readXML</b>(<i></i>)
236 <p>
237 Public method to read and parse the XML document.
238 </p><a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
239 <h4>XMLStreamReaderBase.showErrorMessage</h4>
240 <b>showErrorMessage</b>(<i></i>)
241 <p>
242 Public method to show an error message.
243 </p><a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
244 <h4>XMLStreamReaderBase.toBool</h4>
245 <b>toBool</b>(<i>value</i>)
246 <p>
247 Public method to convert the given value to bool.
248 </p><dl>
249 <dt><i>value</i></dt>
250 <dd>
251 value to be converted ("True", "False", "1", "0")
252 </dd>
253 </dl><dl>
254 <dt>Returns:</dt>
255 <dd>
256 converted value (boolean) or None in case of an error
257 </dd>
258 </dl>
259 <div align="right"><a href="#top">Up</a></div>
260 <hr />
261 </body></html>

Mercurial Repository: eric

eric ide

mercurial