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