Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html
src/eric7/Documentation/Source/eric7.PipInterface.PipPackageDetailsDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9661
- 1ef89052d991
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PipInterface.PipPackageDetailsDialog</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.PipPackageDetailsDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show details about a package. | |
| 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="#PipPackageDetailsDialog">PipPackageDetailsDialog</a></td> | |
| 25 <td>Class implementing a dialog to show details about a package.</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="PipPackageDetailsDialog" ID="PipPackageDetailsDialog"></a> | |
| 36 <h2>PipPackageDetailsDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show details about a package. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_PipPackageDetailsDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>ButtonInstall</td></tr><tr><td>ButtonRemove</td></tr><tr><td>ButtonUpgrade</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="#PipPackageDetailsDialog.__init__">PipPackageDetailsDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#PipPackageDetailsDialog.__formatSize">__formatSize</a></td> | |
| 63 <td>Private slot to format the size.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PipPackageDetailsDialog.__formatUploadDate">__formatUploadDate</a></td> | |
| 67 <td>Private method to format the upload date.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PipPackageDetailsDialog.__populateDetails">__populateDetails</a></td> | |
| 71 <td>Private method to populate the details tab.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PipPackageDetailsDialog.__populateDownloadUrls">__populateDownloadUrls</a></td> | |
| 75 <td>Private method to populate the download URLs tab.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PipPackageDetailsDialog.__populateRequiresProvides">__populateRequiresProvides</a></td> | |
| 79 <td>Private method to populate the requires/provides tab.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PipPackageDetailsDialog.__sanitize">__sanitize</a></td> | |
| 83 <td>Private method to clean-up the given text.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PipPackageDetailsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 87 <td>Private slot handling the user pressing an action button.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="PipPackageDetailsDialog.__init__" ID="PipPackageDetailsDialog.__init__"></a> | |
| 97 <h4>PipPackageDetailsDialog (Constructor)</h4> | |
| 98 <b>PipPackageDetailsDialog</b>(<i>detailsData, buttonsMode=0, parent=None</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>detailsData</i> (dict)</dt> | |
| 106 <dd> | |
| 107 package details | |
| 108 </dd> | |
| 109 <dt><i>buttonsMode</i> (int (optional))</dt> | |
| 110 <dd> | |
| 111 flags telling which convenience buttons to enable | |
| 112 (defaults to 0) | |
| 113 </dd> | |
| 114 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 115 <dd> | |
| 116 reference to the parent widget (defaults to None) | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> | |
| 120 <h4>PipPackageDetailsDialog.__formatSize</h4> | |
| 121 <b>__formatSize</b>(<i>size</i>) | |
| 122 | |
| 123 <p> | |
| 124 Private slot to format the size. | |
| 125 </p> | |
| 126 <dl> | |
| 127 | |
| 128 <dt><i>size</i> (int)</dt> | |
| 129 <dd> | |
| 130 size to be formatted | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return:</dt> | |
| 135 <dd> | |
| 136 formatted size | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <dl> | |
| 140 <dt>Return Type:</dt> | |
| 141 <dd> | |
| 142 str | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> | |
| 146 <h4>PipPackageDetailsDialog.__formatUploadDate</h4> | |
| 147 <b>__formatUploadDate</b>(<i>datetime</i>) | |
| 148 | |
| 149 <p> | |
| 150 Private method to format the upload date. | |
| 151 </p> | |
| 152 <dl> | |
| 153 | |
| 154 <dt><i>datetime</i> (xmlrpc.DateTime or str)</dt> | |
| 155 <dd> | |
| 156 upload date and time | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <dl> | |
| 160 <dt>Return:</dt> | |
| 161 <dd> | |
| 162 formatted date string | |
| 163 </dd> | |
| 164 </dl> | |
| 165 <dl> | |
| 166 <dt>Return Type:</dt> | |
| 167 <dd> | |
| 168 str | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <a NAME="PipPackageDetailsDialog.__populateDetails" ID="PipPackageDetailsDialog.__populateDetails"></a> | |
| 172 <h4>PipPackageDetailsDialog.__populateDetails</h4> | |
| 173 <b>__populateDetails</b>(<i>detailsData</i>) | |
| 174 | |
| 175 <p> | |
| 176 Private method to populate the details tab. | |
| 177 </p> | |
| 178 <dl> | |
| 179 | |
| 180 <dt><i>detailsData</i> (dict)</dt> | |
| 181 <dd> | |
| 182 package details | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> | |
| 186 <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4> | |
| 187 <b>__populateDownloadUrls</b>(<i>downloadsData</i>) | |
| 188 | |
| 189 <p> | |
| 190 Private method to populate the download URLs tab. | |
| 191 </p> | |
| 192 <dl> | |
| 193 | |
| 194 <dt><i>downloadsData</i> (dict)</dt> | |
| 195 <dd> | |
| 196 downloads information | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> | |
| 200 <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4> | |
| 201 <b>__populateRequiresProvides</b>(<i>detailsData</i>) | |
| 202 | |
| 203 <p> | |
| 204 Private method to populate the requires/provides tab. | |
| 205 </p> | |
| 206 <dl> | |
| 207 | |
| 208 <dt><i>detailsData</i> (dict)</dt> | |
| 209 <dd> | |
| 210 package details | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> | |
| 214 <h4>PipPackageDetailsDialog.__sanitize</h4> | |
| 215 <b>__sanitize</b>(<i>text, forUrl=False</i>) | |
| 216 | |
| 217 <p> | |
| 218 Private method to clean-up the given text. | |
| 219 </p> | |
| 220 <dl> | |
| 221 | |
| 222 <dt><i>text</i> (str)</dt> | |
| 223 <dd> | |
| 224 raw text | |
| 225 </dd> | |
| 226 <dt><i>forUrl</i> (bool)</dt> | |
| 227 <dd> | |
| 228 flag indicating to sanitize an URL text | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <dl> | |
| 232 <dt>Return:</dt> | |
| 233 <dd> | |
| 234 processed text | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <dl> | |
| 238 <dt>Return Type:</dt> | |
| 239 <dd> | |
| 240 str | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <a NAME="PipPackageDetailsDialog.on_buttonBox_clicked" ID="PipPackageDetailsDialog.on_buttonBox_clicked"></a> | |
| 244 <h4>PipPackageDetailsDialog.on_buttonBox_clicked</h4> | |
| 245 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 246 | |
| 247 <p> | |
| 248 Private slot handling the user pressing an action button. | |
| 249 </p> | |
| 250 <dl> | |
| 251 | |
| 252 <dt><i>button</i> (QAbstractButton)</dt> | |
| 253 <dd> | |
| 254 button activated by the user | |
| 255 </dd> | |
| 256 </dl> | |
| 257 <div align="right"><a href="#top">Up</a></div> | |
| 258 <hr /> | |
| 259 </body></html> |
