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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9503
ae9232bf4854
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterTEX.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterTEX.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,182 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QScintilla.Exporters.ExporterTEX</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<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>
+<td><a href="#ExporterTEX.__defineTexStyle">__defineTexStyle</a></td>
+<td>Private method to define a new TeX style.</td>
+</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>
+<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>
+<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>
+
+<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="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>
+
+<dt><i>font</i></dt>
+<dd>
+the font to be used (QFont)
+</dd>
+<dt><i>color</i></dt>
+<dd>
+the foreground color to be used (QColor)
+</dd>
+<dt><i>paper</i></dt>
+<dd>
+the background color to be used (QColor)
+</dd>
+<dt><i>file</i></dt>
+<dd>
+reference to the open file to write to (file object)
+</dd>
+<dt><i>istyle</i></dt>
+<dd>
+style number (integer)
+</dd>
+</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>
+
+<dt><i>color</i></dt>
+<dd>
+color object to convert (QColor)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+TeX color string (string)
+</dd>
+</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>
+
+<dt><i>style</i></dt>
+<dd>
+style number (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+style name string (string)
+</dd>
+</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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial