Mercurial Repositories > pipx Interface / file diff

--- a/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html	Sat Jul 27 19:39:32 2024 +0200
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html	Sun Jul 28 11:46:18 2024 +0200
@@ -43,6 +43,7 @@
 <table>
 <tr><td>AppPathRole</td></tr>
 <tr><td>LatestVersionRole</td></tr>
+<tr><td>OutdatedDependenciesRole</td></tr>
 <tr><td>PackageColumn</td></tr>
 <tr><td>PythonVersionColumn</td></tr>
 <tr><td>VersionColumn</td></tr>
@@ -77,6 +78,14 @@
 <td>Private slot to ensure that the directory where pipx stores apps is in your PATH environment variable.</td>
 </tr>
 <tr>
+<td><a href="#PipxWidget.__getAllRunningApps">__getAllRunningApps</a></td>
+<td>Private method to determine all running pipx managed apps.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__getRunningApps">__getRunningApps</a></td>
+<td>Private method to determine, which app of the given list of apps is running.</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>
@@ -89,10 +98,18 @@
 <td>Private slot to install packages to be given by the user.</td>
 </tr>
 <tr>
+<td><a href="#PipxWidget.__markPackageDependenciesOutdated">__markPackageDependenciesOutdated</a></td>
+<td>Private method to mark the given package item as having outdated dependencies.</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.__packageApps">__packageApps</a></td>
+<td>Private method to determine the apps belonging to a package item.</td>
+</tr>
+<tr>
 <td><a href="#PipxWidget.__pipxConfigure">__pipxConfigure</a></td>
 <td>Private slot to show the pipx configuration page.</td>
 </tr>
@@ -113,6 +130,10 @@
 <td>Private method to resize the columns of the packages list.</td>
 </tr>
 <tr>
+<td><a href="#PipxWidget.__selectedPackageItems">__selectedPackageItems</a></td>
+<td>Private method to determine the list of selected package items.</td>
+</tr>
+<tr>
 <td><a href="#PipxWidget.__selectedPackages">__selectedPackages</a></td>
 <td>Private method to determine the list of selected packages.</td>
 </tr>
@@ -216,6 +237,51 @@
         in your PATH environment variable.
 </p>
 
+<a NAME="PipxWidget.__getAllRunningApps" ID="PipxWidget.__getAllRunningApps"></a>
+<h4>PipxWidget.__getAllRunningApps</h4>
+<b>__getAllRunningApps</b>(<i></i>)
+<p>
+        Private method to determine all running pipx managed apps.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+set of running apps
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+set of str
+</dd>
+</dl>
+<a NAME="PipxWidget.__getRunningApps" ID="PipxWidget.__getRunningApps"></a>
+<h4>PipxWidget.__getRunningApps</h4>
+<b>__getRunningApps</b>(<i>apps</i>)
+<p>
+        Private method to determine, which app of the given list of apps is running.
+</p>
+
+<dl>
+
+<dt><i>apps</i> (str)</dt>
+<dd>
+list of apps to check
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+set of running apps
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+set of str
+</dd>
+</dl>
 <a NAME="PipxWidget.__initPipxMenu" ID="PipxWidget.__initPipxMenu"></a>
 <h4>PipxWidget.__initPipxMenu</h4>
 <b>__initPipxMenu</b>(<i></i>)
@@ -238,9 +304,23 @@
         Private slot to install packages to be given by the user.
 </p>
 
+<a NAME="PipxWidget.__markPackageDependenciesOutdated" ID="PipxWidget.__markPackageDependenciesOutdated"></a>
+<h4>PipxWidget.__markPackageDependenciesOutdated</h4>
+<b>__markPackageDependenciesOutdated</b>(<i>item</i>)
+<p>
+        Private method to mark the given package item as having outdated dependencies.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the outdated package item
+</dd>
+</dl>
 <a NAME="PipxWidget.__markPackageOutdated" ID="PipxWidget.__markPackageOutdated"></a>
 <h4>PipxWidget.__markPackageOutdated</h4>
-<b>__markPackageOutdated</b>(<i>item, latestVersion</i>)
+<b>__markPackageOutdated</b>(<i>item, latestVersion, outdatedDependencies</i>)
 <p>
         Private method to mark the given package item as outdated.
 </p>
@@ -256,6 +336,32 @@
 latest version of the package
 </dd>
 </dl>
+<a NAME="PipxWidget.__packageApps" ID="PipxWidget.__packageApps"></a>
+<h4>PipxWidget.__packageApps</h4>
+<b>__packageApps</b>(<i>packageItem</i>)
+<p>
+        Private method to determine the apps belonging to a package item.
+</p>
+
+<dl>
+
+<dt><i>packageItem</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the package item
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of app names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="PipxWidget.__pipxConfigure" ID="PipxWidget.__pipxConfigure"></a>
 <h4>PipxWidget.__pipxConfigure</h4>
 <b>__pipxConfigure</b>(<i></i>)
@@ -291,6 +397,25 @@
         Private method to resize the columns of the packages list.
 </p>
 
+<a NAME="PipxWidget.__selectedPackageItems" ID="PipxWidget.__selectedPackageItems"></a>
+<h4>PipxWidget.__selectedPackageItems</h4>
+<b>__selectedPackageItems</b>(<i></i>)
+<p>
+        Private method to determine the list of selected package items.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of selected package items
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
 <a NAME="PipxWidget.__selectedPackages" ID="PipxWidget.__selectedPackages"></a>
 <h4>PipxWidget.__selectedPackages</h4>
 <b>__selectedPackages</b>(<i></i>)
@@ -307,7 +432,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-list of QTreeWidgetItem
+list of str
 </dd>
 </dl>
 <a NAME="PipxWidget.__showInterpreters" ID="PipxWidget.__showInterpreters"></a>