Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html

changeset 3673
e26d7d0c1088
child 5837
9ef6a28f1694
diff -r f0cb7579c0b4 -r e26d7d0c1088 Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.QScintilla.Exporters.ExporterHTML</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.QScintilla.Exporters.ExporterHTML</h1>
+<p>
+Module implementing an exporter for HTML.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<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>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="ExporterHTML" ID="ExporterHTML"></a>
+<h2>ExporterHTML</h2>
+<p>
+    Class implementing an exporter for HTML.
+</p>
+<h3>Derived from</h3>
+ExporterBase
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ExporterHTML.__init__">ExporterHTML</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ExporterHTML.exportSource">exportSource</a></td>
+<td>Public method performing the export.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="ExporterHTML.__init__" ID="ExporterHTML.__init__"></a>
+<h4>ExporterHTML (Constructor)</h4>
+<b>ExporterHTML</b>(<i>editor, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the editor object (QScintilla.Editor.Editor)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent object of the exporter (QObject)
+</dd>
+</dl><a NAME="ExporterHTML.exportSource" ID="ExporterHTML.exportSource"></a>
+<h4>ExporterHTML.exportSource</h4>
+<b>exportSource</b>(<i></i>)
+<p>
+        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>Class Methods</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>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</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

eric ide

mercurial