diff -r 831e08e94960 -r 2f1ccadee231 eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html --- a/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html Sat Jul 02 17:22:06 2022 +0200 +++ b/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.SetupWizard.SetupWizardDialog.html Sat Jul 02 18:53:56 2022 +0200 @@ -75,6 +75,18 @@ <td>Private method to get the license text.</td> </tr> <tr> +<td><a href="#SetupWizardDialog.__getPyprojectCode">__getPyprojectCode</a></td> +<td>Private method to get the source code for a 'pyproject.toml' file.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.__getSetupCfgCode">__getSetupCfgCode</a></td> +<td>Private method to get the source code for a 'setup.cfg' file.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.__getSetupPyCode">__getSetupPyCode</a></td> +<td>Private method to get the source code for a 'setup.py' file.</td> +</tr> +<tr> <td><a href="#SetupWizardDialog.__getStartDir">__getStartDir</a></td> <td>Private method to get the start directory for selection dialogs.</td> </tr> @@ -87,6 +99,10 @@ <td>Public method to get the source code.</td> </tr> <tr> +<td><a href="#SetupWizardDialog.on_addEntryPointButton_clicked">on_addEntryPointButton_clicked</a></td> +<td>Private slot to add an entry point to the list.</td> +</tr> +<tr> <td><a href="#SetupWizardDialog.on_addExludePatternButton_clicked">on_addExludePatternButton_clicked</a></td> <td>Private slot to add an exclude pattern to the list.</td> </tr> @@ -95,8 +111,8 @@ <td>Private slot to add Python modules to the list.</td> </tr> <tr> -<td><a href="#SetupWizardDialog.on_addScriptButton_clicked">on_addScriptButton_clicked</a></td> -<td>Private slot to add scripts to the list.</td> +<td><a href="#SetupWizardDialog.on_deleteEntryPointButton_clicked">on_deleteEntryPointButton_clicked</a></td> +<td>Private slot to delete the selected entry point items.</td> </tr> <tr> <td><a href="#SetupWizardDialog.on_deleteExcludePatternButton_clicked">on_deleteExcludePatternButton_clicked</a></td> @@ -104,11 +120,15 @@ </tr> <tr> <td><a href="#SetupWizardDialog.on_deleteModuleButton_clicked">on_deleteModuleButton_clicked</a></td> -<td>Private slot to delete the selected script items.</td> +<td>Private slot to delete the selected module items.</td> </tr> <tr> -<td><a href="#SetupWizardDialog.on_deleteScriptButton_clicked">on_deleteScriptButton_clicked</a></td> -<td>Private slot to delete the selected script items.</td> +<td><a href="#SetupWizardDialog.on_editEntryPointButton_clicked">on_editEntryPointButton_clicked</a></td> +<td>Private slot to edit the selected entry point.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.on_entryPointsList_itemSelectionChanged">on_entryPointsList_itemSelectionChanged</a></td> +<td>Private slot to handle a change of selected items of the entry points list.</td> </tr> <tr> <td><a href="#SetupWizardDialog.on_excludePatternEdit_returnPressed">on_excludePatternEdit_returnPressed</a></td> @@ -131,8 +151,20 @@ <td>Private slot to populate some fields with data retrieved from the current project.</td> </tr> <tr> -<td><a href="#SetupWizardDialog.on_scriptsList_itemSelectionChanged">on_scriptsList_itemSelectionChanged</a></td> -<td>Private slot to handle a change of selected items of the scripts list.</td> +<td><a href="#SetupWizardDialog.on_projectUrlsList_itemSelectionChanged">on_projectUrlsList_itemSelectionChanged</a></td> +<td>Private slot to handle a change of selected items of the project URLs list.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.on_urlAddButton_clicked">on_urlAddButton_clicked</a></td> +<td>Private slot to add a project URL to the list.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.on_urlDeleteButton_clicked">on_urlDeleteButton_clicked</a></td> +<td>Private slot to delete the selected URL items.</td> +</tr> +<tr> +<td><a href="#SetupWizardDialog.on_urlEditButton_clicked">on_urlEditButton_clicked</a></td> +<td>Private slot to edit the selected project URL.</td> </tr> </table> <h3>Static Methods</h3> @@ -143,16 +175,27 @@ <a NAME="SetupWizardDialog.__init__" ID="SetupWizardDialog.__init__"></a> <h4>SetupWizardDialog (Constructor)</h4> -<b>SetupWizardDialog</b>(<i>parent=None</i>) +<b>SetupWizardDialog</b>(<i>category, parent=None</i>) <p> Constructor </p> <dl> -<dt><i>parent</i> (QWidget)</dt> +<dt><i>category</i> (str)</dt> +<dd> +category of setup file to create +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> <dd> -reference to the parent widget +reference to the parent widget (defaults to None) +</dd> +</dl> +<dl> + +<dt>Raises <b>ValueError</b>:</dt> +<dd> +raised for an illegal setup file category </dd> </dl> <a NAME="SetupWizardDialog.__addClassifierEntry" ID="SetupWizardDialog.__addClassifierEntry"></a> @@ -195,6 +238,74 @@ str </dd> </dl> +<a NAME="SetupWizardDialog.__getPyprojectCode" ID="SetupWizardDialog.__getPyprojectCode"></a> +<h4>SetupWizardDialog.__getPyprojectCode</h4> +<b>__getPyprojectCode</b>(<i></i>) + +<p> + Private method to get the source code for a 'pyproject.toml' file. +</p> +<dl> +<dt>Return:</dt> +<dd> +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="SetupWizardDialog.__getSetupCfgCode" ID="SetupWizardDialog.__getSetupCfgCode"></a> +<h4>SetupWizardDialog.__getSetupCfgCode</h4> +<b>__getSetupCfgCode</b>(<i></i>) + +<p> + Private method to get the source code for a 'setup.cfg' file. +</p> +<dl> +<dt>Return:</dt> +<dd> +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="SetupWizardDialog.__getSetupPyCode" ID="SetupWizardDialog.__getSetupPyCode"></a> +<h4>SetupWizardDialog.__getSetupPyCode</h4> +<b>__getSetupPyCode</b>(<i>indLevel, indString</i>) + +<p> + Private method to get the source code for a 'setup.py' file. +</p> +<dl> + +<dt><i>indLevel</i> (int)</dt> +<dd> +indentation level +</dd> +<dt><i>indString</i> (str)</dt> +<dd> +string used for indentation (space or tab) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +generated code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="SetupWizardDialog.__getStartDir" ID="SetupWizardDialog.__getStartDir"></a> <h4>SetupWizardDialog.__getStartDir</h4> <b>__getStartDir</b>(<i></i>) @@ -251,6 +362,13 @@ str </dd> </dl> +<a NAME="SetupWizardDialog.on_addEntryPointButton_clicked" ID="SetupWizardDialog.on_addEntryPointButton_clicked"></a> +<h4>SetupWizardDialog.on_addEntryPointButton_clicked</h4> +<b>on_addEntryPointButton_clicked</b>(<i></i>) + +<p> + Private slot to add an entry point to the list. +</p> <a NAME="SetupWizardDialog.on_addExludePatternButton_clicked" ID="SetupWizardDialog.on_addExludePatternButton_clicked"></a> <h4>SetupWizardDialog.on_addExludePatternButton_clicked</h4> <b>on_addExludePatternButton_clicked</b>(<i></i>) @@ -265,12 +383,12 @@ <p> Private slot to add Python modules to the list. </p> -<a NAME="SetupWizardDialog.on_addScriptButton_clicked" ID="SetupWizardDialog.on_addScriptButton_clicked"></a> -<h4>SetupWizardDialog.on_addScriptButton_clicked</h4> -<b>on_addScriptButton_clicked</b>(<i></i>) +<a NAME="SetupWizardDialog.on_deleteEntryPointButton_clicked" ID="SetupWizardDialog.on_deleteEntryPointButton_clicked"></a> +<h4>SetupWizardDialog.on_deleteEntryPointButton_clicked</h4> +<b>on_deleteEntryPointButton_clicked</b>(<i></i>) <p> - Private slot to add scripts to the list. + Private slot to delete the selected entry point items. </p> <a NAME="SetupWizardDialog.on_deleteExcludePatternButton_clicked" ID="SetupWizardDialog.on_deleteExcludePatternButton_clicked"></a> <h4>SetupWizardDialog.on_deleteExcludePatternButton_clicked</h4> @@ -284,14 +402,22 @@ <b>on_deleteModuleButton_clicked</b>(<i></i>) <p> - Private slot to delete the selected script items. + Private slot to delete the selected module items. </p> -<a NAME="SetupWizardDialog.on_deleteScriptButton_clicked" ID="SetupWizardDialog.on_deleteScriptButton_clicked"></a> -<h4>SetupWizardDialog.on_deleteScriptButton_clicked</h4> -<b>on_deleteScriptButton_clicked</b>(<i></i>) +<a NAME="SetupWizardDialog.on_editEntryPointButton_clicked" ID="SetupWizardDialog.on_editEntryPointButton_clicked"></a> +<h4>SetupWizardDialog.on_editEntryPointButton_clicked</h4> +<b>on_editEntryPointButton_clicked</b>(<i></i>) <p> - Private slot to delete the selected script items. + Private slot to edit the selected entry point. +</p> +<a NAME="SetupWizardDialog.on_entryPointsList_itemSelectionChanged" ID="SetupWizardDialog.on_entryPointsList_itemSelectionChanged"></a> +<h4>SetupWizardDialog.on_entryPointsList_itemSelectionChanged</h4> +<b>on_entryPointsList_itemSelectionChanged</b>(<i></i>) + +<p> + Private slot to handle a change of selected items of the + entry points list. </p> <a NAME="SetupWizardDialog.on_excludePatternEdit_returnPressed" ID="SetupWizardDialog.on_excludePatternEdit_returnPressed"></a> <h4>SetupWizardDialog.on_excludePatternEdit_returnPressed</h4> @@ -339,13 +465,34 @@ Private slot to populate some fields with data retrieved from the current project. </p> -<a NAME="SetupWizardDialog.on_scriptsList_itemSelectionChanged" ID="SetupWizardDialog.on_scriptsList_itemSelectionChanged"></a> -<h4>SetupWizardDialog.on_scriptsList_itemSelectionChanged</h4> -<b>on_scriptsList_itemSelectionChanged</b>(<i></i>) +<a NAME="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged" ID="SetupWizardDialog.on_projectUrlsList_itemSelectionChanged"></a> +<h4>SetupWizardDialog.on_projectUrlsList_itemSelectionChanged</h4> +<b>on_projectUrlsList_itemSelectionChanged</b>(<i></i>) <p> Private slot to handle a change of selected items of the - scripts list. + project URLs list. +</p> +<a NAME="SetupWizardDialog.on_urlAddButton_clicked" ID="SetupWizardDialog.on_urlAddButton_clicked"></a> +<h4>SetupWizardDialog.on_urlAddButton_clicked</h4> +<b>on_urlAddButton_clicked</b>(<i></i>) + +<p> + Private slot to add a project URL to the list. +</p> +<a NAME="SetupWizardDialog.on_urlDeleteButton_clicked" ID="SetupWizardDialog.on_urlDeleteButton_clicked"></a> +<h4>SetupWizardDialog.on_urlDeleteButton_clicked</h4> +<b>on_urlDeleteButton_clicked</b>(<i></i>) + +<p> + Private slot to delete the selected URL items. +</p> +<a NAME="SetupWizardDialog.on_urlEditButton_clicked" ID="SetupWizardDialog.on_urlEditButton_clicked"></a> +<h4>SetupWizardDialog.on_urlEditButton_clicked</h4> +<b>on_urlEditButton_clicked</b>(<i></i>) + +<p> + Private slot to edit the selected project URL. </p> <div align="right"><a href="#top">Up</a></div> <hr />