src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterHTML.html

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Exporters.ExporterHTML</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.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><a href="#createExporter">createExporter</a></td>
<td>Function to instantiate an exporter object.</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.__generateFromMarkdown">__generateFromMarkdown</a></td>
<td>Private method to convert Markdown text into HTML.</td>
</tr>
<tr>
<td><a href="#ExporterHTML.__generateFromReSTDocutils">__generateFromReSTDocutils</a></td>
<td>Private method to convert ReST text into HTML using 'docutils'.</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> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object
</dd>
<dt><i>parent</i> (QObject)</dt>
<dd>
parent object of the exporter
</dd>
</dl>
<a NAME="ExporterHTML.__generateFromMarkdown" ID="ExporterHTML.__generateFromMarkdown"></a>
<h4>ExporterHTML.__generateFromMarkdown</h4>
<b>__generateFromMarkdown</b>(<i>useDarkScheme</i>)
<p>
        Private method to convert Markdown text into HTML.
</p>

<dl>

<dt><i>useDarkScheme</i> (bool)</dt>
<dd>
flag indicating to export using a dark color
            scheme
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
processed HTML
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ExporterHTML.__generateFromReSTDocutils" ID="ExporterHTML.__generateFromReSTDocutils"></a>
<h4>ExporterHTML.__generateFromReSTDocutils</h4>
<b>__generateFromReSTDocutils</b>(<i></i>)
<p>
        Private method to convert ReST text into HTML using 'docutils'.
</p>

<dl>
<dt>Return:</dt>
<dd>
processed HTML
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</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>
None
<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> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object
</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> (int)</dt>
<dd>
size of tabs
</dd>
<dt><i>useTabs</i> (bool)</dt>
<dd>
flag indicating the use of tab characters
</dd>
<dt><i>wysiwyg</i> (bool)</dt>
<dd>
flag indicating colorization
</dd>
<dt><i>folding</i> (bool)</dt>
<dd>
flag indicating usage of fold markers
</dd>
<dt><i>onlyStylesUsed</i> (bool)</dt>
<dd>
flag indicating to include only style
            definitions for styles used in the source
</dd>
<dt><i>titleFullPath</i> (bool)</dt>
<dd>
flag indicating to include the full file path
            in the title tag
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
generated HTML text
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createExporter" ID="createExporter"></a>
<h2>createExporter</h2>
<b>createExporter</b>(<i>editor, parent=None</i>)
<p>
    Function to instantiate an exporter object.
</p>

<dl>

<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object
</dd>
<dt><i>parent</i> (QObject (optional))</dt>
<dd>
parent object of the exporter (defaults to None)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
exporter object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ExporterHTML
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>