Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.E5XML.XMLStreamReaderBase.html

changeset 603
7f620c649182
child 615
c8dd16cc69ce
equal deleted inserted replaced
602:2f32aef5cc67 603:7f620c649182
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.E5XML.XMLStreamReaderBase</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.E5XML.XMLStreamReaderBase</h1>
24 <p>
25 Module implementing a base class for all of eric5s XML stream writers.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#XMLStreamReaderBase">XMLStreamReaderBase</a></td>
35 <td>Class implementing a base class for all of eric5s XML stream readers.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="XMLStreamReaderBase" ID="XMLStreamReaderBase"></a>
44 <h2>XMLStreamReaderBase</h2>
45 <p>
46 Class implementing a base class for all of eric5s XML stream readers.
47 </p>
48 <h3>Derived from</h3>
49 QXmlStreamReader
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#XMLStreamReaderBase.__init__">XMLStreamReaderBase</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#XMLStreamReaderBase.__readDict">__readDict</a></td>
61 <td>Private method to read a Python dictionary.</td>
62 </tr><tr>
63 <td><a href="#XMLStreamReaderBase.__readFrozenset">__readFrozenset</a></td>
64 <td>Private method to read a Python set.</td>
65 </tr><tr>
66 <td><a href="#XMLStreamReaderBase.__readList">__readList</a></td>
67 <td>Private method to read a Python list.</td>
68 </tr><tr>
69 <td><a href="#XMLStreamReaderBase.__readSet">__readSet</a></td>
70 <td>Private method to read a Python set.</td>
71 </tr><tr>
72 <td><a href="#XMLStreamReaderBase.__readTuple">__readTuple</a></td>
73 <td>Private method to read a Python tuple.</td>
74 </tr><tr>
75 <td><a href="#XMLStreamReaderBase._readBasics">_readBasics</a></td>
76 <td>Protected method to read an object of a basic Python type.</td>
77 </tr><tr>
78 <td><a href="#XMLStreamReaderBase._skipUnknownElement">_skipUnknownElement</a></td>
79 <td>Protected method to skip over all unknown elements.</td>
80 </tr><tr>
81 <td><a href="#XMLStreamReaderBase.attribute">attribute</a></td>
82 <td>Public method to read the given attribute of the current tag.</td>
83 </tr><tr>
84 <td><a href="#XMLStreamReaderBase.decodedNewLines">decodedNewLines</a></td>
85 <td>Public method to decode newlines and paragraph breaks.</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 <a NAME="XMLStreamReaderBase.__init__" ID="XMLStreamReaderBase.__init__"></a>
107 <h4>XMLStreamReaderBase (Constructor)</h4>
108 <b>XMLStreamReaderBase</b>(<i>device</i>)
109 <p>
110 Constructor
111 </p><dl>
112 <dt><i>device</i></dt>
113 <dd>
114 reference to the I/O device to read from (QIODevice)
115 </dd>
116 </dl><a NAME="XMLStreamReaderBase.__readDict" ID="XMLStreamReaderBase.__readDict"></a>
117 <h4>XMLStreamReaderBase.__readDict</h4>
118 <b>__readDict</b>(<i></i>)
119 <p>
120 Private method to read a Python dictionary.
121 </p><dl>
122 <dt>Returns:</dt>
123 <dd>
124 Python dictionary
125 </dd>
126 </dl><a NAME="XMLStreamReaderBase.__readFrozenset" ID="XMLStreamReaderBase.__readFrozenset"></a>
127 <h4>XMLStreamReaderBase.__readFrozenset</h4>
128 <b>__readFrozenset</b>(<i></i>)
129 <p>
130 Private method to read a Python set.
131 </p><dl>
132 <dt>Returns:</dt>
133 <dd>
134 Python set
135 </dd>
136 </dl><a NAME="XMLStreamReaderBase.__readList" ID="XMLStreamReaderBase.__readList"></a>
137 <h4>XMLStreamReaderBase.__readList</h4>
138 <b>__readList</b>(<i></i>)
139 <p>
140 Private method to read a Python list.
141 </p><dl>
142 <dt>Returns:</dt>
143 <dd>
144 Python list
145 </dd>
146 </dl><a NAME="XMLStreamReaderBase.__readSet" ID="XMLStreamReaderBase.__readSet"></a>
147 <h4>XMLStreamReaderBase.__readSet</h4>
148 <b>__readSet</b>(<i></i>)
149 <p>
150 Private method to read a Python set.
151 </p><dl>
152 <dt>Returns:</dt>
153 <dd>
154 Python set
155 </dd>
156 </dl><a NAME="XMLStreamReaderBase.__readTuple" ID="XMLStreamReaderBase.__readTuple"></a>
157 <h4>XMLStreamReaderBase.__readTuple</h4>
158 <b>__readTuple</b>(<i></i>)
159 <p>
160 Private method to read a Python tuple.
161 </p><dl>
162 <dt>Returns:</dt>
163 <dd>
164 Python tuple
165 </dd>
166 </dl><a NAME="XMLStreamReaderBase._readBasics" ID="XMLStreamReaderBase._readBasics"></a>
167 <h4>XMLStreamReaderBase._readBasics</h4>
168 <b>_readBasics</b>(<i></i>)
169 <p>
170 Protected method to read an object of a basic Python type.
171 </p><dl>
172 <dt>Returns:</dt>
173 <dd>
174 Python object read
175 </dd>
176 </dl><a NAME="XMLStreamReaderBase._skipUnknownElement" ID="XMLStreamReaderBase._skipUnknownElement"></a>
177 <h4>XMLStreamReaderBase._skipUnknownElement</h4>
178 <b>_skipUnknownElement</b>(<i></i>)
179 <p>
180 Protected method to skip over all unknown elements.
181 </p><a NAME="XMLStreamReaderBase.attribute" ID="XMLStreamReaderBase.attribute"></a>
182 <h4>XMLStreamReaderBase.attribute</h4>
183 <b>attribute</b>(<i>name, default = ""</i>)
184 <p>
185 Public method to read the given attribute of the current tag.
186 </p><dl>
187 <dt><i>name</i></dt>
188 <dd>
189 name of the attribute (string)
190 </dd><dt><i>default</i></dt>
191 <dd>
192 default value (string)
193 </dd>
194 </dl><a NAME="XMLStreamReaderBase.decodedNewLines" ID="XMLStreamReaderBase.decodedNewLines"></a>
195 <h4>XMLStreamReaderBase.decodedNewLines</h4>
196 <b>decodedNewLines</b>(<i>text</i>)
197 <p>
198 Public method to decode newlines and paragraph breaks.
199 </p><dl>
200 <dt><i>text</i></dt>
201 <dd>
202 text to decode (string)
203 </dd>
204 </dl><a NAME="XMLStreamReaderBase.raiseBadValue" ID="XMLStreamReaderBase.raiseBadValue"></a>
205 <h4>XMLStreamReaderBase.raiseBadValue</h4>
206 <b>raiseBadValue</b>(<i>value</i>)
207 <p>
208 Public method to raise an error for a bad value.
209 </p><dl>
210 <dt><i>value</i></dt>
211 <dd>
212 bad value (string)
213 </dd>
214 </dl><a NAME="XMLStreamReaderBase.raiseUnexpectedStartTag" ID="XMLStreamReaderBase.raiseUnexpectedStartTag"></a>
215 <h4>XMLStreamReaderBase.raiseUnexpectedStartTag</h4>
216 <b>raiseUnexpectedStartTag</b>(<i>tag</i>)
217 <p>
218 Public method to raise an error for an unexpected start tag.
219 </p><dl>
220 <dt><i>tag</i></dt>
221 <dd>
222 name of the unexpected tag (string)
223 </dd>
224 </dl><a NAME="XMLStreamReaderBase.raiseUnsupportedFormatVersion" ID="XMLStreamReaderBase.raiseUnsupportedFormatVersion"></a>
225 <h4>XMLStreamReaderBase.raiseUnsupportedFormatVersion</h4>
226 <b>raiseUnsupportedFormatVersion</b>(<i>version</i>)
227 <p>
228 Public method to raise an error for an unsupported file format version.
229 </p><dl>
230 <dt><i>version</i></dt>
231 <dd>
232 unsupported version (string)
233 </dd>
234 </dl><a NAME="XMLStreamReaderBase.readXML" ID="XMLStreamReaderBase.readXML"></a>
235 <h4>XMLStreamReaderBase.readXML</h4>
236 <b>readXML</b>(<i></i>)
237 <p>
238 Public method to read and parse the XML document.
239 </p><a NAME="XMLStreamReaderBase.showErrorMessage" ID="XMLStreamReaderBase.showErrorMessage"></a>
240 <h4>XMLStreamReaderBase.showErrorMessage</h4>
241 <b>showErrorMessage</b>(<i></i>)
242 <p>
243 Public method to show an error message.
244 </p><a NAME="XMLStreamReaderBase.toBool" ID="XMLStreamReaderBase.toBool"></a>
245 <h4>XMLStreamReaderBase.toBool</h4>
246 <b>toBool</b>(<i>value</i>)
247 <p>
248 Public method to convert the given value to bool.
249 </p><dl>
250 <dt><i>value</i></dt>
251 <dd>
252 value to be converted ("True", "False", "1", "0")
253 </dd>
254 </dl><dl>
255 <dt>Returns:</dt>
256 <dd>
257 converted value (boolean) or None in case of an error
258 </dd>
259 </dl>
260 <div align="right"><a href="#top">Up</a></div>
261 <hr />
262 </body></html>

Mercurial Repository: eric

eric ide

mercurial