--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.PluginWizardQRegExp.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,125 @@ +<?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.PluginWizardQRegExp</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Plugins.PluginWizardQRegExp</h1> +<p> +Module implementing the QRegExp 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="#QRegExpWizard">QRegExpWizard</a></td> +<td>Class implementing the QRegExp wizard plugin.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="QRegExpWizard" ID="QRegExpWizard"></a> +<h2>QRegExpWizard</h2> +<p> + Class implementing the QRegExp 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="#QRegExpWizard.__init__">QRegExpWizard</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#QRegExpWizard.__callForm">__callForm</a></td> +<td>Private method to display a dialog and get the code.</td> +</tr><tr> +<td><a href="#QRegExpWizard.__handle">__handle</a></td> +<td>Private method to handle the wizards action</td> +</tr><tr> +<td><a href="#QRegExpWizard.__initAction">__initAction</a></td> +<td>Private method to initialize the action.</td> +</tr><tr> +<td><a href="#QRegExpWizard.__initMenu">__initMenu</a></td> +<td>Private method to add the actions to the right menu.</td> +</tr><tr> +<td><a href="#QRegExpWizard.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#QRegExpWizard.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<a NAME="QRegExpWizard.__init__" ID="QRegExpWizard.__init__"></a> +<h4>QRegExpWizard (Constructor)</h4> +<b>QRegExpWizard</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="QRegExpWizard.__callForm" ID="QRegExpWizard.__callForm"></a> +<h4>QRegExpWizard.__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="QRegExpWizard.__handle" ID="QRegExpWizard.__handle"></a> +<h4>QRegExpWizard.__handle</h4> +<b>__handle</b>(<i></i>) +<p> + Private method to handle the wizards action +</p><a NAME="QRegExpWizard.__initAction" ID="QRegExpWizard.__initAction"></a> +<h4>QRegExpWizard.__initAction</h4> +<b>__initAction</b>(<i></i>) +<p> + Private method to initialize the action. +</p><a NAME="QRegExpWizard.__initMenu" ID="QRegExpWizard.__initMenu"></a> +<h4>QRegExpWizard.__initMenu</h4> +<b>__initMenu</b>(<i></i>) +<p> + Private method to add the actions to the right menu. +</p><a NAME="QRegExpWizard.activate" ID="QRegExpWizard.activate"></a> +<h4>QRegExpWizard.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="QRegExpWizard.deactivate" ID="QRegExpWizard.deactivate"></a> +<h4>QRegExpWizard.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