Documentation/Source/eric5.Plugins.PluginWizardQRegularExpression.html

changeset 2736
86cd4d14b58e
child 2966
f85f686981ad
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.PluginWizardQRegularExpression.html	Sun Jun 23 13:12:38 2013 +0200
@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric5.Plugins.PluginWizardQRegularExpression</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>eric5.Plugins.PluginWizardQRegularExpression</h1>
+<p>
+Module implementing the QRegularExpression 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="#QRegularExpressionWizard">QRegularExpressionWizard</a></td>
+<td>Class implementing the QRegularExpression wizard plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="QRegularExpressionWizard" ID="QRegularExpressionWizard"></a>
+<h2>QRegularExpressionWizard</h2>
+<p>
+    Class implementing the QRegularExpression 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="#QRegularExpressionWizard.__init__">QRegularExpressionWizard</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.__callForm">__callForm</a></td>
+<td>Private method to display a dialog and get the code.</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.__handle">__handle</a></td>
+<td>Private method to handle the wizards action</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.__initAction">__initAction</a></td>
+<td>Private method to initialize the action.</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.__initMenu">__initMenu</a></td>
+<td>Private method to add the actions to the right menu.</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#QRegularExpressionWizard.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="QRegularExpressionWizard.__init__" ID="QRegularExpressionWizard.__init__"></a>
+<h4>QRegularExpressionWizard (Constructor)</h4>
+<b>QRegularExpressionWizard</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="QRegularExpressionWizard.__callForm" ID="QRegularExpressionWizard.__callForm"></a>
+<h4>QRegularExpressionWizard.__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>
+the generated code (string)
+</dd>
+</dl><a NAME="QRegularExpressionWizard.__handle" ID="QRegularExpressionWizard.__handle"></a>
+<h4>QRegularExpressionWizard.__handle</h4>
+<b>__handle</b>(<i></i>)
+<p>
+        Private method to handle the wizards action
+</p><a NAME="QRegularExpressionWizard.__initAction" ID="QRegularExpressionWizard.__initAction"></a>
+<h4>QRegularExpressionWizard.__initAction</h4>
+<b>__initAction</b>(<i></i>)
+<p>
+        Private method to initialize the action.
+</p><a NAME="QRegularExpressionWizard.__initMenu" ID="QRegularExpressionWizard.__initMenu"></a>
+<h4>QRegularExpressionWizard.__initMenu</h4>
+<b>__initMenu</b>(<i></i>)
+<p>
+        Private method to add the actions to the right menu.
+</p><a NAME="QRegularExpressionWizard.activate" ID="QRegularExpressionWizard.activate"></a>
+<h4>QRegularExpressionWizard.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+        Public method to activate this plugin.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of None and activation status (boolean)
+</dd>
+</dl><a NAME="QRegularExpressionWizard.deactivate" ID="QRegularExpressionWizard.deactivate"></a>
+<h4>QRegularExpressionWizard.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