Documentation/Source/eric5.Preferences.ProgramsDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Preferences.ProgramsDialog.html
--- a/Documentation/Source/eric5.Preferences.ProgramsDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Preferences.ProgramsDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Preferences.ProgramsDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;.
+Module implementing the Programs page.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ProgramsDialog">ProgramsDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;.</td>
+<td>Class implementing the Programs page.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="ProgramsDialog" ID="ProgramsDialog"></a>
 <h2>ProgramsDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;.
+    Class implementing the Programs page.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_ProgramsDialog
@@ -55,109 +55,109 @@
 <table>
 <tr>
 <td><a href="#ProgramsDialog.__init__">ProgramsDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ProgramsDialog.__createEntry">__createEntry</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.</td>
+<td>Private method to generate a program entry.</td>
 </tr><tr>
 <td><a href="#ProgramsDialog.__createProgramEntry">__createProgramEntry</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.</td>
+<td>Private method to generate a program entry.</td>
 </tr><tr>
 <td><a href="#ProgramsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.</td>
+<td>Private slot called by a button of the button box clicked.</td>
 </tr><tr>
 <td><a href="#ProgramsDialog.on_programsSearchButton_clicked">on_programsSearchButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#97;&#114;&#99;&#104; &#102;&#111;&#114; &#97;&#108;&#108; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;/&#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#112;&#114;&#111;&#103;&#114;&#97;&#109;&#115;.</td>
+<td>Private slot to search for all supported/required programs.</td>
 </tr><tr>
 <td><a href="#ProgramsDialog.show">show</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Public slot to show the dialog.</td>
 </tr>
 </table>
 <a NAME="ProgramsDialog.__init__" ID="ProgramsDialog.__init__"></a>
 <h4>ProgramsDialog (Constructor)</h4>
 <b>ProgramsDialog</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#84;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103;. (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+The parent widget of this dialog. (QWidget)
 </dd>
 </dl><a NAME="ProgramsDialog.__createEntry" ID="ProgramsDialog.__createEntry"></a>
 <h4>ProgramsDialog.__createEntry</h4>
 <b>__createEntry</b>(<i>description, entryText, entryVersion</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.
+        Private method to generate a program entry.
 </p><dl>
 <dt><i>description</i></dt>
 <dd>
-&#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#116;&#101;x&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+descriptive text (string)
 </dd><dt><i>entryText</i></dt>
 <dd>
-&#116;&#101;x&#116; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;)
+text to show (string)
 </dd><dt><i>entryVersion</i></dt>
 <dd>
-v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;).
+version string to show (string).
 </dd>
 </dl><a NAME="ProgramsDialog.__createProgramEntry" ID="ProgramsDialog.__createProgramEntry"></a>
 <h4>ProgramsDialog.__createProgramEntry</h4>
 <b>__createProgramEntry</b>(<i>description, exe, versionCommand = "", versionStartsWith = "", versionPosition = 0, version = "", versionCleanup = None, versionRe = None</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97; &#112;&#114;&#111;&#103;&#114;&#97;&#109; &#101;&#110;&#116;&#114;y.
+        Private method to generate a program entry.
 </p><dl>
 <dt><i>description</i></dt>
 <dd>
-&#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;v&#101; &#116;&#101;x&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+descriptive text (string)
 </dd><dt><i>exe</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the executable program (string)
 </dd><dt><i>versionCommand</i></dt>
 <dd>
-&#99;&#111;&#109;&#109;&#97;&#110;&#100; &#108;&#105;&#110;&#101; &#115;w&#105;&#116;&#99;&#104; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;)
-            &#105;&#102; &#116;&#104;&#105;&#115; &#105;&#115; &#101;&#109;&#112;&#116;y, &#116;&#104;&#101; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; w&#105;&#108;&#108; &#98;&#101; &#115;&#104;&#111;w&#110;.
+command line switch to get the version info (string)
+            if this is empty, the given version will be shown.
 </dd><dt><i>versionStartsWith</i></dt>
 <dd>
-&#115;&#116;&#97;&#114;&#116; &#111;&#102; &#108;&#105;&#110;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;y&#105;&#110;&#103; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;)
+start of line identifying version info (string)
 </dd><dt><i>versionPosition</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#112;&#97;&#114;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#105;&#110;&#102;&#111; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+index of part containing the version info (integer)
 </dd><dt><i>version=</i></dt>
 <dd>
-v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;)
+version string to show (string)
 </dd><dt><i>versionCleanup=</i></dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#105;&#110;&#116;&#101;&#103;&#101;&#114;&#115; &#103;&#105;v&#105;&#110;&#103; &#115;&#116;&#114;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;&#115;
-            &#115;&#116;&#97;&#114;&#116; &#97;&#110;&#100; &#115;&#116;&#111;&#112; &#102;&#111;&#114; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; (&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#105;&#110;&#116;&#101;&#103;&#101;&#114;&#115;)
+tuple of two integers giving string positions
+            start and stop for the version string (tuple of integers)
 </dd><dt><i>versionRe=</i></dt>
 <dd>
-&#114;&#101;&#103;&#101;x&#112; &#116;&#111; &#100;&#101;&#116;&#101;&#114;&#109;&#105;&#110;&#101; &#116;&#104;&#101; &#108;&#105;&#110;&#101; &#105;&#100;&#101;&#110;&#116;&#105;&#102;y&#105;&#110;&#103; v&#101;&#114;&#115;&#105;&#111;&#110;
-            &#105;&#110;&#102;&#111; (&#115;&#116;&#114;&#105;&#110;&#103;). &#84;&#97;&#107;&#101;&#115; &#112;&#114;&#101;&#99;&#101;&#100;&#101;&#110;&#99;&#101; &#111;v&#101;&#114; v&#101;&#114;&#115;&#105;&#111;&#110;&#83;&#116;&#97;&#114;&#116;&#115;&#87;&#105;&#116;&#104;.
+regexp to determine the line identifying version
+            info (string). Takes precedence over versionStartsWith.
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-v&#101;&#114;&#115;&#105;&#111;&#110; &#115;&#116;&#114;&#105;&#110;&#103; &#111;&#102; &#100;&#101;&#116;&#101;&#99;&#116;&#101;&#100; &#111;&#114; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+version string of detected or given version (string)
 </dd>
 </dl><a NAME="ProgramsDialog.on_buttonBox_clicked" ID="ProgramsDialog.on_buttonBox_clicked"></a>
 <h4>ProgramsDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.
+        Private slot called by a button of the button box clicked.
 </p><dl>
 <dt><i>button</i></dt>
 <dd>
-&#98;&#117;&#116;&#116;&#111;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#65;&#98;&#115;&#116;&#114;&#97;&#99;&#116;&#66;&#117;&#116;&#116;&#111;&#110;)
+button that was clicked (QAbstractButton)
 </dd>
 </dl><a NAME="ProgramsDialog.on_programsSearchButton_clicked" ID="ProgramsDialog.on_programsSearchButton_clicked"></a>
 <h4>ProgramsDialog.on_programsSearchButton_clicked</h4>
 <b>on_programsSearchButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#97;&#114;&#99;&#104; &#102;&#111;&#114; &#97;&#108;&#108; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;/&#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#112;&#114;&#111;&#103;&#114;&#97;&#109;&#115;.
+        Private slot to search for all supported/required programs.
 </p><a NAME="ProgramsDialog.show" ID="ProgramsDialog.show"></a>
 <h4>ProgramsDialog.show</h4>
 <b>show</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Public slot to show the dialog.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial