|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.E5Network.E5NetworkMonitor</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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.E5Network.E5NetworkMonitor</h1> |
|
23 <p> |
|
24 Module implementing a network monitor dialog. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#E5NetworkMonitor">E5NetworkMonitor</a></td> |
|
34 <td>Class implementing a network monitor dialog.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#E5NetworkRequest">E5NetworkRequest</a></td> |
|
37 <td>Class for storing all data related to a specific request.</td> |
|
38 </tr><tr> |
|
39 <td><a href="#E5RequestModel">E5RequestModel</a></td> |
|
40 <td>Class implementing a model storing request objects.</td> |
|
41 </tr> |
|
42 </table> |
|
43 <h3>Functions</h3> |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /><hr /> |
|
48 <a NAME="E5NetworkMonitor" ID="E5NetworkMonitor"></a> |
|
49 <h2>E5NetworkMonitor</h2> |
|
50 <p> |
|
51 Class implementing a network monitor dialog. |
|
52 </p> |
|
53 <h3>Derived from</h3> |
|
54 QDialog, Ui_E5NetworkMonitor |
|
55 <h3>Class Attributes</h3> |
|
56 <table> |
|
57 <tr><td>_monitor</td></tr> |
|
58 </table> |
|
59 <h3>Class Methods</h3> |
|
60 <table> |
|
61 <tr> |
|
62 <td><a href="#E5NetworkMonitor.closeMonitor">closeMonitor</a></td> |
|
63 <td>Class method to close the monitor dialog.</td> |
|
64 </tr><tr> |
|
65 <td><a href="#E5NetworkMonitor.instance">instance</a></td> |
|
66 <td>Class method to get a reference to our singleton.</td> |
|
67 </tr> |
|
68 </table> |
|
69 <h3>Methods</h3> |
|
70 <table> |
|
71 <tr> |
|
72 <td><a href="#E5NetworkMonitor.__init__">E5NetworkMonitor</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr><tr> |
|
75 <td><a href="#E5NetworkMonitor.__currentChanged">__currentChanged</a></td> |
|
76 <td>Private slot to handle a change of the current index.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#E5NetworkMonitor.__showHeaderDetails">__showHeaderDetails</a></td> |
|
79 <td>Private slot to show a dialog with the header details.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#E5NetworkMonitor.closeEvent">closeEvent</a></td> |
|
82 <td>Protected method called upon closing the dialog.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#E5NetworkMonitor.reject">reject</a></td> |
|
85 <td>Public slot to close the dialog with a Reject status.</td> |
|
86 </tr> |
|
87 </table> |
|
88 <h3>Static Methods</h3> |
|
89 <table> |
|
90 <tr><td>None</td></tr> |
|
91 </table> |
|
92 <a NAME="E5NetworkMonitor.closeMonitor" ID="E5NetworkMonitor.closeMonitor"></a> |
|
93 <h4>E5NetworkMonitor.closeMonitor (class method)</h4> |
|
94 <b>closeMonitor</b>(<i></i>) |
|
95 <p> |
|
96 Class method to close the monitor dialog. |
|
97 </p><a NAME="E5NetworkMonitor.instance" ID="E5NetworkMonitor.instance"></a> |
|
98 <h4>E5NetworkMonitor.instance (class method)</h4> |
|
99 <b>instance</b>(<i>networkAccessManager</i>) |
|
100 <p> |
|
101 Class method to get a reference to our singleton. |
|
102 </p><dl> |
|
103 <dt><i>networkAccessManager</i></dt> |
|
104 <dd> |
|
105 reference to the network access manager |
|
106 (QNetworkAccessManager) |
|
107 </dd> |
|
108 </dl><dl> |
|
109 <dt>Returns:</dt> |
|
110 <dd> |
|
111 reference to the network monitor singleton (E5NetworkMonitor) |
|
112 </dd> |
|
113 </dl><a NAME="E5NetworkMonitor.__init__" ID="E5NetworkMonitor.__init__"></a> |
|
114 <h4>E5NetworkMonitor (Constructor)</h4> |
|
115 <b>E5NetworkMonitor</b>(<i>networkAccessManager, parent=None</i>) |
|
116 <p> |
|
117 Constructor |
|
118 </p><dl> |
|
119 <dt><i>networkAccessManager</i></dt> |
|
120 <dd> |
|
121 reference to the network access manager |
|
122 (QNetworkAccessManager) |
|
123 </dd><dt><i>parent</i></dt> |
|
124 <dd> |
|
125 reference to the parent widget (QWidget) |
|
126 </dd> |
|
127 </dl><a NAME="E5NetworkMonitor.__currentChanged" ID="E5NetworkMonitor.__currentChanged"></a> |
|
128 <h4>E5NetworkMonitor.__currentChanged</h4> |
|
129 <b>__currentChanged</b>(<i>current, previous</i>) |
|
130 <p> |
|
131 Private slot to handle a change of the current index. |
|
132 </p><dl> |
|
133 <dt><i>current</i></dt> |
|
134 <dd> |
|
135 new current index (QModelIndex) |
|
136 </dd><dt><i>previous</i></dt> |
|
137 <dd> |
|
138 old current index (QModelIndex) |
|
139 </dd> |
|
140 </dl><a NAME="E5NetworkMonitor.__showHeaderDetails" ID="E5NetworkMonitor.__showHeaderDetails"></a> |
|
141 <h4>E5NetworkMonitor.__showHeaderDetails</h4> |
|
142 <b>__showHeaderDetails</b>(<i>index, headerList</i>) |
|
143 <p> |
|
144 Private slot to show a dialog with the header details. |
|
145 </p><dl> |
|
146 <dt><i>index</i> (QModelIndex)</dt> |
|
147 <dd> |
|
148 index of the entry to show |
|
149 </dd><dt><i>headerList</i> (QTableView)</dt> |
|
150 <dd> |
|
151 list requesting the header details |
|
152 </dd> |
|
153 </dl><a NAME="E5NetworkMonitor.closeEvent" ID="E5NetworkMonitor.closeEvent"></a> |
|
154 <h4>E5NetworkMonitor.closeEvent</h4> |
|
155 <b>closeEvent</b>(<i>evt</i>) |
|
156 <p> |
|
157 Protected method called upon closing the dialog. |
|
158 </p><dl> |
|
159 <dt><i>evt</i></dt> |
|
160 <dd> |
|
161 reference to the close event object (QCloseEvent) |
|
162 </dd> |
|
163 </dl><a NAME="E5NetworkMonitor.reject" ID="E5NetworkMonitor.reject"></a> |
|
164 <h4>E5NetworkMonitor.reject</h4> |
|
165 <b>reject</b>(<i></i>) |
|
166 <p> |
|
167 Public slot to close the dialog with a Reject status. |
|
168 </p> |
|
169 <div align="right"><a href="#top">Up</a></div> |
|
170 <hr /><hr /> |
|
171 <a NAME="E5NetworkRequest" ID="E5NetworkRequest"></a> |
|
172 <h2>E5NetworkRequest</h2> |
|
173 <p> |
|
174 Class for storing all data related to a specific request. |
|
175 </p> |
|
176 <h3>Derived from</h3> |
|
177 object |
|
178 <h3>Class Attributes</h3> |
|
179 <table> |
|
180 <tr><td>None</td></tr> |
|
181 </table> |
|
182 <h3>Class Methods</h3> |
|
183 <table> |
|
184 <tr><td>None</td></tr> |
|
185 </table> |
|
186 <h3>Methods</h3> |
|
187 <table> |
|
188 <tr> |
|
189 <td><a href="#E5NetworkRequest.__init__">E5NetworkRequest</a></td> |
|
190 <td>Constructor</td> |
|
191 </tr> |
|
192 </table> |
|
193 <h3>Static Methods</h3> |
|
194 <table> |
|
195 <tr><td>None</td></tr> |
|
196 </table> |
|
197 <a NAME="E5NetworkRequest.__init__" ID="E5NetworkRequest.__init__"></a> |
|
198 <h4>E5NetworkRequest (Constructor)</h4> |
|
199 <b>E5NetworkRequest</b>(<i></i>) |
|
200 <p> |
|
201 Constructor |
|
202 </p> |
|
203 <div align="right"><a href="#top">Up</a></div> |
|
204 <hr /><hr /> |
|
205 <a NAME="E5RequestModel" ID="E5RequestModel"></a> |
|
206 <h2>E5RequestModel</h2> |
|
207 <p> |
|
208 Class implementing a model storing request objects. |
|
209 </p> |
|
210 <h3>Derived from</h3> |
|
211 QAbstractTableModel |
|
212 <h3>Class Attributes</h3> |
|
213 <table> |
|
214 <tr><td>None</td></tr> |
|
215 </table> |
|
216 <h3>Class Methods</h3> |
|
217 <table> |
|
218 <tr><td>None</td></tr> |
|
219 </table> |
|
220 <h3>Methods</h3> |
|
221 <table> |
|
222 <tr> |
|
223 <td><a href="#E5RequestModel.__init__">E5RequestModel</a></td> |
|
224 <td>Constructor</td> |
|
225 </tr><tr> |
|
226 <td><a href="#E5RequestModel.__addReply">__addReply</a></td> |
|
227 <td>Private slot to add the reply data to the model.</td> |
|
228 </tr><tr> |
|
229 <td><a href="#E5RequestModel.__addRequest">__addRequest</a></td> |
|
230 <td>Private method to add a request object to the model.</td> |
|
231 </tr><tr> |
|
232 <td><a href="#E5RequestModel.__requestCreated">__requestCreated</a></td> |
|
233 <td>Private slot handling the creation of a network request.</td> |
|
234 </tr><tr> |
|
235 <td><a href="#E5RequestModel.columnCount">columnCount</a></td> |
|
236 <td>Public method to get the number of columns of the model.</td> |
|
237 </tr><tr> |
|
238 <td><a href="#E5RequestModel.data">data</a></td> |
|
239 <td>Public method to get data from the model.</td> |
|
240 </tr><tr> |
|
241 <td><a href="#E5RequestModel.headerData">headerData</a></td> |
|
242 <td>Public method to get header data from the model.</td> |
|
243 </tr><tr> |
|
244 <td><a href="#E5RequestModel.removeRows">removeRows</a></td> |
|
245 <td>Public method to remove entries from the model.</td> |
|
246 </tr><tr> |
|
247 <td><a href="#E5RequestModel.rowCount">rowCount</a></td> |
|
248 <td>Public method to get the number of rows of the model.</td> |
|
249 </tr> |
|
250 </table> |
|
251 <h3>Static Methods</h3> |
|
252 <table> |
|
253 <tr><td>None</td></tr> |
|
254 </table> |
|
255 <a NAME="E5RequestModel.__init__" ID="E5RequestModel.__init__"></a> |
|
256 <h4>E5RequestModel (Constructor)</h4> |
|
257 <b>E5RequestModel</b>(<i>networkAccessManager, parent=None</i>) |
|
258 <p> |
|
259 Constructor |
|
260 </p><dl> |
|
261 <dt><i>networkAccessManager</i></dt> |
|
262 <dd> |
|
263 reference to the network access manager |
|
264 (QNetworkAccessManager) |
|
265 </dd><dt><i>parent</i></dt> |
|
266 <dd> |
|
267 reference to the parent object (QObject) |
|
268 </dd> |
|
269 </dl><a NAME="E5RequestModel.__addReply" ID="E5RequestModel.__addReply"></a> |
|
270 <h4>E5RequestModel.__addReply</h4> |
|
271 <b>__addReply</b>(<i>reply</i>) |
|
272 <p> |
|
273 Private slot to add the reply data to the model. |
|
274 </p><dl> |
|
275 <dt><i>reply</i> (QNetworkReply)</dt> |
|
276 <dd> |
|
277 reference to the network reply object |
|
278 </dd> |
|
279 </dl><a NAME="E5RequestModel.__addRequest" ID="E5RequestModel.__addRequest"></a> |
|
280 <h4>E5RequestModel.__addRequest</h4> |
|
281 <b>__addRequest</b>(<i>req</i>) |
|
282 <p> |
|
283 Private method to add a request object to the model. |
|
284 </p><dl> |
|
285 <dt><i>req</i></dt> |
|
286 <dd> |
|
287 reference to the request object (E5NetworkRequest) |
|
288 </dd> |
|
289 </dl><a NAME="E5RequestModel.__requestCreated" ID="E5RequestModel.__requestCreated"></a> |
|
290 <h4>E5RequestModel.__requestCreated</h4> |
|
291 <b>__requestCreated</b>(<i>operation, request, reply</i>) |
|
292 <p> |
|
293 Private slot handling the creation of a network request. |
|
294 </p><dl> |
|
295 <dt><i>operation</i></dt> |
|
296 <dd> |
|
297 network operation (QNetworkAccessManager.Operation) |
|
298 </dd><dt><i>request</i></dt> |
|
299 <dd> |
|
300 reference to the request object (QNetworkRequest) |
|
301 </dd><dt><i>reply</i></dt> |
|
302 <dd> |
|
303 reference to the reply object(QNetworkReply) |
|
304 </dd> |
|
305 </dl><a NAME="E5RequestModel.columnCount" ID="E5RequestModel.columnCount"></a> |
|
306 <h4>E5RequestModel.columnCount</h4> |
|
307 <b>columnCount</b>(<i>parent</i>) |
|
308 <p> |
|
309 Public method to get the number of columns of the model. |
|
310 </p><dl> |
|
311 <dt><i>parent</i></dt> |
|
312 <dd> |
|
313 parent index (QModelIndex) |
|
314 </dd> |
|
315 </dl><dl> |
|
316 <dt>Returns:</dt> |
|
317 <dd> |
|
318 number of columns (integer) |
|
319 </dd> |
|
320 </dl><a NAME="E5RequestModel.data" ID="E5RequestModel.data"></a> |
|
321 <h4>E5RequestModel.data</h4> |
|
322 <b>data</b>(<i>index, role=Qt.DisplayRole</i>) |
|
323 <p> |
|
324 Public method to get data from the model. |
|
325 </p><dl> |
|
326 <dt><i>index</i></dt> |
|
327 <dd> |
|
328 index to get data for (QModelIndex) |
|
329 </dd><dt><i>role</i></dt> |
|
330 <dd> |
|
331 role of the data to retrieve (integer) |
|
332 </dd> |
|
333 </dl><dl> |
|
334 <dt>Returns:</dt> |
|
335 <dd> |
|
336 requested data |
|
337 </dd> |
|
338 </dl><a NAME="E5RequestModel.headerData" ID="E5RequestModel.headerData"></a> |
|
339 <h4>E5RequestModel.headerData</h4> |
|
340 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>) |
|
341 <p> |
|
342 Public method to get header data from the model. |
|
343 </p><dl> |
|
344 <dt><i>section</i></dt> |
|
345 <dd> |
|
346 section number (integer) |
|
347 </dd><dt><i>orientation</i></dt> |
|
348 <dd> |
|
349 orientation (Qt.Orientation) |
|
350 </dd><dt><i>role</i></dt> |
|
351 <dd> |
|
352 role of the data to retrieve (integer) |
|
353 </dd> |
|
354 </dl><dl> |
|
355 <dt>Returns:</dt> |
|
356 <dd> |
|
357 requested data |
|
358 </dd> |
|
359 </dl><a NAME="E5RequestModel.removeRows" ID="E5RequestModel.removeRows"></a> |
|
360 <h4>E5RequestModel.removeRows</h4> |
|
361 <b>removeRows</b>(<i>row, count, parent</i>) |
|
362 <p> |
|
363 Public method to remove entries from the model. |
|
364 </p><dl> |
|
365 <dt><i>row</i></dt> |
|
366 <dd> |
|
367 start row (integer) |
|
368 </dd><dt><i>count</i></dt> |
|
369 <dd> |
|
370 number of rows to remove (integer) |
|
371 </dd><dt><i>parent</i></dt> |
|
372 <dd> |
|
373 parent index (QModelIndex) |
|
374 </dd> |
|
375 </dl><dl> |
|
376 <dt>Returns:</dt> |
|
377 <dd> |
|
378 flag indicating success (boolean) |
|
379 </dd> |
|
380 </dl><a NAME="E5RequestModel.rowCount" ID="E5RequestModel.rowCount"></a> |
|
381 <h4>E5RequestModel.rowCount</h4> |
|
382 <b>rowCount</b>(<i>parent</i>) |
|
383 <p> |
|
384 Public method to get the number of rows of the model. |
|
385 </p><dl> |
|
386 <dt><i>parent</i></dt> |
|
387 <dd> |
|
388 parent index (QModelIndex) |
|
389 </dd> |
|
390 </dl><dl> |
|
391 <dt>Returns:</dt> |
|
392 <dd> |
|
393 number of columns (integer) |
|
394 </dd> |
|
395 </dl> |
|
396 <div align="right"><a href="#top">Up</a></div> |
|
397 <hr /> |
|
398 </body></html> |