Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Network.EricSchemeHandler.html

eric7/Documentation/Source/eric7.WebBrowser.Network.EricSchemeHandler.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.Network.EricSchemeHandler</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.Network.EricSchemeHandler</h1>
24
25 <p>
26 Module implementing a scheme handler for the eric: scheme.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>_SupportedPages</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EricSchemeHandler">EricSchemeHandler</a></td>
39 <td>Class implementing a scheme handler for the eric: scheme.</td>
40 </tr>
41 <tr>
42 <td><a href="#EricSchemeReply">EricSchemeReply</a></td>
43 <td>Class implementing a reply for a requested eric: page.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="EricSchemeHandler" ID="EricSchemeHandler"></a>
54 <h2>EricSchemeHandler</h2>
55
56 <p>
57 Class implementing a scheme handler for the eric: scheme.
58 </p>
59 <h3>Derived from</h3>
60 QWebEngineUrlSchemeHandler
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#EricSchemeHandler.__init__">EricSchemeHandler</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EricSchemeHandler.__replyClosed">__replyClosed</a></td>
81 <td>Private slot handling the closed signal of a reply.</td>
82 </tr>
83 <tr>
84 <td><a href="#EricSchemeHandler.requestStarted">requestStarted</a></td>
85 <td>Public method handling the URL request.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="EricSchemeHandler.__init__" ID="EricSchemeHandler.__init__"></a>
95 <h4>EricSchemeHandler (Constructor)</h4>
96 <b>EricSchemeHandler</b>(<i>parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>parent</i> (QObject)</dt>
104 <dd>
105 reference to the parent object
106 </dd>
107 </dl>
108 <a NAME="EricSchemeHandler.__replyClosed" ID="EricSchemeHandler.__replyClosed"></a>
109 <h4>EricSchemeHandler.__replyClosed</h4>
110 <b>__replyClosed</b>(<i>reply</i>)
111
112 <p>
113 Private slot handling the closed signal of a reply.
114 </p>
115 <dl>
116
117 <dt><i>reply</i> (EricSchemeReply)</dt>
118 <dd>
119 reference to the network reply
120 </dd>
121 </dl>
122 <a NAME="EricSchemeHandler.requestStarted" ID="EricSchemeHandler.requestStarted"></a>
123 <h4>EricSchemeHandler.requestStarted</h4>
124 <b>requestStarted</b>(<i>job</i>)
125
126 <p>
127 Public method handling the URL request.
128 </p>
129 <dl>
130
131 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
132 <dd>
133 URL request job
134 </dd>
135 </dl>
136 <div align="right"><a href="#top">Up</a></div>
137 <hr />
138 <hr />
139 <a NAME="EricSchemeReply" ID="EricSchemeReply"></a>
140 <h2>EricSchemeReply</h2>
141
142 <p>
143 Class implementing a reply for a requested eric: page.
144 </p>
145 <h3>Signals</h3>
146 <dl>
147
148 <dt>closed</dt>
149 <dd>
150 emitted to signal that the web engine has read
151 the data
152 </dd>
153 </dl>
154 <h3>Derived from</h3>
155 QIODevice
156 <h3>Class Attributes</h3>
157
158 <table>
159 <tr><td>_speedDialPage</td></tr>
160 </table>
161 <h3>Class Methods</h3>
162
163 <table>
164 <tr><td>None</td></tr>
165 </table>
166 <h3>Methods</h3>
167
168 <table>
169
170 <tr>
171 <td><a href="#EricSchemeReply.__init__">EricSchemeReply</a></td>
172 <td>Constructor</td>
173 </tr>
174 <tr>
175 <td><a href="#EricSchemeReply.__adBlockPage">__adBlockPage</a></td>
176 <td>Private method to build the AdBlock page.</td>
177 </tr>
178 <tr>
179 <td><a href="#EricSchemeReply.__errorPage">__errorPage</a></td>
180 <td>Private method to build the Error page.</td>
181 </tr>
182 <tr>
183 <td><a href="#EricSchemeReply.__loadPage">__loadPage</a></td>
184 <td>Private method to load the requested page.</td>
185 </tr>
186 <tr>
187 <td><a href="#EricSchemeReply.__speedDialPage">__speedDialPage</a></td>
188 <td>Private method to create the Speeddial page.</td>
189 </tr>
190 <tr>
191 <td><a href="#EricSchemeReply.__startPage">__startPage</a></td>
192 <td>Private method to build the Start page.</td>
193 </tr>
194 <tr>
195 <td><a href="#EricSchemeReply.bytesAvailable">bytesAvailable</a></td>
196 <td>Public method to get the number of available bytes.</td>
197 </tr>
198 <tr>
199 <td><a href="#EricSchemeReply.close">close</a></td>
200 <td>Public method used to cloase the reply.</td>
201 </tr>
202 <tr>
203 <td><a href="#EricSchemeReply.readData">readData</a></td>
204 <td>Public method to retrieve data from the reply object.</td>
205 </tr>
206 </table>
207 <h3>Static Methods</h3>
208
209 <table>
210 <tr><td>None</td></tr>
211 </table>
212
213 <a NAME="EricSchemeReply.__init__" ID="EricSchemeReply.__init__"></a>
214 <h4>EricSchemeReply (Constructor)</h4>
215 <b>EricSchemeReply</b>(<i>job, parent=None</i>)
216
217 <p>
218 Constructor
219 </p>
220 <dl>
221
222 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
223 <dd>
224 reference to the URL request
225 </dd>
226 <dt><i>parent</i> (QObject)</dt>
227 <dd>
228 reference to the parent object
229 </dd>
230 </dl>
231 <a NAME="EricSchemeReply.__adBlockPage" ID="EricSchemeReply.__adBlockPage"></a>
232 <h4>EricSchemeReply.__adBlockPage</h4>
233 <b>__adBlockPage</b>(<i></i>)
234
235 <p>
236 Private method to build the AdBlock page.
237 </p>
238 <dl>
239 <dt>Return:</dt>
240 <dd>
241 built AdBlock page
242 </dd>
243 </dl>
244 <dl>
245 <dt>Return Type:</dt>
246 <dd>
247 str
248 </dd>
249 </dl>
250 <a NAME="EricSchemeReply.__errorPage" ID="EricSchemeReply.__errorPage"></a>
251 <h4>EricSchemeReply.__errorPage</h4>
252 <b>__errorPage</b>(<i></i>)
253
254 <p>
255 Private method to build the Error page.
256 </p>
257 <dl>
258 <dt>Return:</dt>
259 <dd>
260 built Error page
261 </dd>
262 </dl>
263 <dl>
264 <dt>Return Type:</dt>
265 <dd>
266 str
267 </dd>
268 </dl>
269 <a NAME="EricSchemeReply.__loadPage" ID="EricSchemeReply.__loadPage"></a>
270 <h4>EricSchemeReply.__loadPage</h4>
271 <b>__loadPage</b>(<i></i>)
272
273 <p>
274 Private method to load the requested page.
275 </p>
276 <a NAME="EricSchemeReply.__speedDialPage" ID="EricSchemeReply.__speedDialPage"></a>
277 <h4>EricSchemeReply.__speedDialPage</h4>
278 <b>__speedDialPage</b>(<i></i>)
279
280 <p>
281 Private method to create the Speeddial page.
282 </p>
283 <dl>
284 <dt>Return:</dt>
285 <dd>
286 prepared speeddial page
287 </dd>
288 </dl>
289 <dl>
290 <dt>Return Type:</dt>
291 <dd>
292 str
293 </dd>
294 </dl>
295 <a NAME="EricSchemeReply.__startPage" ID="EricSchemeReply.__startPage"></a>
296 <h4>EricSchemeReply.__startPage</h4>
297 <b>__startPage</b>(<i></i>)
298
299 <p>
300 Private method to build the Start page.
301 </p>
302 <dl>
303 <dt>Return:</dt>
304 <dd>
305 built Start page
306 </dd>
307 </dl>
308 <dl>
309 <dt>Return Type:</dt>
310 <dd>
311 str
312 </dd>
313 </dl>
314 <a NAME="EricSchemeReply.bytesAvailable" ID="EricSchemeReply.bytesAvailable"></a>
315 <h4>EricSchemeReply.bytesAvailable</h4>
316 <b>bytesAvailable</b>(<i></i>)
317
318 <p>
319 Public method to get the number of available bytes.
320 </p>
321 <dl>
322 <dt>Return:</dt>
323 <dd>
324 number of available bytes
325 </dd>
326 </dl>
327 <dl>
328 <dt>Return Type:</dt>
329 <dd>
330 int
331 </dd>
332 </dl>
333 <a NAME="EricSchemeReply.close" ID="EricSchemeReply.close"></a>
334 <h4>EricSchemeReply.close</h4>
335 <b>close</b>(<i></i>)
336
337 <p>
338 Public method used to cloase the reply.
339 </p>
340 <a NAME="EricSchemeReply.readData" ID="EricSchemeReply.readData"></a>
341 <h4>EricSchemeReply.readData</h4>
342 <b>readData</b>(<i>maxlen</i>)
343
344 <p>
345 Public method to retrieve data from the reply object.
346 </p>
347 <dl>
348
349 <dt><i>maxlen</i></dt>
350 <dd>
351 maximum number of bytes to read (integer)
352 </dd>
353 </dl>
354 <dl>
355 <dt>Return:</dt>
356 <dd>
357 string containing the data (bytes)
358 </dd>
359 </dl>
360 <div align="right"><a href="#top">Up</a></div>
361 <hr />
362 </body></html>

Mercurial Repository: eric

eric ide

mercurial