--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Project.NewDirectoryDialog.html Sun Jul 14 17:38:30 2024 +0200 @@ -0,0 +1,132 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Project.NewDirectoryDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Project.NewDirectoryDialog</h1> +<p> +Module implementing a dialog to enter the data for a new project sub-directory. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#NewDirectoryDialog">NewDirectoryDialog</a></td> +<td>Class implementing a dialog to enter the data for a new project sub-directory.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="NewDirectoryDialog" ID="NewDirectoryDialog"></a> +<h2>NewDirectoryDialog</h2> +<p> + Class implementing a dialog to enter the data for a new project sub-directory. +</p> + +<h3>Derived from</h3> +QDialog +<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="#NewDirectoryDialog.__init__">NewDirectoryDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#NewDirectoryDialog.getDirectory">getDirectory</a></td> +<td>Public method to get the entered directory.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="NewDirectoryDialog.__init__" ID="NewDirectoryDialog.__init__"></a> +<h4>NewDirectoryDialog (Constructor)</h4> +<b>NewDirectoryDialog</b>(<i>title=None, label=None, mode=EricPathPickerModes.DIRECTORY_MODE, strPath=None, defaultDirectory=None, remote=False, parent=None, </i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>title</i> (str (optional))</dt> +<dd> +title of the dialog (defaults to None) +</dd> +<dt><i>label</i> (str (optional))</dt> +<dd> +text to be shown above the directory path picker (defaults to None) +</dd> +<dt><i>mode</i> (EricPathPickerModes (optional))</dt> +<dd> +mode of the path picker (defaults to + EricPathPickerModes.DIRECTORY_MODE) +</dd> +<dt><i>strPath</i> (str (optional))</dt> +<dd> +initial path to be shown (defaults to None) +</dd> +<dt><i>defaultDirectory</i> (str (optional))</dt> +<dd> +default directory of the path picker selection dialog + (defaults to None) +</dd> +<dt><i>remote</i> (bool (optional))</dt> +<dd> +flag indicating the remote mode (defaults to False) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="NewDirectoryDialog.getDirectory" ID="NewDirectoryDialog.getDirectory"></a> +<h4>NewDirectoryDialog.getDirectory</h4> +<b>getDirectory</b>(<i></i>) +<p> + Public method to get the entered directory. +</p> + +<dl> +<dt>Return:</dt> +<dd> +tuple containing the entered directory and a flag indicating to add + that directory to the project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>