Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial