src/eric7/Documentation/Source/eric7.MultiProject.AddProjectDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.MultiProject.AddProjectDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MultiProject.AddProjectDialog</h1>

<p>
Module implementing the add project dialog.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#AddProjectDialog">AddProjectDialog</a></td>
<td>Class implementing the add project dialog.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="AddProjectDialog" ID="AddProjectDialog"></a>
<h2>AddProjectDialog</h2>

<p>
    Class implementing the add project dialog.
</p>
<h3>Derived from</h3>
QDialog, Ui_AddProjectDialog
<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="#AddProjectDialog.__init__">AddProjectDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#AddProjectDialog.__getFileName">__getFileName</a></td>
<td>Private method to get the file name of the project file.</td>
</tr>
<tr>
<td><a href="#AddProjectDialog.__updateUi">__updateUi</a></td>
<td>Private method to update the dialog.</td>
</tr>
<tr>
<td><a href="#AddProjectDialog.getProjectMetadata">getProjectMetadata</a></td>
<td>Public method to get the entered project metadata.</td>
</tr>
<tr>
<td><a href="#AddProjectDialog.on_filenamePicker_textChanged">on_filenamePicker_textChanged</a></td>
<td>Private slot called when the project filename has changed.</td>
</tr>
<tr>
<td><a href="#AddProjectDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
<td>Private slot called when the project name has changed.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="AddProjectDialog.__init__" ID="AddProjectDialog.__init__"></a>
<h4>AddProjectDialog (Constructor)</h4>
<b>AddProjectDialog</b>(<i>parent=None, startdir="", project=None, categories=None, category=""</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget of this dialog
</dd>
<dt><i>startdir</i> (str)</dt>
<dd>
start directory for the selection dialog
</dd>
<dt><i>project</i> (MultiProjectProjectMeta)</dt>
<dd>
dictionary containing project metadata
</dd>
<dt><i>categories</i> (list of str)</dt>
<dd>
list of already used categories
</dd>
<dt><i>category</i> (str)</dt>
<dd>
category to be preset
</dd>
</dl>
<a NAME="AddProjectDialog.__getFileName" ID="AddProjectDialog.__getFileName"></a>
<h4>AddProjectDialog.__getFileName</h4>
<b>__getFileName</b>(<i></i>)

<p>
        Private method to get the file name of the project file.
</p>
<dl>
<dt>Return:</dt>
<dd>
project file name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="AddProjectDialog.__updateUi" ID="AddProjectDialog.__updateUi"></a>
<h4>AddProjectDialog.__updateUi</h4>
<b>__updateUi</b>(<i></i>)

<p>
        Private method to update the dialog.
</p>
<a NAME="AddProjectDialog.getProjectMetadata" ID="AddProjectDialog.getProjectMetadata"></a>
<h4>AddProjectDialog.getProjectMetadata</h4>
<b>getProjectMetadata</b>(<i></i>)

<p>
        Public method to get the entered project metadata.
</p>
<dl>
<dt>Return:</dt>
<dd>
project metadata iaw. the entered values
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
MultiProjectProjectMeta
</dd>
</dl>
<a NAME="AddProjectDialog.on_filenamePicker_textChanged" ID="AddProjectDialog.on_filenamePicker_textChanged"></a>
<h4>AddProjectDialog.on_filenamePicker_textChanged</h4>
<b>on_filenamePicker_textChanged</b>(<i>txt</i>)

<p>
        Private slot called when the project filename has changed.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the edit
</dd>
</dl>
<a NAME="AddProjectDialog.on_nameEdit_textChanged" ID="AddProjectDialog.on_nameEdit_textChanged"></a>
<h4>AddProjectDialog.on_nameEdit_textChanged</h4>
<b>on_nameEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot called when the project name has changed.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
text of the edit
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>