eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html

branch
eric7
changeset 8997
d8946c2a22b5
parent 8985
30e9e592732d
child 8999
723f61499a79
--- a/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Tue Mar 22 19:31:29 2022 +0100
+++ b/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Wed Mar 23 20:21:42 2022 +0100
@@ -47,7 +47,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>AvailableVersionColumn</td></tr><tr><td>InstalledVersionColumn</td></tr><tr><td>PackageColumn</td></tr><tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr><tr><td>VulnerabilityColumn</td></tr><tr><td>VulnerabilityRole</td></tr>
+<tr><td>AvailableVersionColumn</td></tr><tr><td>DepInstalledVersionColumn</td></tr><tr><td>DepPackageColumn</td></tr><tr><td>DepRequiredVersionColumn</td></tr><tr><td>InstalledVersionColumn</td></tr><tr><td>PackageColumn</td></tr><tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr><tr><td>VulnerabilityColumn</td></tr><tr><td>VulnerabilityRole</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -67,6 +67,10 @@
 <td>Private slot to set the action enabled status.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__addDependency">__addDependency</a></td>
+<td>Private method to add a dependency branch to a given parent.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__allUpdateableItems">__allUpdateableItems</a></td>
 <td>Private method to get a list of all items that can be updated.</td>
 </tr>
@@ -143,8 +147,12 @@
 <td>Private slot to empty the pip cache.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__refreshDependencyTree">__refreshDependencyTree</a></td>
+<td>Private method to refresh the dependency tree.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__refreshPackagesList">__refreshPackagesList</a></td>
-<td>Private method to referesh the packages list.</td>
+<td>Private method to refresh the packages list.</td>
 </tr>
 <tr>
 <td><a href="#PipPackagesWidget.__reinstallPackages">__reinstallPackages</a></td>
@@ -203,6 +211,10 @@
 <td>Private method to set the state of the action buttons.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__updateDepActionButtons">__updateDepActionButtons</a></td>
+<td>Private method to set the state of the dependency page action buttons.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__updateSearchActionButtons">__updateSearchActionButtons</a></td>
 <td>Private method to update the action button states of the search widget.</td>
 </tr>
@@ -235,6 +247,18 @@
 <td>Public method to get a reference to the pip interface object.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_dependenciesList_itemActivated">on_dependenciesList_itemActivated</a></td>
+<td>Private slot reacting on a package item of the dependency tree being activated.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.on_dependenciesList_itemPressed">on_dependenciesList_itemPressed</a></td>
+<td>Private slot reacting on a package item of the dependency tree being pressed.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.on_dependenciesList_itemSelectionChanged">on_dependenciesList_itemSelectionChanged</a></td>
+<td>Private slot reacting on a change of selected items of the dependency tree.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
 <td>Private slot handling the selection of a Python environment.</td>
 </tr>
@@ -255,6 +279,10 @@
 <td>Private slot handling the switching of the local mode.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_localDepCheckBox_clicked">on_localDepCheckBox_clicked</a></td>
+<td>Private slot handling the switching of the local mode.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
 <td>Private slot handling the switching of the 'not required' mode.</td>
 </tr>
@@ -275,6 +303,14 @@
 <td>Private slot to refresh the display.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_refreshDependenciesButton_clicked">on_refreshDependenciesButton_clicked</a></td>
+<td>Private slot to refresh the dependency tree.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.on_requiresButton_toggled">on_requiresButton_toggled</a></td>
+<td>Private slot handling the selection of the view type.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_searchButton_clicked">on_searchButton_clicked</a></td>
 <td>Private slot handling a press of the search button.</td>
 </tr>
@@ -299,6 +335,10 @@
 <td>Private slot to togle the search widget.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_showDepPackageDetailsButton_clicked">on_showDepPackageDetailsButton_clicked</a></td>
+<td>Private slot to show information for the selected package of the dependency tree.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_showDetailsButton_clicked">on_showDetailsButton_clicked</a></td>
 <td>Private slot to handle pressing the Show Details button.</td>
 </tr>
@@ -323,10 +363,18 @@
 <td>Private slot handling the switching of the 'user-site' mode.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_userDepCheckBox_clicked">on_userDepCheckBox_clicked</a></td>
