Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpSchemeHandler.html
src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpSchemeHandler.html
- branch
- eric7
- changeset 9686
- 2eee7a645cba
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9685:b43e04854aba | 9686:2eee7a645cba |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QtHelpInterface.QtHelpSchemeHandler</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.QtHelpInterface.QtHelpSchemeHandler</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a scheme access handler for QtHelp. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td> | |
| 25 <td>Class implementing a scheme handler for the qthelp: scheme.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td> | |
| 29 <td>Class implementing a reply for a requested qthelp: 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="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a> | |
| 40 <h2>QtHelpSchemeHandler</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a scheme handler for the qthelp: 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="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#QtHelpSchemeHandler.__replyClosed">__replyClosed</a></td> | |
| 67 <td>Private slot handling the closed signal of a reply.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#QtHelpSchemeHandler.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="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a> | |
| 81 <h4>QtHelpSchemeHandler (Constructor)</h4> | |
| 82 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 90 <dd> | |
| 91 reference to the help engine | |
| 92 </dd> | |
| 93 <dt><i>parent</i> (QObject)</dt> | |
| 94 <dd> | |
| 95 reference to the parent object | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a> | |
| 99 <h4>QtHelpSchemeHandler.__replyClosed</h4> | |
| 100 <b>__replyClosed</b>(<i>reply</i>) | |
| 101 | |
| 102 <p> | |
| 103 Private slot handling the closed signal of a reply. | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>reply</i> (QtHelpSchemeReply)</dt> | |
| 108 <dd> | |
| 109 reference to the network reply | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a> | |
| 113 <h4>QtHelpSchemeHandler.requestStarted</h4> | |
| 114 <b>requestStarted</b>(<i>job</i>) | |
| 115 | |
| 116 <p> | |
| 117 Public method handling the URL request. | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 122 <dd> | |
| 123 URL request job | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <div align="right"><a href="#top">Up</a></div> | |
| 127 <hr /> | |
| 128 <hr /> | |
| 129 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a> | |
| 130 <h2>QtHelpSchemeReply</h2> | |
| 131 | |
| 132 <p> | |
| 133 Class implementing a reply for a requested qthelp: page. | |
| 134 </p> | |
| 135 <h3>Signals</h3> | |
| 136 <dl> | |
| 137 | |
| 138 <dt>closed</dt> | |
| 139 <dd> | |
| 140 emitted to signal that the web engine has read | |
| 141 the data | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <h3>Derived from</h3> | |
| 145 QIODevice | |
| 146 <h3>Class Attributes</h3> | |
| 147 | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 <h3>Class Methods</h3> | |
| 152 | |
| 153 <table> | |
| 154 <tr><td>None</td></tr> | |
| 155 </table> | |
| 156 <h3>Methods</h3> | |
| 157 | |
| 158 <table> | |
| 159 | |
| 160 <tr> | |
| 161 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td> | |
| 162 <td>Constructor</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#QtHelpSchemeReply.__loadQtHelpPage">__loadQtHelpPage</a></td> | |
| 166 <td>Private method to load the requested QtHelp page.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td> | |
| 170 <td>Private method to guess the mime type given an URL.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td> | |
| 174 <td>Public method to get the number of available bytes.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#QtHelpSchemeReply.close">close</a></td> | |
| 178 <td>Public method used to cloase the reply.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td> | |
| 182 <td>Public method to get the reply mime type.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#QtHelpSchemeReply.readData">readData</a></td> | |
| 186 <td>Public method to retrieve data from the reply object.</td> | |
| 187 </tr> | |
| 188 </table> | |
| 189 <h3>Static Methods</h3> | |
| 190 | |
| 191 <table> | |
| 192 <tr><td>None</td></tr> | |
| 193 </table> | |
| 194 | |
| 195 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a> | |
| 196 <h4>QtHelpSchemeReply (Constructor)</h4> | |
| 197 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>) | |
| 198 | |
| 199 <p> | |
| 200 Constructor | |
| 201 </p> | |
| 202 <dl> | |
| 203 | |
| 204 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 205 <dd> | |
| 206 reference to the URL request | |
| 207 </dd> | |
| 208 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 209 <dd> | |
| 210 reference to the help engine | |
| 211 </dd> | |
| 212 <dt><i>parent</i> (QObject)</dt> | |
| 213 <dd> | |
| 214 reference to the parent object | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a> | |
| 218 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4> | |
| 219 <b>__loadQtHelpPage</b>(<i>url</i>) | |
| 220 | |
| 221 <p> | |
| 222 Private method to load the requested QtHelp page. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>url</i> (QUrl)</dt> | |
| 227 <dd> | |
| 228 URL of the requested page | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a> | |
| 232 <h4>QtHelpSchemeReply.__mimeFromUrl</h4> | |
| 233 <b>__mimeFromUrl</b>(<i>url</i>) | |
| 234 | |
| 235 <p> | |
| 236 Private method to guess the mime type given an URL. | |
| 237 </p> | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>url</i></dt> | |
| 241 <dd> | |
| 242 URL to guess the mime type from (QUrl) | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <dl> | |
| 246 <dt>Return:</dt> | |
| 247 <dd> | |
| 248 mime type for the given URL (string) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a> | |
| 252 <h4>QtHelpSchemeReply.bytesAvailable</h4> | |
| 253 <b>bytesAvailable</b>(<i></i>) | |
| 254 | |
| 255 <p> | |
| 256 Public method to get the number of available bytes. | |
| 257 </p> | |
| 258 <dl> | |
| 259 <dt>Return:</dt> | |
| 260 <dd> | |
| 261 number of available bytes | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <dl> | |
| 265 <dt>Return Type:</dt> | |
| 266 <dd> | |
| 267 int | |
| 268 </dd> | |
| 269 </dl> | |
| 270 <a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a> | |
| 271 <h4>QtHelpSchemeReply.close</h4> | |
| 272 <b>close</b>(<i></i>) | |
| 273 | |
| 274 <p> | |
| 275 Public method used to cloase the reply. | |
| 276 </p> | |
| 277 <a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a> | |
| 278 <h4>QtHelpSchemeReply.mimeType</h4> | |
| 279 <b>mimeType</b>(<i></i>) | |
| 280 | |
| 281 <p> | |
| 282 Public method to get the reply mime type. | |
| 283 </p> | |
| 284 <dl> | |
| 285 <dt>Return:</dt> | |
| 286 <dd> | |
| 287 mime type of the reply | |
| 288 </dd> | |
| 289 </dl> | |
| 290 <dl> | |
| 291 <dt>Return Type:</dt> | |
| 292 <dd> | |
| 293 bytes | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a> | |
| 297 <h4>QtHelpSchemeReply.readData</h4> | |
| 298 <b>readData</b>(<i>maxlen</i>) | |
| 299 | |
| 300 <p> | |
| 301 Public method to retrieve data from the reply object. | |
| 302 </p> | |
| 303 <dl> | |
| 304 | |
| 305 <dt><i>maxlen</i></dt> | |
| 306 <dd> | |
| 307 maximum number of bytes to read (integer) | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <dl> | |
| 311 <dt>Return:</dt> | |
| 312 <dd> | |
| 313 string containing the data (bytes) | |
| 314 </dd> | |
| 315 </dl> | |
| 316 <div align="right"><a href="#top">Up</a></div> | |
| 317 <hr /> | |
| 318 </body></html> |
