Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.Network.EricSchemeHandler.html
eric6/Documentation/Source/eric6.WebBrowser.Network.EricSchemeHandler.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.Network.EricSchemeHandler</h1> | |
| 23 <p> | |
| 24 Module implementing a scheme handler for the eric: scheme. | |
| 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="#EricSchemeHandler">EricSchemeHandler</a></td> | |
| 34 <td>Class implementing a scheme handler for the eric: scheme.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#EricSchemeReply">EricSchemeReply</a></td> | |
| 37 <td>Class implementing a reply for a requested eric: page.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 <table> | |
| 42 <tr><td>None</td></tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="EricSchemeHandler" ID="EricSchemeHandler"></a> | |
| 46 <h2>EricSchemeHandler</h2> | |
| 47 <p> | |
| 48 Class implementing a scheme handler for the eric: scheme. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QWebEngineUrlSchemeHandler | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>SupportedPages</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#EricSchemeHandler.__init__">EricSchemeHandler</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EricSchemeHandler.__replyClosed">__replyClosed</a></td> | |
| 67 <td>Private slot handling the closed signal of a reply.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EricSchemeHandler.requestStarted">requestStarted</a></td> | |
| 70 <td>Public method handling the URL request.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <h3>Static Methods</h3> | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <a NAME="EricSchemeHandler.__init__" ID="EricSchemeHandler.__init__"></a> | |
| 78 <h4>EricSchemeHandler (Constructor)</h4> | |
| 79 <b>EricSchemeHandler</b>(<i>parent=None</i>) | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p><dl> | |
| 83 <dt><i>parent</i> (QObject)</dt> | |
| 84 <dd> | |
| 85 reference to the parent object | |
| 86 </dd> | |
| 87 </dl><a NAME="EricSchemeHandler.__replyClosed" ID="EricSchemeHandler.__replyClosed"></a> | |
| 88 <h4>EricSchemeHandler.__replyClosed</h4> | |
| 89 <b>__replyClosed</b>(<i>reply</i>) | |
| 90 <p> | |
| 91 Private slot handling the closed signal of a reply. | |
| 92 </p><dl> | |
| 93 <dt><i>reply</i> (EricSchemeReply)</dt> | |
| 94 <dd> | |
| 95 reference to the network reply | |
| 96 </dd> | |
| 97 </dl><a NAME="EricSchemeHandler.requestStarted" ID="EricSchemeHandler.requestStarted"></a> | |
| 98 <h4>EricSchemeHandler.requestStarted</h4> | |
| 99 <b>requestStarted</b>(<i>job</i>) | |
| 100 <p> | |
| 101 Public method handling the URL request. | |
| 102 </p><dl> | |
| 103 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 104 <dd> | |
| 105 URL request job | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <div align="right"><a href="#top">Up</a></div> | |
| 109 <hr /><hr /> | |
| 110 <a NAME="EricSchemeReply" ID="EricSchemeReply"></a> | |
| 111 <h2>EricSchemeReply</h2> | |
| 112 <p> | |
| 113 Class implementing a reply for a requested eric: page. | |
| 114 </p><h3>Signals</h3> | |
| 115 <dl> | |
| 116 <dt>closed</dt> | |
| 117 <dd> | |
| 118 emitted to signal that the web engine has read | |
| 119 the data | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <h3>Derived from</h3> | |
| 123 QIODevice | |
| 124 <h3>Class Attributes</h3> | |
| 125 <table> | |
| 126 <tr><td>_speedDialPage</td></tr> | |
| 127 </table> | |
| 128 <h3>Class Methods</h3> | |
| 129 <table> | |
| 130 <tr><td>None</td></tr> | |
| 131 </table> | |
| 132 <h3>Methods</h3> | |
| 133 <table> | |
| 134 <tr> | |
| 135 <td><a href="#EricSchemeReply.__init__">EricSchemeReply</a></td> | |
| 136 <td>Constructor</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#EricSchemeReply.__adBlockPage">__adBlockPage</a></td> | |
| 139 <td>Private method to build the AdBlock page.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#EricSchemeReply.__loadPage">__loadPage</a></td> | |
| 142 <td>Private method to load the requested page.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#EricSchemeReply.__speedDialPage">__speedDialPage</a></td> | |
| 145 <td>Private method to create the Speeddial page.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#EricSchemeReply.__startPage">__startPage</a></td> | |
| 148 <td>Private method to build the Start page.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#EricSchemeReply.bytesAvailable">bytesAvailable</a></td> | |
| 151 <td>Public method to get the number of available bytes.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#EricSchemeReply.close">close</a></td> | |
| 154 <td>Public method used to cloase the reply.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#EricSchemeReply.readData">readData</a></td> | |
| 157 <td>Public method to retrieve data from the reply object.</td> | |
| 158 </tr> | |
| 159 </table> | |
| 160 <h3>Static Methods</h3> | |
| 161 <table> | |
| 162 <tr><td>None</td></tr> | |
| 163 </table> | |
| 164 <a NAME="EricSchemeReply.__init__" ID="EricSchemeReply.__init__"></a> | |
| 165 <h4>EricSchemeReply (Constructor)</h4> | |
| 166 <b>EricSchemeReply</b>(<i>job, parent=None</i>) | |
| 167 <p> | |
| 168 Constructor | |
| 169 </p><dl> | |
| 170 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 171 <dd> | |
| 172 reference to the URL request | |
| 173 </dd><dt><i>parent</i> (QObject)</dt> | |
| 174 <dd> | |
| 175 reference to the parent object | |
| 176 </dd> | |
| 177 </dl><a NAME="EricSchemeReply.__adBlockPage" ID="EricSchemeReply.__adBlockPage"></a> | |
| 178 <h4>EricSchemeReply.__adBlockPage</h4> | |
| 179 <b>__adBlockPage</b>(<i></i>) | |
| 180 <p> | |
| 181 Private method to build the AdBlock page. | |
| 182 </p><dl> | |
| 183 <dt>Returns:</dt> | |
| 184 <dd> | |
| 185 built AdBlock page | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Return Type:</dt> | |
| 189 <dd> | |
| 190 str | |
| 191 </dd> | |
| 192 </dl><a NAME="EricSchemeReply.__loadPage" ID="EricSchemeReply.__loadPage"></a> | |
| 193 <h4>EricSchemeReply.__loadPage</h4> | |
| 194 <b>__loadPage</b>(<i></i>) | |
| 195 <p> | |
| 196 Private method to load the requested page. | |
| 197 </p><a NAME="EricSchemeReply.__speedDialPage" ID="EricSchemeReply.__speedDialPage"></a> | |
| 198 <h4>EricSchemeReply.__speedDialPage</h4> | |
| 199 <b>__speedDialPage</b>(<i></i>) | |
| 200 <p> | |
| 201 Private method to create the Speeddial page. | |
| 202 </p><dl> | |
| 203 <dt>Returns:</dt> | |
| 204 <dd> | |
| 205 prepared speeddial page (QByteArray) | |
| 206 </dd> | |
| 207 </dl><a NAME="EricSchemeReply.__startPage" ID="EricSchemeReply.__startPage"></a> | |
| 208 <h4>EricSchemeReply.__startPage</h4> | |
| 209 <b>__startPage</b>(<i></i>) | |
| 210 <p> | |
| 211 Private method to build the Start page. | |
| 212 </p><dl> | |
| 213 <dt>Returns:</dt> | |
| 214 <dd> | |
| 215 built Start page | |
| 216 </dd> | |
| 217 </dl><dl> | |
| 218 <dt>Return Type:</dt> | |
| 219 <dd> | |
| 220 str | |
| 221 </dd> | |
| 222 </dl><a NAME="EricSchemeReply.bytesAvailable" ID="EricSchemeReply.bytesAvailable"></a> | |
| 223 <h4>EricSchemeReply.bytesAvailable</h4> | |
| 224 <b>bytesAvailable</b>(<i></i>) | |
| 225 <p> | |
| 226 Public method to get the number of available bytes. | |
| 227 </p><dl> | |
| 228 <dt>Returns:</dt> | |
| 229 <dd> | |
| 230 number of available bytes | |
| 231 </dd> | |
| 232 </dl><dl> | |
| 233 <dt>Return Type:</dt> | |
| 234 <dd> | |
| 235 int | |
| 236 </dd> | |
| 237 </dl><a NAME="EricSchemeReply.close" ID="EricSchemeReply.close"></a> | |
| 238 <h4>EricSchemeReply.close</h4> | |
| 239 <b>close</b>(<i></i>) | |
| 240 <p> | |
| 241 Public method used to cloase the reply. | |
| 242 </p><a NAME="EricSchemeReply.readData" ID="EricSchemeReply.readData"></a> | |
| 243 <h4>EricSchemeReply.readData</h4> | |
| 244 <b>readData</b>(<i>maxlen</i>) | |
| 245 <p> | |
| 246 Public method to retrieve data from the reply object. | |
| 247 </p><dl> | |
| 248 <dt><i>maxlen</i></dt> | |
| 249 <dd> | |
| 250 maximum number of bytes to read (integer) | |
| 251 </dd> | |
| 252 </dl><dl> | |
| 253 <dt>Returns:</dt> | |
| 254 <dd> | |
| 255 string containing the data (bytes) | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <div align="right"><a href="#top">Up</a></div> | |
| 259 <hr /> | |
| 260 </body></html> |
