Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.E4XML.XMLWriterBase.html

Documentation/Source/eric4.E4XML.XMLWriterBase.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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>eric4.E4XML.XMLWriterBase</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.E4XML.XMLWriterBase</h1>
24 <p>
25 Module implementing a base class for all of eric4s XML 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="#XMLWriterBase">XMLWriterBase</a></td>
35 <td>Class implementing a base class for all of eric4s XML 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="XMLWriterBase" ID="XMLWriterBase"></a>
44 <h2>XMLWriterBase</h2>
45 <p>
46 Class implementing a base class for all of eric4s XML writers.
47 </p>
48 <h3>Derived from</h3>
49 object
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="#XMLWriterBase.__init__">XMLWriterBase</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#XMLWriterBase._write">_write</a></td>
61 <td>Protected method used to do the real write operation.</td>
62 </tr><tr>
63 <td><a href="#XMLWriterBase._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="#XMLWriterBase._write_bool">_write_bool</a></td>
67 <td>Protected method to dump a BooleanType object.</td>
68 </tr><tr>
69 <td><a href="#XMLWriterBase._write_complex">_write_complex</a></td>
70 <td>Protected method to dump a ComplexType object.</td>
71 </tr><tr>
72 <td><a href="#XMLWriterBase._write_dictionary">_write_dictionary</a></td>
73 <td>Protected method to dump a DictType object.</td>
74 </tr><tr>
75 <td><a href="#XMLWriterBase._write_float">_write_float</a></td>
76 <td>Protected method to dump a FloatType object.</td>
77 </tr><tr>
78 <td><a href="#XMLWriterBase._write_int">_write_int</a></td>
79 <td>Protected method to dump an IntType object.</td>
80 </tr><tr>
81 <td><a href="#XMLWriterBase._write_list">_write_list</a></td>
82 <td>Protected method to dump a ListType object.</td>
83 </tr><tr>
84 <td><a href="#XMLWriterBase._write_long">_write_long</a></td>
85 <td>Protected method to dump a LongType object.</td>
86 </tr><tr>
87 <td><a href="#XMLWriterBase._write_none">_write_none</a></td>
88 <td>Protected method to dump a NoneType object.</td>
89 </tr><tr>
90 <td><a href="#XMLWriterBase._write_string">_write_string</a></td>
91 <td>Protected method to dump a StringType object.</td>
92 </tr><tr>
93 <td><a href="#XMLWriterBase._write_tuple">_write_tuple</a></td>
94 <td>Protected method to dump a TupleType object.</td>
95 </tr><tr>
96 <td><a href="#XMLWriterBase._write_unicode">_write_unicode</a></td>
97 <td>Protected method to dump an UnicodeType object.</td>
98 </tr><tr>
99 <td><a href="#XMLWriterBase._write_unimplemented">_write_unimplemented</a></td>
100 <td>Protected method to dump a type, that has no special method.</td>
101 </tr><tr>
102 <td><a href="#XMLWriterBase.encodedNewLines">encodedNewLines</a></td>
103 <td>Public method to encode newlines and paragraph breaks.</td>
104 </tr><tr>
105 <td><a href="#XMLWriterBase.escape">escape</a></td>
106 <td>Function to escape &, <, and > in a string of data.</td>
107 </tr><tr>
108 <td><a href="#XMLWriterBase.writeXML">writeXML</a></td>
109 <td>Public method to write the XML to the file.</td>
110 </tr>
111 </table>
112 <a NAME="XMLWriterBase.__init__" ID="XMLWriterBase.__init__"></a>
113 <h4>XMLWriterBase (Constructor)</h4>
114 <b>XMLWriterBase</b>(<i>file</i>)
115 <p>
116 Constructor
117 </p><dl>
118 <dt><i>file</i></dt>
119 <dd>
120 open file (like) object for writing
121 </dd>
122 </dl><a NAME="XMLWriterBase._write" ID="XMLWriterBase._write"></a>
123 <h4>XMLWriterBase._write</h4>
124 <b>_write</b>(<i>s, newline = True</i>)
125 <p>
126 Protected method used to do the real write operation.
127 </p><dl>
128 <dt><i>s</i></dt>
129 <dd>
130 string to be written to the XML file
131 </dd><dt><i>newline</i></dt>
132 <dd>
133 flag indicating a linebreak
134 </dd>
135 </dl><a NAME="XMLWriterBase._writeBasics" ID="XMLWriterBase._writeBasics"></a>
136 <h4>XMLWriterBase._writeBasics</h4>
137 <b>_writeBasics</b>(<i>pyobject, indent = 0</i>)
138 <p>
139 Protected method to dump an object of a basic Python type.
140 </p><dl>
141 <dt><i>pyobject</i></dt>
142 <dd>
143 object to be dumped
144 </dd><dt><i>indent</i></dt>
145 <dd>
146 indentation level for prettier output (integer)
147 </dd>
148 </dl><a NAME="XMLWriterBase._write_bool" ID="XMLWriterBase._write_bool"></a>
149 <h4>XMLWriterBase._write_bool</h4>
150 <b>_write_bool</b>(<i>value, indent</i>)
151 <p>
152 Protected method to dump a BooleanType object.
153 </p><dl>
154 <dt><i>value</i></dt>
155 <dd>
156 value to be dumped (boolean)
157 </dd><dt><i>indent</i></dt>
158 <dd>
159 indentation level for prettier output (integer)
160 </dd>
161 </dl><a NAME="XMLWriterBase._write_complex" ID="XMLWriterBase._write_complex"></a>
162 <h4>XMLWriterBase._write_complex</h4>
163 <b>_write_complex</b>(<i>value, indent</i>)
164 <p>
165 Protected method to dump a ComplexType object.
166 </p><dl>
167 <dt><i>value</i></dt>
168 <dd>
169 value to be dumped (complex)
170 </dd><dt><i>indent</i></dt>
171 <dd>
172 indentation level for prettier output (integer)
173 </dd>
174 </dl><a NAME="XMLWriterBase._write_dictionary" ID="XMLWriterBase._write_dictionary"></a>
175 <h4>XMLWriterBase._write_dictionary</h4>
176 <b>_write_dictionary</b>(<i>value, indent</i>)
177 <p>
178 Protected method to dump a DictType object.
179 </p><dl>
180 <dt><i>value</i></dt>
181 <dd>
182 value to be dumped (dictionary)
183 </dd><dt><i>indent</i></dt>
184 <dd>
185 indentation level for prettier output (integer)
186 </dd>
187 </dl><a NAME="XMLWriterBase._write_float" ID="XMLWriterBase._write_float"></a>
188 <h4>XMLWriterBase._write_float</h4>
189 <b>_write_float</b>(<i>value, indent</i>)
190 <p>
191 Protected method to dump a FloatType object.
192 </p><dl>
193 <dt><i>value</i></dt>
194 <dd>
195 value to be dumped (float)
196 </dd><dt><i>indent</i></dt>
197 <dd>
198 indentation level for prettier output (integer)
199 </dd>
200 </dl><a NAME="XMLWriterBase._write_int" ID="XMLWriterBase._write_int"></a>
201 <h4>XMLWriterBase._write_int</h4>
202 <b>_write_int</b>(<i>value, indent</i>)
203 <p>
204 Protected method to dump an IntType object.
205 </p><dl>
206 <dt><i>value</i></dt>
207 <dd>
208 value to be dumped (integer)
209 </dd><dt><i>indent</i></dt>
210 <dd>
211 indentation level for prettier output (integer)
212 </dd>
213 </dl><a NAME="XMLWriterBase._write_list" ID="XMLWriterBase._write_list"></a>
214 <h4>XMLWriterBase._write_list</h4>
215 <b>_write_list</b>(<i>value, indent</i>)
216 <p>
217 Protected method to dump a ListType object.
218 </p><dl>
219 <dt><i>value</i></dt>
220 <dd>
221 value to be dumped (list)
222 </dd><dt><i>indent</i></dt>
223 <dd>
224 indentation level for prettier output (integer)
225 </dd>
226 </dl><a NAME="XMLWriterBase._write_long" ID="XMLWriterBase._write_long"></a>
227 <h4>XMLWriterBase._write_long</h4>
228 <b>_write_long</b>(<i>value, indent</i>)
229 <p>
230 Protected method to dump a LongType object.
231 </p><dl>
232 <dt><i>value</i></dt>
233 <dd>
234 value to be dumped (long)
235 </dd><dt><i>indent</i></dt>
236 <dd>
237 indentation level for prettier output (integer)
238 </dd>
239 </dl><a NAME="XMLWriterBase._write_none" ID="XMLWriterBase._write_none"></a>
240 <h4>XMLWriterBase._write_none</h4>
241 <b>_write_none</b>(<i>value, indent</i>)
242 <p>
243 Protected method to dump a NoneType object.
244 </p><dl>
245 <dt><i>value</i></dt>
246 <dd>
247 value to be dumped (None) (ignored)
248 </dd><dt><i>indent</i></dt>
249 <dd>
250 indentation level for prettier output (integer)
251 </dd>
252 </dl><a NAME="XMLWriterBase._write_string" ID="XMLWriterBase._write_string"></a>
253 <h4>XMLWriterBase._write_string</h4>
254 <b>_write_string</b>(<i>value, indent</i>)
255 <p>
256 Protected method to dump a StringType object.
257 </p><dl>
258 <dt><i>value</i></dt>
259 <dd>
260 value to be dumped (string)
261 </dd><dt><i>indent</i></dt>
262 <dd>
263 indentation level for prettier output (integer)
264 </dd>
265 </dl><a NAME="XMLWriterBase._write_tuple" ID="XMLWriterBase._write_tuple"></a>
266 <h4>XMLWriterBase._write_tuple</h4>
267 <b>_write_tuple</b>(<i>value, indent</i>)
268 <p>
269 Protected method to dump a TupleType object.
270 </p><dl>
271 <dt><i>value</i></dt>
272 <dd>
273 value to be dumped (tuple)
274 </dd><dt><i>indent</i></dt>
275 <dd>
276 indentation level for prettier output (integer)
277 </dd>
278 </dl><a NAME="XMLWriterBase._write_unicode" ID="XMLWriterBase._write_unicode"></a>
279 <h4>XMLWriterBase._write_unicode</h4>
280 <b>_write_unicode</b>(<i>value, indent</i>)
281 <p>
282 Protected method to dump an UnicodeType object.
283 </p><dl>
284 <dt><i>value</i></dt>
285 <dd>
286 value to be dumped (unicode)
287 </dd><dt><i>indent</i></dt>
288 <dd>
289 indentation level for prettier output (integer)
290 </dd>
291 </dl><a NAME="XMLWriterBase._write_unimplemented" ID="XMLWriterBase._write_unimplemented"></a>
292 <h4>XMLWriterBase._write_unimplemented</h4>
293 <b>_write_unimplemented</b>(<i>value, indent</i>)
294 <p>
295 Protected method to dump a type, that has no special method.
296 </p><dl>
297 <dt><i>value</i></dt>
298 <dd>
299 value to be dumped (any pickleable object)
300 </dd><dt><i>indent</i></dt>
301 <dd>
302 indentation level for prettier output (integer)
303 </dd>
304 </dl><a NAME="XMLWriterBase.encodedNewLines" ID="XMLWriterBase.encodedNewLines"></a>
305 <h4>XMLWriterBase.encodedNewLines</h4>
306 <b>encodedNewLines</b>(<i>text</i>)
307 <p>
308 Public method to encode newlines and paragraph breaks.
309 </p><dl>
310 <dt><i>text</i></dt>
311 <dd>
312 text to encode (string or QString)
313 </dd>
314 </dl><a NAME="XMLWriterBase.escape" ID="XMLWriterBase.escape"></a>
315 <h4>XMLWriterBase.escape</h4>
316 <b>escape</b>(<i>data, attribute=False</i>)
317 <p>
318 Function to escape &, <, and > in a string of data.
319 </p><dl>
320 <dt><i>data</i></dt>
321 <dd>
322 data to be escaped (string)
323 </dd><dt><i>attribute</i></dt>
324 <dd>
325 flag indicating escaping is done for an attribute
326 </dd>
327 </dl><dl>
328 <dt>Returns:</dt>
329 <dd>
330 the escaped data (string)
331 </dd>
332 </dl><a NAME="XMLWriterBase.writeXML" ID="XMLWriterBase.writeXML"></a>
333 <h4>XMLWriterBase.writeXML</h4>
334 <b>writeXML</b>(<i></i>)
335 <p>
336 Public method to write the XML to the file.
337 </p>
338 <div align="right"><a href="#top">Up</a></div>
339 <hr />
340 </body></html>

Mercurial Repository: eric

eric ide

mercurial