src/eric7/Documentation/Source/eric7.Plugins.PluginVmListspace.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.PluginVmListspace</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.PluginVmListspace</h1>
<p>
This plugin provides the listspace view manager.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>__header__</td></tr>
<tr><td>error</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#VmListspacePlugin">VmListspacePlugin</a></td>
<td>Class implementing the Listspace 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="VmListspacePlugin" ID="VmListspacePlugin"></a>
<h2>VmListspacePlugin</h2>
<p>
    Class implementing the Listspace view manager 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="#VmListspacePlugin.__init__">VmListspacePlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#VmListspacePlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr>
<tr>
<td><a href="#VmListspacePlugin.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="VmListspacePlugin.__init__" ID="VmListspacePlugin.__init__"></a>
<h4>VmListspacePlugin (Constructor)</h4>
<b>VmListspacePlugin</b>(<i>ui</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>ui</i> (UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
</dl>
<a NAME="VmListspacePlugin.activate" ID="VmListspacePlugin.activate"></a>
<h4>VmListspacePlugin.activate</h4>
<b>activate</b>(<i></i>)
<p>
        Public method to activate this plugin.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of reference to instantiated viewmanager and
            activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="VmListspacePlugin.deactivate" ID="VmListspacePlugin.deactivate"></a>
<h4>VmListspacePlugin.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>Return:</dt>
<dd>
preview pixmap
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QPixmap
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>