Documentation/Source/eric6.WebBrowser.Download.DownloadManager.html

changeset 6225
56b6f18abc21
parent 6153
0b18c86c03a1
equal deleted inserted replaced
6224:08875555771a 6225:56b6f18abc21
53 </dl> 53 </dl>
54 <h3>Derived from</h3> 54 <h3>Derived from</h3>
55 QDialog, Ui_DownloadManager 55 QDialog, Ui_DownloadManager
56 <h3>Class Attributes</h3> 56 <h3>Class Attributes</h3>
57 <table> 57 <table>
58 <tr><td>RemoveExit</td></tr><tr><td>RemoveNever</td></tr><tr><td>RemoveSuccessFullDownload</td></tr> 58 <tr><td>RemoveExit</td></tr><tr><td>RemoveNever</td></tr><tr><td>RemoveSuccessFullDownload</td></tr><tr><td>UpdateTimerTimeout</td></tr>
59 </table> 59 </table>
60 <h3>Class Methods</h3> 60 <h3>Class Methods</h3>
61 <table> 61 <table>
62 <tr><td>None</td></tr> 62 <tr><td>None</td></tr>
63 </table> 63 </table>
68 <td>Constructor</td> 68 <td>Constructor</td>
69 </tr><tr> 69 </tr><tr>
70 <td><a href="#DownloadManager.__addItem">__addItem</a></td> 70 <td><a href="#DownloadManager.__addItem">__addItem</a></td>
71 <td>Private method to add a download to the list of downloads.</td> 71 <td>Private method to add a download to the list of downloads.</td>
72 </tr><tr> 72 </tr><tr>
73 <td><a href="#DownloadManager.__closeDownloadTab">__closeDownloadTab</a></td>
74 <td>Private method to close an empty tab, that was opened only for loading the download URL.</td>
75 </tr><tr>
73 <td><a href="#DownloadManager.__contextMenuCancel">__contextMenuCancel</a></td> 76 <td><a href="#DownloadManager.__contextMenuCancel">__contextMenuCancel</a></td>
74 <td>Private method to cancel the current download.</td> 77 <td>Private method to cancel the current download.</td>
75 </tr><tr> 78 </tr><tr>
76 <td><a href="#DownloadManager.__contextMenuCopyLink">__contextMenuCopyLink</a></td> 79 <td><a href="#DownloadManager.__contextMenuCopyLink">__contextMenuCopyLink</a></td>
77 <td>Private method to copy the download link to the clipboard.</td> 80 <td>Private method to copy the download link to the clipboard.</td>
101 <td>Private slot to handle a finished download.</td> 104 <td>Private slot to handle a finished download.</td>
102 </tr><tr> 105 </tr><tr>
103 <td><a href="#DownloadManager.__load">__load</a></td> 106 <td><a href="#DownloadManager.__load">__load</a></td>
104 <td>Private method to load the download settings.</td> 107 <td>Private method to load the download settings.</td>
105 </tr><tr> 108 </tr><tr>
106 <td><a href="#DownloadManager.__updateActiveItemCount">__updateActiveItemCount</a></td> 109 <td><a href="#DownloadManager.__startUpdateTimer">__startUpdateTimer</a></td>
107 <td>Private method to update the window title.</td> 110 <td>Private slot to start the update timer.</td>
108 </tr><tr> 111 </tr><tr>
109 <td><a href="#DownloadManager.__updateItemCount">__updateItemCount</a></td> 112 <td><a href="#DownloadManager.__stopUpdateTimer">__stopUpdateTimer</a></td>
110 <td>Private method to update the count label.</td> 113 <td>Private slot to stop the update timer.</td>
114 </tr><tr>
115 <td><a href="#DownloadManager.__taskbarButton">__taskbarButton</a></td>
116 <td>Private method to get a reference to the task bar button (Windows only).</td>
117 </tr><tr>
118 <td><a href="#DownloadManager.__testWebBrowserView">__testWebBrowserView</a></td>
119 <td>Private method to test a web browser view against an URL.</td>
111 </tr><tr> 120 </tr><tr>
112 <td><a href="#DownloadManager.__updateRow">__updateRow</a></td> 121 <td><a href="#DownloadManager.__updateRow">__updateRow</a></td>
113 <td>Private slot to update a download item.</td> 122 <td>Private slot to update a download item.</td>
114 </tr><tr> 123 </tr><tr>
115 <td><a href="#DownloadManager.activeDownloadsCount">activeDownloadsCount</a></td> 124 <td><a href="#DownloadManager.activeDownloadsCount">activeDownloadsCount</a></td>
138 </tr><tr> 147 </tr><tr>
139 <td><a href="#DownloadManager.downloadsCount">downloadsCount</a></td> 148 <td><a href="#DownloadManager.downloadsCount">downloadsCount</a></td>
140 <td>Public method to get the number of downloads.</td> 149 <td>Public method to get the number of downloads.</td>
141 </tr><tr> 150 </tr><tr>
142 <td><a href="#DownloadManager.on_cleanupButton_clicked">on_cleanupButton_clicked</a></td> 151 <td><a href="#DownloadManager.on_cleanupButton_clicked">on_cleanupButton_clicked</a></td>
143 <td>Private slot cleanup the downloads.</td> 152 <td>Private slot to cleanup the downloads.</td>
144 </tr><tr> 153 </tr><tr>
145 <td><a href="#DownloadManager.removePolicy">removePolicy</a></td> 154 <td><a href="#DownloadManager.removePolicy">removePolicy</a></td>
146 <td>Public method to get the remove policy.</td> 155 <td>Public method to get the remove policy.</td>
147 </tr><tr> 156 </tr><tr>
148 <td><a href="#DownloadManager.save">save</a></td> 157 <td><a href="#DownloadManager.save">save</a></td>
152 <td>Public method to set the current download directory.</td> 161 <td>Public method to set the current download directory.</td>
153 </tr><tr> 162 </tr><tr>
154 <td><a href="#DownloadManager.setRemovePolicy">setRemovePolicy</a></td> 163 <td><a href="#DownloadManager.setRemovePolicy">setRemovePolicy</a></td>
155 <td>Public method to set the remove policy.</td> 164 <td>Public method to set the remove policy.</td>
156 </tr><tr> 165 </tr><tr>
166 <td><a href="#DownloadManager.show">show</a></td>
167 <td>Public slot to show the download manager dialog.</td>
168 </tr><tr>
157 <td><a href="#DownloadManager.shutdown">shutdown</a></td> 169 <td><a href="#DownloadManager.shutdown">shutdown</a></td>
158 <td>Public method to stop the download manager.</td> 170 <td>Public method to stop the download manager.</td>
171 </tr><tr>
172 <td><a href="#DownloadManager.timerEvent">timerEvent</a></td>
173 <td>Protected event handler for timer events.</td>
159 </tr> 174 </tr>
160 </table> 175 </table>
161 <h3>Static Methods</h3> 176 <h3>Static Methods</h3>
162 <table> 177 <table>
163 <tr><td>None</td></tr> 178 <tr><td>None</td></tr>
182 <dd> 197 <dd>
183 reference to the download item 198 reference to the download item
184 </dd><dt><i>append</i> (bool)</dt> 199 </dd><dt><i>append</i> (bool)</dt>
185 <dd> 200 <dd>
186 flag indicating to append the item 201 flag indicating to append the item
202 </dd>
203 </dl><a NAME="DownloadManager.__closeDownloadTab" ID="DownloadManager.__closeDownloadTab"></a>
204 <h4>DownloadManager.__closeDownloadTab</h4>
205 <b>__closeDownloadTab</b>(<i>url</i>)
206 <p>
207 Private method to close an empty tab, that was opened only for loading
208 the download URL.
209 </p><dl>
210 <dt><i>url</i> (QUrl)</dt>
211 <dd>
212 download URL
187 </dd> 213 </dd>
188 </dl><a NAME="DownloadManager.__contextMenuCancel" ID="DownloadManager.__contextMenuCancel"></a> 214 </dl><a NAME="DownloadManager.__contextMenuCancel" ID="DownloadManager.__contextMenuCancel"></a>
189 <h4>DownloadManager.__contextMenuCancel</h4> 215 <h4>DownloadManager.__contextMenuCancel</h4>
190 <b>__contextMenuCancel</b>(<i></i>) 216 <b>__contextMenuCancel</b>(<i></i>)
191 <p> 217 <p>
240 <dd> 266 <dd>
241 position the context menu was requested (QPoint) 267 position the context menu was requested (QPoint)
242 </dd> 268 </dd>
243 </dl><a NAME="DownloadManager.__finished" ID="DownloadManager.__finished"></a> 269 </dl><a NAME="DownloadManager.__finished" ID="DownloadManager.__finished"></a>
244 <h4>DownloadManager.__finished</h4> 270 <h4>DownloadManager.__finished</h4>
245 <b>__finished</b>(<i></i>) 271 <b>__finished</b>(<i>success</i>)
246 <p> 272 <p>
247 Private slot to handle a finished download. 273 Private slot to handle a finished download.
248 </p><a NAME="DownloadManager.__load" ID="DownloadManager.__load"></a> 274 </p><dl>
275 <dt><i>success</i> (bool)</dt>
276 <dd>
277 flag indicating a successful download
278 </dd>
279 </dl><a NAME="DownloadManager.__load" ID="DownloadManager.__load"></a>
249 <h4>DownloadManager.__load</h4> 280 <h4>DownloadManager.__load</h4>
250 <b>__load</b>(<i></i>) 281 <b>__load</b>(<i></i>)
251 <p> 282 <p>
252 Private method to load the download settings. 283 Private method to load the download settings.
253 </p><a NAME="DownloadManager.__updateActiveItemCount" ID="DownloadManager.__updateActiveItemCount"></a> 284 </p><a NAME="DownloadManager.__startUpdateTimer" ID="DownloadManager.__startUpdateTimer"></a>
254 <h4>DownloadManager.__updateActiveItemCount</h4> 285 <h4>DownloadManager.__startUpdateTimer</h4>
255 <b>__updateActiveItemCount</b>(<i></i>) 286 <b>__startUpdateTimer</b>(<i></i>)
256 <p> 287 <p>
257 Private method to update the window title. 288 Private slot to start the update timer.
258 </p><a NAME="DownloadManager.__updateItemCount" ID="DownloadManager.__updateItemCount"></a> 289 </p><a NAME="DownloadManager.__stopUpdateTimer" ID="DownloadManager.__stopUpdateTimer"></a>
259 <h4>DownloadManager.__updateItemCount</h4> 290 <h4>DownloadManager.__stopUpdateTimer</h4>
260 <b>__updateItemCount</b>(<i></i>) 291 <b>__stopUpdateTimer</b>(<i></i>)
261 <p> 292 <p>
262 Private method to update the count label. 293 Private slot to stop the update timer.
263 </p><a NAME="DownloadManager.__updateRow" ID="DownloadManager.__updateRow"></a> 294 </p><a NAME="DownloadManager.__taskbarButton" ID="DownloadManager.__taskbarButton"></a>
295 <h4>DownloadManager.__taskbarButton</h4>
296 <b>__taskbarButton</b>(<i></i>)
297 <p>
298 Private method to get a reference to the task bar button (Windows
299 only).
300 </p><dl>
301 <dt>Returns:</dt>
302 <dd>
303 reference to the task bar button
304 </dd>
305 </dl><dl>
306 <dt>Return Type:</dt>
307 <dd>
308 QWinTaskbarButton or None
309 </dd>
310 </dl><a NAME="DownloadManager.__testWebBrowserView" ID="DownloadManager.__testWebBrowserView"></a>
311 <h4>DownloadManager.__testWebBrowserView</h4>
312 <b>__testWebBrowserView</b>(<i>view, url</i>)
313 <p>
314 Private method to test a web browser view against an URL.
315 </p><dl>
316 <dt><i>view</i> (WebBrowserView)</dt>
317 <dd>
318 reference to the web browser view to be tested
319 </dd><dt><i>url</i> (QUrl)</dt>
320 <dd>
321 URL to test against
322 </dd>
323 </dl><dl>
324 <dt>Returns:</dt>
325 <dd>
326 flag indicating, that the view is the one for the URL
327 </dd>
328 </dl><dl>
329 <dt>Return Type:</dt>
330 <dd>
331 bool
332 </dd>
333 </dl><a NAME="DownloadManager.__updateRow" ID="DownloadManager.__updateRow"></a>
264 <h4>DownloadManager.__updateRow</h4> 334 <h4>DownloadManager.__updateRow</h4>
265 <b>__updateRow</b>(<i>itm</i>) 335 <b>__updateRow</b>(<i>itm</i>)
266 <p> 336 <p>
267 Private slot to update a download item. 337 Private slot to update a download item.
268 </p><dl> 338 </p><dl>
358 </dd> 428 </dd>
359 </dl><a NAME="DownloadManager.on_cleanupButton_clicked" ID="DownloadManager.on_cleanupButton_clicked"></a> 429 </dl><a NAME="DownloadManager.on_cleanupButton_clicked" ID="DownloadManager.on_cleanupButton_clicked"></a>
360 <h4>DownloadManager.on_cleanupButton_clicked</h4> 430 <h4>DownloadManager.on_cleanupButton_clicked</h4>
361 <b>on_cleanupButton_clicked</b>(<i></i>) 431 <b>on_cleanupButton_clicked</b>(<i></i>)
362 <p> 432 <p>
363 Private slot cleanup the downloads. 433 Private slot to cleanup the downloads.
364 </p><a NAME="DownloadManager.removePolicy" ID="DownloadManager.removePolicy"></a> 434 </p><a NAME="DownloadManager.removePolicy" ID="DownloadManager.removePolicy"></a>
365 <h4>DownloadManager.removePolicy</h4> 435 <h4>DownloadManager.removePolicy</h4>
366 <b>removePolicy</b>(<i></i>) 436 <b>removePolicy</b>(<i></i>)
367 <p> 437 <p>
368 Public method to get the remove policy. 438 Public method to get the remove policy.
396 <dd> 466 <dd>
397 policy to be set 467 policy to be set
398 (DownloadManager.RemoveExit, DownloadManager.RemoveNever, 468 (DownloadManager.RemoveExit, DownloadManager.RemoveNever,
399 DownloadManager.RemoveSuccessFullDownload) 469 DownloadManager.RemoveSuccessFullDownload)
400 </dd> 470 </dd>
401 </dl><a NAME="DownloadManager.shutdown" ID="DownloadManager.shutdown"></a> 471 </dl><a NAME="DownloadManager.show" ID="DownloadManager.show"></a>
472 <h4>DownloadManager.show</h4>
473 <b>show</b>(<i></i>)
474 <p>
475 Public slot to show the download manager dialog.
476 </p><a NAME="DownloadManager.shutdown" ID="DownloadManager.shutdown"></a>
402 <h4>DownloadManager.shutdown</h4> 477 <h4>DownloadManager.shutdown</h4>
403 <b>shutdown</b>(<i></i>) 478 <b>shutdown</b>(<i></i>)
404 <p> 479 <p>
405 Public method to stop the download manager. 480 Public method to stop the download manager.
406 </p> 481 </p><a NAME="DownloadManager.timerEvent" ID="DownloadManager.timerEvent"></a>
482 <h4>DownloadManager.timerEvent</h4>
483 <b>timerEvent</b>(<i>evt</i>)
484 <p>
485 Protected event handler for timer events.
486 </p><dl>
487 <dt><i>evt</i> (QTimerEvent)</dt>
488 <dd>
489 reference to the timer event
490 </dd>
491 </dl>
407 <div align="right"><a href="#top">Up</a></div> 492 <div align="right"><a href="#top">Up</a></div>
408 <hr /> 493 <hr />
409 </body></html> 494 </body></html>

eric ide

mercurial