Documentation/Source/eric4.Plugins.PluginVmListspace.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.PluginVmListspace</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.PluginVmListspace</h1>
24 <p>
25 Module implementing the Tabview view manager plugin.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <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>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#VmListspacePlugin">VmListspacePlugin</a></td>
35 <td>Class implementing the Listspace view manager plugin.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr>
41 <td><a href="#previewPix">previewPix</a></td>
42 <td>Module function to return a preview pixmap.</td>
43 </tr>
44 </table>
45 <hr /><hr />
46 <a NAME="VmListspacePlugin" ID="VmListspacePlugin"></a>
47 <h2>VmListspacePlugin</h2>
48 <p>
49 Class implementing the Listspace view manager plugin.
50 </p>
51 <h3>Derived from</h3>
52 object
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#VmListspacePlugin.__init__">VmListspacePlugin</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#VmListspacePlugin.activate">activate</a></td>
64 <td>Public method to activate this plugin.</td>
65 </tr><tr>
66 <td><a href="#VmListspacePlugin.deactivate">deactivate</a></td>
67 <td>Public method to deactivate this plugin.</td>
68 </tr>
69 </table>
70 <a NAME="VmListspacePlugin.__init__" ID="VmListspacePlugin.__init__"></a>
71 <h4>VmListspacePlugin (Constructor)</h4>
72 <b>VmListspacePlugin</b>(<i>ui</i>)
73 <p>
74 Constructor
75 </p><dl>
76 <dt><i>ui</i></dt>
77 <dd>
78 reference to the user interface object (UI.UserInterface)
79 </dd>
80 </dl><a NAME="VmListspacePlugin.activate" ID="VmListspacePlugin.activate"></a>
81 <h4>VmListspacePlugin.activate</h4>
82 <b>activate</b>(<i></i>)
83 <p>
84 Public method to activate this plugin.
85 </p><dl>
86 <dt>Returns:</dt>
87 <dd>
88 tuple of reference to instantiated viewmanager and
89 activation status (boolean)
90 </dd>
91 </dl><a NAME="VmListspacePlugin.deactivate" ID="VmListspacePlugin.deactivate"></a>
92 <h4>VmListspacePlugin.deactivate</h4>
93 <b>deactivate</b>(<i></i>)
94 <p>
95 Public method to deactivate this plugin.
96 </p>
97 <div align="right"><a href="#top">Up</a></div>
98 <hr /><hr />
99 <a NAME="previewPix" ID="previewPix"></a>
100 <h2>previewPix</h2>
101 <b>previewPix</b>(<i></i>)
102 <p>
103 Module function to return a preview pixmap.
104 </p><dl>
105 <dt>Returns:</dt>
106 <dd>
107 preview pixmap (QPixmap)
108 </dd>
109 </dl>
110 <div align="right"><a href="#top">Up</a></div>
111 <hr />
112 </body></html>

eric ide

mercurial