+<td>Private slot handling the switching of the 'user-site' mode.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
 <td>Private slot to handle a change of the verbose package information checkbox.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.on_viewToggleButton_toggled">on_viewToggleButton_toggled</a></td>
+<td>Private slot handling the view selection.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_vulnerabilityCheckBox_clicked">on_vulnerabilityCheckBox_clicked</a></td>
 <td>Private slot handling a change of the automatic vulnerability checks.</td>
 </tr>
@@ -362,6 +410,24 @@
 <p>
         Private slot to set the action enabled status.
 </p>
+<a NAME="PipPackagesWidget.__addDependency" ID="PipPackagesWidget.__addDependency"></a>
+<h4>PipPackagesWidget.__addDependency</h4>
+<b>__addDependency</b>(<i>dependency, parent</i>)
+
+<p>
+        Private method to add a dependency branch to a given parent.
+</p>
+<dl>
+
+<dt><i>dependency</i> (dict)</dt>
+<dd>
+dependency to be added
+</dd>
+<dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
+<dd>
+reference to the parent item
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.__allUpdateableItems" ID="PipPackagesWidget.__allUpdateableItems"></a>
 <h4>PipPackagesWidget.__allUpdateableItems</h4>
 <b>__allUpdateableItems</b>(<i></i>)
@@ -549,12 +615,19 @@
 <p>
         Private slot to empty the pip cache.
 </p>
+<a NAME="PipPackagesWidget.__refreshDependencyTree" ID="PipPackagesWidget.__refreshDependencyTree"></a>
+<h4>PipPackagesWidget.__refreshDependencyTree</h4>
+<b>__refreshDependencyTree</b>(<i></i>)
+
+<p>
+        Private method to refresh the dependency tree.
+</p>
 <a NAME="PipPackagesWidget.__refreshPackagesList" ID="PipPackagesWidget.__refreshPackagesList"></a>
 <h4>PipPackagesWidget.__refreshPackagesList</h4>
 <b>__refreshPackagesList</b>(<i></i>)
 
 <p>
-        Private method to referesh the packages list.
+        Private method to refresh the packages list.
 </p>
 <a NAME="PipPackagesWidget.__reinstallPackages" ID="PipPackagesWidget.__reinstallPackages"></a>
 <h4>PipPackagesWidget.__reinstallPackages</h4>
@@ -662,7 +735,7 @@
 </dl>
 <a NAME="PipPackagesWidget.__showPackageInformation" ID="PipPackagesWidget.__showPackageInformation"></a>
 <h4>PipPackagesWidget.__showPackageInformation</h4>
-<b>__showPackageInformation</b>(<i>packageName</i>)
+<b>__showPackageInformation</b>(<i>packageName, infoWidget</i>)
 
 <p>
         Private method to show information for a package.
@@ -673,6 +746,10 @@
 <dd>
 name of the package
 </dd>
+<dt><i>infoWidget</i> (QTreeWidget)</dt>
+<dd>
+reference to the widget to contain the information
+</dd>
 </dl>
 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
 <h4>PipPackagesWidget.__showSearchedDetails</h4>
@@ -724,6 +801,13 @@
 <p>
         Private method to set the state of the action buttons.
 </p>
+<a NAME="PipPackagesWidget.__updateDepActionButtons" ID="PipPackagesWidget.__updateDepActionButtons"></a>
+<h4>PipPackagesWidget.__updateDepActionButtons</h4>
+<b>__updateDepActionButtons</b>(<i></i>)
+
+<p>
+        Private method to set the state of the dependency page action buttons.
+</p>
 <a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
 <h4>PipPackagesWidget.__updateSearchActionButtons</h4>
 <b>__updateSearchActionButtons</b>(<i></i>)
@@ -826,6 +910,52 @@
 Pip
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.on_dependenciesList_itemActivated" ID="PipPackagesWidget.on_dependenciesList_itemActivated"></a>
+<h4>PipPackagesWidget.on_dependenciesList_itemActivated</h4>
+<b>on_dependenciesList_itemActivated</b>(<i>item, column</i>)
+
+<p>
+        Private slot reacting on a package item of the dependency tree being
+        activated.
+</p>
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd>
+<dt><i>column</i> (int)</dt>
+<dd>
+activated column
+</dd>
+</dl>
+<a NAME="PipPackagesWidget.on_dependenciesList_itemPressed" ID="PipPackagesWidget.on_dependenciesList_itemPressed"></a>
+<h4>PipPackagesWidget.on_dependenciesList_itemPressed</h4>
+<b>on_dependenciesList_itemPressed</b>(<i>item, column</i>)
+
+<p>
+        Private slot reacting on a package item of the dependency tree being
+        pressed.
+</p>
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the pressed item
+</dd>
+<dt><i>column</i> (int)</dt>
+<dd>
+pressed column
+</dd>
+</dl>
+<a NAME="PipPackagesWidget.on_dependenciesList_itemSelectionChanged" ID="PipPackagesWidget.on_dependenciesList_itemSelectionChanged"></a>
+<h4>PipPackagesWidget.on_dependenciesList_itemSelectionChanged</h4>
+<b>on_dependenciesList_itemSelectionChanged</b>(<i></i>)
+
+<p>
+        Private slot reacting on a change of selected items of the dependency
+        tree.
+</p>
 <a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)
@@ -876,6 +1006,13 @@
 <p>
         Private slot handling the switching of the local mode.
 </p>
+<a NAME="PipPackagesWidget.on_localDepCheckBox_clicked" ID="PipPackagesWidget.on_localDepCheckBox_clicked"></a>
+<h4>PipPackagesWidget.on_localDepCheckBox_clicked</h4>
+<b>on_localDepCheckBox_clicked</b>(<i></i>)
+
+<p>
+        Private slot handling the switching of the local mode.
+</p>
 <a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
 <b>on_notRequiredCheckBox_clicked</b>(<i></i>)
@@ -933,6 +1070,27 @@
 <p>
         Private slot to refresh the display.
 </p>
+<a NAME="PipPackagesWidget.on_refreshDependenciesButton_clicked" ID="PipPackagesWidget.on_refreshDependenciesButton_clicked"></a>
+<h4>PipPackagesWidget.on_refreshDependenciesButton_clicked</h4>
+<b>on_refreshDependenciesButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to refresh the dependency tree.
+</p>
+<a NAME="PipPackagesWidget.on_requiresButton_toggled" ID="PipPackagesWidget.on_requiresButton_toggled"></a>
+<h4>PipPackagesWidget.on_requiresButton_toggled</h4>
+<b>on_requiresButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection of the view type.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the radio button (unused)
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
 <h4>PipPackagesWidget.on_searchButton_clicked</h4>
 <b>on_searchButton_clicked</b>(<i></i>)
@@ -1000,6 +1158,14 @@
 state of the search widget button
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a>
+<h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4>
+<b>on_showDepPackageDetailsButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to show information for the selected package of the
+        dependency tree.
+</p>
 <a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
 <h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
 <b>on_showDetailsButton_clicked</b>(<i></i>)
@@ -1042,6 +1208,13 @@
 <p>
         Private slot handling the switching of the 'user-site' mode.
 </p>
+<a NAME="PipPackagesWidget.on_userDepCheckBox_clicked" ID="PipPackagesWidget.on_userDepCheckBox_clicked"></a>
+<h4>PipPackagesWidget.on_userDepCheckBox_clicked</h4>
+<b>on_userDepCheckBox_clicked</b>(<i></i>)
+
+<p>
+        Private slot handling the switching of the 'user-site' mode.
+</p>
 <a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
@@ -1057,6 +1230,20 @@
 state of the checkbox
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.on_viewToggleButton_toggled" ID="PipPackagesWidget.on_viewToggleButton_toggled"></a>
+<h4>PipPackagesWidget.on_viewToggleButton_toggled</h4>
+<b>on_viewToggleButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the view selection.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the toggle button
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.on_vulnerabilityCheckBox_clicked" ID="PipPackagesWidget.on_vulnerabilityCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_vulnerabilityCheckBox_clicked</h4>
 <b>on_vulnerabilityCheckBox_clicked</b>(<i>checked</i>)

eric ide

mercurial