Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 6507
54054456ca58
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
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>reply</i>)
93 <p>
94 Private slot handling the closed signal of a reply.
95 </p><dl>
96 <dt><i>reply</i> (QtHelpSchemeReply)</dt>
97 <dd>
98 reference to the network reply
99 </dd>
100 </dl><a NAME="QtHelpSchemeHandler.requestStarted" ID="QtHelpSchemeHandler.requestStarted"></a>
101 <h4>QtHelpSchemeHandler.requestStarted</h4>
102 <b>requestStarted</b>(<i>job</i>)
103 <p>
104 Public method handling the URL request.
105 </p><dl>
106 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
107 <dd>
108 URL request job
109 </dd>
110 </dl>
111 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr />
113 <a NAME="QtHelpSchemeReply" ID="QtHelpSchemeReply"></a>
114 <h2>QtHelpSchemeReply</h2>
115 <p>
116 Class implementing a reply for a requested qthelp: page.
117 </p><h3>Signals</h3>
118 <dl>
119 <dt>closed</dt>
120 <dd>
121 emitted to signal that the web engine has read
122 the data
123 </dd>
124 </dl>
125 <h3>Derived from</h3>
126 QIODevice
127 <h3>Class Attributes</h3>
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131 <h3>Class Methods</h3>
132 <table>
133 <tr><td>None</td></tr>
134 </table>
135 <h3>Methods</h3>
136 <table>
137 <tr>
138 <td><a href="#QtHelpSchemeReply.__init__">QtHelpSchemeReply</a></td>
139 <td>Constructor</td>
140 </tr><tr>
141 <td><a href="#QtHelpSchemeReply.__loadQtHelpPage">__loadQtHelpPage</a></td>
142 <td>Private method to load the requested QtHelp page.</td>
143 </tr><tr>
144 <td><a href="#QtHelpSchemeReply.__mimeFromUrl">__mimeFromUrl</a></td>
145 <td>Private method to guess the mime type given an URL.</td>
146 </tr><tr>
147 <td><a href="#QtHelpSchemeReply.bytesAvailable">bytesAvailable</a></td>
148 <td>Public method to get the number of available bytes.</td>
149 </tr><tr>
150 <td><a href="#QtHelpSchemeReply.close">close</a></td>
151 <td>Public method used to cloase the reply.</td>
152 </tr><tr>
153 <td><a href="#QtHelpSchemeReply.mimeType">mimeType</a></td>
154 <td>Public method to get the reply mime type.</td>
155 </tr><tr>
156 <td><a href="#QtHelpSchemeReply.readData">readData</a></td>
157 <td>Public method to retrieve data from the reply object.</td>
158 </tr>
159 </table>
160 <h3>Static Methods</h3>
161 <table>
162 <tr><td>None</td></tr>
163 </table>
164 <a NAME="QtHelpSchemeReply.__init__" ID="QtHelpSchemeReply.__init__"></a>
165 <h4>QtHelpSchemeReply (Constructor)</h4>
166 <b>QtHelpSchemeReply</b>(<i>job, engine, parent=None</i>)
167 <p>
168 Constructor
169 </p><dl>
170 <dt><i>job</i> (QWebEngineUrlRequestJob)</dt>
171 <dd>
172 reference to the URL request
173 </dd><dt><i>engine</i> (QHelpEngine)</dt>
174 <dd>
175 reference to the help engine
176 </dd><dt><i>parent</i> (QObject)</dt>
177 <dd>
178 reference to the parent object
179 </dd>
180 </dl><a NAME="QtHelpSchemeReply.__loadQtHelpPage" ID="QtHelpSchemeReply.__loadQtHelpPage"></a>
181 <h4>QtHelpSchemeReply.__loadQtHelpPage</h4>
182 <b>__loadQtHelpPage</b>(<i>url</i>)
183 <p>
184 Private method to load the requested QtHelp page.
185 </p><dl>
186 <dt><i>url</i> (QUrl)</dt>
187 <dd>
188 URL of the requested page
189 </dd>
190 </dl><a NAME="QtHelpSchemeReply.__mimeFromUrl" ID="QtHelpSchemeReply.__mimeFromUrl"></a>
191 <h4>QtHelpSchemeReply.__mimeFromUrl</h4>
192 <b>__mimeFromUrl</b>(<i>url</i>)
193 <p>
194 Private method to guess the mime type given an URL.
195 </p><dl>
196 <dt><i>url</i></dt>
197 <dd>
198 URL to guess the mime type from (QUrl)
199 </dd>
200 </dl><dl>
201 <dt>Returns:</dt>
202 <dd>
203 mime type for the given URL (string)
204 </dd>
205 </dl><a NAME="QtHelpSchemeReply.bytesAvailable" ID="QtHelpSchemeReply.bytesAvailable"></a>
206 <h4>QtHelpSchemeReply.bytesAvailable</h4>
207 <b>bytesAvailable</b>(<i></i>)
208 <p>
209 Public method to get the number of available bytes.
210 </p><dl>
211 <dt>Returns:</dt>
212 <dd>
213 number of available bytes
214 </dd>
215 </dl><dl>
216 <dt>Return Type:</dt>
217 <dd>
218 int
219 </dd>
220 </dl><a NAME="QtHelpSchemeReply.close" ID="QtHelpSchemeReply.close"></a>
221 <h4>QtHelpSchemeReply.close</h4>
222 <b>close</b>(<i></i>)
223 <p>
224 Public method used to cloase the reply.
225 </p><a NAME="QtHelpSchemeReply.mimeType" ID="QtHelpSchemeReply.mimeType"></a>
226 <h4>QtHelpSchemeReply.mimeType</h4>
227 <b>mimeType</b>(<i></i>)
228 <p>
229 Public method to get the reply mime type.
230 </p><dl>
231 <dt>Returns:</dt>
232 <dd>
233 mime type of the reply
234 </dd>
235 </dl><dl>
236 <dt>Return Type:</dt>
237 <dd>
238 bytes
239 </dd>
240 </dl><a NAME="QtHelpSchemeReply.readData" ID="QtHelpSchemeReply.readData"></a>
241 <h4>QtHelpSchemeReply.readData</h4>
242 <b>readData</b>(<i>maxlen</i>)
243 <p>
244 Public method to retrieve data from the reply object.
245 </p><dl>
246 <dt><i>maxlen</i></dt>
247 <dd>
248 maximum number of bytes to read (integer)
249 </dd>
250 </dl><dl>
251 <dt>Returns:</dt>
252 <dd>
253 string containing the data (bytes)
254 </dd>
255 </dl>
256 <div align="right"><a href="#top">Up</a></div>
257 <hr />
258 </body></html>

Mercurial Repository: eric

eric ide

mercurial