Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.WebBrowser.Network.EricSchemeHandler.html

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

Mercurial Repository: eric

eric ide

mercurial