Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
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.QtHelpSchemeHandler</h1> 23 <h1>eric6.WebBrowser.Network.QtHelpSchemeHandler</h1>
24
23 <p> 25 <p>
24 Module implementing a scheme access handler for QtHelp. 26 Module implementing a scheme access handler for QtHelp.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr> 31 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</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="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td> 38 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td>
34 <td>Class implementing a scheme handler for the qthelp: scheme.</td> 39 <td>Class implementing a scheme handler for the qthelp: scheme.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td> 42 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td>
37 <td>Class implementing a reply for a requested qthelp: page.</td> 43 <td>Class implementing a reply for a requested qthelp: 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="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a> 53 <a NAME="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a>
46 <h2>QtHelpSchemeHandler</h2> 54 <h2>QtHelpSchemeHandler</h2>
55
47 <p> 56 <p>
48 Class implementing a scheme handler for the qthelp: scheme. 57 Class implementing a scheme handler for the qthelp: 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>None</td></tr> 64 <tr><td>None</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="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td> 76 <td><a href="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#QtHelpSchemeHandler.__replyClosed">__replyClosed</a></td> 80 <td><a href="#QtHelpSchemeHandler.__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="#QtHelpSchemeHandler.requestStarted">requestStarted</a></td> 84 <td><a href="#QtHelpSchemeHandler.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="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a> 94 <a NAME="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a>
78 <h4>QtHelpSchemeHandler (Constructor)</h4> 95 <h4>QtHelpSchemeHandler (Constructor)</h4>
79 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>) 96 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>)
97
80 <p> 98 <p>
81 Constructor 99 Constructor
82 </p><dl> 100 </p>
101 <dl>
102
83 <dt><i>engine</i> (QHelpEngine)</dt> 103 <dt><i>engine</i> (QHelpEngine)</dt>
84 <dd> 104 <dd>
85 reference to the help engine 105 reference to the help engine
86 </dd><dt><i>parent</i> (QObject)</dt> 106 </dd>
107 <dt><i>parent</i> (QObject)</dt>
87 <dd> 108 <dd>
88 reference to the parent object 109 reference to the parent object
89 </dd> 110 </dd>
90 </dl><a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a> 111 </dl>
112 <a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a>
91 <h4>QtHelpSchemeHandler.__replyClosed</h4> 113 <h4>QtHelpSchemeHandler.__replyClosed</h4>
92 <b>__replyClosed</b>(<i>reply</i>) 114 <b>__replyClosed</b>(<i>reply</i>)
115
93 <p> 116 <p>
94 Private slot handling the closed signal of a reply. 117 Private slot handling the closed signal of a reply.
95 </p><dl> 118 </p>
119 <dl>
120
96 <dt><i>reply</i> (QtHelpSchemeReply)</dt> 121 <dt><i>reply</i> (QtHelpSchemeReply)</dt>
97 <dd> 122 <dd>
98 reference to the network reply 123 reference to the network reply
99 </dd> 124 </dd>
100 </dl><a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a> 125 </dl>
126 <a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a>
101 <h4>QtHelpSchemeHandler.requestStarted</h4> 127 <h4>QtHelpSchemeHandler.requestStarted</h4>
102 <b>requestStarted</b>(<i>job</i>) 128 <b>requestStarted</b>(<i>job</i>)
129
103 <p> 130 <p>
104 Public method handling the URL request. 131 Public method handling the URL request.
105 </p><dl> 132 </p>
133 <dl>
134
106 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> 135 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
107 <dd> 136 <dd>
108 URL request job 137 URL request job
109 </dd> 138 </dd>
110 </dl> 139 </dl>
111 <div align="right"><a href="#top">Up</a></div> 140 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr /> 141 <hr />
142 <hr />
113 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a> 143 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a>
114 <h2>QtHelpSchemeReply</h2> 144 <h2>QtHelpSchemeReply</h2>
145
115 <p> 146 <p>
116 Class implementing a reply for a requested qthelp: page. 147 Class implementing a reply for a requested qthelp: page.
117 </p><h3>Signals</h3> 148 </p>
118 <dl> 149 <h3>Signals</h3>
150 <dl>
151
119 <dt>closed</dt> 152 <dt>closed</dt>
120 <dd> 153 <dd>
121 emitted to signal that the web engine has read 154 emitted to signal that the web engine has read
122 the data 155 the data
123 </dd> 156 </dd>
124 </dl> 157 </dl>
125 <h3>Derived from</h3> 158 <h3>Derived from</h3>
126 QIODevice 159 QIODevice
127 <h3>Class Attributes</h3> 160 <h3>Class Attributes</h3>
161
128 <table> 162 <table>
129 <tr><td>None</td></tr> 163 <tr><td>None</td></tr>
130 </table> 164 </table>
131 <h3>Class Methods</h3> 165 <h3>Class Methods</h3>
166
132 <table> 167 <table>
133 <tr><td>None</td></tr> 168 <tr><td>None</td></tr>
134 </table> 169 </table>
135 <h3>Methods</h3> 170 <h3>Methods</h3>
136 <table> 171
172 <table>
173
137 <tr> 174 <tr>
138 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td> 175 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td>
139 <td>Constructor</td> 176 <td>Constructor</td>
140 </tr><tr> 177 </tr>
178 <tr>
141 <td><a href="#QtHelpSchemeReply.__loadQtHelpPage">__loadQtHelpPage</a></td> 179 <td><a href="#QtHelpSchemeReply.__loadQtHelpPage">__loadQtHelpPage</a></td>
142 <td>Private method to load the requested QtHelp page.</td> 180 <td>Private method to load the requested QtHelp page.</td>
143 </tr><tr> 181 </tr>
182 <tr>
144 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td> 183 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td>
145 <td>Private method to guess the mime type given an URL.</td> 184 <td>Private method to guess the mime type given an URL.</td>
146 </tr><tr> 185 </tr>
186 <tr>
147 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td> 187 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td>
148 <td>Public method to get the number of available bytes.</td> 188 <td>Public method to get the number of available bytes.</td>
149 </tr><tr> 189 </tr>
190 <tr>
150 <td><a href="#QtHelpSchemeReply.close">close</a></td> 191 <td><a href="#QtHelpSchemeReply.close">close</a></td>
151 <td>Public method used to cloase the reply.</td> 192 <td>Public method used to cloase the reply.</td>
152 </tr><tr> 193 </tr>
194 <tr>
153 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td> 195 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td>
154 <td>Public method to get the reply mime type.</td> 196 <td>Public method to get the reply mime type.</td>
155 </tr><tr> 197 </tr>
198 <tr>
156 <td><a href="#QtHelpSchemeReply.readData">readData</a></td> 199 <td><a href="#QtHelpSchemeReply.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="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a> 209 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a>
165 <h4>QtHelpSchemeReply (Constructor)</h4> 210 <h4>QtHelpSchemeReply (Constructor)</h4>
166 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>) 211 <b>QtHelpSchemeReply</b>(<i>job, engine, 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>engine</i> (QHelpEngine)</dt> 221 </dd>
222 <dt><i>engine</i> (QHelpEngine)</dt>
174 <dd> 223 <dd>
175 reference to the help engine 224 reference to the help engine
176 </dd><dt><i>parent</i> (QObject)</dt> 225 </dd>
226 <dt><i>parent</i> (QObject)</dt>
177 <dd> 227 <dd>
178 reference to the parent object 228 reference to the parent object
179 </dd> 229 </dd>
180 </dl><a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a> 230 </dl>
231 <a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a>
181 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4> 232 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4>
182 <b>__loadQtHelpPage</b>(<i>url</i>) 233 <b>__loadQtHelpPage</b>(<i>url</i>)
234
183 <p> 235 <p>
184 Private method to load the requested QtHelp page. 236 Private method to load the requested QtHelp page.
185 </p><dl> 237 </p>
238 <dl>
239
186 <dt><i>url</i> (QUrl)</dt> 240 <dt><i>url</i> (QUrl)</dt>
187 <dd> 241 <dd>
188 URL of the requested page 242 URL of the requested page
189 </dd> 243 </dd>
190 </dl><a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a> 244 </dl>
245 <a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a>
191 <h4>QtHelpSchemeReply.__mimeFromUrl</h4> 246 <h4>QtHelpSchemeReply.__mimeFromUrl</h4>
192 <b>__mimeFromUrl</b>(<i>url</i>) 247 <b>__mimeFromUrl</b>(<i>url</i>)
248
193 <p> 249 <p>
194 Private method to guess the mime type given an URL. 250 Private method to guess the mime type given an URL.
195 </p><dl> 251 </p>
252 <dl>
253
196 <dt><i>url</i></dt> 254 <dt><i>url</i></dt>
197 <dd> 255 <dd>
198 URL to guess the mime type from (QUrl) 256 URL to guess the mime type from (QUrl)
199 </dd> 257 </dd>
200 </dl><dl> 258 </dl>
259 <dl>
201 <dt>Returns:</dt> 260 <dt>Returns:</dt>
202 <dd> 261 <dd>
203 mime type for the given URL (string) 262 mime type for the given URL (string)
204 </dd> 263 </dd>
205 </dl><a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a> 264 </dl>
265 <a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a>
206 <h4>QtHelpSchemeReply.bytesAvailable</h4> 266 <h4>QtHelpSchemeReply.bytesAvailable</h4>
207 <b>bytesAvailable</b>(<i></i>) 267 <b>bytesAvailable</b>(<i></i>)
268
208 <p> 269 <p>
209 Public method to get the number of available bytes. 270 Public method to get the number of available bytes.
210 </p><dl> 271 </p>
272 <dl>
211 <dt>Returns:</dt> 273 <dt>Returns:</dt>
212 <dd> 274 <dd>
213 number of available bytes 275 number of available bytes
214 </dd> 276 </dd>
215 </dl><dl> 277 </dl>
278 <dl>
216 <dt>Return Type:</dt> 279 <dt>Return Type:</dt>
217 <dd> 280 <dd>
218 int 281 int
219 </dd> 282 </dd>
220 </dl><a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a> 283 </dl>
284 <a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a>
221 <h4>QtHelpSchemeReply.close</h4> 285 <h4>QtHelpSchemeReply.close</h4>
222 <b>close</b>(<i></i>) 286 <b>close</b>(<i></i>)
287
223 <p> 288 <p>
224 Public method used to cloase the reply. 289 Public method used to cloase the reply.
225 </p><a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a> 290 </p>
291 <a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a>
226 <h4>QtHelpSchemeReply.mimeType</h4> 292 <h4>QtHelpSchemeReply.mimeType</h4>
227 <b>mimeType</b>(<i></i>) 293 <b>mimeType</b>(<i></i>)
294
228 <p> 295 <p>
229 Public method to get the reply mime type. 296 Public method to get the reply mime type.
230 </p><dl> 297 </p>
298 <dl>
231 <dt>Returns:</dt> 299 <dt>Returns:</dt>
232 <dd> 300 <dd>
233 mime type of the reply 301 mime type of the reply
234 </dd> 302 </dd>
235 </dl><dl> 303 </dl>
304 <dl>
236 <dt>Return Type:</dt> 305 <dt>Return Type:</dt>
237 <dd> 306 <dd>
238 bytes 307 bytes
239 </dd> 308 </dd>
240 </dl><a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a> 309 </dl>
310 <a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a>
241 <h4>QtHelpSchemeReply.readData</h4> 311 <h4>QtHelpSchemeReply.readData</h4>
242 <b>readData</b>(<i>maxlen</i>) 312 <b>readData</b>(<i>maxlen</i>)
313
243 <p> 314 <p>
244 Public method to retrieve data from the reply object. 315 Public method to retrieve data from the reply object.
245 </p><dl> 316 </p>
317 <dl>
318
246 <dt><i>maxlen</i></dt> 319 <dt><i>maxlen</i></dt>
247 <dd> 320 <dd>
248 maximum number of bytes to read (integer) 321 maximum number of bytes to read (integer)
249 </dd> 322 </dd>
250 </dl><dl> 323 </dl>
324 <dl>
251 <dt>Returns:</dt> 325 <dt>Returns:</dt>
252 <dd> 326 <dd>
253 string containing the data (bytes) 327 string containing the data (bytes)
254 </dd> 328 </dd>
255 </dl> 329 </dl>

Mercurial Repository: eric

eric ide

mercurial