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

<!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>
<tr>
<td><a href="#_StrikeThroughExtension">_StrikeThroughExtension</a></td>
<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</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.__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></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.__generateFromMarkdown" ID="ExporterHTML.__generateFromMarkdown"></a>
<h4>ExporterHTML.__generateFromMarkdown</h4>
<b>__generateFromMarkdown</b>(<i></i>)

<p>
        Private method to convert Markdown text into HTML.
</p>
<dl>
<dt>Returns:</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>Returns:</dt>
<dd>
processed HTML (string)
</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 />
<hr />
<a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a>
<h2>_StrikeThroughExtension</h2>

<p>
                Class is placed here, because it depends on imported markdown,
                and markdown import is lazy.
</p>
<p>
                (see http://achinghead.com/
                python-markdown-adding-insert-delete.html this page for
                details)
</p>
<h3>Derived from</h3>
markdown.Extension
<h3>Class Attributes</h3>

<table>
<tr><td>DEL_RE</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td>
<td></td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a>
<h4>_StrikeThroughExtension.extendMarkdown</h4>
<b>extendMarkdown</b>(<i>md, md_globals</i>)

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>