src/eric7/Documentation/Source/eric7.WebBrowser.Download.DownloadUtilities.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Download.DownloadUtilities</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Download.DownloadUtilities</h1>
10
11 <p>
12 Module implementing some utility functions for the Download package.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#dataString">dataString</a></td>
30 <td>Module function to generate a formatted size string.</td>
31 </tr>
32 <tr>
33 <td><a href="#speedString">speedString</a></td>
34 <td>Module function to generate a formatted speed string.</td>
35 </tr>
36 <tr>
37 <td><a href="#timeString">timeString</a></td>
38 <td>Module function to format the given time.</td>
39 </tr>
40 </table>
41 <hr />
42 <hr />
43 <a NAME="dataString" ID="dataString"></a>
44 <h2>dataString</h2>
45 <b>dataString</b>(<i>size</i>)
46
47 <p>
48 Module function to generate a formatted size string.
49 </p>
50 <dl>
51
52 <dt><i>size</i> (int)</dt>
53 <dd>
54 size to be formatted
55 </dd>
56 </dl>
57 <dl>
58 <dt>Return:</dt>
59 <dd>
60 formatted data string
61 </dd>
62 </dl>
63 <dl>
64 <dt>Return Type:</dt>
65 <dd>
66 str
67 </dd>
68 </dl>
69 <div align="right"><a href="#top">Up</a></div>
70 <hr />
71 <hr />
72 <a NAME="speedString" ID="speedString"></a>
73 <h2>speedString</h2>
74 <b>speedString</b>(<i>speed</i>)
75
76 <p>
77 Module function to generate a formatted speed string.
78 </p>
79 <dl>
80
81 <dt><i>speed</i> (float)</dt>
82 <dd>
83 speed to be formatted
84 </dd>
85 </dl>
86 <dl>
87 <dt>Return:</dt>
88 <dd>
89 formatted speed string
90 </dd>
91 </dl>
92 <dl>
93 <dt>Return Type:</dt>
94 <dd>
95 str
96 </dd>
97 </dl>
98 <div align="right"><a href="#top">Up</a></div>
99 <hr />
100 <hr />
101 <a NAME="timeString" ID="timeString"></a>
102 <h2>timeString</h2>
103 <b>timeString</b>(<i>timeRemaining</i>)
104
105 <p>
106 Module function to format the given time.
107 </p>
108 <dl>
109
110 <dt><i>timeRemaining</i> (float)</dt>
111 <dd>
112 time to be formatted
113 </dd>
114 </dl>
115 <dl>
116 <dt>Return:</dt>
117 <dd>
118 time string
119 </dd>
120 </dl>
121 <dl>
122 <dt>Return Type:</dt>
123 <dd>
124 str
125 </dd>
126 </dl>
127 <div align="right"><a href="#top">Up</a></div>
128 <hr />
129 </body></html>

eric ide

mercurial