Documentation/Source/eric5.QScintilla.Exporters.ExporterTEX.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.QScintilla.Exporters.ExporterTEX.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.Exporters.ExporterTEX.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.Exporters.ExporterTEX</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#101;x&#112;&#111;&#114;&#116;&#101;&#114; &#102;&#111;&#114; &#84;&#101;&#88;.
+Module implementing an exporter for TeX.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ExporterTEX">ExporterTEX</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#101;x&#112;&#111;&#114;&#116;&#101;&#114; &#102;&#111;&#114; &#84;&#101;&#88;.</td>
+<td>Class implementing an exporter for TeX.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="ExporterTEX" ID="ExporterTEX"></a>
 <h2>ExporterTEX</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#101;x&#112;&#111;&#114;&#116;&#101;&#114; &#102;&#111;&#114; &#84;&#101;&#88;.
+    Class implementing an exporter for TeX.
 </p>
 <h3>Derived from</h3>
 ExporterBase
@@ -55,91 +55,91 @@
 <table>
 <tr>
 <td><a href="#ExporterTEX.__init__">ExporterTEX</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ExporterTEX.__defineTexStyle">__defineTexStyle</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#102;&#105;&#110;&#101; &#97; &#110;&#101;w &#84;&#101;&#88; &#115;&#116;y&#108;&#101;.</td>
+<td>Private method to define a new TeX style.</td>
 </tr><tr>
 <td><a href="#ExporterTEX.__getTexRGB">__getTexRGB</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#111;&#110;v&#101;&#114;&#116; &#97; &#99;&#111;&#108;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#97; &#84;&#101;&#88; &#99;&#111;&#108;&#111;&#114; &#115;&#116;&#114;&#105;&#110;&#103;</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>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#97; &#115;&#116;y&#108;&#101; &#110;&#97;&#109;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#102;&#111;&#114; &#97; &#103;&#105;v&#101;&#110; &#115;&#116;y&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#112;&#101;&#114;&#102;&#111;&#114;&#109;&#105;&#110;&#103; &#116;&#104;&#101; &#101;x&#112;&#111;&#114;&#116;.</td>
+<td>Public method performing the export.</td>
 </tr>
 </table>
 <a NAME="ExporterTEX.__init__" ID="ExporterTEX.__init__"></a>
 <h4>ExporterTEX (Constructor)</h4>
 <b>ExporterTEX</b>(<i>editor, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;.&#69;&#100;&#105;&#116;&#111;&#114;)
+reference to the editor object (QScintilla.Editor.Editor)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#111;&#102; &#116;&#104;&#101; &#101;x&#112;&#111;&#114;&#116;&#101;&#114; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#102;&#105;&#110;&#101; &#97; &#110;&#101;w &#84;&#101;&#88; &#115;&#116;y&#108;&#101;.
+        Private method to define a new TeX style.
 </p><dl>
 <dt><i>font</i></dt>
 <dd>
-&#116;&#104;&#101; &#102;&#111;&#110;&#116; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#81;&#70;&#111;&#110;&#116;)
+the font to be used (QFont)
 </dd><dt><i>color</i></dt>
 <dd>
-&#116;&#104;&#101; &#102;&#111;&#114;&#101;&#103;&#114;&#111;&#117;&#110;&#100; &#99;&#111;&#108;&#111;&#114; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#81;&#67;&#111;&#108;&#111;&#114;)
+the foreground color to be used (QColor)
 </dd><dt><i>paper</i></dt>
 <dd>
-&#116;&#104;&#101; &#98;&#97;&#99;&#107;&#103;&#114;&#111;&#117;&#110;&#100; &#99;&#111;&#108;&#111;&#114; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; (&#81;&#67;&#111;&#108;&#111;&#114;)
+the background color to be used (QColor)
 </dd><dt><i>file</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#111;&#112;&#101;&#110; &#102;&#105;&#108;&#101; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#111; (&#102;&#105;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116;)
+reference to the open file to write to (file object)
 </dd><dt><i>istyle</i></dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+style number (integer)
 </dd>
 </dl><a NAME="ExporterTEX.__getTexRGB" ID="ExporterTEX.__getTexRGB"></a>
 <h4>ExporterTEX.__getTexRGB</h4>
 <b>__getTexRGB</b>(<i>color</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#111;&#110;v&#101;&#114;&#116; &#97; &#99;&#111;&#108;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#97; &#84;&#101;&#88; &#99;&#111;&#108;&#111;&#114; &#115;&#116;&#114;&#105;&#110;&#103;
+        Private method to convert a color object to a TeX color string
 </p><dl>
 <dt><i>color</i></dt>
 <dd>
-&#99;&#111;&#108;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#99;&#111;&#110;v&#101;&#114;&#116; (&#81;&#67;&#111;&#108;&#111;&#114;)
+color object to convert (QColor)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#84;&#101;&#88; &#99;&#111;&#108;&#111;&#114; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#97; &#115;&#116;y&#108;&#101; &#110;&#97;&#109;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#102;&#111;&#114; &#97; &#103;&#105;v&#101;&#110; &#115;&#116;y&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114;.
+        Private method to calculate a style name string for a given style number.
 </p><dl>
 <dt><i>style</i></dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+style number (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#110;&#97;&#109;&#101; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+style name string (string)
 </dd>
 </dl><a NAME="ExporterTEX.exportSource" ID="ExporterTEX.exportSource"></a>
 <h4>ExporterTEX.exportSource</h4>
 <b>exportSource</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#112;&#101;&#114;&#102;&#111;&#114;&#109;&#105;&#110;&#103; &#116;&#104;&#101; &#101;x&#112;&#111;&#114;&#116;.
+        Public method performing the export.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial