Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.DownloadDialog.html

Documentation/Source/eric5.Helpviewer.DownloadDialog.html

changeset 668
b0061a6f7484
parent 666
fdd568d3533d
child 669
d405dc3e2ed6
equal deleted inserted replaced
666:fdd568d3533d 668:b0061a6f7484
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.DownloadDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.DownloadDialog</h1>
24 <p>
25 Module implementing the download dialog.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#DownloadDialog">DownloadDialog</a></td>
35 <td>Class implementing the download dialog.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="DownloadDialog" ID="DownloadDialog"></a>
44 <h2>DownloadDialog</h2>
45 <p>
46 Class implementing the download dialog.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>done()</dt>
50 <dd>
51 emitted just before the dialog is closed
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QWidget, Ui_DownloadDialog
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>done</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#DownloadDialog.__init__">DownloadDialog</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#DownloadDialog.__dataString">__dataString</a></td>
67 <td>Private method to generate a formatted data string.</td>
68 </tr><tr>
69 <td><a href="#DownloadDialog.__downloadProgress">__downloadProgress</a></td>
70 <td>Private method show the download progress.</td>
71 </tr><tr>
72 <td><a href="#DownloadDialog.__downloading">__downloading</a></td>
73 <td>Private method to determine, if a download is in progress.</td>
74 </tr><tr>
75 <td><a href="#DownloadDialog.__finished">__finished</a></td>
76 <td>Private slot to handle the download finished.</td>
77 </tr><tr>
78 <td><a href="#DownloadDialog.__getFileName">__getFileName</a></td>
79 <td>Private method to get the filename to save to from the user.</td>
80 </tr><tr>
81 <td><a href="#DownloadDialog.__metaDataChanged">__metaDataChanged</a></td>
82 <td>Private slot to handle a change of the meta data.</td>
83 </tr><tr>
84 <td><a href="#DownloadDialog.__networkError">__networkError</a></td>
85 <td>Private slot to handle a network error.</td>
86 </tr><tr>
87 <td><a href="#DownloadDialog.__open">__open</a></td>
88 <td>Private slot to open the downloaded file.</td>
89 </tr><tr>
90 <td><a href="#DownloadDialog.__readyRead">__readyRead</a></td>
91 <td>Private slot to read the available data.</td>
92 </tr><tr>
93 <td><a href="#DownloadDialog.__saveFileName">__saveFileName</a></td>
94 <td>Private method to calculate a name for the file to download.</td>
95 </tr><tr>
96 <td><a href="#DownloadDialog.__stop">__stop</a></td>
97 <td>Private slot to stop the download.</td>
98 </tr><tr>
99 <td><a href="#DownloadDialog.__tryAgain">__tryAgain</a></td>
100 <td>Private slot to retry the download.</td>
101 </tr><tr>
102 <td><a href="#DownloadDialog.__updateInfoLabel">__updateInfoLabel</a></td>
103 <td>Private method to update the info label.</td>
104 </tr><tr>
105 <td><a href="#DownloadDialog.closeEvent">closeEvent</a></td>
106 <td>Protected method called when the dialog is closed.</td>
107 </tr><tr>
108 <td><a href="#DownloadDialog.initialize">initialize</a></td>
109 <td>Public method to (re)initialize the dialog.</td>
110 </tr><tr>
111 <td><a href="#DownloadDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
112 <td>Private slot called by a button of the button box clicked.</td>
113 </tr>
114 </table>
115 <a NAME="DownloadDialog.__init__" ID="DownloadDialog.__init__"></a>
116 <h4>DownloadDialog (Constructor)</h4>
117 <b>DownloadDialog</b>(<i>reply = None, requestFilename = False, webPage = None, download = False, parent = None</i>)
118 <p>
119 Constructor
120 </p><dl>
121 <dt><i>reply</i></dt>
122 <dd>
123 reference to the network reply object (QNetworkReply)
124 </dd><dt><i>requestFilename</i></dt>
125 <dd>
126 flag indicating to ask the user for a filename (boolean)
127 </dd><dt><i>webPage</i></dt>
128 <dd>
129 reference to the web page object the download originated
130 from (QWebPage)
131 </dd><dt><i>download</i></dt>
132 <dd>
133 flag indicating a download operation (boolean)
134 </dd><dt><i>parent</i></dt>
135 <dd>
136 reference to the parent widget (QWidget)
137 </dd>
138 </dl><a NAME="DownloadDialog.__dataString" ID="DownloadDialog.__dataString"></a>
139 <h4>DownloadDialog.__dataString</h4>
140 <b>__dataString</b>(<i>size</i>)
141 <p>
142 Private method to generate a formatted data string.
143 </p><dl>
144 <dt><i>size</i></dt>
145 <dd>
146 size to be formatted (integer)
147 </dd>
148 </dl><dl>
149 <dt>Returns:</dt>
150 <dd>
151 formatted data string (string)
152 </dd>
153 </dl><a NAME="DownloadDialog.__downloadProgress" ID="DownloadDialog.__downloadProgress"></a>
154 <h4>DownloadDialog.__downloadProgress</h4>
155 <b>__downloadProgress</b>(<i>received, total</i>)
156 <p>
157 Private method show the download progress.
158 </p><dl>
159 <dt><i>received</i></dt>
160 <dd>
161 number of bytes received (integer)
162 </dd><dt><i>total</i></dt>
163 <dd>
164 number of total bytes (integer)
165 </dd>
166 </dl><a NAME="DownloadDialog.__downloading" ID="DownloadDialog.__downloading"></a>
167 <h4>DownloadDialog.__downloading</h4>
168 <b>__downloading</b>(<i></i>)
169 <p>
170 Private method to determine, if a download is in progress.
171 </p><dl>
172 <dt>Returns:</dt>
173 <dd>
174 flag indicating a download is in progress (boolean)
175 </dd>
176 </dl><a NAME="DownloadDialog.__finished" ID="DownloadDialog.__finished"></a>
177 <h4>DownloadDialog.__finished</h4>
178 <b>__finished</b>(<i></i>)
179 <p>
180 Private slot to handle the download finished.
181 </p><a NAME="DownloadDialog.__getFileName" ID="DownloadDialog.__getFileName"></a>
182 <h4>DownloadDialog.__getFileName</h4>
183 <b>__getFileName</b>(<i></i>)
184 <p>
185 Private method to get the filename to save to from the user.
186 </p><dl>
187 <dt>Returns:</dt>
188 <dd>
189 flag indicating success (boolean)
190 </dd>
191 </dl><a NAME="DownloadDialog.__metaDataChanged" ID="DownloadDialog.__metaDataChanged"></a>
192 <h4>DownloadDialog.__metaDataChanged</h4>
193 <b>__metaDataChanged</b>(<i></i>)
194 <p>
195 Private slot to handle a change of the meta data.
196 </p><a NAME="DownloadDialog.__networkError" ID="DownloadDialog.__networkError"></a>
197 <h4>DownloadDialog.__networkError</h4>
198 <b>__networkError</b>(<i></i>)
199 <p>
200 Private slot to handle a network error.
201 </p><a NAME="DownloadDialog.__open" ID="DownloadDialog.__open"></a>
202 <h4>DownloadDialog.__open</h4>
203 <b>__open</b>(<i></i>)
204 <p>
205 Private slot to open the downloaded file.
206 </p><a NAME="DownloadDialog.__readyRead" ID="DownloadDialog.__readyRead"></a>
207 <h4>DownloadDialog.__readyRead</h4>
208 <b>__readyRead</b>(<i></i>)
209 <p>
210 Private slot to read the available data.
211 </p><a NAME="DownloadDialog.__saveFileName" ID="DownloadDialog.__saveFileName"></a>
212 <h4>DownloadDialog.__saveFileName</h4>
213 <b>__saveFileName</b>(<i>directory</i>)
214 <p>
215 Private method to calculate a name for the file to download.
216 </p><dl>
217 <dt><i>directory</i></dt>
218 <dd>
219 name of the directory to store the file into (string)
220 </dd>
221 </dl><dl>
222 <dt>Returns:</dt>
223 <dd>
224 proposed filename (string)
225 </dd>
226 </dl><a NAME="DownloadDialog.__stop" ID="DownloadDialog.__stop"></a>
227 <h4>DownloadDialog.__stop</h4>
228 <b>__stop</b>(<i></i>)
229 <p>
230 Private slot to stop the download.
231 </p><a NAME="DownloadDialog.__tryAgain" ID="DownloadDialog.__tryAgain"></a>
232 <h4>DownloadDialog.__tryAgain</h4>
233 <b>__tryAgain</b>(<i></i>)
234 <p>
235 Private slot to retry the download.
236 </p><a NAME="DownloadDialog.__updateInfoLabel" ID="DownloadDialog.__updateInfoLabel"></a>
237 <h4>DownloadDialog.__updateInfoLabel</h4>
238 <b>__updateInfoLabel</b>(<i></i>)
239 <p>
240 Private method to update the info label.
241 </p><a NAME="DownloadDialog.closeEvent" ID="DownloadDialog.closeEvent"></a>
242 <h4>DownloadDialog.closeEvent</h4>
243 <b>closeEvent</b>(<i>evt</i>)
244 <p>
245 Protected method called when the dialog is closed.
246 </p><a NAME="DownloadDialog.initialize" ID="DownloadDialog.initialize"></a>
247 <h4>DownloadDialog.initialize</h4>
248 <b>initialize</b>(<i></i>)
249 <p>
250 Public method to (re)initialize the dialog.
251 </p><dl>
252 <dt>Returns:</dt>
253 <dd>
254 flag indicating success (boolean)
255 </dd>
256 </dl><a NAME="DownloadDialog.on_buttonBox_clicked" ID="DownloadDialog.on_buttonBox_clicked"></a>
257 <h4>DownloadDialog.on_buttonBox_clicked</h4>
258 <b>on_buttonBox_clicked</b>(<i>button</i>)
259 <p>
260 Private slot called by a button of the button box clicked.
261 </p><dl>
262 <dt><i>button</i></dt>
263 <dd>
264 button that was clicked (QAbstractButton)
265 </dd>
266 </dl>
267 <div align="right"><a href="#top">Up</a></div>
268 <hr />
269 </body></html>

Mercurial Repository: eric

eric ide

mercurial