src/eric7/Documentation/Source/eric7.WebBrowser.Download.DownloadManager.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10436
f6881d10e995
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Download.DownloadManager</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.WebBrowser.Download.DownloadManager</h1>
10
11 <p>
12 Module implementing the download manager class.
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="#DownloadManager">DownloadManager</a></td>
25 <td>Class implementing the download manager.</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="DownloadManager" ID="DownloadManager"></a>
36 <h2>DownloadManager</h2>
37
38 <p>
39 Class implementing the download manager.
40 </p>
41 <h3>Signals</h3>
42 <dl>
43
44 <dt>downloadsCountChanged()</dt>
45 <dd>
46 emitted to indicate a change of the
47 count of download items
48 </dd>
49 </dl>
50 <h3>Derived from</h3>
51 QDialog, Ui_DownloadManager
52 <h3>Class Attributes</h3>
53
54 <table>
55 <tr><td>RemoveExit</td></tr><tr><td>RemoveNever</td></tr><tr><td>RemoveSuccessFullDownload</td></tr><tr><td>UpdateTimerTimeout</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Methods</h3>
63
64 <table>
65
66 <tr>
67 <td><a href="#DownloadManager.__init__">DownloadManager</a></td>
68 <td>Constructor</td>
69 </tr>
70 <tr>
71 <td><a href="#DownloadManager.__addItem">__addItem</a></td>
72 <td>Private method to add a download to the list of downloads.</td>
73 </tr>
74 <tr>
75 <td><a href="#DownloadManager.__closeDownloadTab">__closeDownloadTab</a></td>
76 <td>Private method to close an empty tab, that was opened only for loading the download URL.</td>
77 </tr>
78 <tr>
79 <td><a href="#DownloadManager.__contextMenuCancel">__contextMenuCancel</a></td>
80 <td>Private method to cancel the current download.</td>
81 </tr>
82 <tr>
83 <td><a href="#DownloadManager.__contextMenuCopyLink">__contextMenuCopyLink</a></td>
84 <td>Private method to copy the download link to the clipboard.</td>
85 </tr>
86 <tr>
87 <td><a href="#DownloadManager.__contextMenuGotoPage">__contextMenuGotoPage</a></td>
88 <td>Private method to open the download page.</td>
89 </tr>
90 <tr>
91 <td><a href="#DownloadManager.__contextMenuOpen">__contextMenuOpen</a></td>
92 <td>Private method to open the downloaded file.</td>
93 </tr>
94 <tr>
95 <td><a href="#DownloadManager.__contextMenuOpenFolder">__contextMenuOpenFolder</a></td>
96 <td>Private method to open the folder containing the downloaded file.</td>
97 </tr>
98 <tr>
99 <td><a href="#DownloadManager.__contextMenuRemoveSelected">__contextMenuRemoveSelected</a></td>
100 <td>Private method to remove the selected downloads from the list.</td>
101 </tr>
102 <tr>
103 <td><a href="#DownloadManager.__contextMenuSelectAll">__contextMenuSelectAll</a></td>
104 <td>Private method to select all downloads.</td>
105 </tr>
106 <tr>
107 <td><a href="#DownloadManager.__currentItem">__currentItem</a></td>
108 <td>Private method to get a reference to the current item.</td>
109 </tr>
110 <tr>
111 <td><a href="#DownloadManager.__customContextMenuRequested">__customContextMenuRequested</a></td>
112 <td>Private slot to handle the context menu request for the bookmarks tree.</td>
113 </tr>
114 <tr>
115 <td><a href="#DownloadManager.__finished">__finished</a></td>
116 <td>Private slot to handle a finished download.</td>
117 </tr>
118 <tr>
119 <td><a href="#DownloadManager.__load">__load</a></td>
120 <td>Private method to load the download settings.</td>
121 </tr>
122 <tr>
123 <td><a href="#DownloadManager.__startUpdateTimer">__startUpdateTimer</a></td>
124 <td>Private slot to start the update timer.</td>
125 </tr>
126 <tr>
127 <td><a href="#DownloadManager.__stopUpdateTimer">__stopUpdateTimer</a></td>
128 <td>Private slot to stop the update timer.</td>
129 </tr>
130 <tr>
131 <td><a href="#DownloadManager.__taskbarButton">__taskbarButton</a></td>
132 <td>Private method to get a reference to the task bar button (Windows only).</td>
133 </tr>
134 <tr>
135 <td><a href="#DownloadManager.__testWebBrowserView">__testWebBrowserView</a></td>
136 <td>Private method to test a web browser view against an URL.</td>
137 </tr>
138 <tr>
139 <td><a href="#DownloadManager.__updateRow">__updateRow</a></td>
140 <td>Private slot to update a download item.</td>
141 </tr>
142 <tr>
143 <td><a href="#DownloadManager.activeDownloadsCount">activeDownloadsCount</a></td>
144 <td>Public method to get the number of active downloads.</td>
145 </tr>
146 <tr>
147 <td><a href="#DownloadManager.allowQuit">allowQuit</a></td>
148 <td>Public method to check, if it is ok to quit.</td>
149 </tr>
150 <tr>
151 <td><a href="#DownloadManager.changeOccurred">changeOccurred</a></td>
152 <td>Public method to signal a change.</td>
153 </tr>
154 <tr>
155 <td><a href="#DownloadManager.cleanup">cleanup</a></td>
156 <td>Public slot to cleanup the downloads.</td>
157 </tr>
158 <tr>
159 <td><a href="#DownloadManager.closeEvent">closeEvent</a></td>
160 <td>Protected event handler for the close event.</td>
161 </tr>
162 <tr>
163 <td><a href="#DownloadManager.download">download</a></td>
164 <td>Public method to download a file.</td>
165 </tr>
166 <tr>
167 <td><a href="#DownloadManager.downloadDirectory">downloadDirectory</a></td>
168 <td>Public method to get the current download directory.</td>
169 </tr>
170 <tr>
171 <td><a href="#DownloadManager.downloads">downloads</a></td>
172 <td>Public method to get a reference to the downloads.</td>
173 </tr>
174 <tr>
175 <td><a href="#DownloadManager.downloadsCount">downloadsCount</a></td>
176 <td>Public method to get the number of downloads.</td>
177 </tr>
178 <tr>
179 <td><a href="#DownloadManager.on_cleanupButton_clicked">on_cleanupButton_clicked</a></td>
180 <td>Private slot to cleanup the downloads.</td>
181 </tr>
182 <tr>
183 <td><a href="#DownloadManager.removePolicy">removePolicy</a></td>
184 <td>Public method to get the remove policy.</td>
185 </tr>
186 <tr>
187 <td><a href="#DownloadManager.save">save</a></td>
188 <td>Public method to save the download settings.</td>
189 </tr>
190 <tr>
191 <td><a href="#DownloadManager.setDownloadDirectory">setDownloadDirectory</a></td>
192 <td>Public method to set the current download directory.</td>
193 </tr>
194 <tr>
195 <td><a href="#DownloadManager.setRemovePolicy">setRemovePolicy</a></td>
196 <td>Public method to set the remove policy.</td>
197 </tr>
198 <tr>
199 <td><a href="#DownloadManager.show">show</a></td>
200 <td>Public slot to show the download manager dialog.</td>
201 </tr>
202 <tr>
203 <td><a href="#DownloadManager.shutdown">shutdown</a></td>
204 <td>Public method to stop the download manager.</td>
205 </tr>
206 <tr>
207 <td><a href="#DownloadManager.timerEvent">timerEvent</a></td>
208 <td>Protected event handler for timer events.</td>
209 </tr>
210 </table>
211 <h3>Static Methods</h3>
212
213 <table>
214 <tr><td>None</td></tr>
215 </table>
216
217 <a NAME="DownloadManager.__init__" ID="DownloadManager.__init__"></a>
218 <h4>DownloadManager (Constructor)</h4>
219 <b>DownloadManager</b>(<i>parent=None</i>)
220
221 <p>
222 Constructor
223 </p>
224 <dl>
225
226 <dt><i>parent</i></dt>
227 <dd>
228 reference to the parent widget (QWidget)
229 </dd>
230 </dl>
231 <a NAME="DownloadManager.__addItem" ID="DownloadManager.__addItem"></a>
232 <h4>DownloadManager.__addItem</h4>
233 <b>__addItem</b>(<i>itm, append=False</i>)
234
235 <p>
236 Private method to add a download to the list of downloads.
237 </p>
238 <dl>
239
240 <dt><i>itm</i> (DownloadItem)</dt>
241 <dd>
242 reference to the download item
243 </dd>
244 <dt><i>append</i> (bool)</dt>
245 <dd>
246 flag indicating to append the item
247 </dd>
248 </dl>
249 <a NAME="DownloadManager.__closeDownloadTab" ID="DownloadManager.__closeDownloadTab"></a>
250 <h4>DownloadManager.__closeDownloadTab</h4>
251 <b>__closeDownloadTab</b>(<i>url</i>)
252
253 <p>
254 Private method to close an empty tab, that was opened only for loading
255 the download URL.
256 </p>
257 <dl>
258
259 <dt><i>url</i> (QUrl)</dt>
260 <dd>
261 download URL
262 </dd>
263 </dl>
264 <a NAME="DownloadManager.__contextMenuCancel" ID="DownloadManager.__contextMenuCancel"></a>
265 <h4>DownloadManager.__contextMenuCancel</h4>
266 <b>__contextMenuCancel</b>(<i></i>)
267
268 <p>
269 Private method to cancel the current download.
270 </p>
271 <a NAME="DownloadManager.__contextMenuCopyLink" ID="DownloadManager.__contextMenuCopyLink"></a>
272 <h4>DownloadManager.__contextMenuCopyLink</h4>
273 <b>__contextMenuCopyLink</b>(<i></i>)
274
275 <p>
276 Private method to copy the download link to the clipboard.
277 </p>
278 <a NAME="DownloadManager.__contextMenuGotoPage" ID="DownloadManager.__contextMenuGotoPage"></a>
279 <h4>DownloadManager.__contextMenuGotoPage</h4>
280 <b>__contextMenuGotoPage</b>(<i></i>)
281
282 <p>
283 Private method to open the download page.
284 </p>
285 <a NAME="DownloadManager.__contextMenuOpen" ID="DownloadManager.__contextMenuOpen"></a>
286 <h4>DownloadManager.__contextMenuOpen</h4>
287 <b>__contextMenuOpen</b>(<i></i>)
288
289 <p>
290 Private method to open the downloaded file.
291 </p>
292 <a NAME="DownloadManager.__contextMenuOpenFolder" ID="DownloadManager.__contextMenuOpenFolder"></a>
293 <h4>DownloadManager.__contextMenuOpenFolder</h4>
294 <b>__contextMenuOpenFolder</b>(<i></i>)
295
296 <p>
297 Private method to open the folder containing the downloaded file.
298 </p>
299 <a NAME="DownloadManager.__contextMenuRemoveSelected" ID="DownloadManager.__contextMenuRemoveSelected"></a>
300 <h4>DownloadManager.__contextMenuRemoveSelected</h4>
301 <b>__contextMenuRemoveSelected</b>(<i></i>)
302
303 <p>
304 Private method to remove the selected downloads from the list.
305 </p>
306 <a NAME="DownloadManager.__contextMenuSelectAll" ID="DownloadManager.__contextMenuSelectAll"></a>
307 <h4>DownloadManager.__contextMenuSelectAll</h4>
308 <b>__contextMenuSelectAll</b>(<i></i>)
309
310 <p>
311 Private method to select all downloads.
312 </p>
313 <a NAME="DownloadManager.__currentItem" ID="DownloadManager.__currentItem"></a>
314 <h4>DownloadManager.__currentItem</h4>
315 <b>__currentItem</b>(<i></i>)
316
317 <p>
318 Private method to get a reference to the current item.
319 </p>
320 <dl>
321 <dt>Return:</dt>
322 <dd>
323 reference to the current item (DownloadItem)
324 </dd>
325 </dl>
326 <a NAME="DownloadManager.__customContextMenuRequested" ID="DownloadManager.__customContextMenuRequested"></a>
327 <h4>DownloadManager.__customContextMenuRequested</h4>
328 <b>__customContextMenuRequested</b>(<i>pos</i>)
329
330 <p>
331 Private slot to handle the context menu request for the bookmarks tree.
332 </p>
333 <dl>
334
335 <dt><i>pos</i></dt>
336 <dd>
337 position the context menu was requested (QPoint)
338 </dd>
339 </dl>
340 <a NAME="DownloadManager.__finished" ID="DownloadManager.__finished"></a>
341 <h4>DownloadManager.__finished</h4>
342 <b>__finished</b>(<i>success</i>)
343
344 <p>
345 Private slot to handle a finished download.
346 </p>
347 <dl>
348
349 <dt><i>success</i> (bool)</dt>
350 <dd>
351 flag indicating a successful download
352 </dd>
353 </dl>
354 <a NAME="DownloadManager.__load" ID="DownloadManager.__load"></a>
355 <h4>DownloadManager.__load</h4>
356 <b>__load</b>(<i></i>)
357
358 <p>
359 Private method to load the download settings.
360 </p>
361 <a NAME="DownloadManager.__startUpdateTimer" ID="DownloadManager.__startUpdateTimer"></a>
362 <h4>DownloadManager.__startUpdateTimer</h4>
363 <b>__startUpdateTimer</b>(<i></i>)
364
365 <p>
366 Private slot to start the update timer.
367 </p>
368 <a NAME="DownloadManager.__stopUpdateTimer" ID="DownloadManager.__stopUpdateTimer"></a>
369 <h4>DownloadManager.__stopUpdateTimer</h4>
370 <b>__stopUpdateTimer</b>(<i></i>)
371
372 <p>
373 Private slot to stop the update timer.
374 </p>
375 <a NAME="DownloadManager.__taskbarButton" ID="DownloadManager.__taskbarButton"></a>
376 <h4>DownloadManager.__taskbarButton</h4>
377 <b>__taskbarButton</b>(<i></i>)
378
379 <p>
380 Private method to get a reference to the task bar button (Windows
381 only).
382 </p>
383 <dl>
384 <dt>Return:</dt>
385 <dd>
386 reference to the task bar button
387 </dd>
388 </dl>
389 <dl>
390 <dt>Return Type:</dt>
391 <dd>
392 QWinTaskbarButton or None
393 </dd>
394 </dl>
395 <a NAME="DownloadManager.__testWebBrowserView" ID="DownloadManager.__testWebBrowserView"></a>
396 <h4>DownloadManager.__testWebBrowserView</h4>
397 <b>__testWebBrowserView</b>(<i>view, url</i>)
398
399 <p>
400 Private method to test a web browser view against an URL.
401 </p>
402 <dl>
403
404 <dt><i>view</i> (WebBrowserView)</dt>
405 <dd>
406 reference to the web browser view to be tested
407 </dd>
408 <dt><i>url</i> (QUrl)</dt>
409 <dd>
410 URL to test against
411 </dd>
412 </dl>
413 <dl>
414 <dt>Return:</dt>
415 <dd>
416 flag indicating, that the view is the one for the URL
417 </dd>
418 </dl>
419 <dl>
420 <dt>Return Type:</dt>
421 <dd>
422 bool
423 </dd>
424 </dl>
425 <a NAME="DownloadManager.__updateRow" ID="DownloadManager.__updateRow"></a>
426 <h4>DownloadManager.__updateRow</h4>
427 <b>__updateRow</b>(<i>itm</i>)
428
429 <p>
430 Private slot to update a download item.
431 </p>
432 <dl>
433
434 <dt><i>itm</i> (DownloadItem)</dt>
435 <dd>
436 reference to the download item
437 </dd>
438 </dl>
439 <a NAME="DownloadManager.activeDownloadsCount" ID="DownloadManager.activeDownloadsCount"></a>
440 <h4>DownloadManager.activeDownloadsCount</h4>
441 <b>activeDownloadsCount</b>(<i></i>)
442
443 <p>
444 Public method to get the number of active downloads.
445 </p>
446 <dl>
447 <dt>Return:</dt>
448 <dd>
449 number of active downloads (integer)
450 </dd>
451 </dl>
452 <a NAME="DownloadManager.allowQuit" ID="DownloadManager.allowQuit"></a>
453 <h4>DownloadManager.allowQuit</h4>
454 <b>allowQuit</b>(<i></i>)
455
456 <p>
457 Public method to check, if it is ok to quit.
458 </p>
459 <dl>
460 <dt>Return:</dt>
461 <dd>
462 flag indicating allowance to quit (boolean)
463 </dd>
464 </dl>
465 <a NAME="DownloadManager.changeOccurred" ID="DownloadManager.changeOccurred"></a>
466 <h4>DownloadManager.changeOccurred</h4>
467 <b>changeOccurred</b>(<i></i>)
468
469 <p>
470 Public method to signal a change.
471 </p>
472 <a NAME="DownloadManager.cleanup" ID="DownloadManager.cleanup"></a>
473 <h4>DownloadManager.cleanup</h4>
474 <b>cleanup</b>(<i></i>)
475
476 <p>
477 Public slot to cleanup the downloads.
478 </p>
479 <a NAME="DownloadManager.closeEvent" ID="DownloadManager.closeEvent"></a>
480 <h4>DownloadManager.closeEvent</h4>
481 <b>closeEvent</b>(<i>evt</i>)
482
483 <p>
484 Protected event handler for the close event.
485 </p>
486 <dl>
487
488 <dt><i>evt</i> (QCloseEvent)</dt>
489 <dd>
490 reference to the close event
491 </dd>
492 </dl>
493 <a NAME="DownloadManager.download" ID="DownloadManager.download"></a>
494 <h4>DownloadManager.download</h4>
495 <b>download</b>(<i>downloadRequest</i>)
496
497 <p>
498 Public method to download a file.
499 </p>
500 <dl>
501
502 <dt><i>downloadRequest</i> (QWebEngineDownloadRequest)</dt>
503 <dd>
504 reference to the download object containing the
505 download data.
506 </dd>
507 </dl>
508 <a NAME="DownloadManager.downloadDirectory" ID="DownloadManager.downloadDirectory"></a>
509 <h4>DownloadManager.downloadDirectory</h4>
510 <b>downloadDirectory</b>(<i></i>)
511
512 <p>
513 Public method to get the current download directory.
514 </p>
515 <dl>
516 <dt>Return:</dt>
517 <dd>
518 current download directory (string)
519 </dd>
520 </dl>
521 <a NAME="DownloadManager.downloads" ID="DownloadManager.downloads"></a>
522 <h4>DownloadManager.downloads</h4>
523 <b>downloads</b>(<i></i>)
524
525 <p>
526 Public method to get a reference to the downloads.
527 </p>
528 <dl>
529 <dt>Return:</dt>
530 <dd>
531 reference to the downloads (list of DownloadItem)
532 </dd>
533 </dl>
534 <a NAME="DownloadManager.downloadsCount" ID="DownloadManager.downloadsCount"></a>
535 <h4>DownloadManager.downloadsCount</h4>
536 <b>downloadsCount</b>(<i></i>)
537
538 <p>
539 Public method to get the number of downloads.
540 </p>
541 <dl>
542 <dt>Return:</dt>
543 <dd>
544 number of downloads
545 </dd>
546 </dl>
547 <dl>
548 <dt>Return Type:</dt>
549 <dd>
550 int
551 </dd>
552 </dl>
553 <a NAME="DownloadManager.on_cleanupButton_clicked" ID="DownloadManager.on_cleanupButton_clicked"></a>
554 <h4>DownloadManager.on_cleanupButton_clicked</h4>
555 <b>on_cleanupButton_clicked</b>(<i></i>)
556
557 <p>
558 Private slot to cleanup the downloads.
559 </p>
560 <a NAME="DownloadManager.removePolicy" ID="DownloadManager.removePolicy"></a>
561 <h4>DownloadManager.removePolicy</h4>
562 <b>removePolicy</b>(<i></i>)
563
564 <p>
565 Public method to get the remove policy.
566 </p>
567 <dl>
568 <dt>Return:</dt>
569 <dd>
570 remove policy (integer)
571 </dd>
572 </dl>
573 <a NAME="DownloadManager.save" ID="DownloadManager.save"></a>
574 <h4>DownloadManager.save</h4>
575 <b>save</b>(<i></i>)
576
577 <p>
578 Public method to save the download settings.
579 </p>
580 <a NAME="DownloadManager.setDownloadDirectory" ID="DownloadManager.setDownloadDirectory"></a>
581 <h4>DownloadManager.setDownloadDirectory</h4>
582 <b>setDownloadDirectory</b>(<i>directory</i>)
583
584 <p>
585 Public method to set the current download directory.
586 </p>
587 <dl>
588
589 <dt><i>directory</i></dt>
590 <dd>
591 current download directory (string)
592 </dd>
593 </dl>
594 <a NAME="DownloadManager.setRemovePolicy" ID="DownloadManager.setRemovePolicy"></a>
595 <h4>DownloadManager.setRemovePolicy</h4>
596 <b>setRemovePolicy</b>(<i>policy</i>)
597
598 <p>
599 Public method to set the remove policy.
600 </p>
601 <dl>
602
603 <dt><i>policy</i></dt>
604 <dd>
605 policy to be set
606 (DownloadManager.RemoveExit, DownloadManager.RemoveNever,
607 DownloadManager.RemoveSuccessFullDownload)
608 </dd>
609 </dl>
610 <a NAME="DownloadManager.show" ID="DownloadManager.show"></a>
611 <h4>DownloadManager.show</h4>
612 <b>show</b>(<i></i>)
613
614 <p>
615 Public slot to show the download manager dialog.
616 </p>
617 <a NAME="DownloadManager.shutdown" ID="DownloadManager.shutdown"></a>
618 <h4>DownloadManager.shutdown</h4>
619 <b>shutdown</b>(<i></i>)
620
621 <p>
622 Public method to stop the download manager.
623 </p>
624 <a NAME="DownloadManager.timerEvent" ID="DownloadManager.timerEvent"></a>
625 <h4>DownloadManager.timerEvent</h4>
626 <b>timerEvent</b>(<i>evt</i>)
627
628 <p>
629 Protected event handler for timer events.
630 </p>
631 <dl>
632
633 <dt><i>evt</i> (QTimerEvent)</dt>
634 <dd>
635 reference to the timer event
636 </dd>
637 </dl>
638 <div align="right"><a href="#top">Up</a></div>
639 <hr />
640 </body></html>

eric ide

mercurial