--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Download.DownloadItem.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Download.DownloadItem.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.Download.DownloadItem</h1>
-
<p>
Module implementing a widget controlling a download.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DownloadItem">DownloadItem</a></td>
<td>Class implementing a widget controlling a download.</td>
@@ -29,19 +27,20 @@
<td>Class implementing the various download states.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="DownloadItem" ID="DownloadItem"></a>
<h2>DownloadItem</h2>
-
<p>
Class implementing a widget controlling a download.
</p>
+
<h3>Signals</h3>
<dl>
@@ -61,19 +60,17 @@
<h3>Derived from</h3>
QWidget, Ui_DownloadItem
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DownloadItem.__init__">DownloadItem</a></td>
<td>Constructor</td>
@@ -215,19 +212,20 @@
<td>Public method to update the buttons.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DownloadItem.__init__" ID="DownloadItem.__init__"></a>
<h4>DownloadItem (Constructor)</h4>
<b>DownloadItem</b>(<i>downloadRequest=None, pageUrl=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>downloadRequest</i> (QWebEngineDownloadRequest)</dt>
@@ -247,45 +245,45 @@
<a NAME="DownloadItem.__adjustSize" ID="DownloadItem.__adjustSize"></a>
<h4>DownloadItem.__adjustSize</h4>
<b>__adjustSize</b>(<i></i>)
-
<p>
Private method to adjust the size of the download item.
</p>
+
<a NAME="DownloadItem.__downloadProgress" ID="DownloadItem.__downloadProgress"></a>
<h4>DownloadItem.__downloadProgress</h4>
<b>__downloadProgress</b>(<i></i>)
-
<p>
Private slot to show the download progress.
</p>
+
<a NAME="DownloadItem.__finished" ID="DownloadItem.__finished"></a>
<h4>DownloadItem.__finished</h4>
<b>__finished</b>(<i></i>)
-
<p>
Private slot to handle the download finished.
</p>
+
<a NAME="DownloadItem.__getFileName" ID="DownloadItem.__getFileName"></a>
<h4>DownloadItem.__getFileName</h4>
<b>__getFileName</b>(<i></i>)
-
<p>
Private method to get the file name to save to from the user.
</p>
+
<a NAME="DownloadItem.__initialize" ID="DownloadItem.__initialize"></a>
<h4>DownloadItem.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private method to initialize the widget.
</p>
+
<a NAME="DownloadItem.__saveFileName" ID="DownloadItem.__saveFileName"></a>
<h4>DownloadItem.__saveFileName</h4>
<b>__saveFileName</b>(<i>directory</i>)
-
<p>
Private method to calculate a name for the file to download.
</p>
+
<dl>
<dt><i>directory</i> (str)</dt>
@@ -308,10 +306,10 @@
<a NAME="DownloadItem.__setDateTime" ID="DownloadItem.__setDateTime"></a>
<h4>DownloadItem.__setDateTime</h4>
<b>__setDateTime</b>(<i>dateTime=None</i>)
-
<p>
Private method to set the download date and time.
</p>
+
<dl>
<dt><i>dateTime</i> (QDateTime)</dt>
@@ -322,17 +320,17 @@
<a NAME="DownloadItem.__setFileLabels" ID="DownloadItem.__setFileLabels"></a>
<h4>DownloadItem.__setFileLabels</h4>
<b>__setFileLabels</b>(<i></i>)
-
<p>
Private slot to set and format the info label.
</p>
+
<a NAME="DownloadItem.__setFileName" ID="DownloadItem.__setFileName"></a>
<h4>DownloadItem.__setFileName</h4>
<b>__setFileName</b>(<i>fileName</i>)
-
<p>
Private method to set the file name to save the download into.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -343,17 +341,17 @@
<a NAME="DownloadItem.__updateInfoLabel" ID="DownloadItem.__updateInfoLabel"></a>
<h4>DownloadItem.__updateInfoLabel</h4>
<b>__updateInfoLabel</b>(<i></i>)
-
<p>
Private method to update the info label.
</p>
+
<a NAME="DownloadItem.absoluteFilePath" ID="DownloadItem.absoluteFilePath"></a>
<h4>DownloadItem.absoluteFilePath</h4>
<b>absoluteFilePath</b>(<i></i>)
-
<p>
Public method to get the absolute path of the output file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -369,10 +367,10 @@
<a NAME="DownloadItem.bytesReceived" ID="DownloadItem.bytesReceived"></a>
<h4>DownloadItem.bytesReceived</h4>
<b>bytesReceived</b>(<i></i>)
-
<p>
Public method to get the number of bytes received.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -388,10 +386,10 @@
<a NAME="DownloadItem.bytesTotal" ID="DownloadItem.bytesTotal"></a>
<h4>DownloadItem.bytesTotal</h4>
<b>bytesTotal</b>(<i></i>)
-
<p>
Public method to get the total number of bytes of the download.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -407,17 +405,17 @@
<a NAME="DownloadItem.cancelDownload" ID="DownloadItem.cancelDownload"></a>
<h4>DownloadItem.cancelDownload</h4>
<b>cancelDownload</b>(<i></i>)
-
<p>
Public slot to stop the download.
</p>
+
<a NAME="DownloadItem.canceledFileSelect" ID="DownloadItem.canceledFileSelect"></a>
<h4>DownloadItem.canceledFileSelect</h4>
<b>canceledFileSelect</b>(<i></i>)
-
<p>
Public method to check, if the user canceled the file selection.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -433,10 +431,10 @@
<a NAME="DownloadItem.currentSpeed" ID="DownloadItem.currentSpeed"></a>
<h4>DownloadItem.currentSpeed</h4>
<b>currentSpeed</b>(<i></i>)
-
<p>
Public method to get an estimation for the download speed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -452,10 +450,10 @@
<a NAME="DownloadItem.downloadCanceled" ID="DownloadItem.downloadCanceled"></a>
<h4>DownloadItem.downloadCanceled</h4>
<b>downloadCanceled</b>(<i></i>)
-
<p>
Public method to check, if the download was cancelled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -471,10 +469,10 @@
<a NAME="DownloadItem.downloadProgress" ID="DownloadItem.downloadProgress"></a>
<h4>DownloadItem.downloadProgress</h4>
<b>downloadProgress</b>(<i></i>)
-
<p>
Public method to get the download progress.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -490,10 +488,10 @@
<a NAME="DownloadItem.downloadedSuccessfully" ID="DownloadItem.downloadedSuccessfully"></a>
<h4>DownloadItem.downloadedSuccessfully</h4>
<b>downloadedSuccessfully</b>(<i></i>)
-
<p>
Public method to check for a successful download.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -509,10 +507,10 @@
<a NAME="DownloadItem.downloading" ID="DownloadItem.downloading"></a>
<h4>DownloadItem.downloading</h4>
<b>downloading</b>(<i></i>)
-
<p>
Public method to determine, if a download is in progress.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -528,10 +526,10 @@
<a NAME="DownloadItem.exists" ID="DownloadItem.exists"></a>
<h4>DownloadItem.exists</h4>
<b>exists</b>(<i></i>)
-
<p>
Public method to check, if the downloaded file exists.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -547,10 +545,10 @@
<a NAME="DownloadItem.fileName" ID="DownloadItem.fileName"></a>
<h4>DownloadItem.fileName</h4>
<b>fileName</b>(<i></i>)
-
<p>
Public method to get the name of the output file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -566,10 +564,10 @@
<a NAME="DownloadItem.getData" ID="DownloadItem.getData"></a>
<h4>DownloadItem.getData</h4>
<b>getData</b>(<i></i>)
-
<p>
Public method to get the relevant download data.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -588,10 +586,10 @@
<a NAME="DownloadItem.getInfoData" ID="DownloadItem.getInfoData"></a>
<h4>DownloadItem.getInfoData</h4>
<b>getInfoData</b>(<i></i>)
-
<p>
Public method to get the text of the info label.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -607,10 +605,10 @@
<a NAME="DownloadItem.getPageUrl" ID="DownloadItem.getPageUrl"></a>
<h4>DownloadItem.getPageUrl</h4>
<b>getPageUrl</b>(<i></i>)
-
<p>
Public method to get the URL of the download page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -626,17 +624,17 @@
<a NAME="DownloadItem.on_openButton_clicked" ID="DownloadItem.on_openButton_clicked"></a>
<h4>DownloadItem.on_openButton_clicked</h4>
<b>on_openButton_clicked</b>(<i></i>)
-
<p>
Private slot to open the downloaded file.
</p>
+
<a NAME="DownloadItem.on_pauseButton_clicked" ID="DownloadItem.on_pauseButton_clicked"></a>
<h4>DownloadItem.on_pauseButton_clicked</h4>
<b>on_pauseButton_clicked</b>(<i>checked</i>)
-
<p>
Private slot to pause the download.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -647,31 +645,31 @@
<a NAME="DownloadItem.on_stopButton_clicked" ID="DownloadItem.on_stopButton_clicked"></a>
<h4>DownloadItem.on_stopButton_clicked</h4>
<b>on_stopButton_clicked</b>(<i></i>)
-
<p>
Private slot to stop the download.
</p>
+
<a NAME="DownloadItem.openFile" ID="DownloadItem.openFile"></a>
<h4>DownloadItem.openFile</h4>
<b>openFile</b>(<i></i>)
-
<p>
Public slot to open the downloaded file.
</p>
+
<a NAME="DownloadItem.openFolder" ID="DownloadItem.openFolder"></a>
<h4>DownloadItem.openFolder</h4>
<b>openFolder</b>(<i></i>)
-
<p>
Public slot to open the folder containing the downloaded file.
</p>
+
<a NAME="DownloadItem.remainingTime" ID="DownloadItem.remainingTime"></a>
<h4>DownloadItem.remainingTime</h4>
<b>remainingTime</b>(<i></i>)
-
<p>
Public method to get an estimation for the remaining time.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -687,10 +685,10 @@
<a NAME="DownloadItem.setData" ID="DownloadItem.setData"></a>
<h4>DownloadItem.setData</h4>
<b>setData</b>(<i>data</i>)
-
<p>
Public method to set the relevant download data.
</p>
+
<dl>
<dt><i>data</i> (dict of {"URL": QUrl, "Location": str, "Done": bool,)</dt>
@@ -704,10 +702,10 @@
<a NAME="DownloadItem.setIcon" ID="DownloadItem.setIcon"></a>
<h4>DownloadItem.setIcon</h4>
<b>setIcon</b>(<i>icon</i>)
-
<p>
Public method to set the download icon.
</p>
+
<dl>
<dt><i>icon</i> (QIcon)</dt>
@@ -718,42 +716,44 @@
<a NAME="DownloadItem.updateButtonsAndLabels" ID="DownloadItem.updateButtonsAndLabels"></a>
<h4>DownloadItem.updateButtonsAndLabels</h4>
<b>updateButtonsAndLabels</b>(<i></i>)
-
<p>
Public method to update the buttons.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="DownloadState" ID="DownloadState"></a>
<h2>DownloadState</h2>
-
<p>
Class implementing the various download states.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>Cancelled</td></tr><tr><td>Downloading</td></tr><tr><td>Successful</td></tr>
+<tr><td>Cancelled</td></tr>
+<tr><td>Downloading</td></tr>
+<tr><td>Successful</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
