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