src/eric7/Documentation/Source/eric7.PluginManager.PluginUninstallDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PluginManager.PluginUninstallDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PluginManager.PluginUninstallDialog</h1>
10
11 <p>
12 Module implementing a dialog for plugin deinstallation.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#PluginUninstallDialog">PluginUninstallDialog</a></td>
25 <td>Class for the dialog variant.</td>
26 </tr>
27 <tr>
28 <td><a href="#PluginUninstallWidget">PluginUninstallWidget</a></td>
29 <td>Class implementing a dialog for plugin deinstallation.</td>
30 </tr>
31 <tr>
32 <td><a href="#PluginUninstallWindow">PluginUninstallWindow</a></td>
33 <td>Main window class for the standalone dialog.</td>
34 </tr>
35 </table>
36 <h3>Functions</h3>
37
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr />
42 <hr />
43 <a NAME="PluginUninstallDialog" ID="PluginUninstallDialog"></a>
44 <h2>PluginUninstallDialog</h2>
45
46 <p>
47 Class for the dialog variant.
48 </p>
49 <h3>Derived from</h3>
50 QDialog
51 <h3>Class Attributes</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62
63 <table>
64
65 <tr>
66 <td><a href="#PluginUninstallDialog.__init__">PluginUninstallDialog</a></td>
67 <td>Constructor</td>
68 </tr>
69 </table>
70 <h3>Static Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75
76 <a NAME="PluginUninstallDialog.__init__" ID="PluginUninstallDialog.__init__"></a>
77 <h4>PluginUninstallDialog (Constructor)</h4>
78 <b>PluginUninstallDialog</b>(<i>pluginManager, parent=None</i>)
79
80 <p>
81 Constructor
82 </p>
83 <dl>
84
85 <dt><i>pluginManager</i></dt>
86 <dd>
87 reference to the plugin manager object
88 </dd>
89 <dt><i>parent</i></dt>
90 <dd>
91 reference to the parent widget (QWidget)
92 </dd>
93 </dl>
94 <div align="right"><a href="#top">Up</a></div>
95 <hr />
96 <hr />
97 <a NAME="PluginUninstallWidget" ID="PluginUninstallWidget"></a>
98 <h2>PluginUninstallWidget</h2>
99
100 <p>
101 Class implementing a dialog for plugin deinstallation.
102 </p>
103 <h3>Signals</h3>
104 <dl>
105
106 <dt>accepted()</dt>
107 <dd>
108 emitted to indicate the removal of a plug-in
109 </dd>
110 </dl>
111 <h3>Derived from</h3>
112 QWidget, Ui_PluginUninstallDialog
113 <h3>Class Attributes</h3>
114
115 <table>
116 <tr><td>None</td></tr>
117 </table>
118 <h3>Class Methods</h3>
119
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123 <h3>Methods</h3>
124
125 <table>
126
127 <tr>
128 <td><a href="#PluginUninstallWidget.__init__">PluginUninstallWidget</a></td>
129 <td>Constructor</td>
130 </tr>
131 <tr>
132 <td><a href="#PluginUninstallWidget.__getCheckedPlugins">__getCheckedPlugins</a></td>
133 <td>Private method to get the list of plugins to be uninstalled.</td>
134 </tr>
135 <tr>
136 <td><a href="#PluginUninstallWidget.__uninstallPlugin">__uninstallPlugin</a></td>
137 <td>Private method to uninstall a given plugin.</td>
138 </tr>
139 <tr>
140 <td><a href="#PluginUninstallWidget.__uninstallPlugins">__uninstallPlugins</a></td>
141 <td>Private method to uninstall the selected plugins.</td>
142 </tr>
143 <tr>
144 <td><a href="#PluginUninstallWidget.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
145 <td>Private slot to handle the accepted signal of the button box.</td>
146 </tr>
147 <tr>
148 <td><a href="#PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged">on_pluginDirectoryCombo_currentIndexChanged</a></td>
149 <td>Private slot to populate the plugin name combo upon a change of the plugin area.</td>
150 </tr>
151 </table>
152 <h3>Static Methods</h3>
153
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157
158 <a NAME="PluginUninstallWidget.__init__" ID="PluginUninstallWidget.__init__"></a>
159 <h4>PluginUninstallWidget (Constructor)</h4>
160 <b>PluginUninstallWidget</b>(<i>pluginManager, parent=None</i>)
161
162 <p>
163 Constructor
164 </p>
165 <dl>
166
167 <dt><i>pluginManager</i></dt>
168 <dd>
169 reference to the plugin manager object
170 </dd>
171 <dt><i>parent</i></dt>
172 <dd>
173 parent of this dialog (QWidget)
174 </dd>
175 </dl>
176 <a NAME="PluginUninstallWidget.__getCheckedPlugins" ID="PluginUninstallWidget.__getCheckedPlugins"></a>
177 <h4>PluginUninstallWidget.__getCheckedPlugins</h4>
178 <b>__getCheckedPlugins</b>(<i></i>)
179
180 <p>
181 Private method to get the list of plugins to be uninstalled.
182 </p>
183 <dl>
184 <dt>Return:</dt>
185 <dd>
186 list of tuples with the plugin name and plugin file name
187 </dd>
188 </dl>
189 <dl>
190 <dt>Return Type:</dt>
191 <dd>
192 list of tuples of (str, str)
193 </dd>
194 </dl>
195 <a NAME="PluginUninstallWidget.__uninstallPlugin" ID="PluginUninstallWidget.__uninstallPlugin"></a>
196 <h4>PluginUninstallWidget.__uninstallPlugin</h4>
197 <b>__uninstallPlugin</b>(<i>pluginName, pluginFile</i>)
198
199 <p>
200 Private method to uninstall a given plugin.
201 </p>
202 <dl>
203
204 <dt><i>pluginName</i> (str)</dt>
205 <dd>
206 name of the plugin
207 </dd>
208 <dt><i>pluginFile</i> (str)</dt>
209 <dd>
210 file name of the plugin
211 </dd>
212 </dl>
213 <dl>
214 <dt>Return:</dt>
215 <dd>
216 flag indicating success
217 </dd>
218 </dl>
219 <dl>
220 <dt>Return Type:</dt>
221 <dd>
222 bool
223 </dd>
224 </dl>
225 <a NAME="PluginUninstallWidget.__uninstallPlugins" ID="PluginUninstallWidget.__uninstallPlugins"></a>
226 <h4>PluginUninstallWidget.__uninstallPlugins</h4>
227 <b>__uninstallPlugins</b>(<i></i>)
228
229 <p>
230 Private method to uninstall the selected plugins.
231 </p>
232 <dl>
233 <dt>Return:</dt>
234 <dd>
235 flag indicating success
236 </dd>
237 </dl>
238 <dl>
239 <dt>Return Type:</dt>
240 <dd>
241 bool
242 </dd>
243 </dl>
244 <a NAME="PluginUninstallWidget.on_buttonBox_accepted" ID="PluginUninstallWidget.on_buttonBox_accepted"></a>
245 <h4>PluginUninstallWidget.on_buttonBox_accepted</h4>
246 <b>on_buttonBox_accepted</b>(<i></i>)
247
248 <p>
249 Private slot to handle the accepted signal of the button box.
250 </p>
251 <a NAME="PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged" ID="PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged"></a>
252 <h4>PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged</h4>
253 <b>on_pluginDirectoryCombo_currentIndexChanged</b>(<i>index</i>)
254
255 <p>
256 Private slot to populate the plugin name combo upon a change of the
257 plugin area.
258 </p>
259 <dl>
260
261 <dt><i>index</i></dt>
262 <dd>
263 index of the selected item (integer)
264 </dd>
265 </dl>
266 <div align="right"><a href="#top">Up</a></div>
267 <hr />
268 <hr />
269 <a NAME="PluginUninstallWindow" ID="PluginUninstallWindow"></a>
270 <h2>PluginUninstallWindow</h2>
271
272 <p>
273 Main window class for the standalone dialog.
274 </p>
275 <h3>Derived from</h3>
276 EricMainWindow
277 <h3>Class Attributes</h3>
278
279 <table>
280 <tr><td>None</td></tr>
281 </table>
282 <h3>Class Methods</h3>
283
284 <table>
285 <tr><td>None</td></tr>
286 </table>
287 <h3>Methods</h3>
288
289 <table>
290
291 <tr>
292 <td><a href="#PluginUninstallWindow.__init__">PluginUninstallWindow</a></td>
293 <td>Constructor</td>
294 </tr>
295 </table>
296 <h3>Static Methods</h3>
297
298 <table>
299 <tr><td>None</td></tr>
300 </table>
301
302 <a NAME="PluginUninstallWindow.__init__" ID="PluginUninstallWindow.__init__"></a>
303 <h4>PluginUninstallWindow (Constructor)</h4>
304 <b>PluginUninstallWindow</b>(<i>parent=None</i>)
305
306 <p>
307 Constructor
308 </p>
309 <dl>
310
311 <dt><i>parent</i></dt>
312 <dd>
313 reference to the parent widget (QWidget)
314 </dd>
315 </dl>
316 <div align="right"><a href="#top">Up</a></div>
317 <hr />
318 </body></html>

eric ide

mercurial