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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9202
81388c6065e8
child 10064
8c3207703dac
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Plugins.PluginWizardSetup.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardSetup.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,158 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.PluginWizardSetup</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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 />
+<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>
+<td><a href="#SetupWizard.__handle">__handle</a></td>
+<td>Private method to handle the wizards action.</td>
+</tr>
+<tr>
+<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.activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</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>
+
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a>
+<h4>SetupWizard.__handle</h4>
+<b>__handle</b>(<i>category</i>)
+
+<p>
+        Private method to handle the wizards action.
+</p>
+<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 actions.
+</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.activate" ID="SetupWizard.activate"></a>
+<h4>SetupWizard.activate</h4>
+<b>activate</b>(<i></i>)
+
+<p>
+        Public method to activate this plug-in.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+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>
+<h4>SetupWizard.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+
+<p>
+        Public method to deactivate this plug-in.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial