--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.PluginAbout.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,115 @@ +<?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.PluginAbout</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.PluginAbout</h1> +<p> +Module implementing the About 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="#AboutPlugin">AboutPlugin</a></td> +<td>Class implementing the About plugin.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="AboutPlugin" ID="AboutPlugin"></a> +<h2>AboutPlugin</h2> +<p> + Class implementing the About 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="#AboutPlugin.__init__">AboutPlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#AboutPlugin.__about">__about</a></td> +<td>Private slot to handle the About dialog.</td> +</tr><tr> +<td><a href="#AboutPlugin.__aboutQt">__aboutQt</a></td> +<td>Private slot to handle the About Qt dialog.</td> +</tr><tr> +<td><a href="#AboutPlugin.__initActions">__initActions</a></td> +<td>Private method to initialize the actions.</td> +</tr><tr> +<td><a href="#AboutPlugin.__initMenu">__initMenu</a></td> +<td>Private method to add the actions to the right menu.</td> +</tr><tr> +<td><a href="#AboutPlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#AboutPlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<a NAME="AboutPlugin.__init__" ID="AboutPlugin.__init__"></a> +<h4>AboutPlugin (Constructor)</h4> +<b>AboutPlugin</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="AboutPlugin.__about" ID="AboutPlugin.__about"></a> +<h4>AboutPlugin.__about</h4> +<b>__about</b>(<i></i>) +<p> + Private slot to handle the About dialog. +</p><a NAME="AboutPlugin.__aboutQt" ID="AboutPlugin.__aboutQt"></a> +<h4>AboutPlugin.__aboutQt</h4> +<b>__aboutQt</b>(<i></i>) +<p> + Private slot to handle the About Qt dialog. +</p><a NAME="AboutPlugin.__initActions" ID="AboutPlugin.__initActions"></a> +<h4>AboutPlugin.__initActions</h4> +<b>__initActions</b>(<i></i>) +<p> + Private method to initialize the actions. +</p><a NAME="AboutPlugin.__initMenu" ID="AboutPlugin.__initMenu"></a> +<h4>AboutPlugin.__initMenu</h4> +<b>__initMenu</b>(<i></i>) +<p> + Private method to add the actions to the right menu. +</p><a NAME="AboutPlugin.activate" ID="AboutPlugin.activate"></a> +<h4>AboutPlugin.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="AboutPlugin.deactivate" ID="AboutPlugin.deactivate"></a> +<h4>AboutPlugin.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