diff -r fdd568d3533d -r b0061a6f7484 Documentation/Source/eric5.Helpviewer.Download.DownloadItem.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.Download.DownloadItem.html Sun Oct 10 21:12:43 2010 +0200
@@ -0,0 +1,382 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.Download.DownloadItem</title>
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.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>
+</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>Derived from</h3>
+QWidget, Ui_DownloadItem
+<h3>Class Attributes</h3>
+<table>
+<tr><td>progress</td></tr><tr><td>statusChanged</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#DownloadItem.__init__">DownloadItem</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#DownloadItem.__downloadProgress">__downloadProgress</a></td>
+<td>Private method to show the download progress.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__finished">__finished</a></td>
+<td>Private slot to handle the download finished.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__getFileName">__getFileName</a></td>
+<td>Private method to get the filename to save to from the user.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__initialize">__initialize</a></td>
+<td>Private method to (re)initialize the widget.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__metaDataChanged">__metaDataChanged</a></td>
+<td>Private slot to handle a change of the meta data.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__networkError">__networkError</a></td>
+<td>Private slot to handle a network error.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__readyRead">__readyRead</a></td>
+<td>Private slot to read the available data.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__saveFileName">__saveFileName</a></td>
+<td>Private method to calculate a name for the file to download.</td>
+</tr><tr>
+<td><a href="#DownloadItem.__updateInfoLabel">__updateInfoLabel</a></td>
+<td>Private method to update the info label.</td>
+</tr><tr>
+<td><a href="#DownloadItem.absoluteFilePath">absoluteFilePath</a></td>
+<td>Public method to get the absolute path of the output file.</td>
+</tr><tr>
+<td><a href="#DownloadItem.bytesReceived">bytesReceived</a></td>
+<td>Public method to get the number of bytes received.</td>
+</tr><tr>
+<td><a href="#DownloadItem.bytesTotal">bytesTotal</a></td>
+<td>Public method to get the total number of bytes of the download.</td>
+</tr><tr>
+<td><a href="#DownloadItem.canceledFileSelect">canceledFileSelect</a></td>
+<td>Public method to check, if the user canceled the file selection.</td>
+</tr><tr>
+<td><a href="#DownloadItem.currentSpeed">currentSpeed</a></td>
+<td>Public method to get an estimation for the download speed.</td>
+</tr><tr>
+<td><a href="#DownloadItem.downloadedSuccessfully">downloadedSuccessfully</a></td>
+<td>Public method to check for a successful download.</td>
+</tr><tr>
+<td><a href="#DownloadItem.downloading">downloading</a></td>
+<td>Public method to determine, if a download is in progress.</td>
+</tr><tr>
+<td><a href="#DownloadItem.fileName">fileName</a></td>
+<td>Public method to get the name of the output file.</td>
+</tr><tr>
+<td><a href="#DownloadItem.getData">getData</a></td>
+<td>Public method to get the relevant download data.</td>
+</tr><tr>
+<td><a href="#DownloadItem.getInfoData">getInfoData</a></td>
+<td>Public method to get the text of the info label.</td>
+</tr><tr>
+<td><a href="#DownloadItem.on_openButton_clicked">on_openButton_clicked</a></td>
+<td>Private slot to open the downloaded file.</td>
+</tr><tr>
+<td><a href="#DownloadItem.on_stopButton_clicked">on_stopButton_clicked</a></td>
+<td>Private slot to stop the download.</td>
+</tr><tr>
+<td><a href="#DownloadItem.on_tryAgainButton_clicked">on_tryAgainButton_clicked</a></td>
+<td>Private slot to retry the download.</td>
+</tr><tr>
+<td><a href="#DownloadItem.remainingTime">remainingTime</a></td>
+<td>Public method to get an estimation for the remaining time.</td>
+</tr><tr>
+<td><a href="#DownloadItem.setData">setData</a></td>
+<td>Public method to set the relevant download data.</td>
+</tr><tr>
+<td><a href="#DownloadItem.setIcon">setIcon</a></td>
+<td>Public method to set the download icon.</td>
+</tr>
+</table>
+<a NAME="DownloadItem.__init__" ID="DownloadItem.__init__"></a>
+<h4>DownloadItem (Constructor)</h4>
+<b>DownloadItem</b>(<i>reply = None, requestFilename = False, webPage = None, download = False, parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>reply</i></dt>
+<dd>
+reference to the network reply object (QNetworkReply)
+</dd><dt><i>requestFilename</i></dt>
+<dd>
+flag indicating to ask the user for a filename (boolean)
+</dd><dt><i>webPage</i></dt>
+<dd>
+reference to the web page object the download originated
+ from (QWebPage)
+</dd><dt><i>download</i></dt>
+<dd>
+flag indicating a download operation (boolean)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="DownloadItem.__downloadProgress" ID="DownloadItem.__downloadProgress"></a>
+<h4>DownloadItem.__downloadProgress</h4>
+<b>__downloadProgress</b>(<i>bytesReceived, bytesTotal</i>)
+<p>
+ Private method to show the download progress.
+</p><dl>
+<dt><i>bytesReceived</i></dt>
+<dd>
+number of bytes received (integer)
+</dd><dt><i>bytesTotal</i></dt>
+<dd>
+number of total bytes (integer)
+</dd>
+</dl><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 filename to save to from the user.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl><a NAME="DownloadItem.__initialize" ID="DownloadItem.__initialize"></a>
+<h4>DownloadItem.__initialize</h4>
+<b>__initialize</b>(<i>tryAgain = False</i>)
+<p>
+ Private method to (re)initialize the widget.
+</p><dl>
+<dt><i>tryAgain</i></dt>
+<dd>
+flag indicating a retry (boolean)
+</dd>
+</dl><a NAME="DownloadItem.__metaDataChanged" ID="DownloadItem.__metaDataChanged"></a>
+<h4>DownloadItem.__metaDataChanged</h4>
+<b>__metaDataChanged</b>(<i></i>)
+<p>
+ Private slot to handle a change of the meta data.
+</p><a NAME="DownloadItem.__networkError" ID="DownloadItem.__networkError"></a>
+<h4>DownloadItem.__networkError</h4>
+<b>__networkError</b>(<i></i>)
+<p>
+ Private slot to handle a network error.
+</p><a NAME="DownloadItem.__readyRead" ID="DownloadItem.__readyRead"></a>
+<h4>DownloadItem.__readyRead</h4>
+<b>__readyRead</b>(<i></i>)
+<p>
+ Private slot to read the available data.
+</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></dt>
+<dd>
+name of the directory to store the file into (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+proposed filename (string)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+absolute path of the output file (string)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+number of bytes received (integer)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+total number of bytes (integer)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+flag indicating cancellation (boolean)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+estimation for the download speed (float)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+flag indicating a successful download (boolean)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+flag indicating a download is in progress (boolean)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+name of the output file (string)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+tuple of URL, save location and done flag
+ (QUrl, string, boolean)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+text of the info label (string)
+</dd>
+</dl><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_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.on_tryAgainButton_clicked" ID="DownloadItem.on_tryAgainButton_clicked"></a>
+<h4>DownloadItem.on_tryAgainButton_clicked</h4>
+<b>on_tryAgainButton_clicked</b>(<i></i>)
+<p>
+ Private slot to retry the download.
+</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>Returns:</dt>
+<dd>
+estimation for the remaining time (float)
+</dd>
+</dl><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></dt>
+<dd>
+tuple of URL, save location and done flag
+ (QUrl, string, boolean)
+</dd>
+</dl><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></dt>
+<dd>
+reference to the icon to be set (QIcon)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
