eric: diff Documentation/Source/eric5.Project.AddFoundFilesDialog.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Project.AddFoundFilesDialog.html
--- a/Documentation/Source/eric5.Project.AddFoundFilesDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Project.AddFoundFilesDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Project.AddFoundFilesDialog</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; &#102;&#111;&#117;&#110;&#100; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114;.
+Module implementing a dialog to show the found files to the user.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</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; &#102;&#111;&#117;&#110;&#100; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114;.</td>
+<td>Class implementing a dialog to show the found files to the user.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,12 +43,12 @@
 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
 <h2>AddFoundFilesDialog</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; &#102;&#111;&#117;&#110;&#100; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114;.
+    Class implementing a dialog to show the found files to the user.
 </p><p>
-    &#84;&#104;&#101; &#102;&#111;&#117;&#110;&#100; &#102;&#105;&#108;&#101;&#115; &#97;&#114;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#105;&#110; &#97; &#108;&#105;&#115;&#116;v&#105;&#101;w.
-    &#80;&#114;&#101;&#115;&#115;&#105;&#110;&#103; &#116;&#104;&#101; '&#65;&#100;&#100; &#65;&#108;&#108;' &#98;&#117;&#116;&#116;&#111;&#110; &#97;&#100;&#100;&#115; &#97;&#108;&#108; &#102;&#105;&#108;&#101;&#115; &#116;&#111; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#112;&#114;&#111;&#106;&#101;&#99;&#116;,
-    &#116;&#104;&#101; '&#65;&#100;&#100; &#83;&#101;&#108;&#101;&#99;&#116;&#101;&#100;' &#98;&#117;&#116;&#116;&#111;&#110; &#97;&#100;&#100;&#115; &#111;&#110;&#108;y &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#105;&#108;&#101;&#115; &#97;&#110;&#100; &#116;&#104;&#101; '&#67;&#97;&#110;&#99;&#101;&#108;'
-    &#98;&#117;&#116;&#116;&#111;&#110; &#99;&#97;&#110;&#99;&#101;&#108;&#115; &#116;&#104;&#101; &#111;&#112;&#101;&#114;&#97;&#116;&#105;&#111;&#110;.
+    The found files are displayed in a listview.
+    Pressing the 'Add All' button adds all files to the current project,
+    the 'Add Selected' button adds only the selected files and the 'Cancel'
+    button cancels the operation.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_AddFoundFilesDialog
@@ -60,76 +60,76 @@
 <table>
 <tr>
 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#105;&#116;&#101;&#109;&#115;.</td>
+<td>Public method to return the selected items.</td>
 </tr><tr>
 <td><a href="#AddFoundFilesDialog.on_addAllButton_clicked">on_addAllButton_clicked</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; '&#65;&#100;&#100; &#65;&#108;&#108;' &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the 'Add All' button press.</td>
 </tr><tr>
 <td><a href="#AddFoundFilesDialog.on_addSelectedButton_clicked">on_addSelectedButton_clicked</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; '&#65;&#100;&#100; &#83;&#101;&#108;&#101;&#99;&#116;&#101;&#100;' &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the 'Add Selected' button press.</td>
 </tr><tr>
 <td><a href="#AddFoundFilesDialog.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>
 </table>
 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a>
 <h4>AddFoundFilesDialog (Constructor)</h4>
 <b>AddFoundFilesDialog</b>(<i>files, parent = None, name = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>files</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#102;&#105;&#108;&#101;&#115;, &#116;&#104;&#97;&#116; &#104;&#97;v&#101; &#98;&#101;&#101;&#110; &#102;&#111;&#117;&#110;&#100; &#102;&#111;&#114; &#97;&#100;&#100;&#105;&#116;&#105;&#111;&#110; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of files, that have been found for addition (list of strings)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#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;)
+parent widget of this dialog (QWidget)
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of this dialog (string)
 </dd>
 </dl><a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a>
 <h4>AddFoundFilesDialog.getSelection</h4>
 <b>getSelection</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#117;&#114;&#110; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#105;&#116;&#101;&#109;&#115;.
+        Public method to return the selected items.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#105;&#108;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of selected files (list of strings)
 </dd>
 </dl><a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a>
 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4>
 <b>on_addAllButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; '&#65;&#100;&#100; &#65;&#108;&#108;' &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the 'Add All' button press.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#97;&#108;w&#97;y&#115; &#49; (&#105;&#110;&#116;)
+always 1 (int)
 </dd>
 </dl><a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a>
 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4>
 <b>on_addSelectedButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; '&#65;&#100;&#100; &#83;&#101;&#108;&#101;&#99;&#116;&#101;&#100;' &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the 'Add Selected' button press.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#97;&#108;w&#97;y&#115; &#50; (&#105;&#110;&#116;)
+always 2 (int)
 </dd>
 </dl><a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a>
 <h4>AddFoundFilesDialog.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>
 <div align="right"><a href="#top">Up</a></div>