--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Download.DownloadUtilities.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,129 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.Download.DownloadUtilities</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.WebBrowser.Download.DownloadUtilities</h1> + +<p> +Module implementing some utility functions for the Download package. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#dataString">dataString</a></td> +<td>Module function to generate a formatted size string.</td> +</tr> +<tr> +<td><a href="#speedString">speedString</a></td> +<td>Module function to generate a formatted speed string.</td> +</tr> +<tr> +<td><a href="#timeString">timeString</a></td> +<td>Module function to format the given time.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="dataString" ID="dataString"></a> +<h2>dataString</h2> +<b>dataString</b>(<i>size</i>) + +<p> + Module function to generate a formatted size string. +</p> +<dl> + +<dt><i>size</i> (int)</dt> +<dd> +size to be formatted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +formatted data string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="speedString" ID="speedString"></a> +<h2>speedString</h2> +<b>speedString</b>(<i>speed</i>) + +<p> + Module function to generate a formatted speed string. +</p> +<dl> + +<dt><i>speed</i> (float)</dt> +<dd> +speed to be formatted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +formatted speed string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="timeString" ID="timeString"></a> +<h2>timeString</h2> +<b>timeString</b>(<i>timeRemaining</i>) + +<p> + Module function to format the given time. +</p> +<dl> + +<dt><i>timeRemaining</i> (float)</dt> +<dd> +time to be formatted +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +time string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file