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 10479
856476537696
parent 10431
64157aeb0312
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.QtHelpSchemeHandler</h1> 9 <h1>eric7.QtHelpInterface.QtHelpSchemeHandler</h1>
10
11 <p> 10 <p>
12 Module implementing a scheme access handler for QtHelp. 11 Module implementing a scheme access handler for QtHelp.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>ExtensionMap</td></tr>
17 <tr><td>ExtensionMap</td></tr><tr><td>QtDocPath</td></tr> 17 <tr><td>QtDocPath</td></tr>
18 </table> 18 </table>
19
19 <h3>Classes</h3> 20 <h3>Classes</h3>
20 21 <table>
21 <table>
22
23 <tr> 22 <tr>
24 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td> 23 <td><a href="#QtHelpSchemeHandler">QtHelpSchemeHandler</a></td>
25 <td>Class implementing a scheme handler for the qthelp: scheme.</td> 24 <td>Class implementing a scheme handler for the qthelp: scheme.</td>
26 </tr> 25 </tr>
27 <tr> 26 <tr>
28 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td> 27 <td><a href="#QtHelpSchemeReply">QtHelpSchemeReply</a></td>
29 <td>Class implementing a reply for a requested qthelp: page.</td> 28 <td>Class implementing a reply for a requested qthelp: page.</td>
30 </tr> 29 </tr>
31 </table> 30 </table>
31
32 <h3>Functions</h3> 32 <h3>Functions</h3>
33 33 <table>
34 <table> 34 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 35 </table>
36 </table> 36
37 <hr /> 37 <hr />
38 <hr /> 38 <hr />
39 <a NAME="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a> 39 <a NAME="QtHelpSchemeHandler" ID="QtHelpSchemeHandler"></a>
40 <h2>QtHelpSchemeHandler</h2> 40 <h2>QtHelpSchemeHandler</h2>
41
42 <p> 41 <p>
43 Class implementing a scheme handler for the qthelp: scheme. 42 Class implementing a scheme handler for the qthelp: scheme.
44 </p> 43 </p>
44
45 <h3>Derived from</h3> 45 <h3>Derived from</h3>
46 QWebEngineUrlSchemeHandler 46 QWebEngineUrlSchemeHandler
47 <h3>Class Attributes</h3> 47 <h3>Class Attributes</h3>
48 48 <table>
49 <table> 49 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 50 </table>
51 </table> 51
52 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
53 53 <table>
54 <table> 54 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 55 </table>
56 </table> 56
57 <h3>Methods</h3> 57 <h3>Methods</h3>
58 58 <table>
59 <table>
60
61 <tr> 59 <tr>
62 <td><a href="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td> 60 <td><a href="#QtHelpSchemeHandler.__init__">QtHelpSchemeHandler</a></td>
63 <td>Constructor</td> 61 <td>Constructor</td>
64 </tr> 62 </tr>
65 <tr> 63 <tr>
69 <tr> 67 <tr>
70 <td><a href="#QtHelpSchemeHandler.requestStarted">requestStarted</a></td> 68 <td><a href="#QtHelpSchemeHandler.requestStarted">requestStarted</a></td>
71 <td>Public method handling the URL request.</td> 69 <td>Public method handling the URL request.</td>
72 </tr> 70 </tr>
73 </table> 71 </table>
72
74 <h3>Static Methods</h3> 73 <h3>Static Methods</h3>
75 74 <table>
76 <table> 75 <tr><td>None</td></tr>
77 <tr><td>None</td></tr> 76 </table>
78 </table> 77
79 78
80 <a NAME="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a> 79 <a NAME="QtHelpSchemeHandler.__init__" ID="QtHelpSchemeHandler.__init__"></a>
81 <h4>QtHelpSchemeHandler (Constructor)</h4> 80 <h4>QtHelpSchemeHandler (Constructor)</h4>
82 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>) 81 <b>QtHelpSchemeHandler</b>(<i>engine, parent=None</i>)
83
84 <p> 82 <p>
85 Constructor 83 Constructor
86 </p> 84 </p>
85
87 <dl> 86 <dl>
88 87
89 <dt><i>engine</i> (QHelpEngine)</dt> 88 <dt><i>engine</i> (QHelpEngine)</dt>
90 <dd> 89 <dd>
91 reference to the help engine 90 reference to the help engine
96 </dd> 95 </dd>
97 </dl> 96 </dl>
98 <a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a> 97 <a NAME="QtHelpSchemeHandler.__replyClosed" ID="QtHelpSchemeHandler.__replyClosed"></a>
99 <h4>QtHelpSchemeHandler.__replyClosed</h4> 98 <h4>QtHelpSchemeHandler.__replyClosed</h4>
100 <b>__replyClosed</b>(<i>reply</i>) 99 <b>__replyClosed</b>(<i>reply</i>)
101
102 <p> 100 <p>
103 Private slot handling the closed signal of a reply. 101 Private slot handling the closed signal of a reply.
104 </p> 102 </p>
103
105 <dl> 104 <dl>
106 105
107 <dt><i>reply</i> (QtHelpSchemeReply)</dt> 106 <dt><i>reply</i> (QtHelpSchemeReply)</dt>
108 <dd> 107 <dd>
109 reference to the network reply 108 reference to the network reply
110 </dd> 109 </dd>
111 </dl> 110 </dl>
112 <a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a> 111 <a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a>
113 <h4>QtHelpSchemeHandler.requestStarted</h4> 112 <h4>QtHelpSchemeHandler.requestStarted</h4>
114 <b>requestStarted</b>(<i>job</i>) 113 <b>requestStarted</b>(<i>job</i>)
115
116 <p> 114 <p>
117 Public method handling the URL request. 115 Public method handling the URL request.
118 </p> 116 </p>
117
119 <dl> 118 <dl>
120 119
121 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> 120 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
122 <dd> 121 <dd>
123 URL request job 122 URL request job
126 <div align="right"><a href="#top">Up</a></div> 125 <div align="right"><a href="#top">Up</a></div>
127 <hr /> 126 <hr />
128 <hr /> 127 <hr />
129 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a> 128 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a>
130 <h2>QtHelpSchemeReply</h2> 129 <h2>QtHelpSchemeReply</h2>
131
132 <p> 130 <p>
133 Class implementing a reply for a requested qthelp: page. 131 Class implementing a reply for a requested qthelp: page.
134 </p> 132 </p>
133
135 <h3>Signals</h3> 134 <h3>Signals</h3>
136 <dl> 135 <dl>
137 136
138 <dt>closed</dt> 137 <dt>closed</dt>
139 <dd> 138 <dd>
142 </dd> 141 </dd>
143 </dl> 142 </dl>
144 <h3>Derived from</h3> 143 <h3>Derived from</h3>
145 QIODevice 144 QIODevice
146 <h3>Class Attributes</h3> 145 <h3>Class Attributes</h3>
147 146 <table>
148 <table> 147 <tr><td>None</td></tr>
149 <tr><td>None</td></tr> 148 </table>
150 </table> 149
151 <h3>Class Methods</h3> 150 <h3>Class Methods</h3>
152 151 <table>
153 <table> 152 <tr><td>None</td></tr>
154 <tr><td>None</td></tr> 153 </table>
155 </table> 154
156 <h3>Methods</h3> 155 <h3>Methods</h3>
157 156 <table>
158 <table>
159
160 <tr> 157 <tr>
161 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td> 158 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td>
162 <td>Constructor</td> 159 <td>Constructor</td>
163 </tr> 160 </tr>
164 <tr> 161 <tr>
184 <tr> 181 <tr>
185 <td><a href="#QtHelpSchemeReply.readData">readData</a></td> 182 <td><a href="#QtHelpSchemeReply.readData">readData</a></td>
186 <td>Public method to retrieve data from the reply object.</td> 183 <td>Public method to retrieve data from the reply object.</td>
187 </tr> 184 </tr>
188 </table> 185 </table>
186
189 <h3>Static Methods</h3> 187 <h3>Static Methods</h3>
190 188 <table>
191 <table> 189 <tr><td>None</td></tr>
192 <tr><td>None</td></tr> 190 </table>
193 </table> 191
194 192
195 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a> 193 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a>
196 <h4>QtHelpSchemeReply (Constructor)</h4> 194 <h4>QtHelpSchemeReply (Constructor)</h4>
197 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>) 195 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>)
198
199 <p> 196 <p>
200 Constructor 197 Constructor
201 </p> 198 </p>
199
202 <dl> 200 <dl>
203 201
204 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt> 202 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
205 <dd> 203 <dd>
206 reference to the URL request 204 reference to the URL request
215 </dd> 213 </dd>
216 </dl> 214 </dl>
217 <a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a> 215 <a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a>
218 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4> 216 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4>
219 <b>__loadQtHelpPage</b>(<i>url</i>) 217 <b>__loadQtHelpPage</b>(<i>url</i>)
220
221 <p> 218 <p>
222 Private method to load the requested QtHelp page. 219 Private method to load the requested QtHelp page.
223 </p> 220 </p>
221
224 <dl> 222 <dl>
225 223
226 <dt><i>url</i> (QUrl)</dt> 224 <dt><i>url</i> (QUrl)</dt>
227 <dd> 225 <dd>
228 URL of the requested page 226 URL of the requested page
229 </dd> 227 </dd>
230 </dl> 228 </dl>
231 <a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a> 229 <a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a>
232 <h4>QtHelpSchemeReply.__mimeFromUrl</h4> 230 <h4>QtHelpSchemeReply.__mimeFromUrl</h4>
233 <b>__mimeFromUrl</b>(<i>url</i>) 231 <b>__mimeFromUrl</b>(<i>url</i>)
234
235 <p> 232 <p>
236 Private method to guess the mime type given an URL. 233 Private method to guess the mime type given an URL.
237 </p> 234 </p>
235
238 <dl> 236 <dl>
239 237
240 <dt><i>url</i> (QUrl)</dt> 238 <dt><i>url</i> (QUrl)</dt>
241 <dd> 239 <dd>
242 URL to guess the mime type from 240 URL to guess the mime type from
255 </dd> 253 </dd>
256 </dl> 254 </dl>
257 <a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a> 255 <a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a>
258 <h4>QtHelpSchemeReply.bytesAvailable</h4> 256 <h4>QtHelpSchemeReply.bytesAvailable</h4>
259 <b>bytesAvailable</b>(<i></i>) 257 <b>bytesAvailable</b>(<i></i>)
260
261 <p> 258 <p>
262 Public method to get the number of available bytes. 259 Public method to get the number of available bytes.
263 </p> 260 </p>
261
264 <dl> 262 <dl>
265 <dt>Return:</dt> 263 <dt>Return:</dt>
266 <dd> 264 <dd>
267 number of available bytes 265 number of available bytes
268 </dd> 266 </dd>
274 </dd> 272 </dd>
275 </dl> 273 </dl>
276 <a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a> 274 <a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a>
277 <h4>QtHelpSchemeReply.close</h4> 275 <h4>QtHelpSchemeReply.close</h4>
278 <b>close</b>(<i></i>) 276 <b>close</b>(<i></i>)
279
280 <p> 277 <p>
281 Public method used to cloase the reply. 278 Public method used to cloase the reply.
282 </p> 279 </p>
280
283 <a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a> 281 <a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a>
284 <h4>QtHelpSchemeReply.mimeType</h4> 282 <h4>QtHelpSchemeReply.mimeType</h4>
285 <b>mimeType</b>(<i></i>) 283 <b>mimeType</b>(<i></i>)
286
287 <p> 284 <p>
288 Public method to get the reply mime type. 285 Public method to get the reply mime type.
289 </p> 286 </p>
287
290 <dl> 288 <dl>
291 <dt>Return:</dt> 289 <dt>Return:</dt>
292 <dd> 290 <dd>
293 mime type of the reply 291 mime type of the reply
294 </dd> 292 </dd>
300 </dd> 298 </dd>
301 </dl> 299 </dl>
302 <a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a> 300 <a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a>
303 <h4>QtHelpSchemeReply.readData</h4> 301 <h4>QtHelpSchemeReply.readData</h4>
304 <b>readData</b>(<i>maxlen</i>) 302 <b>readData</b>(<i>maxlen</i>)
305
306 <p> 303 <p>
307 Public method to retrieve data from the reply object. 304 Public method to retrieve data from the reply object.
308 </p> 305 </p>
306
309 <dl> 307 <dl>
310 308
311 <dt><i>maxlen</i> (int)</dt> 309 <dt><i>maxlen</i> (int)</dt>
312 <dd> 310 <dd>
313 maximum number of bytes to read 311 maximum number of bytes to read

Mercurial Repository: eric

eric ide

mercurial