eric7/Documentation/Source/eric7.Plugins.PluginWizardSetup.html

branch
eric7
changeset 9201
2f1ccadee231
parent 8596
d64760b2da50
child 9202
81388c6065e8
--- a/eric7/Documentation/Source/eric7.Plugins.PluginWizardSetup.html	Sat Jul 02 17:22:06 2022 +0200
+++ b/eric7/Documentation/Source/eric7.Plugins.PluginWizardSetup.html	Sat Jul 02 18:53:56 2022 +0200
@@ -67,18 +67,14 @@
 <td>Private method to handle the wizards action.</td>
 </tr>
 <tr>
-<td><a href="#SetupWizard.__initAction">__initAction</a></td>
-<td>Private method to initialize the action.</td>
+<td><a href="#SetupWizard.__initActions">__initActions</a></td>
+<td>Private method to initialize the actions.</td>
 </tr>
 <tr>
 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td>
 <td>Private method to add the actions to the right menu.</td>
 </tr>
 <tr>
-<td><a href="#SetupWizard.__initialize">__initialize</a></td>
-<td>Private slot to (re)initialize the plug-in.</td>
-</tr>
-<tr>
 <td><a href="#SetupWizard.activate">activate</a></td>
 <td>Public method to activate this plug-in.</td>
 </tr>
@@ -102,44 +98,61 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UI.UserInterface)</dt>
 <dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
 </dd>
 </dl>
 <a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a>
 <h4>SetupWizard.__callForm</h4>
-<b>__callForm</b>(<i>editor</i>)
+<b>__callForm</b>(<i>editor, category</i>)
 
 <p>
         Private method to display a dialog and get the code.
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 reference to the current editor
 </dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+category of setup file to create
+</dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the generated code (string)
+tuple containing the generated code and a flag indicating an error
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool)
 </dd>
 </dl>
 <a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a>
 <h4>SetupWizard.__handle</h4>
-<b>__handle</b>(<i></i>)
+<b>__handle</b>(<i>category</i>)
 
 <p>
         Private method to handle the wizards action.
 </p>
-<a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a>
-<h4>SetupWizard.__initAction</h4>
-<b>__initAction</b>(<i></i>)
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+category of setup file to create
+</dd>
+</dl>
+<a NAME="SetupWizard.__initActions" ID="SetupWizard.__initActions"></a>
+<h4>SetupWizard.__initActions</h4>
+<b>__initActions</b>(<i></i>)
 
 <p>
-        Private method to initialize the action.
+        Private method to initialize the actions.
 </p>
 <a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a>
 <h4>SetupWizard.__initMenu</h4>
@@ -148,13 +161,6 @@
 <p>
         Private method to add the actions to the right menu.
 </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>
 <h4>SetupWizard.activate</h4>
 <b>activate</b>(<i></i>)
@@ -165,7 +171,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (None, boolean)
 </dd>
 </dl>
 <a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a>

eric ide

mercurial