--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,384 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxWidget</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxWidget</h1>
+<p>
+Module implementing the pipx management widget.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxWidget">PipxWidget</a></td>
+<td>Class documentation goes here.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxWidget" ID="PipxWidget"></a>
+<h2>PipxWidget</h2>
+<p>
+ Class documentation goes here.
+</p>
+
+<h3>Derived from</h3>
+QWidget, Ui_PipxWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>AppPathRole</td></tr>
+<tr><td>LatestVersionRole</td></tr>
+<tr><td>PackageColumn</td></tr>
+<tr><td>PythonVersionColumn</td></tr>
+<tr><td>VersionColumn</td></tr>
+<tr><td>VersionRole</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxWidget.__init__">PipxWidget</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__aboutToShowPipxMenu">__aboutToShowPipxMenu</a></td>
+<td>Private slot to set the action enabled status.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__checkOutdatedPackages">__checkOutdatedPackages</a></td>
+<td>Private slot to check, if there are any outdated packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__createSpecMetadataFile">__createSpecMetadataFile</a></td>
+<td>Private slot to create a spec metadata file needed by 'pipx install-all'.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__initPipxMenu">__initPipxMenu</a></td>
+<td>Private method to create the super menu and attach it to the super menu button.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__installAllPackages">__installAllPackages</a></td>
+<td>Private slot to install all packages listed in a specification file.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__installPackages">__installPackages</a></td>
+<td>Private slot to install packages to be given by the user.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__markPackageOutdated">__markPackageOutdated</a></td>
+<td>Private method to mark the given package item as outdated.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__pipxConfigure">__pipxConfigure</a></td>
+<td>Private slot to show the pipx configuration page.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__populatePackages">__populatePackages</a></td>
+<td>Private method to populate the packages list.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__reinstallAllPackages">__reinstallAllPackages</a></td>
+<td>Private slot to force a re-installation of all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__reinstallPackage">__reinstallPackage</a></td>
+<td>Private slot to force a re-installation of the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__resizePackagesColumns">__resizePackagesColumns</a></td>
+<td>Private method to resize the columns of the packages list.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__selectedPackages">__selectedPackages</a></td>
+<td>Private method to determine the list of selected packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__showInterpreters">__showInterpreters</a></td>
+<td>Private slot to show a list of standalone Python interpreters.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__showPipxVersion">__showPipxVersion</a></td>
+<td>Private method to show the pipx version in the widget header.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__uninstallAllPackages">__uninstallAllPackages</a></td>
+<td>Private slot to uninstall all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__uninstallPackage">__uninstallPackage</a></td>
+<td>Private slot to uninstall the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradeAllPackages">__upgradeAllPackages</a></td>
+<td>Private slot to upgrade all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradePackage">__upgradePackage</a></td>
+<td>Private slot to upgrade the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradeSharedLibs">__upgradeSharedLibs</a></td>
+<td>Private slot to upgrade the shared libraries.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
+<td>Private slot to start the activated item, if it is not a top level one.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
+<td>Private slot to handle a change of selected packages and apps.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
+<td>Private slot to refresh the packages list.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxWidget.__init__" ID="PipxWidget.__init__"></a>
+<h4>PipxWidget (Constructor)</h4>
+<b>PipxWidget</b>(<i>plugin, fromEric=True, parent=None</i>)
+<p>
+ Constructor
+</p>
+
+<dl>
+
+<dt><i>plugin</i> (MqttMonitorPlugin)</dt>
+<dd>
+reference to the plug-in object
+</dd>
+<dt><i>fromEric</i> (bool (optional))</dt>
+<dd>
+flag indicating the eric-ide mode (defaults to True)
+ (True = eric-ide mode, False = application mode)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxWidget.__aboutToShowPipxMenu" ID="PipxWidget.__aboutToShowPipxMenu"></a>
+<h4>PipxWidget.__aboutToShowPipxMenu</h4>
+<b>__aboutToShowPipxMenu</b>(<i></i>)
+<p>
+ Private slot to set the action enabled status.
+</p>
+
+<a NAME="PipxWidget.__checkOutdatedPackages" ID="PipxWidget.__checkOutdatedPackages"></a>
+<h4>PipxWidget.__checkOutdatedPackages</h4>
+<b>__checkOutdatedPackages</b>(<i></i>)
+<p>
+ Private slot to check, if there are any outdated packages.
+</p>
+
+<a NAME="PipxWidget.__createSpecMetadataFile" ID="PipxWidget.__createSpecMetadataFile"></a>
+<h4>PipxWidget.__createSpecMetadataFile</h4>
+<b>__createSpecMetadataFile</b>(<i></i>)
+<p>
+ Private slot to create a spec metadata file needed by 'pipx install-all'.
+</p>
+
+<a NAME="PipxWidget.__initPipxMenu" ID="PipxWidget.__initPipxMenu"></a>
+<h4>PipxWidget.__initPipxMenu</h4>
+<b>__initPipxMenu</b>(<i></i>)
+<p>
+ Private method to create the super menu and attach it to the super
+ menu button.
+</p>
+
+<a NAME="PipxWidget.__installAllPackages" ID="PipxWidget.__installAllPackages"></a>
+<h4>PipxWidget.__installAllPackages</h4>
+<b>__installAllPackages</b>(<i></i>)
+<p>
+ Private slot to install all packages listed in a specification file.
+</p>
+
+<a NAME="PipxWidget.__installPackages" ID="PipxWidget.__installPackages"></a>
+<h4>PipxWidget.__installPackages</h4>
+<b>__installPackages</b>(<i></i>)
+<p>
+ Private slot to install packages to be given by the user.
+</p>
+
+<a NAME="PipxWidget.__markPackageOutdated" ID="PipxWidget.__markPackageOutdated"></a>
+<h4>PipxWidget.__markPackageOutdated</h4>
+<b>__markPackageOutdated</b>(<i>item, latestVersion</i>)
+<p>
+ Private method to mark the given package item as outdated.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the outdated package item
+</dd>
+<dt><i>latestVersion</i> (str)</dt>
+<dd>
+latest version of the package
+</dd>
+</dl>
+<a NAME="PipxWidget.__pipxConfigure" ID="PipxWidget.__pipxConfigure"></a>
+<h4>PipxWidget.__pipxConfigure</h4>
+<b>__pipxConfigure</b>(<i></i>)
+<p>
+ Private slot to show the pipx configuration page.
+</p>
+
+<a NAME="PipxWidget.__populatePackages" ID="PipxWidget.__populatePackages"></a>
+<h4>PipxWidget.__populatePackages</h4>
+<b>__populatePackages</b>(<i></i>)
+<p>
+ Private method to populate the packages list.
+</p>
+
+<a NAME="PipxWidget.__reinstallAllPackages" ID="PipxWidget.__reinstallAllPackages"></a>
+<h4>PipxWidget.__reinstallAllPackages</h4>
+<b>__reinstallAllPackages</b>(<i></i>)
+<p>
+ Private slot to force a re-installation of all packages.
+</p>
+
+<a NAME="PipxWidget.__reinstallPackage" ID="PipxWidget.__reinstallPackage"></a>
+<h4>PipxWidget.__reinstallPackage</h4>
+<b>__reinstallPackage</b>(<i></i>)
+<p>
+ Private slot to force a re-installation of the selected package.
+</p>
+
+<a NAME="PipxWidget.__resizePackagesColumns" ID="PipxWidget.__resizePackagesColumns"></a>
+<h4>PipxWidget.__resizePackagesColumns</h4>
+<b>__resizePackagesColumns</b>(<i></i>)
+<p>
+ Private method to resize the columns of the packages list.
+</p>
+
+<a NAME="PipxWidget.__selectedPackages" ID="PipxWidget.__selectedPackages"></a>
+<h4>PipxWidget.__selectedPackages</h4>
+<b>__selectedPackages</b>(<i></i>)
+<p>
+ Private method to determine the list of selected packages.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of selected packages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
+<a NAME="PipxWidget.__showInterpreters" ID="PipxWidget.__showInterpreters"></a>
+<h4>PipxWidget.__showInterpreters</h4>
+<b>__showInterpreters</b>(<i></i>)
+<p>
+ Private slot to show a list of standalone Python interpreters.
+</p>
+
+<a NAME="PipxWidget.__showPipxVersion" ID="PipxWidget.__showPipxVersion"></a>
+<h4>PipxWidget.__showPipxVersion</h4>
+<b>__showPipxVersion</b>(<i></i>)
+<p>
+ Private method to show the pipx version in the widget header.
+</p>
+
+<a NAME="PipxWidget.__uninstallAllPackages" ID="PipxWidget.__uninstallAllPackages"></a>
+<h4>PipxWidget.__uninstallAllPackages</h4>
+<b>__uninstallAllPackages</b>(<i></i>)
+<p>
+ Private slot to uninstall all packages.
+</p>
+
+<a NAME="PipxWidget.__uninstallPackage" ID="PipxWidget.__uninstallPackage"></a>
+<h4>PipxWidget.__uninstallPackage</h4>
+<b>__uninstallPackage</b>(<i></i>)
+<p>
+ Private slot to uninstall the selected package.
+</p>
+
+<a NAME="PipxWidget.__upgradeAllPackages" ID="PipxWidget.__upgradeAllPackages"></a>
+<h4>PipxWidget.__upgradeAllPackages</h4>
+<b>__upgradeAllPackages</b>(<i></i>)
+<p>
+ Private slot to upgrade all packages.
+</p>
+
+<a NAME="PipxWidget.__upgradePackage" ID="PipxWidget.__upgradePackage"></a>
+<h4>PipxWidget.__upgradePackage</h4>
+<b>__upgradePackage</b>(<i></i>)
+<p>
+ Private slot to upgrade the selected package.
+</p>
+
+<a NAME="PipxWidget.__upgradeSharedLibs" ID="PipxWidget.__upgradeSharedLibs"></a>
+<h4>PipxWidget.__upgradeSharedLibs</h4>
+<b>__upgradeSharedLibs</b>(<i></i>)
+<p>
+ Private slot to upgrade the shared libraries.
+</p>
+
+<a NAME="PipxWidget.on_packagesList_itemActivated" ID="PipxWidget.on_packagesList_itemActivated"></a>
+<h4>PipxWidget.on_packagesList_itemActivated</h4>
+<b>on_packagesList_itemActivated</b>(<i>item, column</i>)
+<p>
+ Private slot to start the activated item, if it is not a top level one.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd>
+<dt><i>column</i> (int)</dt>
+<dd>
+column number of the activation
+</dd>
+</dl>
+<a NAME="PipxWidget.on_packagesList_itemSelectionChanged" ID="PipxWidget.on_packagesList_itemSelectionChanged"></a>
+<h4>PipxWidget.on_packagesList_itemSelectionChanged</h4>
+<b>on_packagesList_itemSelectionChanged</b>(<i></i>)
+<p>
+ Private slot to handle a change of selected packages and apps.
+</p>
+
+<a NAME="PipxWidget.on_refreshButton_clicked" ID="PipxWidget.on_refreshButton_clicked"></a>
+<h4>PipxWidget.on_refreshButton_clicked</h4>
+<b>on_refreshButton_clicked</b>(<i></i>)
+<p>
+ Private slot to refresh the packages list.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
