micropython/eric6/Documentation/Source/eric6.QScintilla.Exporters.__init__.html

<!DOCTYPE html>
<html><head>
<title>eric6.QScintilla.Exporters.__init__</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.__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></dt>
<dd>
format of the exporter (string)
</dd><dt><i>editor</i></dt>
<dd>
reference to the editor object (QScintilla.Editor.Editor)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the instanciated exporter object
        (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>Returns:</dt>
<dd>
dictionary of supported exporters. The keys are the
        internal format names. The items are the display strings
        for the exporters (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>