Documentation/Source/eric4.Plugins.PluginVmMdiArea.html

changeset 3
0d9daebf5b8c
diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.Plugins.PluginVmMdiArea.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Plugins.PluginVmMdiArea.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,112 @@
+<?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>eric4.Plugins.PluginVmMdiArea</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Plugins.PluginVmMdiArea</h1>
+<p>
+Module implementing the mdi area view manager 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>displayString</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</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="#VmMdiAreaPlugin">VmMdiAreaPlugin</a></td>
+<td>Class implementing the Workspace view manager plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#previewPix">previewPix</a></td>
+<td>Module function to return a preview pixmap.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="VmMdiAreaPlugin" ID="VmMdiAreaPlugin"></a>
+<h2>VmMdiAreaPlugin</h2>
+<p>
+    Class implementing the Workspace view manager plugin.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#VmMdiAreaPlugin.__init__">VmMdiAreaPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#VmMdiAreaPlugin.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#VmMdiAreaPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plugin.</td>
+</tr>
+</table>
+<a NAME="VmMdiAreaPlugin.__init__" ID="VmMdiAreaPlugin.__init__"></a>
+<h4>VmMdiAreaPlugin (Constructor)</h4>
+<b>VmMdiAreaPlugin</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="VmMdiAreaPlugin.activate" ID="VmMdiAreaPlugin.activate"></a>
+<h4>VmMdiAreaPlugin.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+        Public method to activate this plugin.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of reference to instantiated viewmanager and
+            activation status (boolean)
+</dd>
+</dl><a NAME="VmMdiAreaPlugin.deactivate" ID="VmMdiAreaPlugin.deactivate"></a>
+<h4>VmMdiAreaPlugin.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="previewPix" ID="previewPix"></a>
+<h2>previewPix</h2>
+<b>previewPix</b>(<i></i>)
+<p>
+    Module function to return a preview pixmap.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+preview pixmap (QPixmap)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial