Documentation/Source/eric6.Project.AddFileDialog.html

changeset 3673
e26d7d0c1088
child 4602
48cc4820e2c2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.Project.AddFileDialog.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Project.AddFileDialog</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>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 />
+<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_sourceFileButton_clicked">on_sourceFileButton_clicked</a></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>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>Private slot to display a directory selection dialog.</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, filter=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>filter</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>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_sourceFileButton_clicked" ID="AddFileDialog.on_sourceFileButton_clicked"></a>
+<h4>AddFileDialog.on_sourceFileButton_clicked</h4>
+<b>on_sourceFileButton_clicked</b>(<i></i>)
+<p>
+        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>
+        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 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>
+        Private slot to display a directory selection dialog.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial