diff -r eb28b4b6f7f5 -r dcbd3a96f03c ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html --- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html Tue Jun 01 19:37:46 2021 +0200 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html Sun Jun 06 16:30:37 2021 +0200 @@ -57,7 +57,7 @@ <h3>Class Attributes</h3> <table> -<tr><td>None</td></tr> +<tr><td>PyramidStarter</td></tr><tr><td>PyramidStarterGH</td></tr> </table> <h3>Class Methods</h3> @@ -73,10 +73,6 @@ <td>Constructor</td> </tr> <tr> -<td><a href="#CreateParametersDialog.__prepareScaffoldString">__prepareScaffoldString</a></td> -<td>Private method to prepare a scaffold string for the combo box.</td> -</tr> -<tr> <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> <td>Private slot to update the dialog.</td> </tr> @@ -85,11 +81,7 @@ <td>Public method to get the data.</td> </tr> <tr> -<td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> -<td>Private slot to handle changes of the site name.</td> -</tr> -<tr> -<td><a href="#CreateParametersDialog.on_scaffoldCombo_currentTextChanged">on_scaffoldCombo_currentTextChanged</a></td> +<td><a href="#CreateParametersDialog.on_templateCombo_currentTextChanged">on_templateCombo_currentTextChanged</a></td> <td>Private slot to handle changes of the selected scaffold.</td> </tr> </table> @@ -101,49 +93,18 @@ <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> <h4>CreateParametersDialog (Constructor)</h4> -<b>CreateParametersDialog</b>(<i>project, parent=None</i>) +<b>CreateParametersDialog</b>(<i>parent=None</i>) <p> Constructor </p> <dl> -<dt><i>project</i> (Project)</dt> -<dd> -reference to the project object -</dd> <dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> </dl> -<a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a> -<h4>CreateParametersDialog.__prepareScaffoldString</h4> -<b>__prepareScaffoldString</b>(<i>line</i>) - -<p> - Private method to prepare a scaffold string for the combo box. -</p> -<dl> - -<dt><i>line</i> (str)</dt> -<dd> -output line containing the scaffold name and some - explanatory text -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -prepared scaffold text -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> <a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> <h4>CreateParametersDialog.__updateUi</h4> <b>__updateUi</b>(<i></i>) @@ -161,34 +122,20 @@ <dl> <dt>Return:</dt> <dd> -tuple giving the scaffold, the project name, a flag indicating - to overwrite existing files and a flag indicating to simulate the - creation +tuple giving the template name, an optional template version, + a flag indicating to overwrite existing files and a dictionary + containing additional context data </dd> </dl> <dl> <dt>Return Type:</dt> <dd> -tuple of (str, str, bool, bool) +tuple of (str, str, bool) </dd> </dl> -<a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> -<h4>CreateParametersDialog.on_nameEdit_textChanged</h4> -<b>on_nameEdit_textChanged</b>(<i>text</i>) - -<p> - Private slot to handle changes of the site name. -</p> -<dl> - -<dt><i>text</i> (str)</dt> -<dd> -text of the site entry -</dd> -</dl> -<a NAME="CreateParametersDialog.on_scaffoldCombo_currentTextChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentTextChanged"></a> -<h4>CreateParametersDialog.on_scaffoldCombo_currentTextChanged</h4> -<b>on_scaffoldCombo_currentTextChanged</b>(<i>text</i>) +<a NAME="CreateParametersDialog.on_templateCombo_currentTextChanged" ID="CreateParametersDialog.on_templateCombo_currentTextChanged"></a> +<h4>CreateParametersDialog.on_templateCombo_currentTextChanged</h4> +<b>on_templateCombo_currentTextChanged</b>(<i>text</i>) <p> Private slot to handle changes of the selected scaffold.