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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.PluginManager.PluginUninstallDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginUninstallDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,318 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.PluginManager.PluginUninstallDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.PluginManager.PluginUninstallDialog</h1>
+
+<p>
+Module implementing a dialog for plugin deinstallation.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PluginUninstallDialog">PluginUninstallDialog</a></td>
+<td>Class for the dialog variant.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget">PluginUninstallWidget</a></td>
+<td>Class implementing a dialog for plugin deinstallation.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWindow">PluginUninstallWindow</a></td>
+<td>Main window class for the standalone dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="PluginUninstallDialog" ID="PluginUninstallDialog"></a>
+<h2>PluginUninstallDialog</h2>
+
+<p>
+    Class for the dialog variant.
+</p>
+<h3>Derived from</h3>
+QDialog
+<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="#PluginUninstallDialog.__init__">PluginUninstallDialog</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PluginUninstallDialog.__init__" ID="PluginUninstallDialog.__init__"></a>
+<h4>PluginUninstallDialog (Constructor)</h4>
+<b>PluginUninstallDialog</b>(<i>pluginManager, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>pluginManager</i></dt>
+<dd>
+reference to the plugin manager object
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="PluginUninstallWidget" ID="PluginUninstallWidget"></a>
+<h2>PluginUninstallWidget</h2>
+
+<p>
+    Class implementing a dialog for plugin deinstallation.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>accepted()</dt>
+<dd>
+emitted to indicate the removal of a plug-in
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget, Ui_PluginUninstallDialog
+<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="#PluginUninstallWidget.__init__">PluginUninstallWidget</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget.__getCheckedPlugins">__getCheckedPlugins</a></td>
+<td>Private method to get the list of plugins to be uninstalled.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget.__uninstallPlugin">__uninstallPlugin</a></td>
+<td>Private method to uninstall a given plugin.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget.__uninstallPlugins">__uninstallPlugins</a></td>
+<td>Private method to uninstall the selected plugins.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
+<td>Private slot to handle the accepted signal of the button box.</td>
+</tr>
+<tr>
+<td><a href="#PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged">on_pluginDirectoryCombo_currentIndexChanged</a></td>
+<td>Private slot to populate the plugin name combo upon a change of the plugin area.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PluginUninstallWidget.__init__" ID="PluginUninstallWidget.__init__"></a>
+<h4>PluginUninstallWidget (Constructor)</h4>
+<b>PluginUninstallWidget</b>(<i>pluginManager, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>pluginManager</i></dt>
+<dd>
+reference to the plugin manager object
+</dd>
+<dt><i>parent</i></dt>
+<dd>
+parent of this dialog (QWidget)
+</dd>
+</dl>
+<a NAME="PluginUninstallWidget.__getCheckedPlugins" ID="PluginUninstallWidget.__getCheckedPlugins"></a>
+<h4>PluginUninstallWidget.__getCheckedPlugins</h4>
+<b>__getCheckedPlugins</b>(<i></i>)
+
+<p>
+        Private method to get the list of plugins to be uninstalled.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of tuples with the plugin name and plugin file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str)
+</dd>
+</dl>
+<a NAME="PluginUninstallWidget.__uninstallPlugin" ID="PluginUninstallWidget.__uninstallPlugin"></a>
+<h4>PluginUninstallWidget.__uninstallPlugin</h4>
+<b>__uninstallPlugin</b>(<i>pluginName, pluginFile</i>)
+
+<p>
+        Private method to uninstall a given plugin.
+</p>
+<dl>
+
+<dt><i>pluginName</i> (str)</dt>
+<dd>
+name of the plugin
+</dd>
+<dt><i>pluginFile</i> (str)</dt>
+<dd>
+file name of the plugin
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PluginUninstallWidget.__uninstallPlugins" ID="PluginUninstallWidget.__uninstallPlugins"></a>
+<h4>PluginUninstallWidget.__uninstallPlugins</h4>
+<b>__uninstallPlugins</b>(<i></i>)
+
+<p>
+        Private method to uninstall the selected plugins.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PluginUninstallWidget.on_buttonBox_accepted" ID="PluginUninstallWidget.on_buttonBox_accepted"></a>
+<h4>PluginUninstallWidget.on_buttonBox_accepted</h4>
+<b>on_buttonBox_accepted</b>(<i></i>)
+
+<p>
+        Private slot to handle the accepted signal of the button box.
+</p>
+<a NAME="PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged" ID="PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged"></a>
+<h4>PluginUninstallWidget.on_pluginDirectoryCombo_currentIndexChanged</h4>
+<b>on_pluginDirectoryCombo_currentIndexChanged</b>(<i>index</i>)
+
+<p>
+        Private slot to populate the plugin name combo upon a change of the
+        plugin area.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index of the selected item (integer)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="PluginUninstallWindow" ID="PluginUninstallWindow"></a>
+<h2>PluginUninstallWindow</h2>
+
+<p>
+    Main window class for the standalone dialog.
+</p>
+<h3>Derived from</h3>
+EricMainWindow
+<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="#PluginUninstallWindow.__init__">PluginUninstallWindow</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PluginUninstallWindow.__init__" ID="PluginUninstallWindow.__init__"></a>
+<h4>PluginUninstallWindow (Constructor)</h4>
+<b>PluginUninstallWindow</b>(<i>parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial