Documentation/Source/eric6.Plugins.PluginWizardEricPlugin.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.PluginWizardEricPlugin</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Plugins.PluginWizardEricPlugin</h1>
<p>
Module implementing the eric plug-in 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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#WizardEricPluginWizard">WizardEricPluginWizard</a></td>
<td>Class implementing the eric plug-in wizard plug-in.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="WizardEricPluginWizard" ID="WizardEricPluginWizard"></a>
<h2>WizardEricPluginWizard</h2>
<p>
    Class implementing the eric plug-in 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="#WizardEricPluginWizard.__init__">WizardEricPluginWizard</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.__callForm">__callForm</a></td>
<td>Private method to display a dialog and get the code.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.__handle">__handle</a></td>
<td>Private method to handle the wizards action.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.__initAction">__initAction</a></td>
<td>Private method to initialize the action.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.__initMenu">__initMenu</a></td>
<td>Private method to add the actions to the right menu.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plug-in.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.activate">activate</a></td>
<td>Public method to activate this plug-in.</td>
</tr><tr>
<td><a href="#WizardEricPluginWizard.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="WizardEricPluginWizard.__init__" ID="WizardEricPluginWizard.__init__"></a>
<h4>WizardEricPluginWizard (Constructor)</h4>
<b>WizardEricPluginWizard</b>(<i>ui</i>)
<p>
        Constructor
</p><dl>
<dt><i>ui</i></dt>
<dd>
reference to the user interface object (UI.UserInterface)
</dd>
</dl><a NAME="WizardEricPluginWizard.__callForm" ID="WizardEricPluginWizard.__callForm"></a>
<h4>WizardEricPluginWizard.__callForm</h4>
<b>__callForm</b>(<i>editor</i>)
<p>
        Private method to display a dialog and get the code.
</p><dl>
<dt><i>editor</i></dt>
<dd>
reference to the current editor
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
generated code (string), the plug-in package name (string)
            and a flag indicating success (boolean)
</dd>
</dl><a NAME="WizardEricPluginWizard.__handle" ID="WizardEricPluginWizard.__handle"></a>
<h4>WizardEricPluginWizard.__handle</h4>
<b>__handle</b>(<i></i>)
<p>
        Private method to handle the wizards action.
</p><a NAME="WizardEricPluginWizard.__initAction" ID="WizardEricPluginWizard.__initAction"></a>
<h4>WizardEricPluginWizard.__initAction</h4>
<b>__initAction</b>(<i></i>)
<p>
        Private method to initialize the action.
</p><a NAME="WizardEricPluginWizard.__initMenu" ID="WizardEricPluginWizard.__initMenu"></a>
<h4>WizardEricPluginWizard.__initMenu</h4>
<b>__initMenu</b>(<i></i>)
<p>
        Private method to add the actions to the right menu.
</p><a NAME="WizardEricPluginWizard.__initialize" ID="WizardEricPluginWizard.__initialize"></a>
<h4>WizardEricPluginWizard.__initialize</h4>
<b>__initialize</b>(<i></i>)
<p>
        Private slot to (re)initialize the plug-in.
</p><a NAME="WizardEricPluginWizard.activate" ID="WizardEricPluginWizard.activate"></a>
<h4>WizardEricPluginWizard.activate</h4>
<b>activate</b>(<i></i>)
<p>
        Public method to activate this plug-in.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple of None and activation status (boolean)
</dd>
</dl><a NAME="WizardEricPluginWizard.deactivate" ID="WizardEricPluginWizard.deactivate"></a>
<h4>WizardEricPluginWizard.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>