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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9117
c6afba2049cf
child 9850
20c49b517679
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.PipLicensesDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PipInterface.PipLicensesDialog</h1>
10
11 <p>
12 Module implementing a dialog to show the licenses of an environment.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#PipLicensesDialog">PipLicensesDialog</a></td>
25 <td>Class implementing a dialog to show the licenses of an environment.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="PipLicensesDialog" ID="PipLicensesDialog"></a>
36 <h2>PipLicensesDialog</h2>
37
38 <p>
39 Class implementing a dialog to show the licenses of an environment.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_PipLicensesDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <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>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#PipLicensesDialog.__init__">PipLicensesDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#PipLicensesDialog.__filterPackagesByLicense">__filterPackagesByLicense</a></td>
63 <td>Private slot to filter the list of packages by license.</td>
64 </tr>
65 <tr>
66 <td><a href="#PipLicensesDialog.__refreshLicenses">__refreshLicenses</a></td>
67 <td>Private slot to refresh the license lists.</td>
68 </tr>
69 <tr>
70 <td><a href="#PipLicensesDialog.__saveAsCSV">__saveAsCSV</a></td>
71 <td>Private slot to save the license information as a CSV file.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="PipLicensesDialog.__init__" ID="PipLicensesDialog.__init__"></a>
81 <h4>PipLicensesDialog (Constructor)</h4>
82 <b>PipLicensesDialog</b>(<i>pip, environment, localPackages=True, usersite=False, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>pip</i> (Pip)</dt>
90 <dd>
91 reference to the pip interface object
92 </dd>
93 <dt><i>environment</i> (str)</dt>
94 <dd>
95 name of the environment to show the licenses for
96 </dd>
97 <dt><i>localPackages</i> (bool)</dt>
98 <dd>
99 flag indicating to show the licenses for local
100 packages only
101 </dd>
102 <dt><i>usersite</i> (bool)</dt>
103 <dd>
104 flag indicating to show the licenses for packages
105 installed in user-site directory only
106 </dd>
107 <dt><i>parent</i> (QWidget (optional))</dt>
108 <dd>
109 reference to the parent widget (defaults to None)
110 </dd>
111 </dl>
112 <a NAME="PipLicensesDialog.__filterPackagesByLicense" ID="PipLicensesDialog.__filterPackagesByLicense"></a>
113 <h4>PipLicensesDialog.__filterPackagesByLicense</h4>
114 <b>__filterPackagesByLicense</b>(<i>licenseName</i>)
115
116 <p>
117 Private slot to filter the list of packages by license.
118 </p>
119 <dl>
120
121 <dt><i>licenseName</i> (str)</dt>
122 <dd>
123 license name
124 </dd>
125 </dl>
126 <a NAME="PipLicensesDialog.__refreshLicenses" ID="PipLicensesDialog.__refreshLicenses"></a>
127 <h4>PipLicensesDialog.__refreshLicenses</h4>
128 <b>__refreshLicenses</b>(<i></i>)
129
130 <p>
131 Private slot to refresh the license lists.
132 </p>
133 <a NAME="PipLicensesDialog.__saveAsCSV" ID="PipLicensesDialog.__saveAsCSV"></a>
134 <h4>PipLicensesDialog.__saveAsCSV</h4>
135 <b>__saveAsCSV</b>(<i></i>)
136
137 <p>
138 Private slot to save the license information as a CSV file.
139 </p>
140 <div align="right"><a href="#top">Up</a></div>
141 <hr />
142 </body></html>

eric ide

mercurial