--- a/eric6/Documentation/Source/eric6.Plugins.PluginWizardQMessageBox.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Plugins.PluginWizardQMessageBox.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,124 +18,163 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Plugins.PluginWizardQMessageBox</h1> + <p> Module implementing the QMessageBox wizard plugin. </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>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="#MessageBoxWizard">MessageBoxWizard</a></td> <td>Class implementing the QMessageBox wizard plugin.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="MessageBoxWizard" ID="MessageBoxWizard"></a> <h2>MessageBoxWizard</h2> + <p> Class implementing the QMessageBox 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="#MessageBoxWizard.__init__">MessageBoxWizard</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.__callForm">__callForm</a></td> <td>Private method to display a dialog and get the code.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.__handle">__handle</a></td> <td>Private method to handle the wizards action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.__initMenu">__initMenu</a></td> <td>Private method to add the actions to the right menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.activate">activate</a></td> <td>Public method to activate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MessageBoxWizard.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="MessageBoxWizard.__init__" ID="MessageBoxWizard.__init__"></a> <h4>MessageBoxWizard (Constructor)</h4> <b>MessageBoxWizard</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="MessageBoxWizard.__callForm" ID="MessageBoxWizard.__callForm"></a> +</dl> +<a NAME="MessageBoxWizard.__callForm" ID="MessageBoxWizard.__callForm"></a> <h4>MessageBoxWizard.__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="MessageBoxWizard.__handle" ID="MessageBoxWizard.__handle"></a> +</dl> +<a NAME="MessageBoxWizard.__handle" ID="MessageBoxWizard.__handle"></a> <h4>MessageBoxWizard.__handle</h4> <b>__handle</b>(<i></i>) + <p> Private method to handle the wizards action. -</p><a NAME="MessageBoxWizard.__initAction" ID="MessageBoxWizard.__initAction"></a> +</p> +<a NAME="MessageBoxWizard.__initAction" ID="MessageBoxWizard.__initAction"></a> <h4>MessageBoxWizard.__initAction</h4> <b>__initAction</b>(<i></i>) + <p> Private method to initialize the action. -</p><a NAME="MessageBoxWizard.__initMenu" ID="MessageBoxWizard.__initMenu"></a> +</p> +<a NAME="MessageBoxWizard.__initMenu" ID="MessageBoxWizard.__initMenu"></a> <h4>MessageBoxWizard.__initMenu</h4> <b>__initMenu</b>(<i></i>) + <p> Private method to add the actions to the right menu. -</p><a NAME="MessageBoxWizard.activate" ID="MessageBoxWizard.activate"></a> +</p> +<a NAME="MessageBoxWizard.activate" ID="MessageBoxWizard.activate"></a> <h4>MessageBoxWizard.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plugin. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="MessageBoxWizard.deactivate" ID="MessageBoxWizard.deactivate"></a> +</dl> +<a NAME="MessageBoxWizard.deactivate" ID="MessageBoxWizard.deactivate"></a> <h4>MessageBoxWizard.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plugin. </p>