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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10064
8c3207703dac
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQInputDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Plugins.PluginWizardQInputDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Plugins.PluginWizardQInputDialog</h1>
+
+<p>
+Module implementing the QInputDialog 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="#InputDialogWizard">InputDialogWizard</a></td>
+<td>Class implementing the QInputDialog wizard plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="InputDialogWizard" ID="InputDialogWizard"></a>
+<h2>InputDialogWizard</h2>
+
+<p>
+    Class implementing the QInputDialog 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="#InputDialogWizard.__init__">InputDialogWizard</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.__callForm">__callForm</a></td>
+<td>Private method to display a dialog and get the code.</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.__handle">__handle</a></td>
+<td>Private method to handle the wizards action.</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.__initAction">__initAction</a></td>
+<td>Private method to initialize the action.</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.__initMenu">__initMenu</a></td>
+<td>Private method to add the actions to the right menu.</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr>
+<tr>
+<td><a href="#InputDialogWizard.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="InputDialogWizard.__init__" ID="InputDialogWizard.__init__"></a>
+<h4>InputDialogWizard (Constructor)</h4>
+<b>InputDialogWizard</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="InputDialogWizard.__callForm" ID="InputDialogWizard.__callForm"></a>
+<h4>InputDialogWizard.__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="InputDialogWizard.__handle" ID="InputDialogWizard.__handle"></a>
+<h4>InputDialogWizard.__handle</h4>
+<b>__handle</b>(<i></i>)
+
+<p>
+        Private method to handle the wizards action.
+</p>
+<a NAME="InputDialogWizard.__initAction" ID="InputDialogWizard.__initAction"></a>
+<h4>InputDialogWizard.__initAction</h4>
+<b>__initAction</b>(<i></i>)
+
+<p>
+        Private method to initialize the action.
+</p>
+<a NAME="InputDialogWizard.__initMenu" ID="InputDialogWizard.__initMenu"></a>
+<h4>InputDialogWizard.__initMenu</h4>
+<b>__initMenu</b>(<i></i>)
+
+<p>
+        Private method to add the actions to the right menu.
+</p>
+<a NAME="InputDialogWizard.activate" ID="InputDialogWizard.activate"></a>
+<h4>InputDialogWizard.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="InputDialogWizard.deactivate" ID="InputDialogWizard.deactivate"></a>
+<h4>InputDialogWizard.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>
\ No newline at end of file

eric ide

mercurial