--- a/eric6/Documentation/Source/eric6.Plugins.PluginWizardSetup.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.PluginWizardSetup.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,132 +18,174 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.PluginWizardSetup</h1> + <p> Module implementing the setup.py wizard plug-in. </p> <h3>Global Attributes</h3> + <table> <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SetupWizard">SetupWizard</a></td> <td>Class implementing the setup.py wizard plug-in.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SetupWizard" ID="SetupWizard"></a> <h2>SetupWizard</h2> + <p> Class implementing the setup.py wizard plug-in. </p> <h3>Derived from</h3> QObject <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="#SetupWizard.__init__">SetupWizard</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.__callForm">__callForm</a></td> <td>Private method to display a dialog and get the code.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.__handle">__handle</a></td> <td>Private method to handle the wizards action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> <td>Private method to add the actions to the right menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.__initialize">__initialize</a></td> <td>Private slot to (re)initialize the plug-in.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.activate">activate</a></td> <td>Public method to activate this plug-in.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SetupWizard.deactivate">deactivate</a></td> <td>Public method to deactivate this plug-in.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SetupWizard.__init__" ID="SetupWizard.__init__"></a> <h4>SetupWizard (Constructor)</h4> <b>SetupWizard</b>(<i>ui</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the user interface object (UI.UserInterface) </dd> -</dl><a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> +</dl> +<a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> <h4>SetupWizard.__callForm</h4> <b>__callForm</b>(<i>editor</i>) + <p> Private method to display a dialog and get the code. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the current editor </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the generated code (string) </dd> -</dl><a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> +</dl> +<a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> <h4>SetupWizard.__handle</h4> <b>__handle</b>(<i></i>) + <p> Private method to handle the wizards action. -</p><a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a> +</p> +<a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a> <h4>SetupWizard.__initAction</h4> <b>__initAction</b>(<i></i>) + <p> Private method to initialize the action. -</p><a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> +</p> +<a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> <h4>SetupWizard.__initMenu</h4> <b>__initMenu</b>(<i></i>) + <p> Private method to add the actions to the right menu. -</p><a NAME="SetupWizard.__initialize" ID="SetupWizard.__initialize"></a> +</p> +<a NAME="SetupWizard.__initialize" ID="SetupWizard.__initialize"></a> <h4>SetupWizard.__initialize</h4> <b>__initialize</b>(<i></i>) + <p> Private slot to (re)initialize the plug-in. -</p><a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> +</p> +<a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> <h4>SetupWizard.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plug-in. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> +</dl> +<a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> <h4>SetupWizard.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plug-in. </p>