Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html
Documentation/Source/eric6.WebBrowser.Network.QtHelpSchemeHandler.html
- changeset 4918
- 71caf42a13d8
- child 6123
- 39cd368143db
equal
deleted
inserted
replaced
| 4917:682750cc7bd5 | 4918:71caf42a13d8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.Network.QtHelpSchemeHandler</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.QtHelpSchemeHandler</h1> | |
| 23 <p> | |
| 24 Module implementing a scheme access handler for QtHelp. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td> | |
| 34 <td>Class implementing a scheme handler for the qthelp: scheme.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td> | |
| 37 <td>Class implementing a reply for a requested qthelp: 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="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a> | |
| 46 <h2>QtHelpSchemeHandler</h2> | |
| 47 <p> | |
| 48 Class implementing a scheme handler for the qthelp: scheme. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QWebEngineUrlSchemeHandler | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</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="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#QtHelpSchemeHandler.__replyClosed">__replyClosed</a></td> | |
| 67 <td>Private slot handling the closed signal of a reply.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#QtHelpSchemeHandler.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="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a> | |
| 78 <h4>QtHelpSchemeHandler (Constructor)</h4> | |
| 79 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>) | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p><dl> | |
| 83 <dt><i>engine</i> (QHelpEngine)</dt> | |
| 84 <dd> | |
| 85 reference to the help engine | |
| 86 </dd><dt><i>parent</i> (QObject)</dt> | |
| 87 <dd> | |
| 88 reference to the parent object | |
| 89 </dd> | |
| 90 </dl><a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a> | |
| 91 <h4>QtHelpSchemeHandler.__replyClosed</h4> | |
| 92 <b>__replyClosed</b>(<i></i>) | |
| 93 <p> | |
| 94 Private slot handling the closed signal of a reply. | |
| 95 </p><a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a> | |
| 96 <h4>QtHelpSchemeHandler.requestStarted</h4> | |
| 97 <b>requestStarted</b>(<i>job</i>) | |
| 98 <p> | |
| 99 Public method handling the URL request. | |
| 100 </p><dl> | |
| 101 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 102 <dd> | |
| 103 URL request job | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /><hr /> | |
| 108 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a> | |
| 109 <h2>QtHelpSchemeReply</h2> | |
| 110 <p> | |
| 111 Class implementing a reply for a requested qthelp: page. | |
| 112 </p><h3>Signals</h3> | |
| 113 <dl> | |
| 114 <dt>closed</dt> | |
| 115 <dd> | |
| 116 emitted to signal that the web engine has read | |
| 117 the data | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <h3>Derived from</h3> | |
| 121 QIODevice | |
| 122 <h3>Class Attributes</h3> | |
| 123 <table> | |
| 124 <tr><td>None</td></tr> | |
| 125 </table> | |
| 126 <h3>Class Methods</h3> | |
| 127 <table> | |
| 128 <tr><td>None</td></tr> | |
| 129 </table> | |
| 130 <h3>Methods</h3> | |
| 131 <table> | |
| 132 <tr> | |
| 133 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td> | |
| 134 <td>Constructor</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td> | |
| 137 <td>Private method to guess the mime type given an URL.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td> | |
| 140 <td>Public method to get the number of available bytes.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#QtHelpSchemeReply.close">close</a></td> | |
| 143 <td>Public method used to cloase the reply.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td> | |
| 146 <td>Public method to get the reply mime type.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#QtHelpSchemeReply.readData">readData</a></td> | |
| 149 <td>Public method to retrieve data from the reply object.</td> | |
| 150 </tr> | |
| 151 </table> | |
| 152 <h3>Static Methods</h3> | |
| 153 <table> | |
| 154 <tr><td>None</td></tr> | |
| 155 </table> | |
| 156 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a> | |
| 157 <h4>QtHelpSchemeReply (Constructor)</h4> | |
| 158 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>) | |
| 159 <p> | |
| 160 Constructor | |
| 161 </p><dl> | |
| 162 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> | |
| 163 <dd> | |
| 164 reference to the URL request | |
| 165 </dd><dt><i>engine</i> (QHelpEngine)</dt> | |
| 166 <dd> | |
| 167 reference to the help engine | |
| 168 </dd><dt><i>parent</i> (QObject)</dt> | |
| 169 <dd> | |
| 170 reference to the parent object | |
| 171 </dd> | |
| 172 </dl><a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a> | |
| 173 <h4>QtHelpSchemeReply.__mimeFromUrl</h4> | |
| 174 <b>__mimeFromUrl</b>(<i>url</i>) | |
| 175 <p> | |
| 176 Private method to guess the mime type given an URL. | |
| 177 </p><dl> | |
| 178 <dt><i>url</i></dt> | |
| 179 <dd> | |
| 180 URL to guess the mime type from (QUrl) | |
| 181 </dd> | |
| 182 </dl><dl> | |
| 183 <dt>Returns:</dt> | |
| 184 <dd> | |
| 185 mime type for the given URL (string) | |
| 186 </dd> | |
| 187 </dl><a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a> | |
| 188 <h4>QtHelpSchemeReply.bytesAvailable</h4> | |
| 189 <b>bytesAvailable</b>(<i></i>) | |
| 190 <p> | |
| 191 Public method to get the number of available bytes. | |
| 192 </p><dl> | |
| 193 <dt>Returns:</dt> | |
| 194 <dd> | |
| 195 number of available bytes | |
| 196 </dd> | |
| 197 </dl><dl> | |
| 198 <dt>Return Type:</dt> | |
| 199 <dd> | |
| 200 int | |
| 201 </dd> | |
| 202 </dl><a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a> | |
| 203 <h4>QtHelpSchemeReply.close</h4> | |
| 204 <b>close</b>(<i></i>) | |
| 205 <p> | |
| 206 Public method used to cloase the reply. | |
| 207 </p><a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a> | |
| 208 <h4>QtHelpSchemeReply.mimeType</h4> | |
| 209 <b>mimeType</b>(<i></i>) | |
| 210 <p> | |
| 211 Public method to get the reply mime type. | |
| 212 </p><dl> | |
| 213 <dt>Returns:</dt> | |
| 214 <dd> | |
| 215 mime type of the reply | |
| 216 </dd> | |
| 217 </dl><dl> | |
| 218 <dt>Return Type:</dt> | |
| 219 <dd> | |
| 220 bytes | |
| 221 </dd> | |
| 222 </dl><a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a> | |
| 223 <h4>QtHelpSchemeReply.readData</h4> | |
| 224 <b>readData</b>(<i>maxlen</i>) | |
| 225 <p> | |
| 226 Public method to retrieve data from the reply object. | |
| 227 </p><dl> | |
| 228 <dt><i>maxlen</i></dt> | |
| 229 <dd> | |
| 230 maximum number of bytes to read (integer) | |
| 231 </dd> | |
| 232 </dl><dl> | |
| 233 <dt>Returns:</dt> | |
| 234 <dd> | |
| 235 string containing the data (bytes) | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <div align="right"><a href="#top">Up</a></div> | |
| 239 <hr /> | |
| 240 </body></html> |
