Documentation/Source/eric5.Plugins.PluginWizardPyRegExp.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Plugins.PluginWizardPyRegExp</title>
<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.PluginWizardPyRegExp</h1>
<p>
Module implementing the Python re 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="#PyRegExpWizard">PyRegExpWizard</a></td>
<td>Class implementing the Python re wizard plugin.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="PyRegExpWizard" ID="PyRegExpWizard"></a>
<h2>PyRegExpWizard</h2>
<p>
    Class implementing the Python re wizard plugin.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#PyRegExpWizard.__init__">PyRegExpWizard</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#PyRegExpWizard.__callForm">__callForm</a></td>
<td>Private method to display a dialog and get the code.</td>
</tr><tr>
<td><a href="#PyRegExpWizard.__handle">__handle</a></td>
<td>Private method to handle the wizards action</td>
</tr><tr>
<td><a href="#PyRegExpWizard.__initAction">__initAction</a></td>
<td>Private method to initialize the action.</td>
</tr><tr>
<td><a href="#PyRegExpWizard.__initMenu">__initMenu</a></td>
<td>Private method to add the actions to the right menu.</td>
</tr><tr>
<td><a href="#PyRegExpWizard.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr><tr>
<td><a href="#PyRegExpWizard.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
</table>
<a NAME="PyRegExpWizard.__init__" ID="PyRegExpWizard.__init__"></a>
<h4>PyRegExpWizard (Constructor)</h4>
<b>PyRegExpWizard</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="PyRegExpWizard.__callForm" ID="PyRegExpWizard.__callForm"></a>
<h4>PyRegExpWizard.__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="PyRegExpWizard.__handle" ID="PyRegExpWizard.__handle"></a>
<h4>PyRegExpWizard.__handle</h4>
<b>__handle</b>(<i></i>)
<p>
        Private method to handle the wizards action 
</p><a NAME="PyRegExpWizard.__initAction" ID="PyRegExpWizard.__initAction"></a>
<h4>PyRegExpWizard.__initAction</h4>
<b>__initAction</b>(<i></i>)
<p>
        Private method to initialize the action.
</p><a NAME="PyRegExpWizard.__initMenu" ID="PyRegExpWizard.__initMenu"></a>
<h4>PyRegExpWizard.__initMenu</h4>
<b>__initMenu</b>(<i></i>)
<p>
        Private method to add the actions to the right menu.
</p><a NAME="PyRegExpWizard.activate" ID="PyRegExpWizard.activate"></a>
<h4>PyRegExpWizard.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="PyRegExpWizard.deactivate" ID="PyRegExpWizard.deactivate"></a>
<h4>PyRegExpWizard.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>