Wed, 06 Jan 2010 18:14:15 +0000
Fixed a bug in eric5-doc.py and regenerated docu.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.E4XML.XMLWriterBase</title> <style> body { background:white; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #4FA4FF; } h2 { color: white; background: #4FA4FF; } h3 { color: white; background: #00557F; } h4 { color: white; background: #00557F; } a { color: #AA5500; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.E4XML.XMLWriterBase</h1> <p> Module implementing a base class for all of eric5s XML writers. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#XMLWriterBase">XMLWriterBase</a></td> <td>Class implementing a base class for all of eric5s XML writers.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="XMLWriterBase" ID="XMLWriterBase"></a> <h2>XMLWriterBase</h2> <p> Class implementing a base class for all of eric5s XML writers. </p> <h3>Derived from</h3> object <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#XMLWriterBase.__init__">XMLWriterBase</a></td> <td>Constructor</td> </tr><tr> <td><a href="#XMLWriterBase._write">_write</a></td> <td>Protected method used to do the real write operation.</td> </tr><tr> <td><a href="#XMLWriterBase._writeBasics">_writeBasics</a></td> <td>Protected method to dump an object of a basic Python type.</td> </tr><tr> <td><a href="#XMLWriterBase._write_bool">_write_bool</a></td> <td>Protected method to dump a BooleanType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_complex">_write_complex</a></td> <td>Protected method to dump a ComplexType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_dictionary">_write_dictionary</a></td> <td>Protected method to dump a DictType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_float">_write_float</a></td> <td>Protected method to dump a FloatType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_int">_write_int</a></td> <td>Protected method to dump an IntType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_list">_write_list</a></td> <td>Protected method to dump a ListType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_long">_write_long</a></td> <td>Protected method to dump a LongType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_none">_write_none</a></td> <td>Protected method to dump a NoneType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_string">_write_string</a></td> <td>Protected method to dump a StringType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_tuple">_write_tuple</a></td> <td>Protected method to dump a TupleType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_unicode">_write_unicode</a></td> <td>Protected method to dump an UnicodeType object.</td> </tr><tr> <td><a href="#XMLWriterBase._write_unimplemented">_write_unimplemented</a></td> <td>Protected method to dump a type, that has no special method.</td> </tr><tr> <td><a href="#XMLWriterBase.encodedNewLines">encodedNewLines</a></td> <td>Public method to encode newlines and paragraph breaks.</td> </tr><tr> <td><a href="#XMLWriterBase.escape">escape</a></td> <td>Function to escape &, <, and > in a string of data.</td> </tr><tr> <td><a href="#XMLWriterBase.writeXML">writeXML</a></td> <td>Public method to write the XML to the file.</td> </tr> </table> <a NAME="XMLWriterBase.__init__" ID="XMLWriterBase.__init__"></a> <h4>XMLWriterBase (Constructor)</h4> <b>XMLWriterBase</b>(<i>file</i>) <p> Constructor </p><dl> <dt><i>file</i></dt> <dd> open file (like) object for writing </dd> </dl><a NAME="XMLWriterBase._write" ID="XMLWriterBase._write"></a> <h4>XMLWriterBase._write</h4> <b>_write</b>(<i>s, newline = True</i>) <p> Protected method used to do the real write operation. </p><dl> <dt><i>s</i></dt> <dd> string to be written to the XML file </dd><dt><i>newline</i></dt> <dd> flag indicating a linebreak </dd> </dl><a NAME="XMLWriterBase._writeBasics" ID="XMLWriterBase._writeBasics"></a> <h4>XMLWriterBase._writeBasics</h4> <b>_writeBasics</b>(<i>pyobject, indent = 0</i>) <p> Protected method to dump an object of a basic Python type. </p><dl> <dt><i>pyobject</i></dt> <dd> object to be dumped </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_bool" ID="XMLWriterBase._write_bool"></a> <h4>XMLWriterBase._write_bool</h4> <b>_write_bool</b>(<i>value, indent</i>) <p> Protected method to dump a BooleanType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (boolean) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_complex" ID="XMLWriterBase._write_complex"></a> <h4>XMLWriterBase._write_complex</h4> <b>_write_complex</b>(<i>value, indent</i>) <p> Protected method to dump a ComplexType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (complex) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_dictionary" ID="XMLWriterBase._write_dictionary"></a> <h4>XMLWriterBase._write_dictionary</h4> <b>_write_dictionary</b>(<i>value, indent</i>) <p> Protected method to dump a DictType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (dictionary) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_float" ID="XMLWriterBase._write_float"></a> <h4>XMLWriterBase._write_float</h4> <b>_write_float</b>(<i>value, indent</i>) <p> Protected method to dump a FloatType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (float) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_int" ID="XMLWriterBase._write_int"></a> <h4>XMLWriterBase._write_int</h4> <b>_write_int</b>(<i>value, indent</i>) <p> Protected method to dump an IntType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (integer) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_list" ID="XMLWriterBase._write_list"></a> <h4>XMLWriterBase._write_list</h4> <b>_write_list</b>(<i>value, indent</i>) <p> Protected method to dump a ListType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (list) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_long" ID="XMLWriterBase._write_long"></a> <h4>XMLWriterBase._write_long</h4> <b>_write_long</b>(<i>value, indent</i>) <p> Protected method to dump a LongType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (long) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_none" ID="XMLWriterBase._write_none"></a> <h4>XMLWriterBase._write_none</h4> <b>_write_none</b>(<i>value, indent</i>) <p> Protected method to dump a NoneType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (None) (ignored) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_string" ID="XMLWriterBase._write_string"></a> <h4>XMLWriterBase._write_string</h4> <b>_write_string</b>(<i>value, indent</i>) <p> Protected method to dump a StringType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (string) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_tuple" ID="XMLWriterBase._write_tuple"></a> <h4>XMLWriterBase._write_tuple</h4> <b>_write_tuple</b>(<i>value, indent</i>) <p> Protected method to dump a TupleType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (tuple) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_unicode" ID="XMLWriterBase._write_unicode"></a> <h4>XMLWriterBase._write_unicode</h4> <b>_write_unicode</b>(<i>value, indent</i>) <p> Protected method to dump an UnicodeType object. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (unicode) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase._write_unimplemented" ID="XMLWriterBase._write_unimplemented"></a> <h4>XMLWriterBase._write_unimplemented</h4> <b>_write_unimplemented</b>(<i>value, indent</i>) <p> Protected method to dump a type, that has no special method. </p><dl> <dt><i>value</i></dt> <dd> value to be dumped (any pickleable object) </dd><dt><i>indent</i></dt> <dd> indentation level for prettier output (integer) </dd> </dl><a NAME="XMLWriterBase.encodedNewLines" ID="XMLWriterBase.encodedNewLines"></a> <h4>XMLWriterBase.encodedNewLines</h4> <b>encodedNewLines</b>(<i>text</i>) <p> Public method to encode newlines and paragraph breaks. </p><dl> <dt><i>text</i></dt> <dd> text to encode (string or QString) </dd> </dl><a NAME="XMLWriterBase.escape" ID="XMLWriterBase.escape"></a> <h4>XMLWriterBase.escape</h4> <b>escape</b>(<i>data, attribute=False</i>) <p> Function to escape &, <, and > in a string of data. </p><dl> <dt><i>data</i></dt> <dd> data to be escaped (string) </dd><dt><i>attribute</i></dt> <dd> flag indicating escaping is done for an attribute </dd> </dl><dl> <dt>Returns:</dt> <dd> the escaped data (string) </dd> </dl><a NAME="XMLWriterBase.writeXML" ID="XMLWriterBase.writeXML"></a> <h4>XMLWriterBase.writeXML</h4> <b>writeXML</b>(<i></i>) <p> Public method to write the XML to the file. </p> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>