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

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

eric ide

mercurial