--- a/eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterTEX.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterTEX.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,134 +18,176 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.QScintilla.Exporters.ExporterTEX</h1> + <p> Module implementing an exporter for TeX. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ExporterTEX">ExporterTEX</a></td> <td>Class implementing an exporter for TeX.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ExporterTEX" ID="ExporterTEX"></a> <h2>ExporterTEX</h2> + <p> Class implementing an exporter for TeX. </p> <h3>Derived from</h3> ExporterBase <h3>Class Attributes</h3> + <table> <tr><td>CHARZ</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#ExporterTEX.__init__">ExporterTEX</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ExporterTEX.__defineTexStyle">__defineTexStyle</a></td> <td>Private method to define a new TeX style.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ExporterTEX.__getTexRGB">__getTexRGB</a></td> <td>Private method to convert a color object to a TeX color string.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ExporterTEX.__texStyle">__texStyle</a></td> <td>Private method to calculate a style name string for a given style number.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ExporterTEX.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="ExporterTEX.__init__" ID="ExporterTEX.__init__"></a> <h4>ExporterTEX (Constructor)</h4> <b>ExporterTEX</b>(<i>editor, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the editor object (QScintilla.Editor.Editor) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> parent object of the exporter (QObject) </dd> -</dl><a NAME="ExporterTEX.__defineTexStyle" ID="ExporterTEX.__defineTexStyle"></a> +</dl> +<a NAME="ExporterTEX.__defineTexStyle" ID="ExporterTEX.__defineTexStyle"></a> <h4>ExporterTEX.__defineTexStyle</h4> <b>__defineTexStyle</b>(<i>font, color, paper, file, istyle</i>) + <p> Private method to define a new TeX style. -</p><dl> +</p> +<dl> + <dt><i>font</i></dt> <dd> the font to be used (QFont) -</dd><dt><i>color</i></dt> +</dd> +<dt><i>color</i></dt> <dd> the foreground color to be used (QColor) -</dd><dt><i>paper</i></dt> +</dd> +<dt><i>paper</i></dt> <dd> the background color to be used (QColor) -</dd><dt><i>file</i></dt> +</dd> +<dt><i>file</i></dt> <dd> reference to the open file to write to (file object) -</dd><dt><i>istyle</i></dt> +</dd> +<dt><i>istyle</i></dt> <dd> style number (integer) </dd> -</dl><a NAME="ExporterTEX.__getTexRGB" ID="ExporterTEX.__getTexRGB"></a> +</dl> +<a NAME="ExporterTEX.__getTexRGB" ID="ExporterTEX.__getTexRGB"></a> <h4>ExporterTEX.__getTexRGB</h4> <b>__getTexRGB</b>(<i>color</i>) + <p> Private method to convert a color object to a TeX color string. -</p><dl> +</p> +<dl> + <dt><i>color</i></dt> <dd> color object to convert (QColor) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> TeX color string (string) </dd> -</dl><a NAME="ExporterTEX.__texStyle" ID="ExporterTEX.__texStyle"></a> +</dl> +<a NAME="ExporterTEX.__texStyle" ID="ExporterTEX.__texStyle"></a> <h4>ExporterTEX.__texStyle</h4> <b>__texStyle</b>(<i>style</i>) + <p> Private method to calculate a style name string for a given style number. -</p><dl> +</p> +<dl> + <dt><i>style</i></dt> <dd> style number (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> style name string (string) </dd> -</dl><a NAME="ExporterTEX.exportSource" ID="ExporterTEX.exportSource"></a> +</dl> +<a NAME="ExporterTEX.exportSource" ID="ExporterTEX.exportSource"></a> <h4>ExporterTEX.exportSource</h4> <b>exportSource</b>(<i></i>) + <p> Public method performing the export. </p>