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

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Exporters.ExporterBase</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Exporters.ExporterBase</h1>

<p>
Module implementing the exporter base class.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#ExporterBase">ExporterBase</a></td>
<td>Class implementing the exporter base class.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="ExporterBase" ID="ExporterBase"></a>
<h2>ExporterBase</h2>

<p>
    Class implementing the exporter base class.
</p>
<h3>Derived from</h3>
QObject
<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="#ExporterBase.__init__">ExporterBase</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ExporterBase._getFileName">_getFileName</a></td>
<td>Protected method to get the file name of the export file from the user.</td>
</tr>
<tr>
<td><a href="#ExporterBase.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="ExporterBase.__init__" ID="ExporterBase.__init__"></a>
<h4>ExporterBase (Constructor)</h4>
<b>ExporterBase</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="ExporterBase._getFileName" ID="ExporterBase._getFileName"></a>
<h4>ExporterBase._getFileName</h4>
<b>_getFileName</b>(<i>fileFilter</i>)

<p>
        Protected method to get the file name of the export file from the user.
</p>
<dl>

<dt><i>fileFilter</i></dt>
<dd>
the filter string to be used (string). The filter for
            "All Files (*)" is appended by this method.
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
file name entered by the user (string)
</dd>
</dl>
<a NAME="ExporterBase.exportSource" ID="ExporterBase.exportSource"></a>
<h4>ExporterBase.exportSource</h4>
<b>exportSource</b>(<i></i>)

<p>
        Public method performing the export.
</p>
<p>
        This method must be overridden by the real exporters.
</p>
<dl>

<dt>Raises <b>NotImplementedError</b>:</dt>
<dd>
raised to indicate that this method
            must be implemented by a subclass
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>