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

changeset 6225
56b6f18abc21
parent 6153
0b18c86c03a1
--- a/Documentation/Source/eric6.WebBrowser.Download.DownloadManager.html	Sun Apr 08 17:34:59 2018 +0200
+++ b/Documentation/Source/eric6.WebBrowser.Download.DownloadManager.html	Sun Apr 08 17:36:43 2018 +0200
@@ -55,7 +55,7 @@
 QDialog, Ui_DownloadManager
 <h3>Class Attributes</h3>
 <table>
-<tr><td>RemoveExit</td></tr><tr><td>RemoveNever</td></tr><tr><td>RemoveSuccessFullDownload</td></tr>
+<tr><td>RemoveExit</td></tr><tr><td>RemoveNever</td></tr><tr><td>RemoveSuccessFullDownload</td></tr><tr><td>UpdateTimerTimeout</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -70,6 +70,9 @@
 <td><a href="#DownloadManager.__addItem">__addItem</a></td>
 <td>Private method to add a download to the list of downloads.</td>
 </tr><tr>
+<td><a href="#DownloadManager.__closeDownloadTab">__closeDownloadTab</a></td>
+<td>Private method to close an empty tab, that was opened only for loading the download URL.</td>
+</tr><tr>
 <td><a href="#DownloadManager.__contextMenuCancel">__contextMenuCancel</a></td>
 <td>Private method to cancel the current download.</td>
 </tr><tr>
@@ -103,11 +106,17 @@
 <td><a href="#DownloadManager.__load">__load</a></td>
 <td>Private method to load the download settings.</td>
 </tr><tr>
-<td><a href="#DownloadManager.__updateActiveItemCount">__updateActiveItemCount</a></td>
-<td>Private method to update the window title.</td>
+<td><a href="#DownloadManager.__startUpdateTimer">__startUpdateTimer</a></td>
+<td>Private slot to start the update timer.</td>
+</tr><tr>
+<td><a href="#DownloadManager.__stopUpdateTimer">__stopUpdateTimer</a></td>
+<td>Private slot to stop the update timer.</td>
 </tr><tr>
-<td><a href="#DownloadManager.__updateItemCount">__updateItemCount</a></td>
-<td>Private method to update the count label.</td>
+<td><a href="#DownloadManager.__taskbarButton">__taskbarButton</a></td>
+<td>Private method to get a reference to the task bar button (Windows only).</td>
+</tr><tr>
+<td><a href="#DownloadManager.__testWebBrowserView">__testWebBrowserView</a></td>
+<td>Private method to test a web browser view against an URL.</td>
 </tr><tr>
 <td><a href="#DownloadManager.__updateRow">__updateRow</a></td>
 <td>Private slot to update a download item.</td>
@@ -140,7 +149,7 @@
 <td>Public method to get the number of downloads.</td>
 </tr><tr>
 <td><a href="#DownloadManager.on_cleanupButton_clicked">on_cleanupButton_clicked</a></td>
-<td>Private slot cleanup the downloads.</td>
+<td>Private slot to cleanup the downloads.</td>
 </tr><tr>
 <td><a href="#DownloadManager.removePolicy">removePolicy</a></td>
 <td>Public method to get the remove policy.</td>
@@ -154,8 +163,14 @@
 <td><a href="#DownloadManager.setRemovePolicy">setRemovePolicy</a></td>
 <td>Public method to set the remove policy.</td>
 </tr><tr>
+<td><a href="#DownloadManager.show">show</a></td>
+<td>Public slot to show the download manager dialog.</td>
+</tr><tr>
 <td><a href="#DownloadManager.shutdown">shutdown</a></td>
 <td>Public method to stop the download manager.</td>
+</tr><tr>
+<td><a href="#DownloadManager.timerEvent">timerEvent</a></td>
+<td>Protected event handler for timer events.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -185,6 +200,17 @@
 <dd>
 flag indicating to append the item
 </dd>
+</dl><a NAME="DownloadManager.__closeDownloadTab" ID="DownloadManager.__closeDownloadTab"></a>
+<h4>DownloadManager.__closeDownloadTab</h4>
+<b>__closeDownloadTab</b>(<i>url</i>)
+<p>
+        Private method to close an empty tab, that was opened only for loading
+        the download URL.
+</p><dl>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+download URL
+</dd>
 </dl><a NAME="DownloadManager.__contextMenuCancel" ID="DownloadManager.__contextMenuCancel"></a>
 <h4>DownloadManager.__contextMenuCancel</h4>
 <b>__contextMenuCancel</b>(<i></i>)
@@ -242,25 +268,69 @@
 </dd>
 </dl><a NAME="DownloadManager.__finished" ID="DownloadManager.__finished"></a>
 <h4>DownloadManager.__finished</h4>
