Documentation/Source/eric5.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+Module implementing a dialog to show the output of the tabnanny command process.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#TabnannyDialog">TabnannyDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#104;&#101;&#99;&#107; &#114;&#117;&#110;.</td>
+<td>Class implementing a dialog to show the results of the tabnanny check run.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="TabnannyDialog" ID="TabnannyDialog"></a>
 <h2>TabnannyDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116;&#115; &#111;&#102; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#104;&#101;&#99;&#107; &#114;&#117;&#110;.
+    Class implementing a dialog to show the results of the tabnanny check run.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_TabnannyDialog
@@ -55,96 +55,96 @@
 <table>
 <tr>
 <td><a href="#TabnannyDialog.__init__">TabnannyDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#TabnannyDialog.__createResultItem">__createResultItem</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#101;&#110;&#116;&#114;y &#105;&#110; &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116; &#108;&#105;&#115;&#116;.</td>
+<td>Private method to create an entry in the result list.</td>
 </tr><tr>
 <td><a href="#TabnannyDialog.__finish">__finish</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#114; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Private slot called when the action or the user pressed the button.</td>
 </tr><tr>
 <td><a href="#TabnannyDialog.__resort">__resort</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#111;&#114;&#116; &#116;&#104;&#101; &#116;&#114;&#101;&#101;.</td>
+<td>Private method to resort the tree.</td>
 </tr><tr>
 <td><a href="#TabnannyDialog.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="#TabnannyDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.</td>
+<td>Private slot to handle the activation of an item.</td>
 </tr><tr>
 <td><a href="#TabnannyDialog.start">start</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#104;&#101;&#99;&#107;.</td>
+<td>Public slot to start the tabnanny check.</td>
 </tr>
 </table>
 <a NAME="TabnannyDialog.__init__" ID="TabnannyDialog.__init__"></a>
 <h4>TabnannyDialog (Constructor)</h4>
 <b>TabnannyDialog</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; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;).
+The parent widget (QWidget).
 </dd>
 </dl><a NAME="TabnannyDialog.__createResultItem" ID="TabnannyDialog.__createResultItem"></a>
 <h4>TabnannyDialog.__createResultItem</h4>
 <b>__createResultItem</b>(<i>file, line, sourcecode</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#101;&#110;&#116;&#114;y &#105;&#110; &#116;&#104;&#101; &#114;&#101;&#115;&#117;&#108;&#116; &#108;&#105;&#115;&#116;.
+        Private method to create an entry in the result list.
 </p><dl>
 <dt><i>file</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename of file (string)
 </dd><dt><i>line</i></dt>
 <dd>
-&#108;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#102;&#97;&#117;&#108;&#116;y &#115;&#111;&#117;&#114;&#99;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114; &#111;&#114; &#115;&#116;&#114;&#105;&#110;&#103;)
+linenumber of faulty source (integer or string)
 </dd><dt><i>sourcecode</i></dt>
 <dd>
-&#102;&#97;&#117;&#108;&#116;y &#108;&#105;&#110;&#101; &#111;&#102; &#99;&#111;&#100;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+faulty line of code (string)
 </dd>
 </dl><a NAME="TabnannyDialog.__finish" ID="TabnannyDialog.__finish"></a>
 <h4>TabnannyDialog.__finish</h4>
 <b>__finish</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#97;&#99;&#116;&#105;&#111;&#110; &#111;&#114; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.
+        Private slot called when the action or the user pressed the button.
 </p><a NAME="TabnannyDialog.__resort" ID="TabnannyDialog.__resort"></a>
 <h4>TabnannyDialog.__resort</h4>
 <b>__resort</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#115;&#111;&#114;&#116; &#116;&#104;&#101; &#116;&#114;&#101;&#101;.
+        Private method to resort the tree.
 </p><a NAME="TabnannyDialog.on_buttonBox_clicked" ID="TabnannyDialog.on_buttonBox_clicked"></a>
 <h4>TabnannyDialog.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="TabnannyDialog.on_resultList_itemActivated" ID="TabnannyDialog.on_resultList_itemActivated"></a>
 <h4>TabnannyDialog.on_resultList_itemActivated</h4>
 <b>on_resultList_itemActivated</b>(<i>itm, col</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;. 
+        Private slot to handle the activation of an item. 
 </p><dl>
 <dt><i>itm</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100; &#105;&#116;&#101;&#109; (&#81;&#84;&#114;&#101;&#101;&#87;&#105;&#100;&#103;&#101;&#116;&#73;&#116;&#101;&#109;)
+reference to the activated item (QTreeWidgetItem)
 </dd><dt><i>col</i></dt>
 <dd>
-&#99;&#111;&#108;&#117;&#109;&#110; &#116;&#104;&#101; &#105;&#116;&#101;&#109; w&#97;&#115; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100; &#105;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+column the item was activated in (integer)
 </dd>
 </dl><a NAME="TabnannyDialog.start" ID="TabnannyDialog.start"></a>
 <h4>TabnannyDialog.start</h4>
 <b>start</b>(<i>fn</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#116;&#97;&#98;&#110;&#97;&#110;&#110;y &#99;&#104;&#101;&#99;&#107;.
+        Public slot to start the tabnanny check.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
-&#70;&#105;&#108;&#101; &#111;&#114; &#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#101;&#115; &#111;&#114; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100;
-                (&#115;&#116;&#114;&#105;&#110;&#103; &#111;&#114; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+File or list of files or directory to be checked
+                (string or list of strings)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial