diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Project.AddFileDialog.html
--- a/eric6/Documentation/Source/eric6.Project.AddFileDialog.html Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Project.AddFileDialog.html Wed Sep 25 19:42:44 2019 +0200
@@ -18,113 +18,147 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>eric6.Project.AddFileDialog</h1>
+
<p>
Module implementing a dialog to add a file to the project.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#AddFileDialog">AddFileDialog</a></td>
<td>Class implementing a dialog to add a file to the project.</td>
</tr>
</table>
<h3>Functions</h3>
+
<table>
<tr><td>None</td></tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="AddFileDialog" ID="AddFileDialog"></a>
<h2>AddFileDialog</h2>
+
<p>
Class implementing a dialog to add a file to the project.
</p>
<h3>Derived from</h3>
QDialog, Ui_AddFileDialog
<h3>Class Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
+
<table>
+
<tr>
<td><a href="#AddFileDialog.__init__">AddFileDialog</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#AddFileDialog.getData">getData</a></td>
<td>Public slot to retrieve the dialogs data.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog">on_sourceFilesPicker_aboutToShowPathPickerDialog</a></td>
<td>Private slot to perform actions before the source files selection dialog is shown.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#AddFileDialog.on_sourceFilesPicker_textChanged">on_sourceFilesPicker_textChanged</a></td>
<td>Private slot to handle the source file text changed.</td>
</tr>
</table>
<h3>Static Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AddFileDialog.__init__" ID="AddFileDialog.__init__"></a>
<h4>AddFileDialog (Constructor)</h4>
<b>AddFileDialog</b>(<i>pro, parent=None, fileTypeFilter=None, name=None, startdir=None</i>)
+
<p>
Constructor
-</p><dl>
+</p>
+<dl>
+
<dt><i>pro</i></dt>
<dd>
reference to the project object
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
<dd>
parent widget of this dialog (QWidget)
-</dd><dt><i>fileTypeFilter</i></dt>
+</dd>
+<dt><i>fileTypeFilter</i></dt>
<dd>
filter specification for the file to add (string)
-</dd><dt><i>name</i></dt>
+</dd>
+<dt><i>name</i></dt>
<dd>
name of this dialog (string)
-</dd><dt><i>startdir</i></dt>
+</dd>
+<dt><i>startdir</i></dt>
<dd>
start directory for the selection dialog
</dd>
-</dl><a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a>
+</dl>
+<a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a>
<h4>AddFileDialog.getData</h4>
<b>getData</b>(<i></i>)
+
<p>
Public slot to retrieve the dialogs data.
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
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_sourceFilesPicker_aboutToShowPathPickerDialog" ID="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog"></a>
+</dl>
+<a NAME="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog" ID="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog"></a>
<h4>AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog</h4>
<b>on_sourceFilesPicker_aboutToShowPathPickerDialog</b>(<i></i>)
+
<p>
Private slot to perform actions before the source files selection
dialog is shown.
-</p><a NAME="AddFileDialog.on_sourceFilesPicker_textChanged" ID="AddFileDialog.on_sourceFilesPicker_textChanged"></a>
+</p>
+<a NAME="AddFileDialog.on_sourceFilesPicker_textChanged" ID="AddFileDialog.on_sourceFilesPicker_textChanged"></a>
<h4>AddFileDialog.on_sourceFilesPicker_textChanged</h4>
<b>on_sourceFilesPicker_textChanged</b>(<i>sfile</i>)
+
<p>
Private slot to handle the source file text changed.
-</p><p>
+</p>
+<p>
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>
+</p>
+<dl>
+
<dt><i>sfile</i></dt>
<dd>
the text of the source file picker (string)