-<b>__finished</b>(<i></i>)
+<b>__finished</b>(<i>success</i>)
 <p>
         Private slot to handle a finished download.
-</p><a NAME="DownloadManager.__load" ID="DownloadManager.__load"></a>
+</p><dl>
+<dt><i>success</i> (bool)</dt>
+<dd>
+flag indicating a successful download
+</dd>
+</dl><a NAME="DownloadManager.__load" ID="DownloadManager.__load"></a>
 <h4>DownloadManager.__load</h4>
 <b>__load</b>(<i></i>)
 <p>
         Private method to load the download settings.
-</p><a NAME="DownloadManager.__updateActiveItemCount" ID="DownloadManager.__updateActiveItemCount"></a>
-<h4>DownloadManager.__updateActiveItemCount</h4>
-<b>__updateActiveItemCount</b>(<i></i>)
+</p><a NAME="DownloadManager.__startUpdateTimer" ID="DownloadManager.__startUpdateTimer"></a>
+<h4>DownloadManager.__startUpdateTimer</h4>
+<b>__startUpdateTimer</b>(<i></i>)
+<p>
+        Private slot to start the update timer.
+</p><a NAME="DownloadManager.__stopUpdateTimer" ID="DownloadManager.__stopUpdateTimer"></a>
+<h4>DownloadManager.__stopUpdateTimer</h4>
+<b>__stopUpdateTimer</b>(<i></i>)
+<p>
+        Private slot to stop the update timer.
+</p><a NAME="DownloadManager.__taskbarButton" ID="DownloadManager.__taskbarButton"></a>
+<h4>DownloadManager.__taskbarButton</h4>
+<b>__taskbarButton</b>(<i></i>)
 <p>
-        Private method to update the window title.
-</p><a NAME="DownloadManager.__updateItemCount" ID="DownloadManager.__updateItemCount"></a>
-<h4>DownloadManager.__updateItemCount</h4>
-<b>__updateItemCount</b>(<i></i>)
+        Private method to get a reference to the task bar button (Windows
+        only).
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the task bar button
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QWinTaskbarButton or None
+</dd>
+</dl><a NAME="DownloadManager.__testWebBrowserView" ID="DownloadManager.__testWebBrowserView"></a>
+<h4>DownloadManager.__testWebBrowserView</h4>
+<b>__testWebBrowserView</b>(<i>view, url</i>)
 <p>
-        Private method to update the count label.
-</p><a NAME="DownloadManager.__updateRow" ID="DownloadManager.__updateRow"></a>
+        Private method to test a web browser view against an URL.
+</p><dl>
+<dt><i>view</i> (WebBrowserView)</dt>
+<dd>
+reference to the web browser view to be tested
+</dd><dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to test against
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating, that the view is the one for the URL
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="DownloadManager.__updateRow" ID="DownloadManager.__updateRow"></a>
 <h4>DownloadManager.__updateRow</h4>
 <b>__updateRow</b>(<i>itm</i>)
 <p>
@@ -360,7 +430,7 @@
 <h4>DownloadManager.on_cleanupButton_clicked</h4>
 <b>on_cleanupButton_clicked</b>(<i></i>)
 <p>
-        Private slot cleanup the downloads.
+        Private slot to cleanup the downloads.
 </p><a NAME="DownloadManager.removePolicy" ID="DownloadManager.removePolicy"></a>
 <h4>DownloadManager.removePolicy</h4>
 <b>removePolicy</b>(<i></i>)
@@ -398,12 +468,27 @@
             (DownloadManager.RemoveExit, DownloadManager.RemoveNever,
              DownloadManager.RemoveSuccessFullDownload)
 </dd>
-</dl><a NAME="DownloadManager.shutdown" ID="DownloadManager.shutdown"></a>
+</dl><a NAME="DownloadManager.show" ID="DownloadManager.show"></a>
+<h4>DownloadManager.show</h4>
+<b>show</b>(<i></i>)
+<p>
+        Public slot to show the download manager dialog.
+</p><a NAME="DownloadManager.shutdown" ID="DownloadManager.shutdown"></a>
 <h4>DownloadManager.shutdown</h4>
 <b>shutdown</b>(<i></i>)
 <p>
         Public method to stop the download manager.
-</p>
+</p><a NAME="DownloadManager.timerEvent" ID="DownloadManager.timerEvent"></a>
+<h4>DownloadManager.timerEvent</h4>
+<b>timerEvent</b>(<i>evt</i>)
+<p>
+        Protected event handler for timer events.
+</p><dl>
+<dt><i>evt</i> (QTimerEvent)</dt>
+<dd>
+reference to the timer event
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial