Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.E5XML.XMLStreamWriterBase.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.XMLStreamWriterBase</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.XMLStreamWriterBase</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="#XMLStreamWriterBase">XMLStreamWriterBase</a></td>
34 <td>Class implementing a base class for all of eric6s XML stream writers.</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="XMLStreamWriterBase" ID="XMLStreamWriterBase"></a>
43 <h2>XMLStreamWriterBase</h2>
44 <p>
45 Class implementing a base class for all of eric6s XML stream writers.
46 </p>
47 <h3>Derived from</h3>
48 QXmlStreamWriter
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="#XMLStreamWriterBase.__init__">XMLStreamWriterBase</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#XMLStreamWriterBase._writeBasics">_writeBasics</a></td>
64 <td>Protected method to dump an object of a basic Python type.</td>
65 </tr><tr>
66 <td><a href="#XMLStreamWriterBase._write_bool">_write_bool</a></td>
67 <td>Protected method to dump a bool object.</td>
68 </tr><tr>
69 <td><a href="#XMLStreamWriterBase._write_bytearray">_write_bytearray</a></td>
70 <td>Protected method to dump a bytearray object.</td>
71 </tr><tr>
72 <td><a href="#XMLStreamWriterBase._write_bytes">_write_bytes</a></td>
73 <td>Protected method to dump a bytes object.</td>
74 </tr><tr>
75 <td><a href="#XMLStreamWriterBase._write_complex">_write_complex</a></td>
76 <td>Protected method to dump a complex object.</td>
77 </tr><tr>
78 <td><a href="#XMLStreamWriterBase._write_dictionary">_write_dictionary</a></td>
79 <td>Protected method to dump a dict object.</td>
80 </tr><tr>
81 <td><a href="#XMLStreamWriterBase._write_float">_write_float</a></td>
82 <td>Protected method to dump a float object.</td>
83 </tr><tr>
84 <td><a href="#XMLStreamWriterBase._write_frozenset">_write_frozenset</a></td>
85 <td>Protected method to dump a frozenset object.</td>
86 </tr><tr>
87 <td><a href="#XMLStreamWriterBase._write_int">_write_int</a></td>
88 <td>Protected method to dump an int object.</td>
89 </tr><tr>
90 <td><a href="#XMLStreamWriterBase._write_list">_write_list</a></td>
91 <td>Protected method to dump a list object.</td>
92 </tr><tr>
93 <td><a href="#XMLStreamWriterBase._write_none">_write_none</a></td>
94 <td>Protected method to dump a NoneType object.</td>
95 </tr><tr>
96 <td><a href="#XMLStreamWriterBase._write_set">_write_set</a></td>
97 <td>Protected method to dump a set object.</td>
98 </tr><tr>
99 <td><a href="#XMLStreamWriterBase._write_string">_write_string</a></td>
100 <td>Protected method to dump a str object.</td>
101 </tr><tr>
102 <td><a href="#XMLStreamWriterBase._write_tuple">_write_tuple</a></td>
103 <td>Protected method to dump a tuple object.</td>
104 </tr><tr>
105 <td><a href="#XMLStreamWriterBase._write_unimplemented">_write_unimplemented</a></td>
106 <td>Protected method to dump a type, that has no special method.</td>
107 </tr><tr>
108 <td><a href="#XMLStreamWriterBase.writeBasics">writeBasics</a></td>
109 <td>Public method to write a tag with a basic Python object dump.</td>
110 </tr><tr>
111 <td><a href="#XMLStreamWriterBase.writeXML">writeXML</a></td>
112 <td>Public method to write the XML to the file.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="XMLStreamWriterBase.__init__" ID="XMLStreamWriterBase.__init__"></a>
120 <h4>XMLStreamWriterBase (Constructor)</h4>
121 <b>XMLStreamWriterBase</b>(<i>device</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>device</i></dt>
126 <dd>
127 reference to the I/O device to write to (QIODevice)
128 </dd>
129 </dl><a NAME="XMLStreamWriterBase._writeBasics" ID="XMLStreamWriterBase._writeBasics"></a>
130 <h4>XMLStreamWriterBase._writeBasics</h4>
131 <b>_writeBasics</b>(<i>pyobject</i>)
132 <p>
133 Protected method to dump an object of a basic Python type.
134 </p><dl>
135 <dt><i>pyobject</i></dt>
136 <dd>
137 object to be dumped
138 </dd>
139 </dl><a NAME="XMLStreamWriterBase._write_bool" ID="XMLStreamWriterBase._write_bool"></a>
140 <h4>XMLStreamWriterBase._write_bool</h4>
141 <b>_write_bool</b>(<i>value</i>)
142 <p>
143 Protected method to dump a bool object.
144 </p><dl>
145 <dt><i>value</i></dt>
146 <dd>
147 value to be dumped (boolean)
148 </dd>
149 </dl><a NAME="XMLStreamWriterBase._write_bytearray" ID="XMLStreamWriterBase._write_bytearray"></a>
150 <h4>XMLStreamWriterBase._write_bytearray</h4>
151 <b>_write_bytearray</b>(<i>value</i>)
152 <p>
153 Protected method to dump a bytearray object.
154 </p><dl>
155 <dt><i>value</i></dt>
156 <dd>
157 value to be dumped (bytearray)
158 </dd>
159 </dl><a NAME="XMLStreamWriterBase._write_bytes" ID="XMLStreamWriterBase._write_bytes"></a>
160 <h4>XMLStreamWriterBase._write_bytes</h4>
161 <b>_write_bytes</b>(<i>value</i>)
162 <p>
163 Protected method to dump a bytes object.
164 </p><dl>
165 <dt><i>value</i></dt>
166 <dd>
167 value to be dumped (bytes)
168 </dd>
169 </dl><a NAME="XMLStreamWriterBase._write_complex" ID="XMLStreamWriterBase._write_complex"></a>
170 <h4>XMLStreamWriterBase._write_complex</h4>
171 <b>_write_complex</b>(<i>value</i>)
172 <p>
173 Protected method to dump a complex object.
174 </p><dl>
175 <dt><i>value</i></dt>
176 <dd>
177 value to be dumped (complex)
178 </dd>
179 </dl><a NAME="XMLStreamWriterBase._write_dictionary" ID="XMLStreamWriterBase._write_dictionary"></a>
180 <h4>XMLStreamWriterBase._write_dictionary</h4>
181 <b>_write_dictionary</b>(<i>value</i>)
182 <p>
183 Protected method to dump a dict object.
184 </p><dl>
185 <dt><i>value</i></dt>
186 <dd>
187 value to be dumped (dictionary)
188 </dd>
189 </dl><a NAME="XMLStreamWriterBase._write_float" ID="XMLStreamWriterBase._write_float"></a>
190 <h4>XMLStreamWriterBase._write_float</h4>
191 <b>_write_float</b>(<i>value</i>)
192 <p>
193 Protected method to dump a float object.
194 </p><dl>
195 <dt><i>value</i></dt>
196 <dd>
197 value to be dumped (float)
198 </dd>
199 </dl><a NAME="XMLStreamWriterBase._write_frozenset" ID="XMLStreamWriterBase._write_frozenset"></a>
200 <h4>XMLStreamWriterBase._write_frozenset</h4>
201 <b>_write_frozenset</b>(<i>value</i>)
202 <p>
203 Protected method to dump a frozenset object.
204 </p><dl>
205 <dt><i>value</i></dt>
206 <dd>
207 value to be dumped (frozenset)
208 </dd>
209 </dl><a NAME="XMLStreamWriterBase._write_int" ID="XMLStreamWriterBase._write_int"></a>
210 <h4>XMLStreamWriterBase._write_int</h4>
211 <b>_write_int</b>(<i>value</i>)
212 <p>
213 Protected method to dump an int object.
214 </p><dl>
215 <dt><i>value</i></dt>
216 <dd>
217 value to be dumped (integer)
218 </dd>
219 </dl><a NAME="XMLStreamWriterBase._write_list" ID="XMLStreamWriterBase._write_list"></a>
220 <h4>XMLStreamWriterBase._write_list</h4>
221 <b>_write_list</b>(<i>value</i>)
222 <p>
223 Protected method to dump a list object.
224 </p><dl>
225 <dt><i>value</i></dt>
226 <dd>
227 value to be dumped (list)
228 </dd>
229 </dl><a NAME="XMLStreamWriterBase._write_none" ID="XMLStreamWriterBase._write_none"></a>
230 <h4>XMLStreamWriterBase._write_none</h4>
231 <b>_write_none</b>(<i>value</i>)
232 <p>
233 Protected method to dump a NoneType object.
234 </p><dl>
235 <dt><i>value</i></dt>
236 <dd>
237 value to be dumped (None) (ignored)
238 </dd>
239 </dl><a NAME="XMLStreamWriterBase._write_set" ID="XMLStreamWriterBase._write_set"></a>
240 <h4>XMLStreamWriterBase._write_set</h4>
241 <b>_write_set</b>(<i>value</i>)
242 <p>
243 Protected method to dump a set object.
244 </p><dl>
245 <dt><i>value</i></dt>
246 <dd>
247 value to be dumped (set)
248 </dd>
249 </dl><a NAME="XMLStreamWriterBase._write_string" ID="XMLStreamWriterBase._write_string"></a>
250 <h4>XMLStreamWriterBase._write_string</h4>
251 <b>_write_string</b>(<i>value</i>)
252 <p>
253 Protected method to dump a str object.
254 </p><dl>
255 <dt><i>value</i></dt>
256 <dd>
257 value to be dumped (string)
258 </dd>
259 </dl><a NAME="XMLStreamWriterBase._write_tuple" ID="XMLStreamWriterBase._write_tuple"></a>
260 <h4>XMLStreamWriterBase._write_tuple</h4>
261 <b>_write_tuple</b>(<i>value</i>)
262 <p>
263 Protected method to dump a tuple object.
264 </p><dl>
265 <dt><i>value</i></dt>
266 <dd>
267 value to be dumped (tuple)
268 </dd>
269 </dl><a NAME="XMLStreamWriterBase._write_unimplemented" ID="XMLStreamWriterBase._write_unimplemented"></a>
270 <h4>XMLStreamWriterBase._write_unimplemented</h4>
271 <b>_write_unimplemented</b>(<i>value</i>)
272 <p>
273 Protected method to dump a type, that has no special method.
274 </p><dl>
275 <dt><i>value</i></dt>
276 <dd>
277 value to be dumped (any pickleable object)
278 </dd>
279 </dl><a NAME="XMLStreamWriterBase.writeBasics" ID="XMLStreamWriterBase.writeBasics"></a>
280 <h4>XMLStreamWriterBase.writeBasics</h4>
281 <b>writeBasics</b>(<i>tag, pyobject</i>)
282 <p>
283 Public method to write a tag with a basic Python object dump.
284 </p><dl>
285 <dt><i>tag</i></dt>
286 <dd>
287 tag name (string)
288 </dd><dt><i>pyobject</i></dt>
289 <dd>
290 object to be dumped
291 </dd>
292 </dl><a NAME="XMLStreamWriterBase.writeXML" ID="XMLStreamWriterBase.writeXML"></a>
293 <h4>XMLStreamWriterBase.writeXML</h4>
294 <b>writeXML</b>(<i></i>)
295 <p>
296 Public method to write the XML to the file.
297 </p>
298 <div align="right"><a href="#top">Up</a></div>
299 <hr />
300 </body></html>

Mercurial Repository: eric

eric ide

mercurial