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

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Exporters.__init__</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Exporters.__init__</h1>
<p>
Package implementing exporters for various file formats.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

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

<h3>Functions</h3>
<table>
<tr>
<td><a href="#getExporter">getExporter</a></td>
<td>Module function to instantiate an exporter object for a given format.</td>
</tr>
<tr>
<td><a href="#getSupportedFormats">getSupportedFormats</a></td>
<td>Module function to get a dictionary of supported exporters.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="getExporter" ID="getExporter"></a>
<h2>getExporter</h2>
<b>getExporter</b>(<i>exporterFormat, editor</i>)
<p>
    Module function to instantiate an exporter object for a given format.
</p>

<dl>

<dt><i>exporterFormat</i> (str)</dt>
<dd>
format of the exporter
</dd>
<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
<dd>
reference to the editor object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instanciated exporter object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QScintilla.Exporter.Exporter
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getSupportedFormats" ID="getSupportedFormats"></a>
<h2>getSupportedFormats</h2>
<b>getSupportedFormats</b>(<i></i>)
<p>
    Module function to get a dictionary of supported exporters.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary of supported exporters. The keys are the
        internal format names. The items are the display strings
        for the exporters.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>