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

branch
eric7
changeset 10479
856476537696
parent 10437
2f70ca07f0af
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.PluginVmListspace</h1> 9 <h1>eric7.Plugins.PluginVmListspace</h1>
10
11 <p> 10 <p>
12 This plugin provides the listspace view manager. 11 This plugin provides the listspace view manager.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>__header__</td></tr>
17 <tr><td>error</td></tr>
18 </table>
15 19
20 <h3>Classes</h3>
16 <table> 21 <table>
17 <tr><td>__header__</td></tr><tr><td>error</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr> 22 <tr>
24 <td><a href="#VmListspacePlugin">VmListspacePlugin</a></td> 23 <td><a href="#VmListspacePlugin">VmListspacePlugin</a></td>
25 <td>Class implementing the Listspace view manager plugin.</td> 24 <td>Class implementing the Listspace view manager plugin.</td>
26 </tr> 25 </tr>
27 </table> 26 </table>
27
28 <h3>Functions</h3> 28 <h3>Functions</h3>
29
30 <table> 29 <table>
31
32 <tr> 30 <tr>
33 <td><a href="#previewPix">previewPix</a></td> 31 <td><a href="#previewPix">previewPix</a></td>
34 <td>Module function to return a preview pixmap.</td> 32 <td>Module function to return a preview pixmap.</td>
35 </tr> 33 </tr>
36 </table> 34 </table>
35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="VmListspacePlugin" ID="VmListspacePlugin"></a> 38 <a NAME="VmListspacePlugin" ID="VmListspacePlugin"></a>
40 <h2>VmListspacePlugin</h2> 39 <h2>VmListspacePlugin</h2>
41
42 <p> 40 <p>
43 Class implementing the Listspace view manager plugin. 41 Class implementing the Listspace view manager plugin.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QObject 45 QObject
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48
49 <table> 47 <table>
50 <tr><td>None</td></tr> 48 <tr><td>None</td></tr>
51 </table> 49 </table>
50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53
54 <table> 52 <table>
55 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
56 </table> 54 </table>
55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58
59 <table> 57 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#VmListspacePlugin.__init__">VmListspacePlugin</a></td> 59 <td><a href="#VmListspacePlugin.__init__">VmListspacePlugin</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
69 <tr> 66 <tr>
70 <td><a href="#VmListspacePlugin.deactivate">deactivate</a></td> 67 <td><a href="#VmListspacePlugin.deactivate">deactivate</a></td>
71 <td>Public method to deactivate this plugin.</td> 68 <td>Public method to deactivate this plugin.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75
76 <table> 73 <table>
77 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
78 </table> 75 </table>
79 76
77
80 <a NAME="VmListspacePlugin.__init__" ID="VmListspacePlugin.__init__"></a> 78 <a NAME="VmListspacePlugin.__init__" ID="VmListspacePlugin.__init__"></a>
81 <h4>VmListspacePlugin (Constructor)</h4> 79 <h4>VmListspacePlugin (Constructor)</h4>
82 <b>VmListspacePlugin</b>(<i>ui</i>) 80 <b>VmListspacePlugin</b>(<i>ui</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>ui</i> (UserInterface)</dt> 87 <dt><i>ui</i> (UserInterface)</dt>
90 <dd> 88 <dd>
91 reference to the user interface object 89 reference to the user interface object
92 </dd> 90 </dd>
93 </dl> 91 </dl>
94 <a NAME="VmListspacePlugin.activate" ID="VmListspacePlugin.activate"></a> 92 <a NAME="VmListspacePlugin.activate" ID="VmListspacePlugin.activate"></a>
95 <h4>VmListspacePlugin.activate</h4> 93 <h4>VmListspacePlugin.activate</h4>
96 <b>activate</b>(<i></i>) 94 <b>activate</b>(<i></i>)
97
98 <p> 95 <p>
99 Public method to activate this plugin. 96 Public method to activate this plugin.
100 </p> 97 </p>
98
101 <dl> 99 <dl>
102 <dt>Return:</dt> 100 <dt>Return:</dt>
103 <dd> 101 <dd>
104 tuple of reference to instantiated viewmanager and 102 tuple of reference to instantiated viewmanager and
105 activation status 103 activation status
112 </dd> 110 </dd>
113 </dl> 111 </dl>
114 <a NAME="VmListspacePlugin.deactivate" ID="VmListspacePlugin.deactivate"></a> 112 <a NAME="VmListspacePlugin.deactivate" ID="VmListspacePlugin.deactivate"></a>
115 <h4>VmListspacePlugin.deactivate</h4> 113 <h4>VmListspacePlugin.deactivate</h4>
116 <b>deactivate</b>(<i></i>) 114 <b>deactivate</b>(<i></i>)
117
118 <p> 115 <p>
119 Public method to deactivate this plugin. 116 Public method to deactivate this plugin.
120 </p> 117 </p>
118
121 <div align="right"><a href="#top">Up</a></div> 119 <div align="right"><a href="#top">Up</a></div>
122 <hr /> 120 <hr />
123 <hr /> 121 <hr />
124 <a NAME="previewPix" ID="previewPix"></a> 122 <a NAME="previewPix" ID="previewPix"></a>
125 <h2>previewPix</h2> 123 <h2>previewPix</h2>
126 <b>previewPix</b>(<i></i>) 124 <b>previewPix</b>(<i></i>)
127
128 <p> 125 <p>
129 Module function to return a preview pixmap. 126 Module function to return a preview pixmap.
130 </p> 127 </p>
128
131 <dl> 129 <dl>
132 <dt>Return:</dt> 130 <dt>Return:</dt>
133 <dd> 131 <dd>
134 preview pixmap 132 preview pixmap
135 </dd> 133 </dd>

eric ide

mercurial