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

<!DOCTYPE html>
<html><head>
<title>eric6.WebBrowser.Download.DownloadUtilities</title>
<meta charset="UTF-8">
<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>eric6.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>Returns:</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>Returns:</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>Returns:</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>