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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.QScintilla.Exporters.ExporterRTF.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.Exporters.ExporterRTF.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.Exporters.ExporterRTF</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; &#82;&#84;&#70;.
+Module implementing an exporter for RTF.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ExporterRTF">ExporterRTF</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; &#82;&#84;&#70;.</td>
+<td>Class implementing an exporter for RTF.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="ExporterRTF" ID="ExporterRTF"></a>
 <h2>ExporterRTF</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; &#82;&#84;&#70;.
+    Class implementing an exporter for RTF.
 </p>
 <h3>Derived from</h3>
 ExporterBase
@@ -55,73 +55,73 @@
 <table>
 <tr>
 <td><a href="#ExporterRTF.__init__">ExporterRTF</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ExporterRTF.__GetRTFNextControl">__GetRTFNextControl</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;x&#116;&#114;&#97;&#99;&#116; &#116;&#104;&#101; &#110;&#101;x&#116; &#82;&#84;&#70; &#99;&#111;&#110;&#116;&#114;&#111;&#108; w&#111;&#114;&#100; &#102;&#114;&#111;&#109; &#115;&#116;y&#108;&#101;.</td>
+<td>Private method to extract the next RTF control word from style.</td>
 </tr><tr>
 <td><a href="#ExporterRTF.__GetRTFStyleChange">__GetRTFStyleChange</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;x&#116;&#114;&#97;&#99;&#116; &#99;&#111;&#110;&#116;&#114;&#111;&#108; w&#111;&#114;&#100;&#115; &#116;&#104;&#97;&#116; &#97;&#114;&#101; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#116; &#98;&#101;&#116;w&#101;&#101;&#110; &#116;w&#111; &#115;&#116;y&#108;&#101;&#115;.</td>
+<td>Private method to extract control words that are different between two styles.</td>
 </tr><tr>
 <td><a href="#ExporterRTF.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="ExporterRTF.__init__" ID="ExporterRTF.__init__"></a>
 <h4>ExporterRTF (Constructor)</h4>
 <b>ExporterRTF</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="ExporterRTF.__GetRTFNextControl" ID="ExporterRTF.__GetRTFNextControl"></a>
 <h4>ExporterRTF.__GetRTFNextControl</h4>
 <b>__GetRTFNextControl</b>(<i>pos, style</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;x&#116;&#114;&#97;&#99;&#116; &#116;&#104;&#101; &#110;&#101;x&#116; &#82;&#84;&#70; &#99;&#111;&#110;&#116;&#114;&#111;&#108; w&#111;&#114;&#100; &#102;&#114;&#111;&#109; &#115;&#116;y&#108;&#101;.
+        Private method to extract the next RTF control word from style.
 </p><dl>
 <dt><i>pos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#115;&#101;&#97;&#114;&#99;&#104; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to start search (integer)
 </dd><dt><i>style</i></dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#100;&#101;&#102;&#105;&#110;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#101;&#97;&#114;&#99;&#104; &#105;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+style definition to search in (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#110;&#101;w &#115;&#116;&#97;&#114;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#97;&#110;&#100; &#99;&#111;&#110;&#116;&#114;&#111;&#108; w&#111;&#114;&#100; &#102;&#111;&#117;&#110;&#100;
-            (&#105;&#110;&#116;&#101;&#103;&#101;&#114;, &#115;&#116;&#114;&#105;&#110;&#103;)
+tuple of new start position and control word found
+            (integer, string)
 </dd>
 </dl><a NAME="ExporterRTF.__GetRTFStyleChange" ID="ExporterRTF.__GetRTFStyleChange"></a>
 <h4>ExporterRTF.__GetRTFStyleChange</h4>
 <b>__GetRTFStyleChange</b>(<i>last, current</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;x&#116;&#114;&#97;&#99;&#116; &#99;&#111;&#110;&#116;&#114;&#111;&#108; w&#111;&#114;&#100;&#115; &#116;&#104;&#97;&#116; &#97;&#114;&#101; &#100;&#105;&#102;&#102;&#101;&#114;&#101;&#110;&#116; &#98;&#101;&#116;w&#101;&#101;&#110; &#116;w&#111; &#115;&#116;y&#108;&#101;&#115;.
+        Private method to extract control words that are different between two styles.
 </p><dl>
 <dt><i>last</i></dt>
 <dd>
-&#108;&#101;&#97;&#115;&#116; &#114;&#101;&#99;&#101;&#110;&#116;&#108;y &#117;&#115;&#101;&#100; &#115;&#116;y&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+least recently used style (string)
 </dd><dt><i>current</i></dt>
 <dd>
-&#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#116;y&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+current style (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#108;&#116;&#97; &#98;&#101;&#116;w&#101;&#101;&#110; &#116;&#104;&#101;&#115;&#101; &#115;&#116;y&#108;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+string containing the delta between these styles (string)
 </dd>
 </dl><a NAME="ExporterRTF.exportSource" ID="ExporterRTF.exportSource"></a>
 <h4>ExporterRTF.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