Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.QScintilla.Exporters.ExporterHTML.html	Mon Aug 30 12:30:29 2010 +0200
+++ b/Documentation/Source/eric5.QScintilla.Exporters.ExporterHTML.html	Mon Aug 30 15:24:28 2010 +0200
@@ -33,6 +33,9 @@
 <tr>
 <td><a href="#ExporterHTML">ExporterHTML</a></td>
 <td>Class implementing an exporter for HTML.</td>
+</tr><tr>
+<td><a href="#HTMLGenerator">HTMLGenerator</a></td>
+<td>Class implementing an HTML generator for exporting source code.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -81,5 +84,71 @@
         Public method performing the export.
 </p>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="HTMLGenerator" ID="HTMLGenerator"></a>
+<h2>HTMLGenerator</h2>
+<p>
+    Class implementing an HTML generator for exporting source code.
+</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="#HTMLGenerator.__init__">HTMLGenerator</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HTMLGenerator.generate">generate</a></td>
+<td>Public method to generate HTML for the source editor.</td>
+</tr>
+</table>
+<a NAME="HTMLGenerator.__init__" ID="HTMLGenerator.__init__"></a>
+<h4>HTMLGenerator (Constructor)</h4>
+<b>HTMLGenerator</b>(<i>editor</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the editor object (QScintilla.Editor.Editor)
+</dd>
+</dl><a NAME="HTMLGenerator.generate" ID="HTMLGenerator.generate"></a>
+<h4>HTMLGenerator.generate</h4>
+<b>generate</b>(<i>tabSize = 4, useTabs = False, wysiwyg = True, folding = False, onlyStylesUsed = False, titleFullPath = False</i>)
+<p>
+        Public method to generate HTML for the source editor.
+</p><dl>
+<dt><i>tabSize=</i></dt>
+<dd>
+size of tabs (integer)
+</dd><dt><i>useTabs=</i></dt>
+<dd>
+flag indicating the use of tab characters (boolean)
+</dd><dt><i>wysiwyg=</i></dt>
+<dd>
+flag indicating colorization (boolean)
+</dd><dt><i>folding=</i></dt>
+<dd>
+flag indicating usage of fold markers
+</dd><dt><i>onlyStylesUsed=</i></dt>
+<dd>
+flag indicating to include only style definitions
+            for styles used in the source (boolean)
+</dd><dt><i>titleFullPath=</i></dt>
+<dd>
+flag indicating to include the full file path
+            in the title tag (boolean)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+generated HTML text (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file