src/eric7/Documentation/Source/eric7.Project.AddFileDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9530
c30f02ea1b27
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Project.AddFileDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,155 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Project.AddFileDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<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>
+<td><a href="#AddFileDialog.getData">getData</a></td>
+<td>Public slot to retrieve the dialogs data.</td>
+</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>
+<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>
+
+<dt><i>pro</i></dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget of this dialog (QWidget)
+</dd>
+<dt><i>fileTypeFilter</i></dt>
+<dd>
+filter specification for the file to add (string)
+</dd>
+<dt><i>name</i></dt>
+<dd>
+name of this dialog (string)
+</dd>
+<dt><i>startdir</i></dt>
+<dd>
+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>
+        Public slot to retrieve the dialogs data.
+</p>
+<dl>
+<dt>Return:</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>
+<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>
+<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>
+        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>
+the text of the source file picker (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial