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