Mercurial Repositories > pipx Interface / file diff

--- a/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html	Sat Sep 07 19:29:57 2024 +0200
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html	Sun Sep 15 11:57:39 2024 +0200
@@ -20,7 +20,7 @@
 <table>
 <tr>
 <td><a href="#PipxWidget">PipxWidget</a></td>
-<td>Class documentation goes here.</td>
+<td>Class implementing the pipx management widget.</td>
 </tr>
 </table>
 
@@ -34,7 +34,7 @@
 <a NAME="PipxWidget" ID="PipxWidget"></a>
 <h2>PipxWidget</h2>
 <p>
-    Class documentation goes here.
+    Class implementing the pipx management widget.
 </p>
 
 <h3>Derived from</h3>
@@ -74,6 +74,10 @@
 <td>Private method to check, if a package item is outdated or has outdated dependencies.</td>
 </tr>
 <tr>
+<td><a href="#PipxWidget.__checkPackageVersion">__checkPackageVersion</a></td>
+<td>Private method to check the version of a package.</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>
@@ -94,6 +98,10 @@
 <td>Private method to determine, which app of the given list of apps is running.</td>
 </tr>
 <tr>
+<td><a href="#PipxWidget.__handleOutdatedPackage">__handleOutdatedPackage</a></td>
+<td>Private slot to handle the pipx client reporting an outdated package or a package with outdated dependencies.</td>
+</tr>
+<tr>
 <td><a href="#PipxWidget.__hasOutdatedItems">__hasOutdatedItems</a></td>
 <td>Private method to check, if the list of packages contains any entries which is outdated or has outdated dependencies.</td>
 </tr>
@@ -269,16 +277,18 @@
 reference to the package item
 </dd>
 </dl>
+<a NAME="PipxWidget.__checkPackageVersion" ID="PipxWidget.__checkPackageVersion"></a>
+<h4>PipxWidget.__checkPackageVersion</h4>
+<b>__checkPackageVersion</b>(<i>itm</i>)
+<p>
+        Private method to check the version of a package.
+</p>
+
 <dl>
-<dt>Return:</dt>
+
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-flag indicating the outdated status
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
+reference to the package item
 </dd>
 </dl>
 <a NAME="PipxWidget.__createSpecMetadataFile" ID="PipxWidget.__createSpecMetadataFile"></a>
@@ -367,6 +377,29 @@
 set of str
 </dd>
 </dl>
+<a NAME="PipxWidget.__handleOutdatedPackage" ID="PipxWidget.__handleOutdatedPackage"></a>
+<h4>PipxWidget.__handleOutdatedPackage</h4>
+<b>__handleOutdatedPackage</b>(<i>package, latestVersion, outdatedDependencies</i>)
+<p>
+        Private slot to handle the pipx client reporting an outdated package or a
+        package with outdated dependencies.
+</p>
+
+<dl>
+
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package
+</dd>
+<dt><i>latestVersion</i> (str)</dt>
+<dd>
+latest available version in case outdated
+</dd>
+<dt><i>outdatedDependencies</i> (bool)</dt>
+<dd>
+flag indicating outdated dependencies
+</dd>
+</dl>
 <a NAME="PipxWidget.__hasOutdatedItems" ID="PipxWidget.__hasOutdatedItems"></a>
 <h4>PipxWidget.__hasOutdatedItems</h4>
 <b>__hasOutdatedItems</b>(<i></i>)