eric7/Documentation/Source/eric7.Project.AddFoundFilesDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.Project.AddFoundFilesDialog.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,175 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Project.AddFoundFilesDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Project.AddFoundFilesDialog</h1>
+
+<p>
+Module implementing a dialog to show the found files to the user.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td>
+<td>Class implementing a dialog to show the found files to the user.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
+<h2>AddFoundFilesDialog</h2>
+
+<p>
+    Class implementing a dialog to show the found files to the user.
+</p>
+<p>
+    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
+<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="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></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>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>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>Private slot called by a button of the button box clicked.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</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>
+        Constructor
+</p>
+<dl>
+
+<dt><i>files</i></dt>
+<dd>
+list of files, that have been found for addition
+            (list of strings)
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent widget of this dialog (QWidget)
+</dd>
+<dt><i>name</i></dt>
+<dd>
+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>
+        Public method to return the selected items.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+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>
+        Private slot to handle the 'Add All' button press.
+</p>
+<p>
+        Always returns the value 1 (integer).
+</p>
+<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>
+        Private slot to handle the 'Add Selected' button press.
+</p>
+<p>
+        Always returns the value 2 (integer).
+</p>
+<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>
+        Private slot called by a button of the button box clicked.
+</p>
+<dl>
+
+<dt><i>button</i></dt>
+<dd>
+button that was clicked (QAbstractButton)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial