Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial