src/eric7/Documentation/Source/eric7.PipInterface.PipLicensesDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.PipInterface.PipLicensesDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PipInterface.PipLicensesDialog</h1>

<p>
Module implementing a dialog to show the licenses of an environment.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#PipLicensesDialog">PipLicensesDialog</a></td>
<td>Class implementing a dialog to show the licenses of an environment.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="PipLicensesDialog" ID="PipLicensesDialog"></a>
<h2>PipLicensesDialog</h2>

<p>
    Class implementing a dialog to show the licenses of an environment.
</p>
<h3>Derived from</h3>
QDialog, Ui_PipLicensesDialog
<h3>Class Attributes</h3>

<table>
<tr><td>LicensesLicenseColumn</td></tr><tr><td>LicensesPackageColumn</td></tr><tr><td>LicensesVersionColumn</td></tr><tr><td>SummaryCountColumn</td></tr><tr><td>SummaryLicenseColumn</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#PipLicensesDialog.__init__">PipLicensesDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PipLicensesDialog.__filterPackagesByLicense">__filterPackagesByLicense</a></td>
<td>Private slot to filter the list of packages by license.</td>
</tr>
<tr>
<td><a href="#PipLicensesDialog.__refreshLicenses">__refreshLicenses</a></td>
<td>Private slot to refresh the license lists.</td>
</tr>
<tr>
<td><a href="#PipLicensesDialog.__saveAsCSV">__saveAsCSV</a></td>
<td>Private slot to save the license information as a CSV file.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="PipLicensesDialog.__init__" ID="PipLicensesDialog.__init__"></a>
<h4>PipLicensesDialog (Constructor)</h4>
<b>PipLicensesDialog</b>(<i>pip, environment, localPackages=True, usersite=False, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>pip</i> (Pip)</dt>
<dd>
reference to the pip interface object
</dd>
<dt><i>environment</i> (str)</dt>
<dd>
name of the environment to show the licenses for
</dd>
<dt><i>localPackages</i> (bool)</dt>
<dd>
flag indicating to show the licenses for local
            packages only
</dd>
<dt><i>usersite</i> (bool)</dt>
<dd>
flag indicating to show the licenses for packages
            installed in user-site directory only
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="PipLicensesDialog.__filterPackagesByLicense" ID="PipLicensesDialog.__filterPackagesByLicense"></a>
<h4>PipLicensesDialog.__filterPackagesByLicense</h4>
<b>__filterPackagesByLicense</b>(<i>licenseName</i>)

<p>
        Private slot to filter the list of packages by license.
</p>
<dl>

<dt><i>licenseName</i> (str)</dt>
<dd>
license name
</dd>
</dl>
<a NAME="PipLicensesDialog.__refreshLicenses" ID="PipLicensesDialog.__refreshLicenses"></a>
<h4>PipLicensesDialog.__refreshLicenses</h4>
<b>__refreshLicenses</b>(<i></i>)

<p>
        Private slot to refresh the license lists.
</p>
<a NAME="PipLicensesDialog.__saveAsCSV" ID="PipLicensesDialog.__saveAsCSV"></a>
<h4>PipLicensesDialog.__saveAsCSV</h4>
<b>__saveAsCSV</b>(<i></i>)

<p>
        Private slot to save the license information as a CSV file.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>