eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.PipInterface.PipPackageDetailsDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.PipInterface.PipPackageDetailsDialog</h1>
24
25 <p>
26 Module implementing a dialog to show details about a package.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td>
39 <td>Class implementing a dialog to show details about a package.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a>
50 <h2>PipPackageDetailsDialog</h2>
51
52 <p>
53 Class implementing a dialog to show details about a package.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_PipPackageDetailsDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>ButtonInstall</td></tr><tr><td>ButtonRemove</td></tr><tr><td>ButtonUpgrade</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td>
77 <td>Private slot to format the size.</td>
78 </tr>
79 <tr>
80 <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td>
81 <td>Private method to format the upload date.</td>
82 </tr>
83 <tr>
84 <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td>
85 <td>Private method to populate the details tab.</td>
86 </tr>
87 <tr>
88 <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td>
89 <td>Private method to populate the download URLs tab.</td>
90 </tr>
91 <tr>
92 <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td>
93 <td>Private method to populate the requires/provides tab.</td>
94 </tr>
95 <tr>
96 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td>
97 <td>Private method to clean-up the given text.</td>
98 </tr>
99 <tr>
100 <td><a href="#PipPackageDetailsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
101 <td>Private slot handling the user pressing an action button.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a>
111 <h4>PipPackageDetailsDialog (Constructor)</h4>
112 <b>PipPackageDetailsDialog</b>(<i>detailsData, buttonsMode=0, parent=None</i>)
113
114 <p>
115 Constructor
116 </p>
117 <dl>
118
119 <dt><i>detailsData</i> (dict)</dt>
120 <dd>
121 package details
122 </dd>
123 <dt><i>buttonsMode</i> (int (optional))</dt>
124 <dd>
125 flags telling which convenience buttons to enable
126 (defaults to 0)
127 </dd>
128 <dt><i>parent</i> (QWidget (optional))</dt>
129 <dd>
130 reference to the parent widget (defaults to None)
131 </dd>
132 </dl>
133 <a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a>
134 <h4>PipPackageDetailsDialog.__formatSize</h4>
135 <b>__formatSize</b>(<i>size</i>)
136
137 <p>
138 Private slot to format the size.
139 </p>
140 <dl>
141
142 <dt><i>size</i> (int)</dt>
143 <dd>
144 size to be formatted
145 </dd>
146 </dl>
147 <dl>
148 <dt>Return:</dt>
149 <dd>
150 formatted size
151 </dd>
152 </dl>
153 <dl>
154 <dt>Return Type:</dt>
155 <dd>
156 str
157 </dd>
158 </dl>
159 <a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a>
160 <h4>PipPackageDetailsDialog.__formatUploadDate</h4>
161 <b>__formatUploadDate</b>(<i>datetime</i>)
162
163 <p>
164 Private method to format the upload date.
165 </p>
166 <dl>
167
168 <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt>
169 <dd>
170 upload date and time
171 </dd>
172 </dl>
173 <dl>
174 <dt>Return:</dt>
175 <dd>
176 formatted date string
177 </dd>
178 </dl>
179 <dl>
180 <dt>Return Type:</dt>
181 <dd>
182 str
183 </dd>
184 </dl>
185 <a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a>
186 <h4>PipPackageDetailsDialog.__populateDetails</h4>
187 <b>__populateDetails</b>(<i>detailsData</i>)
188
189 <p>
190 Private method to populate the details tab.
191 </p>
192 <dl>
193
194 <dt><i>detailsData</i> (dict)</dt>
195 <dd>
196 package details
197 </dd>
198 </dl>
199 <a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a>
200 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4>
201 <b>__populateDownloadUrls</b>(<i>downloadsData</i>)
202
203 <p>
204 Private method to populate the download URLs tab.
205 </p>
206 <dl>
207
208 <dt><i>downloadsData</i> (dict)</dt>
209 <dd>
210 downloads information
211 </dd>
212 </dl>
213 <a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a>
214 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4>
215 <b>__populateRequiresProvides</b>(<i>detailsData</i>)
216
217 <p>
218 Private method to populate the requires/provides tab.
219 </p>
220 <dl>
221
222 <dt><i>detailsData</i> (dict)</dt>
223 <dd>
224 package details
225 </dd>
226 </dl>
227 <a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a>
228 <h4>PipPackageDetailsDialog.__sanitize</h4>
229 <b>__sanitize</b>(<i>text, forUrl=False</i>)
230
231 <p>
232 Private method to clean-up the given text.
233 </p>
234 <dl>
235
236 <dt><i>text</i> (str)</dt>
237 <dd>
238 raw text
239 </dd>
240 <dt><i>forUrl</i> (bool)</dt>
241 <dd>
242 flag indicating to sanitize an URL text
243 </dd>
244 </dl>
245 <dl>
246 <dt>Return:</dt>
247 <dd>
248 processed text
249 </dd>
250 </dl>
251 <dl>
252 <dt>Return Type:</dt>
253 <dd>
254 str
255 </dd>
256 </dl>
257 <a NAME="PipPackageDetailsDialog.on_buttonBox_clicked" ID="PipPackageDetailsDialog.on_buttonBox_clicked"></a>
258 <h4>PipPackageDetailsDialog.on_buttonBox_clicked</h4>
259 <b>on_buttonBox_clicked</b>(<i>button</i>)
260
261 <p>
262 Private slot handling the user pressing an action button.
263 </p>
264 <dl>
265
266 <dt><i>button</i> (QAbstractButton)</dt>
267 <dd>
268 button activated by the user
269 </dd>
270 </dl>
271 <div align="right"><a href="#top">Up</a></div>
272 <hr />
273 </body></html>

eric ide

mercurial