--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Project.AddDirectoryDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,175 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Project.AddDirectoryDialog</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.AddDirectoryDialog</h1> + +<p> +Module implementing a dialog to add files of a directory to the project. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> +<td>Class implementing a dialog to add files of a directory to the project.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> +<h2>AddDirectoryDialog</h2> + +<p> + Class implementing a dialog to add files of a directory to the project. +</p> +<h3>Derived from</h3> +QDialog, Ui_AddDirectoryDialog +<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="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#AddDirectoryDialog.getData">getData</a></td> +<td>Public slot to retrieve the dialogs data.</td> +</tr> +<tr> +<td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td> +<td>Private slot to handle the selection of a file type.</td> +</tr> +<tr> +<td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td> +<td>Private slot to handle the source directory text changed.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> +<h4>AddDirectoryDialog (Constructor)</h4> +<b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>pro</i></dt> +<dd> +reference to the project object +</dd> +<dt><i>fileTypeFilter</i></dt> +<dd> +file type filter (string) +</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> +<dt><i>startdir</i></dt> +<dd> +start directory for the selection dialog +</dd> +</dl> +<a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> +<h4>AddDirectoryDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public slot to retrieve the dialogs data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of four values (string, string, string, boolean) giving + the selected file type, the source and target directory and + a flag indicating a recursive add +</dd> +</dl> +<a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a> +<h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4> +<b>on_filterComboBox_highlighted</b>(<i>index</i>) + +<p> + Private slot to handle the selection of a file type. +</p> +<dl> + +<dt><i>index</i> (int)</dt> +<dd> +index of the selected entry +</dd> +</dl> +<a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a> +<h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4> +<b>on_sourceDirPicker_textChanged</b>(<i>directory</i>) + +<p> + Private slot to handle the source directory 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>directory</i></dt> +<dd> +the text of the source directory line edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file