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

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.PluginWizardEricMessageBox</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.PluginWizardEricMessageBox</h1>

<p>
This plugin shows the EricMessageBox wizard.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>__header__</td></tr><tr><td>error</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EricMessageBoxWizard">EricMessageBoxWizard</a></td>
<td>Class implementing the EricMessageBox wizard plugin.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EricMessageBoxWizard" ID="EricMessageBoxWizard"></a>
<h2>EricMessageBoxWizard</h2>

<p>
    Class implementing the EricMessageBox wizard plugin.
</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="#EricMessageBoxWizard.__init__">EricMessageBoxWizard</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.__callForm">__callForm</a></td>
<td>Private method to display a dialog and get the code.</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.__handle">__handle</a></td>
<td>Private method to handle the wizards action.</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.__initAction">__initAction</a></td>
<td>Private method to initialize the action.</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.__initMenu">__initMenu</a></td>
<td>Private method to add the actions to the right menu.</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#EricMessageBoxWizard.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricMessageBoxWizard.__init__" ID="EricMessageBoxWizard.__init__"></a>
<h4>EricMessageBoxWizard (Constructor)</h4>
<b>EricMessageBoxWizard</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="EricMessageBoxWizard.__callForm" ID="EricMessageBoxWizard.__callForm"></a>
<h4>EricMessageBoxWizard.__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>Return:</dt>
<dd>
the generated code (string)
</dd>
</dl>
<a NAME="EricMessageBoxWizard.__handle" ID="EricMessageBoxWizard.__handle"></a>
<h4>EricMessageBoxWizard.__handle</h4>
<b>__handle</b>(<i></i>)

<p>
        Private method to handle the wizards action.
</p>
<a NAME="EricMessageBoxWizard.__initAction" ID="EricMessageBoxWizard.__initAction"></a>
<h4>EricMessageBoxWizard.__initAction</h4>
<b>__initAction</b>(<i></i>)

<p>
        Private method to initialize the action.
</p>
<a NAME="EricMessageBoxWizard.__initMenu" ID="EricMessageBoxWizard.__initMenu"></a>
<h4>EricMessageBoxWizard.__initMenu</h4>
<b>__initMenu</b>(<i></i>)

<p>
        Private method to add the actions to the right menu.
</p>
<a NAME="EricMessageBoxWizard.activate" ID="EricMessageBoxWizard.activate"></a>
<h4>EricMessageBoxWizard.activate</h4>
<b>activate</b>(<i></i>)

<p>
        Public method to activate this plugin.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple of None and activation status (boolean)
</dd>
</dl>
<a NAME="EricMessageBoxWizard.deactivate" ID="EricMessageBoxWizard.deactivate"></a>
<h4>EricMessageBoxWizard.deactivate</h4>
<b>deactivate</b>(<i></i>)

<p>
        Public method to deactivate this plugin.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>