Documentation/source/Plugin_Apis.PluginApis.html

changeset 1
9fc07b8c55b8
child 6
89b4debad1df
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/source/Plugin_Apis.PluginApis.html	Sun Jun 09 17:21:45 2013 +0200
@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Apis.PluginApis</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>Plugin_Apis.PluginApis</h1>
+<p>
+Module implementing the APIs 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>needsRestart</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="#PluginApis">PluginApis</a></td>
+<td>Class implementing the Django project plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#apiFiles">apiFiles</a></td>
+<td>Module function to return the API files made available by this plugin.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="PluginApis" ID="PluginApis"></a>
+<h2>PluginApis</h2>
+<p>
+    Class implementing the Django project 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="#PluginApis.__init__">PluginApis</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PluginApis.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#PluginApis.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="PluginApis.__init__" ID="PluginApis.__init__"></a>
+<h4>PluginApis (Constructor)</h4>
+<b>PluginApis</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="PluginApis.activate" ID="PluginApis.activate"></a>
+<h4>PluginApis.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="PluginApis.deactivate" ID="PluginApis.deactivate"></a>
+<h4>PluginApis.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 /><hr />
+<a NAME="apiFiles" ID="apiFiles"></a>
+<h2>apiFiles</h2>
+<b>apiFiles</b>(<i>language</i>)
+<p>
+    Module function to return the API files made available by this plugin.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of API filenames (list of string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial