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

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Project.AddFileDialog.html
--- a/Documentation/Source/eric5.Project.AddFileDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Project.AddFileDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Project.AddFileDialog</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; &#97;&#100;&#100; &#97; &#102;&#105;&#108;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+Module implementing a dialog to add a file to the project.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#AddFileDialog">AddFileDialog</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; &#97;&#100;&#100; &#97; &#102;&#105;&#108;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</td>
+<td>Class implementing a dialog to add a file to the project.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="AddFileDialog" ID="AddFileDialog"></a>
 <h2>AddFileDialog</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; &#97;&#100;&#100; &#97; &#102;&#105;&#108;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+    Class implementing a dialog to add a file to the project.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_AddFileDialog
@@ -55,80 +55,80 @@
 <table>
 <tr>
 <td><a href="#AddFileDialog.__init__">AddFileDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#AddFileDialog.getData">getData</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;&#115; &#100;&#97;&#116;&#97;.</td>
+<td>Public slot to retrieve the dialogs data.</td>
 </tr><tr>
 <td><a href="#AddFileDialog.on_sourceFileButton_clicked">on_sourceFileButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Private slot to display a file selection dialog.</td>
 </tr><tr>
 <td><a href="#AddFileDialog.on_sourceFileEdit_textChanged">on_sourceFileEdit_textChanged</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; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#116;&#101;x&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#100;.</td>
+<td>Private slot to handle the source file text changed.</td>
 </tr><tr>
 <td><a href="#AddFileDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Private slot to display a directory selection dialog.</td>
 </tr>
 </table>
 <a NAME="AddFileDialog.__init__" ID="AddFileDialog.__init__"></a>
 <h4>AddFileDialog (Constructor)</h4>
 <b>AddFileDialog</b>(<i>pro, parent = None, filter = None, name = None, startdir = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>pro</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the project object
 </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>filter</i></dt>
 <dd>
-&#102;&#105;&#108;&#116;&#101;&#114; &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#116;&#111; &#97;&#100;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filter specification for the file to add (string)
 </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><dt><i>startdir</i></dt>
 <dd>
-&#115;&#116;&#97;&#114;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;
+start directory for the selection dialog
 </dd>
 </dl><a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a>
 <h4>AddFileDialog.getData</h4>
 <b>getData</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;&#115; &#100;&#97;&#116;&#97;.
+        Public slot to retrieve the dialogs data.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#114;&#101;&#101; v&#97;&#108;&#117;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;, &#115;&#116;&#114;&#105;&#110;&#103;, &#98;&#111;&#111;&#108;&#101;&#97;&#110;) &#103;&#105;v&#105;&#110;&#103; &#116;&#104;&#101;
-            &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101;&#115;, &#116;&#104;&#101; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#97;&#110;&#100; &#97; &#102;&#108;&#97;&#103; &#116;&#101;&#108;&#108;&#105;&#110;&#103;, w&#104;&#101;&#116;&#104;&#101;&#114;
-            &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#97;&#100;&#100;&#101;&#100; &#97;&#115; &#115;&#111;&#117;&#114;&#99;&#101; &#99;&#111;&#100;&#101;
+tuple of three values (list of string, string, boolean) giving the
+            source files, the target directory and a flag telling, whether
+            the files shall be added as source code
 </dd>
 </dl><a NAME="AddFileDialog.on_sourceFileButton_clicked" ID="AddFileDialog.on_sourceFileButton_clicked"></a>
 <h4>AddFileDialog.on_sourceFileButton_clicked</h4>
 <b>on_sourceFileButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Private slot to display a file selection dialog.
 </p><a NAME="AddFileDialog.on_sourceFileEdit_textChanged" ID="AddFileDialog.on_sourceFileEdit_textChanged"></a>
 <h4>AddFileDialog.on_sourceFileEdit_textChanged</h4>
 <b>on_sourceFileEdit_textChanged</b>(<i>sfile</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#116;&#101;x&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#100;.
+        Private slot to handle the source file text changed.
 </p><p>
-        &#73;&#102; &#116;&#104;&#101; &#101;&#110;&#116;&#101;&#114;&#101;&#100; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#105;&#115; &#97; &#115;&#117;&#98;&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116;
-        &#112;&#114;&#111;&#106;&#101;&#99;&#116;&#115; &#109;&#97;&#105;&#110; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y, &#116;&#104;&#101; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#112;&#97;&#116;&#104; &#105;&#115; &#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#105;z&#101;&#100;.
-        &#73;&#116; &#105;&#115; &#97;&#115;&#115;&#117;&#109;&#101;&#100;, &#116;&#104;&#97;&#116; &#116;&#104;&#101; &#117;&#115;&#101;&#114; w&#97;&#110;&#116;&#115; &#116;&#111; &#97;&#100;&#100; &#97; &#98;&#117;&#110;&#99;&#104; &#111;&#102; &#102;&#105;&#108;&#101;&#115; &#116;&#111;
-        &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110; &#112;&#108;&#97;&#99;&#101;.
+        If the entered source directory is a subdirectory of the current
+        projects main directory, the target directory path is synchronized.
+        It is assumed, that the user wants to add a bunch of files to
+        the project in place.
 </p><dl>
 <dt><i>sfile</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#101;x&#116; &#111;&#102; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#102;&#105;&#108;&#101; &#108;&#105;&#110;&#101; &#101;&#100;&#105;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the text of the source file line edit (string)
 </dd>
 </dl><a NAME="AddFileDialog.on_targetDirButton_clicked" ID="AddFileDialog.on_targetDirButton_clicked"></a>
 <h4>AddFileDialog.on_targetDirButton_clicked</h4>
 <b>on_targetDirButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Private slot to display a directory selection dialog.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />