Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Helpviewer.HelpBrowserWV.html

Documentation/Source/eric6.Helpviewer.HelpBrowserWV.html

changeset 3673
e26d7d0c1088
child 4316
493891cbacee
child 4373
54d6d7c772ea
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpBrowserWV</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.Helpviewer.HelpBrowserWV</h1>
23 <p>
24 Module implementing the helpbrowser using QWebView.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#HelpBrowser">HelpBrowser</a></td>
34 <td>Class implementing the helpbrowser widget.</td>
35 </tr><tr>
36 <td><a href="#HelpWebPage">HelpWebPage</a></td>
37 <td>Class implementing an enhanced web page.</td>
38 </tr><tr>
39 <td><a href="#JavaScriptEricObject">JavaScriptEricObject</a></td>
40 <td>Class implementing an external javascript object to search via the startpage.</td>
41 </tr><tr>
42 <td><a href="#JavaScriptExternalObject">JavaScriptExternalObject</a></td>
43 <td>Class implementing an external javascript object to add search providers.</td>
44 </tr><tr>
45 <td><a href="#LinkedResource">LinkedResource</a></td>
46 <td>Class defining a data structure for linked resources.</td>
47 </tr>
48 </table>
49 <h3>Functions</h3>
50 <table>
51 <tr>
52 <td><a href="#contentSniff">contentSniff</a></td>
53 <td>Module function to do some content sniffing to check, if the data is HTML.</td>
54 </tr>
55 </table>
56 <hr /><hr />
57 <a NAME="HelpBrowser" ID="HelpBrowser"></a>
58 <h2>HelpBrowser</h2>
59 <p>
60 Class implementing the helpbrowser widget.
61 </p><p>
62 This is a subclass of the Qt QWebView to implement an
63 interface compatible with the QTextBrowser based variant.
64 </p><h3>Signals</h3>
65 <dl>
66 <dt>backwardAvailable(bool)</dt>
67 <dd>
68 emitted after the current URL has changed
69 </dd><dt>forwardAvailable(bool)</dt>
70 <dd>
71 emitted after the current URL has changed
72 </dd><dt>highlighted(str)</dt>
73 <dd>
74 emitted, when the mouse hovers over a link
75 </dd><dt>search(QUrl)</dt>
76 <dd>
77 emitted, when a search is requested
78 </dd><dt>sourceChanged(QUrl)</dt>
79 <dd>
80 emitted after the current URL has changed
81 </dd><dt>zoomValueChanged(int)</dt>
82 <dd>
83 emitted to signal a change of the zoom value
84 </dd>
85 </dl>
86 <h3>Derived from</h3>
87 QWebView
88 <h3>Class Attributes</h3>
89 <table>
90 <tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr>
91 </table>
92 <h3>Class Methods</h3>
93 <table>
94 <tr><td>None</td></tr>
95 </table>
96 <h3>Methods</h3>
97 <table>
98 <tr>
99 <td><a href="#HelpBrowser.__init__">HelpBrowser</a></td>
100 <td>Constructor</td>
101 </tr><tr>
102 <td><a href="#HelpBrowser.__accessKeyShortcut">__accessKeyShortcut</a></td>
103 <td>Private slot to switch the display of access keys.</td>
104 </tr><tr>
105 <td><a href="#HelpBrowser.__addExternalBinding">__addExternalBinding</a></td>
106 <td>Private slot to add javascript bindings for adding search providers.</td>
107 </tr><tr>
108 <td><a href="#HelpBrowser.__addSearchEngine">__addSearchEngine</a></td>
109 <td>Private slot to add a new search engine.</td>
110 </tr><tr>
111 <td><a href="#HelpBrowser.__applyZoom">__applyZoom</a></td>
112 <td>Private slot to apply the current zoom factor.</td>
113 </tr><tr>
114 <td><a href="#HelpBrowser.__blockImage">__blockImage</a></td>
115 <td>Private slot to add a block rule for an image URL.</td>
116 </tr><tr>
117 <td><a href="#HelpBrowser.__bookmarkLink">__bookmarkLink</a></td>
118 <td>Private slot to bookmark a link via the context menu.</td>
119 </tr><tr>
120 <td><a href="#HelpBrowser.__checkForAccessKey">__checkForAccessKey</a></td>
121 <td>Private method to check the existence of an access key and activate the corresponding link.</td>
122 </tr><tr>
123 <td><a href="#HelpBrowser.__copyImage">__copyImage</a></td>
124 <td>Private slot to copy an image to the clipboard.</td>
125 </tr><tr>
126 <td><a href="#HelpBrowser.__copyLink">__copyLink</a></td>
127 <td>Private slot to copy a link to the clipboard.</td>
128 </tr><tr>
129 <td><a href="#HelpBrowser.__copyLocation">__copyLocation</a></td>
130 <td>Private slot to copy an image or media location to the clipboard.</td>
131 </tr><tr>
132 <td><a href="#HelpBrowser.__currentEngineChanged">__currentEngineChanged</a></td>
133 <td>Private slot to track a change of the current search engine.</td>
134 </tr><tr>
135 <td><a href="#HelpBrowser.__dataString">__dataString</a></td>
136 <td>Private method to generate a formatted data string.</td>
137 </tr><tr>
138 <td><a href="#HelpBrowser.__databaseQuotaExceeded">__databaseQuotaExceeded</a></td>
139 <td>Private slot to handle the case, where the database quota is exceeded.</td>
140 </tr><tr>
141 <td><a href="#HelpBrowser.__downloadImage">__downloadImage</a></td>
142 <td>Private slot to download an image and save it to disk.</td>
143 </tr><tr>
144 <td><a href="#HelpBrowser.__downloadLink">__downloadLink</a></td>
145 <td>Private slot to download a link and save it to disk.</td>
146 </tr><tr>
147 <td><a href="#HelpBrowser.__downloadMedia">__downloadMedia</a></td>
148 <td>Private slot to download a media and save it to disk.</td>
149 </tr><tr>
150 <td><a href="#HelpBrowser.__downloadRequested">__downloadRequested</a></td>
151 <td>Private slot to handle a download request.</td>
152 </tr><tr>
153 <td><a href="#HelpBrowser.__generatePrintPreviewClickedFrame">__generatePrintPreviewClickedFrame</a></td>
154 <td>Private slot to generate a print preview of the clicked frame.</td>
155 </tr><tr>
156 <td><a href="#HelpBrowser.__hideAccessKeys">__hideAccessKeys</a></td>
157 <td>Private slot to hide the access key labels.</td>
158 </tr><tr>
159 <td><a href="#HelpBrowser.__isMediaElement">__isMediaElement</a></td>
160 <td>Private method to check, if the given element is a media element.</td>
161 </tr><tr>
162 <td><a href="#HelpBrowser.__isUrlValid">__isUrlValid</a></td>
163 <td>Private method to check a URL for validity.</td>
164 </tr><tr>
165 <td><a href="#HelpBrowser.__levelForZoom">__levelForZoom</a></td>
166 <td>Private method determining the zoom level index given a zoom factor.</td>
167 </tr><tr>
168 <td><a href="#HelpBrowser.__linkHovered">__linkHovered</a></td>
169 <td>Private slot to handle the linkHovered signal.</td>
170 </tr><tr>
171 <td><a href="#HelpBrowser.__loadClickedFrame">__loadClickedFrame</a></td>
172 <td>Private slot to load the selected frame only.</td>
173 </tr><tr>
174 <td><a href="#HelpBrowser.__loadFinished">__loadFinished</a></td>
175 <td>Private method to handle the loadFinished signal.</td>
176 </tr><tr>
177 <td><a href="#HelpBrowser.__loadProgress">__loadProgress</a></td>
178 <td>Private method to handle the loadProgress signal.</td>
179 </tr><tr>
180 <td><a href="#HelpBrowser.__loadStarted">__loadStarted</a></td>
181 <td>Private method to handle the loadStarted signal.</td>
182 </tr><tr>
183 <td><a href="#HelpBrowser.__makeAccessLabel">__makeAccessLabel</a></td>
184 <td>Private method to generate the access label for an element.</td>
185 </tr><tr>
186 <td><a href="#HelpBrowser.__muteMedia">__muteMedia</a></td>
187 <td>Private slot to (un)mute the selected media.</td>
188 </tr><tr>
189 <td><a href="#HelpBrowser.__openLinkInNewTab">__openLinkInNewTab</a></td>
190 <td>Private method called by the context menu to open a link in a new window.</td>
191 </tr><tr>
192 <td><a href="#HelpBrowser.__pauseMedia">__pauseMedia</a></td>
193 <td>Private slot to pause or play the selected media.</td>
194 </tr><tr>
195 <td><a href="#HelpBrowser.__printClickedFrame">__printClickedFrame</a></td>
196 <td>Private slot to print the selected frame.</td>
197 </tr><tr>
198 <td><a href="#HelpBrowser.__printPdfClickedFrame">__printPdfClickedFrame</a></td>
199 <td>Private slot to print the selected frame to PDF.</td>
200 </tr><tr>
201 <td><a href="#HelpBrowser.__printPreviewClickedFrame">__printPreviewClickedFrame</a></td>
202 <td>Private slot to show a print preview of the clicked frame.</td>
203 </tr><tr>
204 <td><a href="#HelpBrowser.__searchRequested">__searchRequested</a></td>
205 <td>Private slot to search for some text with a selected search engine.</td>
206 </tr><tr>
207 <td><a href="#HelpBrowser.__sendLink">__sendLink</a></td>
208 <td>Private slot to send a link via email.</td>
209 </tr><tr>
210 <td><a href="#HelpBrowser.__showAccessKeys">__showAccessKeys</a></td>
211 <td>Private method to show the access key labels.</td>
212 </tr><tr>
213 <td><a href="#HelpBrowser.__showClickedFrameSource">__showClickedFrameSource</a></td>
214 <td>Private slot to show the source of the clicked frame.</td>
215 </tr><tr>
216 <td><a href="#HelpBrowser.__statusBarMessage">__statusBarMessage</a></td>
217 <td>Private slot to handle the statusBarMessage signal.</td>
218 </tr><tr>
219 <td><a href="#HelpBrowser.__unsupportedContent">__unsupportedContent</a></td>
220 <td>Private slot to handle the unsupportedContent signal.</td>
221 </tr><tr>
222 <td><a href="#HelpBrowser.__urlChanged">__urlChanged</a></td>
223 <td>Private slot to handle the urlChanged signal.</td>
224 </tr><tr>
225 <td><a href="#HelpBrowser.__virusTotal">__virusTotal</a></td>
226 <td>Private slot to scan the selected URL with VirusTotal.</td>
227 </tr><tr>
228 <td><a href="#HelpBrowser.__webInspector">__webInspector</a></td>
229 <td>Private slot to show the web inspector window.</td>
230 </tr><tr>
231 <td><a href="#HelpBrowser.__zoomInClickedFrame">__zoomInClickedFrame</a></td>
232 <td>Private slot to zoom into the clicked frame.</td>
233 </tr><tr>
234 <td><a href="#HelpBrowser.__zoomOutClickedFrame">__zoomOutClickedFrame</a></td>
235 <td>Private slot to zoom out of the clicked frame.</td>
236 </tr><tr>
237 <td><a href="#HelpBrowser.__zoomResetClickedFrame">__zoomResetClickedFrame</a></td>
238 <td>Private slot to reset the zoom factor of the clicked frame.</td>
239 </tr><tr>
240 <td><a href="#HelpBrowser.addBookmark">addBookmark</a></td>
241 <td>Public slot to bookmark the current page.</td>
242 </tr><tr>
243 <td><a href="#HelpBrowser.backward">backward</a></td>
244 <td>Public slot to move backwards in history.</td>
245 </tr><tr>
246 <td><a href="#HelpBrowser.checkRSS">checkRSS</a></td>
247 <td>Public method to check, if the loaded page contains feed links.</td>
248 </tr><tr>
249 <td><a href="#HelpBrowser.clearHistory">clearHistory</a></td>
250 <td>Public slot to clear the history.</td>
251 </tr><tr>
252 <td><a href="#HelpBrowser.contextMenuEvent">contextMenuEvent</a></td>
253 <td>Protected method called to create a context menu.</td>
254 </tr><tr>
255 <td><a href="#HelpBrowser.copy">copy</a></td>
256 <td>Public slot to copy the selected text.</td>
257 </tr><tr>
258 <td><a href="#HelpBrowser.createWindow">createWindow</a></td>
259 <td>Public method called, when a new window should be created.</td>
260 </tr><tr>
261 <td><a href="#HelpBrowser.documentTitle">documentTitle</a></td>
262 <td>Public method to return the title of the loaded page.</td>
263 </tr><tr>
264 <td><a href="#HelpBrowser.dragEnterEvent">dragEnterEvent</a></td>
265 <td>Protected method called by a drag enter event.</td>
266 </tr><tr>
267 <td><a href="#HelpBrowser.dragMoveEvent">dragMoveEvent</a></td>
268 <td>Protected method called by a drag move event.</td>
269 </tr><tr>
270 <td><a href="#HelpBrowser.dropEvent">dropEvent</a></td>
271 <td>Protected method called by a drop event.</td>
272 </tr><tr>
273 <td><a href="#HelpBrowser.event">event</a></td>
274 <td>Public method handling events.</td>
275 </tr><tr>
276 <td><a href="#HelpBrowser.findNextPrev">findNextPrev</a></td>
277 <td>Public slot to find the next occurrence of a text.</td>
278 </tr><tr>
279 <td><a href="#HelpBrowser.focusOutEvent">focusOutEvent</a></td>
280 <td>Protected method called by a focus out event.</td>
281 </tr><tr>
282 <td><a href="#HelpBrowser.forward">forward</a></td>
283 <td>Public slot to move forward in history.</td>
284 </tr><tr>
285 <td><a href="#HelpBrowser.gestureEvent">gestureEvent</a></td>
286 <td>Protected method handling gesture events.</td>
287 </tr><tr>
288 <td><a href="#HelpBrowser.getRSS">getRSS</a></td>
289 <td>Public method to get the extracted RSS feeds.</td>
290 </tr><tr>
291 <td><a href="#HelpBrowser.hasRSS">hasRSS</a></td>
292 <td>Public method to check, if the loaded page has RSS links.</td>
293 </tr><tr>
294 <td><a href="#HelpBrowser.hasSelection">hasSelection</a></td>
295 <td>Public method to determine, if there is some text selected.</td>
296 </tr><tr>
297 <td><a href="#HelpBrowser.home">home</a></td>
298 <td>Public slot to move to the first page loaded.</td>
299 </tr><tr>
300 <td><a href="#HelpBrowser.isBackwardAvailable">isBackwardAvailable</a></td>
301 <td>Public method to determine, if a backwards move in history is possible.</td>
302 </tr><tr>
303 <td><a href="#HelpBrowser.isForwardAvailable">isForwardAvailable</a></td>
304 <td>Public method to determine, if a forward move in history is possible.</td>
305 </tr><tr>
306 <td><a href="#HelpBrowser.isLoading">isLoading</a></td>
307 <td>Public method to get the loading state.</td>
308 </tr><tr>
309 <td><a href="#HelpBrowser.keyPressEvent">keyPressEvent</a></td>
310 <td>Protected method called by a key press.</td>
311 </tr><tr>
312 <td><a href="#HelpBrowser.keyReleaseEvent">keyReleaseEvent</a></td>
313 <td>Protected method called by a key release.</td>
314 </tr><tr>
315 <td><a href="#HelpBrowser.linkedResources">linkedResources</a></td>
316 <td>Public method to extract linked resources.</td>
317 </tr><tr>
318 <td><a href="#HelpBrowser.mousePressEvent">mousePressEvent</a></td>
319 <td>Protected method called by a mouse press event.</td>
320 </tr><tr>
321 <td><a href="#HelpBrowser.mouseReleaseEvent">mouseReleaseEvent</a></td>
322 <td>Protected method called by a mouse release event.</td>
323 </tr><tr>
324 <td><a href="#HelpBrowser.preferencesChanged">preferencesChanged</a></td>
325 <td>Public method to indicate a change of the settings.</td>
326 </tr><tr>
327 <td><a href="#HelpBrowser.progress">progress</a></td>
328 <td>Public method to get the load progress.</td>
329 </tr><tr>
330 <td><a href="#HelpBrowser.reload">reload</a></td>
331 <td>Public slot to reload the current page.</td>
332 </tr><tr>
333 <td><a href="#HelpBrowser.saveAs">saveAs</a></td>
334 <td>Public method to save the current page to a file.</td>
335 </tr><tr>
336 <td><a href="#HelpBrowser.setSource">setSource</a></td>
337 <td>Public method used to set the source to be displayed.</td>
338 </tr><tr>
339 <td><a href="#HelpBrowser.setZoomValue">setZoomValue</a></td>
340 <td>Public method to set the zoom value.</td>
341 </tr><tr>
342 <td><a href="#HelpBrowser.source">source</a></td>
343 <td>Public method to return the URL of the loaded page.</td>
344 </tr><tr>
345 <td><a href="#HelpBrowser.wheelEvent">wheelEvent</a></td>
346 <td>Protected method to handle wheel events.</td>
347 </tr><tr>
348 <td><a href="#HelpBrowser.zoomIn">zoomIn</a></td>
349 <td>Public slot to zoom into the page.</td>
350 </tr><tr>
351 <td><a href="#HelpBrowser.zoomOut">zoomOut</a></td>
352 <td>Public slot to zoom out of the page.</td>
353 </tr><tr>
354 <td><a href="#HelpBrowser.zoomReset">zoomReset</a></td>
355 <td>Public method to reset the zoom factor.</td>
356 </tr><tr>
357 <td><a href="#HelpBrowser.zoomValue">zoomValue</a></td>
358 <td>Public method to get the current zoom value.</td>
359 </tr>
360 </table>
361 <h3>Static Methods</h3>
362 <table>
363 <tr><td>None</td></tr>
364 </table>
365 <a NAME="HelpBrowser.__init__" ID="HelpBrowser.__init__"></a>
366 <h4>HelpBrowser (Constructor)</h4>
367 <b>HelpBrowser</b>(<i>mainWindow, parent=None, name=""</i>)
368 <p>
369 Constructor
370 </p><dl>
371 <dt><i>mainWindow</i></dt>
372 <dd>
373 reference to the main window (HelpWindow)
374 </dd><dt><i>parent</i></dt>
375 <dd>
376 parent widget of this window (QWidget)
377 </dd><dt><i>name</i></dt>
378 <dd>
379 name of this window (string)
380 </dd>
381 </dl><a NAME="HelpBrowser.__accessKeyShortcut" ID="HelpBrowser.__accessKeyShortcut"></a>
382 <h4>HelpBrowser.__accessKeyShortcut</h4>
383 <b>__accessKeyShortcut</b>(<i></i>)
384 <p>
385 Private slot to switch the display of access keys.
386 </p><a NAME="HelpBrowser.__addExternalBinding" ID="HelpBrowser.__addExternalBinding"></a>
387 <h4>HelpBrowser.__addExternalBinding</h4>
388 <b>__addExternalBinding</b>(<i>frame=None</i>)
389 <p>
390 Private slot to add javascript bindings for adding search providers.
391 </p><dl>
392 <dt><i>frame</i></dt>
393 <dd>
394 reference to the web frame (QWebFrame)
395 </dd>
396 </dl><a NAME="HelpBrowser.__addSearchEngine" ID="HelpBrowser.__addSearchEngine"></a>
397 <h4>HelpBrowser.__addSearchEngine</h4>
398 <b>__addSearchEngine</b>(<i></i>)
399 <p>
400 Private slot to add a new search engine.
401 </p><a NAME="HelpBrowser.__applyZoom" ID="HelpBrowser.__applyZoom"></a>
402 <h4>HelpBrowser.__applyZoom</h4>
403 <b>__applyZoom</b>(<i></i>)
404 <p>
405 Private slot to apply the current zoom factor.
406 </p><a NAME="HelpBrowser.__blockImage" ID="HelpBrowser.__blockImage"></a>
407 <h4>HelpBrowser.__blockImage</h4>
408 <b>__blockImage</b>(<i></i>)
409 <p>
410 Private slot to add a block rule for an image URL.
411 </p><a NAME="HelpBrowser.__bookmarkLink" ID="HelpBrowser.__bookmarkLink"></a>
412 <h4>HelpBrowser.__bookmarkLink</h4>
413 <b>__bookmarkLink</b>(<i></i>)
414 <p>
415 Private slot to bookmark a link via the context menu.
416 </p><a NAME="HelpBrowser.__checkForAccessKey" ID="HelpBrowser.__checkForAccessKey"></a>
417 <h4>HelpBrowser.__checkForAccessKey</h4>
418 <b>__checkForAccessKey</b>(<i>evt</i>)
419 <p>
420 Private method to check the existence of an access key and activate the
421 corresponding link.
422 </p><dl>
423 <dt><i>evt</i></dt>
424 <dd>
425 reference to the key event (QKeyEvent)
426 </dd>
427 </dl><dl>
428 <dt>Returns:</dt>
429 <dd>
430 flag indicating, if the event was handled (boolean)
431 </dd>
432 </dl><a NAME="HelpBrowser.__copyImage" ID="HelpBrowser.__copyImage"></a>
433 <h4>HelpBrowser.__copyImage</h4>
434 <b>__copyImage</b>(<i></i>)
435 <p>
436 Private slot to copy an image to the clipboard.
437 </p><a NAME="HelpBrowser.__copyLink" ID="HelpBrowser.__copyLink"></a>
438 <h4>HelpBrowser.__copyLink</h4>
439 <b>__copyLink</b>(<i></i>)
440 <p>
441 Private slot to copy a link to the clipboard.
442 </p><a NAME="HelpBrowser.__copyLocation" ID="HelpBrowser.__copyLocation"></a>
443 <h4>HelpBrowser.__copyLocation</h4>
444 <b>__copyLocation</b>(<i></i>)
445 <p>
446 Private slot to copy an image or media location to the clipboard.
447 </p><a NAME="HelpBrowser.__currentEngineChanged" ID="HelpBrowser.__currentEngineChanged"></a>
448 <h4>HelpBrowser.__currentEngineChanged</h4>
449 <b>__currentEngineChanged</b>(<i></i>)
450 <p>
451 Private slot to track a change of the current search engine.
452 </p><a NAME="HelpBrowser.__dataString" ID="HelpBrowser.__dataString"></a>
453 <h4>HelpBrowser.__dataString</h4>
454 <b>__dataString</b>(<i>size</i>)
455 <p>
456 Private method to generate a formatted data string.
457 </p><dl>
458 <dt><i>size</i></dt>
459 <dd>
460 size to be formatted (integer)
461 </dd>
462 </dl><dl>
463 <dt>Returns:</dt>
464 <dd>
465 formatted data string (string)
466 </dd>
467 </dl><a NAME="HelpBrowser.__databaseQuotaExceeded" ID="HelpBrowser.__databaseQuotaExceeded"></a>
468 <h4>HelpBrowser.__databaseQuotaExceeded</h4>
469 <b>__databaseQuotaExceeded</b>(<i>frame, databaseName</i>)
470 <p>
471 Private slot to handle the case, where the database quota is exceeded.
472 </p><dl>
473 <dt><i>frame</i></dt>
474 <dd>
475 reference to the frame (QWebFrame)
476 </dd><dt><i>databaseName</i></dt>
477 <dd>
478 name of the web database (string)
479 </dd>
480 </dl><a NAME="HelpBrowser.__downloadImage" ID="HelpBrowser.__downloadImage"></a>
481 <h4>HelpBrowser.__downloadImage</h4>
482 <b>__downloadImage</b>(<i></i>)
483 <p>
484 Private slot to download an image and save it to disk.
485 </p><a NAME="HelpBrowser.__downloadLink" ID="HelpBrowser.__downloadLink"></a>
486 <h4>HelpBrowser.__downloadLink</h4>
487 <b>__downloadLink</b>(<i></i>)
488 <p>
489 Private slot to download a link and save it to disk.
490 </p><a NAME="HelpBrowser.__downloadMedia" ID="HelpBrowser.__downloadMedia"></a>
491 <h4>HelpBrowser.__downloadMedia</h4>
492 <b>__downloadMedia</b>(<i></i>)
493 <p>
494 Private slot to download a media and save it to disk.
495 </p><a NAME="HelpBrowser.__downloadRequested" ID="HelpBrowser.__downloadRequested"></a>
496 <h4>HelpBrowser.__downloadRequested</h4>
497 <b>__downloadRequested</b>(<i>request</i>)
498 <p>
499 Private slot to handle a download request.
500 </p><dl>
501 <dt><i>request</i></dt>
502 <dd>
503 reference to the request object (QNetworkRequest)
504 </dd>
505 </dl><a NAME="HelpBrowser.__generatePrintPreviewClickedFrame" ID="HelpBrowser.__generatePrintPreviewClickedFrame"></a>
506 <h4>HelpBrowser.__generatePrintPreviewClickedFrame</h4>
507 <b>__generatePrintPreviewClickedFrame</b>(<i>printer</i>)
508 <p>
509 Private slot to generate a print preview of the clicked frame.
510 </p><dl>
511 <dt><i>printer</i></dt>
512 <dd>
513 reference to the printer object (QPrinter)
514 </dd>
515 </dl><a NAME="HelpBrowser.__hideAccessKeys" ID="HelpBrowser.__hideAccessKeys"></a>
516 <h4>HelpBrowser.__hideAccessKeys</h4>
517 <b>__hideAccessKeys</b>(<i></i>)
518 <p>
519 Private slot to hide the access key labels.
520 </p><a NAME="HelpBrowser.__isMediaElement" ID="HelpBrowser.__isMediaElement"></a>
521 <h4>HelpBrowser.__isMediaElement</h4>
522 <b>__isMediaElement</b>(<i>element</i>)
523 <p>
524 Private method to check, if the given element is a media element.
525 </p><dl>
526 <dt><i>element</i></dt>
527 <dd>
528 element to be checked (QWebElement)
529 </dd>
530 </dl><dl>
531 <dt>Returns:</dt>
532 <dd>
533 flag indicating a media element (boolean)
534 </dd>
535 </dl><a NAME="HelpBrowser.__isUrlValid" ID="HelpBrowser.__isUrlValid"></a>
536 <h4>HelpBrowser.__isUrlValid</h4>
537 <b>__isUrlValid</b>(<i>url</i>)
538 <p>
539 Private method to check a URL for validity.
540 </p><dl>
541 <dt><i>url</i></dt>
542 <dd>
543 URL to be checked (QUrl)
544 </dd>
545 </dl><dl>
546 <dt>Returns:</dt>
547 <dd>
548 flag indicating a valid URL (boolean)
549 </dd>
550 </dl><a NAME="HelpBrowser.__levelForZoom" ID="HelpBrowser.__levelForZoom"></a>
551 <h4>HelpBrowser.__levelForZoom</h4>
552 <b>__levelForZoom</b>(<i>zoom</i>)
553 <p>
554 Private method determining the zoom level index given a zoom factor.
555 </p><dl>
556 <dt><i>zoom</i></dt>
557 <dd>
558 zoom factor (integer)
559 </dd>
560 </dl><dl>
561 <dt>Returns:</dt>
562 <dd>
563 index of zoom factor (integer)
564 </dd>
565 </dl><a NAME="HelpBrowser.__linkHovered" ID="HelpBrowser.__linkHovered"></a>
566 <h4>HelpBrowser.__linkHovered</h4>
567 <b>__linkHovered</b>(<i>link, title, textContent</i>)
568 <p>
569 Private slot to handle the linkHovered signal.
570 </p><dl>
571 <dt><i>link</i></dt>
572 <dd>
573 the URL of the link (string)
574 </dd><dt><i>title</i></dt>
575 <dd>
576 the link title (string)
577 </dd><dt><i>textContent</i></dt>
578 <dd>
579 text content of the link (string)
580 </dd>
581 </dl><a NAME="HelpBrowser.__loadClickedFrame" ID="HelpBrowser.__loadClickedFrame"></a>
582 <h4>HelpBrowser.__loadClickedFrame</h4>
583 <b>__loadClickedFrame</b>(<i></i>)
584 <p>
585 Private slot to load the selected frame only.
586 </p><a NAME="HelpBrowser.__loadFinished" ID="HelpBrowser.__loadFinished"></a>
587 <h4>HelpBrowser.__loadFinished</h4>
588 <b>__loadFinished</b>(<i>ok</i>)
589 <p>
590 Private method to handle the loadFinished signal.
591 </p><dl>
592 <dt><i>ok</i></dt>
593 <dd>
594 flag indicating the result (boolean)
595 </dd>
596 </dl><a NAME="HelpBrowser.__loadProgress" ID="HelpBrowser.__loadProgress"></a>
597 <h4>HelpBrowser.__loadProgress</h4>
598 <b>__loadProgress</b>(<i>progress</i>)
599 <p>
600 Private method to handle the loadProgress signal.
601 </p><dl>
602 <dt><i>progress</i></dt>
603 <dd>
604 progress value (integer)
605 </dd>
606 </dl><a NAME="HelpBrowser.__loadStarted" ID="HelpBrowser.__loadStarted"></a>
607 <h4>HelpBrowser.__loadStarted</h4>
608 <b>__loadStarted</b>(<i></i>)
609 <p>
610 Private method to handle the loadStarted signal.
611 </p><a NAME="HelpBrowser.__makeAccessLabel" ID="HelpBrowser.__makeAccessLabel"></a>
612 <h4>HelpBrowser.__makeAccessLabel</h4>
613 <b>__makeAccessLabel</b>(<i>accessKey, element</i>)
614 <p>
615 Private method to generate the access label for an element.
616 </p><dl>
617 <dt><i>accessKey</i></dt>
618 <dd>
619 access key to generate the label for (str)
620 </dd><dt><i>element</i></dt>
621 <dd>
622 reference to the web element to create the label for
623 (QWebElement)
624 </dd>
625 </dl><a NAME="HelpBrowser.__muteMedia" ID="HelpBrowser.__muteMedia"></a>
626 <h4>HelpBrowser.__muteMedia</h4>
627 <b>__muteMedia</b>(<i></i>)
628 <p>
629 Private slot to (un)mute the selected media.
630 </p><a NAME="HelpBrowser.__openLinkInNewTab" ID="HelpBrowser.__openLinkInNewTab"></a>
631 <h4>HelpBrowser.__openLinkInNewTab</h4>
632 <b>__openLinkInNewTab</b>(<i></i>)
633 <p>
634 Private method called by the context menu to open a link in a new
635 window.
636 </p><a NAME="HelpBrowser.__pauseMedia" ID="HelpBrowser.__pauseMedia"></a>
637 <h4>HelpBrowser.__pauseMedia</h4>
638 <b>__pauseMedia</b>(<i></i>)
639 <p>
640 Private slot to pause or play the selected media.
641 </p><a NAME="HelpBrowser.__printClickedFrame" ID="HelpBrowser.__printClickedFrame"></a>
642 <h4>HelpBrowser.__printClickedFrame</h4>
643 <b>__printClickedFrame</b>(<i></i>)
644 <p>
645 Private slot to print the selected frame.
646 </p><a NAME="HelpBrowser.__printPdfClickedFrame" ID="HelpBrowser.__printPdfClickedFrame"></a>
647 <h4>HelpBrowser.__printPdfClickedFrame</h4>
648 <b>__printPdfClickedFrame</b>(<i></i>)
649 <p>
650 Private slot to print the selected frame to PDF.
651 </p><a NAME="HelpBrowser.__printPreviewClickedFrame" ID="HelpBrowser.__printPreviewClickedFrame"></a>
652 <h4>HelpBrowser.__printPreviewClickedFrame</h4>
653 <b>__printPreviewClickedFrame</b>(<i></i>)
654 <p>
655 Private slot to show a print preview of the clicked frame.
656 </p><a NAME="HelpBrowser.__searchRequested" ID="HelpBrowser.__searchRequested"></a>
657 <h4>HelpBrowser.__searchRequested</h4>
658 <b>__searchRequested</b>(<i>act</i>)
659 <p>
660 Private slot to search for some text with a selected search engine.
661 </p><dl>
662 <dt><i>act</i></dt>
663 <dd>
664 reference to the action that triggered this slot (QAction)
665 </dd>
666 </dl><a NAME="HelpBrowser.__sendLink" ID="HelpBrowser.__sendLink"></a>
667 <h4>HelpBrowser.__sendLink</h4>
668 <b>__sendLink</b>(<i></i>)
669 <p>
670 Private slot to send a link via email.
671 </p><a NAME="HelpBrowser.__showAccessKeys" ID="HelpBrowser.__showAccessKeys"></a>
672 <h4>HelpBrowser.__showAccessKeys</h4>
673 <b>__showAccessKeys</b>(<i></i>)
674 <p>
675 Private method to show the access key labels.
676 </p><a NAME="HelpBrowser.__showClickedFrameSource" ID="HelpBrowser.__showClickedFrameSource"></a>
677 <h4>HelpBrowser.__showClickedFrameSource</h4>
678 <b>__showClickedFrameSource</b>(<i></i>)
679 <p>
680 Private slot to show the source of the clicked frame.
681 </p><a NAME="HelpBrowser.__statusBarMessage" ID="HelpBrowser.__statusBarMessage"></a>
682 <h4>HelpBrowser.__statusBarMessage</h4>
683 <b>__statusBarMessage</b>(<i>text</i>)
684 <p>
685 Private slot to handle the statusBarMessage signal.
686 </p><dl>
687 <dt><i>text</i></dt>
688 <dd>
689 text to be shown in the status bar (string)
690 </dd>
691 </dl><a NAME="HelpBrowser.__unsupportedContent" ID="HelpBrowser.__unsupportedContent"></a>
692 <h4>HelpBrowser.__unsupportedContent</h4>
693 <b>__unsupportedContent</b>(<i>reply, requestFilename=None, download=False</i>)
694 <p>
695 Private slot to handle the unsupportedContent signal.
696 </p><dl>
697 <dt><i>reply</i></dt>
698 <dd>
699 reference to the reply object (QNetworkReply)
700 </dd><dt><i>requestFilename=</i></dt>
701 <dd>
702 indicating to ask for a filename
703 (boolean or None). If it is None, the behavior is determined
704 by a configuration option.
705 </dd><dt><i>download=</i></dt>
706 <dd>
707 flag indicating a download operation (boolean)
708 </dd>
709 </dl><a NAME="HelpBrowser.__urlChanged" ID="HelpBrowser.__urlChanged"></a>
710 <h4>HelpBrowser.__urlChanged</h4>
711 <b>__urlChanged</b>(<i>url</i>)
712 <p>
713 Private slot to handle the urlChanged signal.
714 </p><dl>
715 <dt><i>url</i></dt>
716 <dd>
717 the new url (QUrl)
718 </dd>
719 </dl><a NAME="HelpBrowser.__virusTotal" ID="HelpBrowser.__virusTotal"></a>
720 <h4>HelpBrowser.__virusTotal</h4>
721 <b>__virusTotal</b>(<i></i>)
722 <p>
723 Private slot to scan the selected URL with VirusTotal.
724 </p><a NAME="HelpBrowser.__webInspector" ID="HelpBrowser.__webInspector"></a>
725 <h4>HelpBrowser.__webInspector</h4>
726 <b>__webInspector</b>(<i></i>)
727 <p>
728 Private slot to show the web inspector window.
729 </p><a NAME="HelpBrowser.__zoomInClickedFrame" ID="HelpBrowser.__zoomInClickedFrame"></a>
730 <h4>HelpBrowser.__zoomInClickedFrame</h4>
731 <b>__zoomInClickedFrame</b>(<i></i>)
732 <p>
733 Private slot to zoom into the clicked frame.
734 </p><a NAME="HelpBrowser.__zoomOutClickedFrame" ID="HelpBrowser.__zoomOutClickedFrame"></a>
735 <h4>HelpBrowser.__zoomOutClickedFrame</h4>
736 <b>__zoomOutClickedFrame</b>(<i></i>)
737 <p>
738 Private slot to zoom out of the clicked frame.
739 </p><a NAME="HelpBrowser.__zoomResetClickedFrame" ID="HelpBrowser.__zoomResetClickedFrame"></a>
740 <h4>HelpBrowser.__zoomResetClickedFrame</h4>
741 <b>__zoomResetClickedFrame</b>(<i></i>)
742 <p>
743 Private slot to reset the zoom factor of the clicked frame.
744 </p><a NAME="HelpBrowser.addBookmark" ID="HelpBrowser.addBookmark"></a>
745 <h4>HelpBrowser.addBookmark</h4>
746 <b>addBookmark</b>(<i></i>)
747 <p>
748 Public slot to bookmark the current page.
749 </p><a NAME="HelpBrowser.backward" ID="HelpBrowser.backward"></a>
750 <h4>HelpBrowser.backward</h4>
751 <b>backward</b>(<i></i>)
752 <p>
753 Public slot to move backwards in history.
754 </p><a NAME="HelpBrowser.checkRSS" ID="HelpBrowser.checkRSS"></a>
755 <h4>HelpBrowser.checkRSS</h4>
756 <b>checkRSS</b>(<i></i>)
757 <p>
758 Public method to check, if the loaded page contains feed links.
759 </p><dl>
760 <dt>Returns:</dt>
761 <dd>
762 flag indicating the existence of feed links (boolean)
763 </dd>
764 </dl><a NAME="HelpBrowser.clearHistory" ID="HelpBrowser.clearHistory"></a>
765 <h4>HelpBrowser.clearHistory</h4>
766 <b>clearHistory</b>(<i></i>)
767 <p>
768 Public slot to clear the history.
769 </p><a NAME="HelpBrowser.contextMenuEvent" ID="HelpBrowser.contextMenuEvent"></a>
770 <h4>HelpBrowser.contextMenuEvent</h4>
771 <b>contextMenuEvent</b>(<i>evt</i>)
772 <p>
773 Protected method called to create a context menu.
774 </p><p>
775 This method is overridden from QWebView.
776 </p><dl>
777 <dt><i>evt</i></dt>
778 <dd>
779 reference to the context menu event object
780 (QContextMenuEvent)
781 </dd>
782 </dl><a NAME="HelpBrowser.copy" ID="HelpBrowser.copy"></a>
783 <h4>HelpBrowser.copy</h4>
784 <b>copy</b>(<i></i>)
785 <p>
786 Public slot to copy the selected text.
787 </p><a NAME="HelpBrowser.createWindow" ID="HelpBrowser.createWindow"></a>
788 <h4>HelpBrowser.createWindow</h4>
789 <b>createWindow</b>(<i>windowType</i>)
790 <p>
791 Public method called, when a new window should be created.
792 </p><dl>
793 <dt><i>windowType</i></dt>
794 <dd>
795 type of the requested window (QWebPage.WebWindowType)
796 </dd>
797 </dl><dl>
798 <dt>Returns:</dt>
799 <dd>
800 reference to the created browser window (HelpBrowser)
801 </dd>
802 </dl><a NAME="HelpBrowser.documentTitle" ID="HelpBrowser.documentTitle"></a>
803 <h4>HelpBrowser.documentTitle</h4>
804 <b>documentTitle</b>(<i></i>)
805 <p>
806 Public method to return the title of the loaded page.
807 </p><dl>
808 <dt>Returns:</dt>
809 <dd>
810 title (string)
811 </dd>
812 </dl><a NAME="HelpBrowser.dragEnterEvent" ID="HelpBrowser.dragEnterEvent"></a>
813 <h4>HelpBrowser.dragEnterEvent</h4>
814 <b>dragEnterEvent</b>(<i>evt</i>)
815 <p>
816 Protected method called by a drag enter event.
817 </p><dl>
818 <dt><i>evt</i></dt>
819 <dd>
820 reference to the drag enter event (QDragEnterEvent)
821 </dd>
822 </dl><a NAME="HelpBrowser.dragMoveEvent" ID="HelpBrowser.dragMoveEvent"></a>
823 <h4>HelpBrowser.dragMoveEvent</h4>
824 <b>dragMoveEvent</b>(<i>evt</i>)
825 <p>
826 Protected method called by a drag move event.
827 </p><dl>
828 <dt><i>evt</i></dt>
829 <dd>
830 reference to the drag move event (QDragMoveEvent)
831 </dd>
832 </dl><a NAME="HelpBrowser.dropEvent" ID="HelpBrowser.dropEvent"></a>
833 <h4>HelpBrowser.dropEvent</h4>
834 <b>dropEvent</b>(<i>evt</i>)
835 <p>
836 Protected method called by a drop event.
837 </p><dl>
838 <dt><i>evt</i></dt>
839 <dd>
840 reference to the drop event (QDropEvent)
841 </dd>
842 </dl><a NAME="HelpBrowser.event" ID="HelpBrowser.event"></a>
843 <h4>HelpBrowser.event</h4>
844 <b>event</b>(<i>evt</i>)
845 <p>
846 Public method handling events.
847 </p><dl>
848 <dt><i>evt</i></dt>
849 <dd>
850 reference to the event (QEvent)
851 </dd>
852 </dl><dl>
853 <dt>Returns:</dt>
854 <dd>
855 flag indicating, if the event was handled (boolean)
856 </dd>
857 </dl><a NAME="HelpBrowser.findNextPrev" ID="HelpBrowser.findNextPrev"></a>
858 <h4>HelpBrowser.findNextPrev</h4>
859 <b>findNextPrev</b>(<i>txt, case, backwards, wrap, highlightAll</i>)
860 <p>
861 Public slot to find the next occurrence of a text.
862 </p><dl>
863 <dt><i>txt</i></dt>
864 <dd>
865 text to search for (string)
866 </dd><dt><i>case</i></dt>
867 <dd>
868 flag indicating a case sensitive search (boolean)
869 </dd><dt><i>backwards</i></dt>
870 <dd>
871 flag indicating a backwards search (boolean)
872 </dd><dt><i>wrap</i></dt>
873 <dd>
874 flag indicating to wrap around (boolean)
875 </dd><dt><i>highlightAll</i></dt>
876 <dd>
877 flag indicating to highlight all occurrences
878 (boolean)
879 </dd>
880 </dl><dl>
881 <dt>Returns:</dt>
882 <dd>
883 flag indicating that a match was found (boolean)
884 </dd>
885 </dl><a NAME="HelpBrowser.focusOutEvent" ID="HelpBrowser.focusOutEvent"></a>
886 <h4>HelpBrowser.focusOutEvent</h4>
887 <b>focusOutEvent</b>(<i>evt</i>)
888 <p>
889 Protected method called by a focus out event.
890 </p><dl>
891 <dt><i>evt</i></dt>
892 <dd>
893 reference to the focus event (QFocusEvent)
894 </dd>
895 </dl><a NAME="HelpBrowser.forward" ID="HelpBrowser.forward"></a>
896 <h4>HelpBrowser.forward</h4>
897 <b>forward</b>(<i></i>)
898 <p>
899 Public slot to move forward in history.
900 </p><a NAME="HelpBrowser.gestureEvent" ID="HelpBrowser.gestureEvent"></a>
901 <h4>HelpBrowser.gestureEvent</h4>
902 <b>gestureEvent</b>(<i>evt</i>)
903 <p>
904 Protected method handling gesture events.
905 </p><dl>
906 <dt><i>evt</i></dt>
907 <dd>
908 reference to the gesture event (QGestureEvent
909 </dd>
910 </dl><a NAME="HelpBrowser.getRSS" ID="HelpBrowser.getRSS"></a>
911 <h4>HelpBrowser.getRSS</h4>
912 <b>getRSS</b>(<i></i>)
913 <p>
914 Public method to get the extracted RSS feeds.
915 </p><dl>
916 <dt>Returns:</dt>
917 <dd>
918 list of RSS feeds (list of tuples of two strings)
919 </dd>
920 </dl><a NAME="HelpBrowser.hasRSS" ID="HelpBrowser.hasRSS"></a>
921 <h4>HelpBrowser.hasRSS</h4>
922 <b>hasRSS</b>(<i></i>)
923 <p>
924 Public method to check, if the loaded page has RSS links.
925 </p><dl>
926 <dt>Returns:</dt>
927 <dd>
928 flag indicating the presence of RSS links (boolean)
929 </dd>
930 </dl><a NAME="HelpBrowser.hasSelection" ID="HelpBrowser.hasSelection"></a>
931 <h4>HelpBrowser.hasSelection</h4>
932 <b>hasSelection</b>(<i></i>)
933 <p>
934 Public method to determine, if there is some text selected.
935 </p><dl>
936 <dt>Returns:</dt>
937 <dd>
938 flag indicating text has been selected (boolean)
939 </dd>
940 </dl><a NAME="HelpBrowser.home" ID="HelpBrowser.home"></a>
941 <h4>HelpBrowser.home</h4>
942 <b>home</b>(<i></i>)
943 <p>
944 Public slot to move to the first page loaded.
945 </p><a NAME="HelpBrowser.isBackwardAvailable" ID="HelpBrowser.isBackwardAvailable"></a>
946 <h4>HelpBrowser.isBackwardAvailable</h4>
947 <b>isBackwardAvailable</b>(<i></i>)
948 <p>
949 Public method to determine, if a backwards move in history is possible.
950 </p><dl>
951 <dt>Returns:</dt>
952 <dd>
953 flag indicating move backwards is possible (boolean)
954 </dd>
955 </dl><a NAME="HelpBrowser.isForwardAvailable" ID="HelpBrowser.isForwardAvailable"></a>
956 <h4>HelpBrowser.isForwardAvailable</h4>
957 <b>isForwardAvailable</b>(<i></i>)
958 <p>
959 Public method to determine, if a forward move in history is possible.
960 </p><dl>
961 <dt>Returns:</dt>
962 <dd>
963 flag indicating move forward is possible (boolean)
964 </dd>
965 </dl><a NAME="HelpBrowser.isLoading" ID="HelpBrowser.isLoading"></a>
966 <h4>HelpBrowser.isLoading</h4>
967 <b>isLoading</b>(<i></i>)
968 <p>
969 Public method to get the loading state.
970 </p><dl>
971 <dt>Returns:</dt>
972 <dd>
973 flag indicating the loading state (boolean)
974 </dd>
975 </dl><a NAME="HelpBrowser.keyPressEvent" ID="HelpBrowser.keyPressEvent"></a>
976 <h4>HelpBrowser.keyPressEvent</h4>
977 <b>keyPressEvent</b>(<i>evt</i>)
978 <p>
979 Protected method called by a key press.
980 </p><dl>
981 <dt><i>evt</i></dt>
982 <dd>
983 reference to the key event (QKeyEvent)
984 </dd>
985 </dl><a NAME="HelpBrowser.keyReleaseEvent" ID="HelpBrowser.keyReleaseEvent"></a>
986 <h4>HelpBrowser.keyReleaseEvent</h4>
987 <b>keyReleaseEvent</b>(<i>evt</i>)
988 <p>
989 Protected method called by a key release.
990 </p><dl>
991 <dt><i>evt</i></dt>
992 <dd>
993 reference to the key event (QKeyEvent)
994 </dd>
995 </dl><a NAME="HelpBrowser.linkedResources" ID="HelpBrowser.linkedResources"></a>
996 <h4>HelpBrowser.linkedResources</h4>
997 <b>linkedResources</b>(<i>relation=""</i>)
998 <p>
999 Public method to extract linked resources.
1000 </p><dl>
1001 <dt><i>relation</i></dt>
1002 <dd>
1003 relation to extract (string)
1004 </dd>
1005 </dl><dl>
1006 <dt>Returns:</dt>
1007 <dd>
1008 list of linked resources (list of LinkedResource)
1009 </dd>
1010 </dl><a NAME="HelpBrowser.mousePressEvent" ID="HelpBrowser.mousePressEvent"></a>
1011 <h4>HelpBrowser.mousePressEvent</h4>
1012 <b>mousePressEvent</b>(<i>evt</i>)
1013 <p>
1014 Protected method called by a mouse press event.
1015 </p><dl>
1016 <dt><i>evt</i></dt>
1017 <dd>
1018 reference to the mouse event (QMouseEvent)
1019 </dd>
1020 </dl><a NAME="HelpBrowser.mouseReleaseEvent" ID="HelpBrowser.mouseReleaseEvent"></a>
1021 <h4>HelpBrowser.mouseReleaseEvent</h4>
1022 <b>mouseReleaseEvent</b>(<i>evt</i>)
1023 <p>
1024 Protected method called by a mouse release event.
1025 </p><dl>
1026 <dt><i>evt</i></dt>
1027 <dd>
1028 reference to the mouse event (QMouseEvent)
1029 </dd>
1030 </dl><a NAME="HelpBrowser.preferencesChanged" ID="HelpBrowser.preferencesChanged"></a>
1031 <h4>HelpBrowser.preferencesChanged</h4>
1032 <b>preferencesChanged</b>(<i></i>)
1033 <p>
1034 Public method to indicate a change of the settings.
1035 </p><a NAME="HelpBrowser.progress" ID="HelpBrowser.progress"></a>
1036 <h4>HelpBrowser.progress</h4>
1037 <b>progress</b>(<i></i>)
1038 <p>
1039 Public method to get the load progress.
1040 </p><dl>
1041 <dt>Returns:</dt>
1042 <dd>
1043 load progress (integer)
1044 </dd>
1045 </dl><a NAME="HelpBrowser.reload" ID="HelpBrowser.reload"></a>
1046 <h4>HelpBrowser.reload</h4>
1047 <b>reload</b>(<i></i>)
1048 <p>
1049 Public slot to reload the current page.
1050 </p><a NAME="HelpBrowser.saveAs" ID="HelpBrowser.saveAs"></a>
1051 <h4>HelpBrowser.saveAs</h4>
1052 <b>saveAs</b>(<i></i>)
1053 <p>
1054 Public method to save the current page to a file.
1055 </p><a NAME="HelpBrowser.setSource" ID="HelpBrowser.setSource"></a>
1056 <h4>HelpBrowser.setSource</h4>
1057 <b>setSource</b>(<i>name, requestData=None</i>)
1058 <p>
1059 Public method used to set the source to be displayed.
1060 </p><dl>
1061 <dt><i>name</i></dt>
1062 <dd>
1063 filename to be shown (QUrl)
1064 </dd><dt><i>requestData</i></dt>
1065 <dd>
1066 tuple containing the request data (QNetworkRequest,
1067 QNetworkAccessManager.Operation, QByteArray)
1068 </dd>
1069 </dl><a NAME="HelpBrowser.setZoomValue" ID="HelpBrowser.setZoomValue"></a>
1070 <h4>HelpBrowser.setZoomValue</h4>
1071 <b>setZoomValue</b>(<i>value</i>)
1072 <p>
1073 Public method to set the zoom value.
1074 </p><dl>
1075 <dt><i>value</i></dt>
1076 <dd>
1077 zoom value (integer)
1078 </dd>
1079 </dl><a NAME="HelpBrowser.source" ID="HelpBrowser.source"></a>
1080 <h4>HelpBrowser.source</h4>
1081 <b>source</b>(<i></i>)
1082 <p>
1083 Public method to return the URL of the loaded page.
1084 </p><dl>
1085 <dt>Returns:</dt>
1086 <dd>
1087 URL loaded in the help browser (QUrl)
1088 </dd>
1089 </dl><a NAME="HelpBrowser.wheelEvent" ID="HelpBrowser.wheelEvent"></a>
1090 <h4>HelpBrowser.wheelEvent</h4>
1091 <b>wheelEvent</b>(<i>evt</i>)
1092 <p>
1093 Protected method to handle wheel events.
1094 </p><dl>
1095 <dt><i>evt</i></dt>
1096 <dd>
1097 reference to the wheel event (QWheelEvent)
1098 </dd>
1099 </dl><a NAME="HelpBrowser.zoomIn" ID="HelpBrowser.zoomIn"></a>
1100 <h4>HelpBrowser.zoomIn</h4>
1101 <b>zoomIn</b>(<i></i>)
1102 <p>
1103 Public slot to zoom into the page.
1104 </p><a NAME="HelpBrowser.zoomOut" ID="HelpBrowser.zoomOut"></a>
1105 <h4>HelpBrowser.zoomOut</h4>
1106 <b>zoomOut</b>(<i></i>)
1107 <p>
1108 Public slot to zoom out of the page.
1109 </p><a NAME="HelpBrowser.zoomReset" ID="HelpBrowser.zoomReset"></a>
1110 <h4>HelpBrowser.zoomReset</h4>
1111 <b>zoomReset</b>(<i></i>)
1112 <p>
1113 Public method to reset the zoom factor.
1114 </p><a NAME="HelpBrowser.zoomValue" ID="HelpBrowser.zoomValue"></a>
1115 <h4>HelpBrowser.zoomValue</h4>
1116 <b>zoomValue</b>(<i></i>)
1117 <p>
1118 Public method to get the current zoom value.
1119 </p><dl>
1120 <dt>Returns:</dt>
1121 <dd>
1122 zoom value (integer)
1123 </dd>
1124 </dl>
1125 <div align="right"><a href="#top">Up</a></div>
1126 <hr /><hr />
1127 <a NAME="HelpWebPage" ID="HelpWebPage"></a>
1128 <h2>HelpWebPage</h2>
1129 <p>
1130 Class implementing an enhanced web page.
1131 </p>
1132 <h3>Derived from</h3>
1133 QWebPage
1134 <h3>Class Attributes</h3>
1135 <table>
1136 <tr><td>_webPluginFactory</td></tr>
1137 </table>
1138 <h3>Class Methods</h3>
1139 <table>
1140 <tr>
1141 <td><a href="#HelpWebPage.webPluginFactory">webPluginFactory</a></td>
1142 <td>Class method to get a reference to the web plug-in factory instance.</td>
1143 </tr>
1144 </table>
1145 <h3>Methods</h3>
1146 <table>
1147 <tr>
1148 <td><a href="#HelpWebPage.__init__">HelpWebPage</a></td>
1149 <td>Constructor</td>
1150 </tr><tr>
1151 <td><a href="#HelpWebPage.__loadStarted">__loadStarted</a></td>
1152 <td>Private method to handle the loadStarted signal.</td>
1153 </tr><tr>
1154 <td><a href="#HelpWebPage.__managerFinished">__managerFinished</a></td>
1155 <td>Private slot to handle a finished reply.</td>
1156 </tr><tr>
1157 <td><a href="#HelpWebPage.acceptNavigationRequest">acceptNavigationRequest</a></td>
1158 <td>Public method to determine, if a request may be accepted.</td>
1159 </tr><tr>
1160 <td><a href="#HelpWebPage.addAdBlockRule">addAdBlockRule</a></td>
1161 <td>Public slot to add an AdBlock rule to the page.</td>
1162 </tr><tr>
1163 <td><a href="#HelpWebPage.event">event</a></td>
1164 <td>Public method implementing the event handler.</td>
1165 </tr><tr>
1166 <td><a href="#HelpWebPage.extension">extension</a></td>
1167 <td>Public method to implement a specific extension.</td>
1168 </tr><tr>
1169 <td><a href="#HelpWebPage.getAdBlockedPageEntries">getAdBlockedPageEntries</a></td>
1170 <td>Public method to get the list of AdBlock page entries.</td>
1171 </tr><tr>
1172 <td><a href="#HelpWebPage.getSslCertificate">getSslCertificate</a></td>
1173 <td>Public method to get a reference to the SSL certificate.</td>
1174 </tr><tr>
1175 <td><a href="#HelpWebPage.getSslCertificateChain">getSslCertificateChain</a></td>
1176 <td>Public method to get a reference to the SSL certificate chain.</td>
1177 </tr><tr>
1178 <td><a href="#HelpWebPage.getSslConfiguration">getSslConfiguration</a></td>
1179 <td>Public method to return a reference to the current SSL configuration.</td>
1180 </tr><tr>
1181 <td><a href="#HelpWebPage.hasValidSslInfo">hasValidSslInfo</a></td>
1182 <td>Public method to check, if the page has a valid SSL certificate.</td>
1183 </tr><tr>
1184 <td><a href="#HelpWebPage.pageAttributeId">pageAttributeId</a></td>
1185 <td>Public method to get the attribute id of the page attribute.</td>
1186 </tr><tr>
1187 <td><a href="#HelpWebPage.populateNetworkRequest">populateNetworkRequest</a></td>
1188 <td>Public method to add data to a network request.</td>
1189 </tr><tr>
1190 <td><a href="#HelpWebPage.setUserAgent">setUserAgent</a></td>
1191 <td>Public method to set the global user agent string.</td>
1192 </tr><tr>
1193 <td><a href="#HelpWebPage.showSslInfo">showSslInfo</a></td>
1194 <td>Public slot to show some SSL information for the loaded page.</td>
1195 </tr><tr>
1196 <td><a href="#HelpWebPage.supportsExtension">supportsExtension</a></td>
1197 <td>Public method to check the support for an extension.</td>
1198 </tr><tr>
1199 <td><a href="#HelpWebPage.url">url</a></td>
1200 <td>Public method to get the URL of the page.</td>
1201 </tr><tr>
1202 <td><a href="#HelpWebPage.userAgent">userAgent</a></td>
1203 <td>Public method to get the global user agent setting.</td>
1204 </tr><tr>
1205 <td><a href="#HelpWebPage.userAgentForUrl">userAgentForUrl</a></td>
1206 <td>Public method to determine the user agent for the given URL.</td>
1207 </tr>
1208 </table>
1209 <h3>Static Methods</h3>
1210 <table>
1211 <tr><td>None</td></tr>
1212 </table>
1213 <a NAME="HelpWebPage.webPluginFactory" ID="HelpWebPage.webPluginFactory"></a>
1214 <h4>HelpWebPage.webPluginFactory (class method)</h4>
1215 <b>webPluginFactory</b>(<i></i>)
1216 <p>
1217 Class method to get a reference to the web plug-in factory
1218 instance.
1219 </p><dl>
1220 <dt>Returns:</dt>
1221 <dd>
1222 reference to the web plug-in factory instance (WebPluginFactory
1223 </dd>
1224 </dl><a NAME="HelpWebPage.__init__" ID="HelpWebPage.__init__"></a>
1225 <h4>HelpWebPage (Constructor)</h4>
1226 <b>HelpWebPage</b>(<i>parent=None</i>)
1227 <p>
1228 Constructor
1229 </p><dl>
1230 <dt><i>parent</i></dt>
1231 <dd>
1232 parent widget of this window (QWidget)
1233 </dd>
1234 </dl><a NAME="HelpWebPage.__loadStarted" ID="HelpWebPage.__loadStarted"></a>
1235 <h4>HelpWebPage.__loadStarted</h4>
1236 <b>__loadStarted</b>(<i></i>)
1237 <p>
1238 Private method to handle the loadStarted signal.
1239 </p><a NAME="HelpWebPage.__managerFinished" ID="HelpWebPage.__managerFinished"></a>
1240 <h4>HelpWebPage.__managerFinished</h4>
1241 <b>__managerFinished</b>(<i>reply</i>)
1242 <p>
1243 Private slot to handle a finished reply.
1244 </p><p>
1245 This slot is used to get SSL related information for a reply.
1246 </p><dl>
1247 <dt><i>reply</i></dt>
1248 <dd>
1249 reference to the finished reply (QNetworkReply)
1250 </dd>
1251 </dl><a NAME="HelpWebPage.acceptNavigationRequest" ID="HelpWebPage.acceptNavigationRequest"></a>
1252 <h4>HelpWebPage.acceptNavigationRequest</h4>
1253 <b>acceptNavigationRequest</b>(<i>frame, request, type_</i>)
1254 <p>
1255 Public method to determine, if a request may be accepted.
1256 </p><dl>
1257 <dt><i>frame</i></dt>
1258 <dd>
1259 reference to the frame sending the request (QWebFrame)
1260 </dd><dt><i>request</i></dt>
1261 <dd>
1262 reference to the request object (QNetworkRequest)
1263 </dd><dt><i>type_</i></dt>
1264 <dd>
1265 type of the navigation request (QWebPage.NavigationType)
1266 </dd>
1267 </dl><dl>
1268 <dt>Returns:</dt>
1269 <dd>
1270 flag indicating acceptance (boolean)
1271 </dd>
1272 </dl><a NAME="HelpWebPage.addAdBlockRule" ID="HelpWebPage.addAdBlockRule"></a>
1273 <h4>HelpWebPage.addAdBlockRule</h4>
1274 <b>addAdBlockRule</b>(<i>rule, url</i>)
1275 <p>
1276 Public slot to add an AdBlock rule to the page.
1277 </p><dl>
1278 <dt><i>rule</i></dt>
1279 <dd>
1280 AdBlock rule to add (AdBlockRule)
1281 </dd><dt><i>url</i></dt>
1282 <dd>
1283 URL that matched the rule (QUrl)
1284 </dd>
1285 </dl><a NAME="HelpWebPage.event" ID="HelpWebPage.event"></a>
1286 <h4>HelpWebPage.event</h4>
1287 <b>event</b>(<i>evt</i>)
1288 <p>
1289 Public method implementing the event handler.
1290 </p><dl>
1291 <dt><i>evt</i></dt>
1292 <dd>
1293 reference to the event (QEvent)
1294 </dd>
1295 </dl><dl>
1296 <dt>Returns:</dt>
1297 <dd>
1298 flag indicating that the event was handled (boolean)
1299 </dd>
1300 </dl><a NAME="HelpWebPage.extension" ID="HelpWebPage.extension"></a>
1301 <h4>HelpWebPage.extension</h4>
1302 <b>extension</b>(<i>extension, option, output</i>)
1303 <p>
1304 Public method to implement a specific extension.
1305 </p><dl>
1306 <dt><i>extension</i></dt>
1307 <dd>
1308 extension to be executed (QWebPage.Extension)
1309 </dd><dt><i>option</i></dt>
1310 <dd>
1311 provides input to the extension
1312 (QWebPage.ExtensionOption)
1313 </dd><dt><i>output</i></dt>
1314 <dd>
1315 stores the output results (QWebPage.ExtensionReturn)
1316 </dd>
1317 </dl><dl>
1318 <dt>Returns:</dt>
1319 <dd>
1320 flag indicating a successful call of the extension (boolean)
1321 </dd>
1322 </dl><a NAME="HelpWebPage.getAdBlockedPageEntries" ID="HelpWebPage.getAdBlockedPageEntries"></a>
1323 <h4>HelpWebPage.getAdBlockedPageEntries</h4>
1324 <b>getAdBlockedPageEntries</b>(<i></i>)
1325 <p>
1326 Public method to get the list of AdBlock page entries.
1327 </p><dl>
1328 <dt>Returns:</dt>
1329 <dd>
1330 list of AdBlock page entries (list of AdBlockedPageEntry)
1331 </dd>
1332 </dl><a NAME="HelpWebPage.getSslCertificate" ID="HelpWebPage.getSslCertificate"></a>
1333 <h4>HelpWebPage.getSslCertificate</h4>
1334 <b>getSslCertificate</b>(<i></i>)
1335 <p>
1336 Public method to get a reference to the SSL certificate.
1337 </p><dl>
1338 <dt>Returns:</dt>
1339 <dd>
1340 amended SSL certificate (QSslCertificate)
1341 </dd>
1342 </dl><a NAME="HelpWebPage.getSslCertificateChain" ID="HelpWebPage.getSslCertificateChain"></a>
1343 <h4>HelpWebPage.getSslCertificateChain</h4>
1344 <b>getSslCertificateChain</b>(<i></i>)
1345 <p>
1346 Public method to get a reference to the SSL certificate chain.
1347 </p><dl>
1348 <dt>Returns:</dt>
1349 <dd>
1350 SSL certificate chain (list of QSslCertificate)
1351 </dd>
1352 </dl><a NAME="HelpWebPage.getSslConfiguration" ID="HelpWebPage.getSslConfiguration"></a>
1353 <h4>HelpWebPage.getSslConfiguration</h4>
1354 <b>getSslConfiguration</b>(<i></i>)
1355 <p>
1356 Public method to return a reference to the current SSL configuration.
1357 </p><dl>
1358 <dt>Returns:</dt>
1359 <dd>
1360 reference to the SSL configuration in use (QSslConfiguration)
1361 </dd>
1362 </dl><a NAME="HelpWebPage.hasValidSslInfo" ID="HelpWebPage.hasValidSslInfo"></a>
1363 <h4>HelpWebPage.hasValidSslInfo</h4>
1364 <b>hasValidSslInfo</b>(<i></i>)
1365 <p>
1366 Public method to check, if the page has a valid SSL certificate.
1367 </p><dl>
1368 <dt>Returns:</dt>
1369 <dd>
1370 flag indicating a valid SSL certificate (boolean)
1371 </dd>
1372 </dl><a NAME="HelpWebPage.pageAttributeId" ID="HelpWebPage.pageAttributeId"></a>
1373 <h4>HelpWebPage.pageAttributeId</h4>
1374 <b>pageAttributeId</b>(<i></i>)
1375 <p>
1376 Public method to get the attribute id of the page attribute.
1377 </p><dl>
1378 <dt>Returns:</dt>
1379 <dd>
1380 attribute id of the page attribute (integer)
1381 </dd>
1382 </dl><a NAME="HelpWebPage.populateNetworkRequest" ID="HelpWebPage.populateNetworkRequest"></a>
1383 <h4>HelpWebPage.populateNetworkRequest</h4>
1384 <b>populateNetworkRequest</b>(<i>request</i>)
1385 <p>
1386 Public method to add data to a network request.
1387 </p><dl>
1388 <dt><i>request</i></dt>
1389 <dd>
1390 reference to the network request object
1391 (QNetworkRequest)
1392 </dd>
1393 </dl><a NAME="HelpWebPage.setUserAgent" ID="HelpWebPage.setUserAgent"></a>
1394 <h4>HelpWebPage.setUserAgent</h4>
1395 <b>setUserAgent</b>(<i>agent</i>)
1396 <p>
1397 Public method to set the global user agent string.
1398 </p><dl>
1399 <dt><i>agent</i></dt>
1400 <dd>
1401 new current user agent string (string)
1402 </dd>
1403 </dl><a NAME="HelpWebPage.showSslInfo" ID="HelpWebPage.showSslInfo"></a>
1404 <h4>HelpWebPage.showSslInfo</h4>
1405 <b>showSslInfo</b>(<i>pos</i>)
1406 <p>
1407 Public slot to show some SSL information for the loaded page.
1408 </p><dl>
1409 <dt><i>pos</i></dt>
1410 <dd>
1411 position to show the info at (QPoint)
1412 </dd>
1413 </dl><a NAME="HelpWebPage.supportsExtension" ID="HelpWebPage.supportsExtension"></a>
1414 <h4>HelpWebPage.supportsExtension</h4>
1415 <b>supportsExtension</b>(<i>extension</i>)
1416 <p>
1417 Public method to check the support for an extension.
1418 </p><dl>
1419 <dt><i>extension</i></dt>
1420 <dd>
1421 extension to test for (QWebPage.Extension)
1422 </dd>
1423 </dl><dl>
1424 <dt>Returns:</dt>
1425 <dd>
1426 flag indicating the support of extension (boolean)
1427 </dd>
1428 </dl><a NAME="HelpWebPage.url" ID="HelpWebPage.url"></a>
1429 <h4>HelpWebPage.url</h4>
1430 <b>url</b>(<i></i>)
1431 <p>
1432 Public method to get the URL of the page.
1433 </p><dl>
1434 <dt>Returns:</dt>
1435 <dd>
1436 URL of the page (QUrl)
1437 </dd>
1438 </dl><a NAME="HelpWebPage.userAgent" ID="HelpWebPage.userAgent"></a>
1439 <h4>HelpWebPage.userAgent</h4>
1440 <b>userAgent</b>(<i>resolveEmpty=False</i>)
1441 <p>
1442 Public method to get the global user agent setting.
1443 </p><dl>
1444 <dt><i>resolveEmpty</i></dt>
1445 <dd>
1446 flag indicating to resolve an empty
1447 user agent (boolean)
1448 </dd>
1449 </dl><dl>
1450 <dt>Returns:</dt>
1451 <dd>
1452 user agent string (string)
1453 </dd>
1454 </dl><a NAME="HelpWebPage.userAgentForUrl" ID="HelpWebPage.userAgentForUrl"></a>
1455 <h4>HelpWebPage.userAgentForUrl</h4>
1456 <b>userAgentForUrl</b>(<i>url</i>)
1457 <p>
1458 Public method to determine the user agent for the given URL.
1459 </p><dl>
1460 <dt><i>url</i></dt>
1461 <dd>
1462 URL to determine user agent for (QUrl)
1463 </dd>
1464 </dl><dl>
1465 <dt>Returns:</dt>
1466 <dd>
1467 user agent string (string)
1468 </dd>
1469 </dl>
1470 <div align="right"><a href="#top">Up</a></div>
1471 <hr /><hr />
1472 <a NAME="JavaScriptEricObject" ID="JavaScriptEricObject"></a>
1473 <h2>JavaScriptEricObject</h2>
1474 <p>
1475 Class implementing an external javascript object to search via the
1476 startpage.
1477 </p>
1478 <h3>Derived from</h3>
1479 QObject
1480 <h3>Class Attributes</h3>
1481 <table>
1482 <tr><td>translations</td></tr>
1483 </table>
1484 <h3>Class Methods</h3>
1485 <table>
1486 <tr><td>None</td></tr>
1487 </table>
1488 <h3>Methods</h3>
1489 <table>
1490 <tr>
1491 <td><a href="#JavaScriptEricObject.__init__">JavaScriptEricObject</a></td>
1492 <td>Constructor</td>
1493 </tr><tr>
1494 <td><a href="#JavaScriptEricObject.providerString">providerString</a></td>
1495 <td>Public method to get a string for the search provider.</td>
1496 </tr><tr>
1497 <td><a href="#JavaScriptEricObject.searchUrl">searchUrl</a></td>
1498 <td>Public method to get the search URL for the given search term.</td>
1499 </tr><tr>
1500 <td><a href="#JavaScriptEricObject.translate">translate</a></td>
1501 <td>Public method to translate the given string.</td>
1502 </tr>
1503 </table>
1504 <h3>Static Methods</h3>
1505 <table>
1506 <tr><td>None</td></tr>
1507 </table>
1508 <a NAME="JavaScriptEricObject.__init__" ID="JavaScriptEricObject.__init__"></a>
1509 <h4>JavaScriptEricObject (Constructor)</h4>
1510 <b>JavaScriptEricObject</b>(<i>mw, parent=None</i>)
1511 <p>
1512 Constructor
1513 </p><dl>
1514 <dt><i>mw</i></dt>
1515 <dd>
1516 reference to the main window 8HelpWindow)
1517 </dd><dt><i>parent</i></dt>
1518 <dd>
1519 reference to the parent object (QObject)
1520 </dd>
1521 </dl><a NAME="JavaScriptEricObject.providerString" ID="JavaScriptEricObject.providerString"></a>
1522 <h4>JavaScriptEricObject.providerString</h4>
1523 <b>providerString</b>(<i></i>)
1524 <p>
1525 Public method to get a string for the search provider.
1526 </p><dl>
1527 <dt>Returns:</dt>
1528 <dd>
1529 string for the search provider (string)
1530 </dd>
1531 </dl><a NAME="JavaScriptEricObject.searchUrl" ID="JavaScriptEricObject.searchUrl"></a>
1532 <h4>JavaScriptEricObject.searchUrl</h4>
1533 <b>searchUrl</b>(<i>searchStr</i>)
1534 <p>
1535 Public method to get the search URL for the given search term.
1536 </p><dl>
1537 <dt><i>searchStr</i></dt>
1538 <dd>
1539 search term (string)
1540 </dd>
1541 </dl><dl>
1542 <dt>Returns:</dt>
1543 <dd>
1544 search URL (string)
1545 </dd>
1546 </dl><a NAME="JavaScriptEricObject.translate" ID="JavaScriptEricObject.translate"></a>
1547 <h4>JavaScriptEricObject.translate</h4>
1548 <b>translate</b>(<i>trans</i>)
1549 <p>
1550 Public method to translate the given string.
1551 </p><dl>
1552 <dt><i>trans</i></dt>
1553 <dd>
1554 string to be translated (string)
1555 </dd>
1556 </dl><dl>
1557 <dt>Returns:</dt>
1558 <dd>
1559 translation (string)
1560 </dd>
1561 </dl>
1562 <div align="right"><a href="#top">Up</a></div>
1563 <hr /><hr />
1564 <a NAME="JavaScriptExternalObject" ID="JavaScriptExternalObject"></a>
1565 <h2>JavaScriptExternalObject</h2>
1566 <p>
1567 Class implementing an external javascript object to add search providers.
1568 </p>
1569 <h3>Derived from</h3>
1570 QObject
1571 <h3>Class Attributes</h3>
1572 <table>
1573 <tr><td>None</td></tr>
1574 </table>
1575 <h3>Class Methods</h3>
1576 <table>
1577 <tr><td>None</td></tr>
1578 </table>
1579 <h3>Methods</h3>
1580 <table>
1581 <tr>
1582 <td><a href="#JavaScriptExternalObject.__init__">JavaScriptExternalObject</a></td>
1583 <td>Constructor</td>
1584 </tr><tr>
1585 <td><a href="#JavaScriptExternalObject.AddSearchProvider">AddSearchProvider</a></td>
1586 <td>Public slot to add a search provider.</td>
1587 </tr>
1588 </table>
1589 <h3>Static Methods</h3>
1590 <table>
1591 <tr><td>None</td></tr>
1592 </table>
1593 <a NAME="JavaScriptExternalObject.__init__" ID="JavaScriptExternalObject.__init__"></a>
1594 <h4>JavaScriptExternalObject (Constructor)</h4>
1595 <b>JavaScriptExternalObject</b>(<i>mw, parent=None</i>)
1596 <p>
1597 Constructor
1598 </p><dl>
1599 <dt><i>mw</i></dt>
1600 <dd>
1601 reference to the main window 8HelpWindow)
1602 </dd><dt><i>parent</i></dt>
1603 <dd>
1604 reference to the parent object (QObject)
1605 </dd>
1606 </dl><a NAME="JavaScriptExternalObject.AddSearchProvider" ID="JavaScriptExternalObject.AddSearchProvider"></a>
1607 <h4>JavaScriptExternalObject.AddSearchProvider</h4>
1608 <b>AddSearchProvider</b>(<i>url</i>)
1609 <p>
1610 Public slot to add a search provider.
1611 </p><dl>
1612 <dt><i>url</i></dt>
1613 <dd>
1614 url of the XML file defining the search provider (string)
1615 </dd>
1616 </dl>
1617 <div align="right"><a href="#top">Up</a></div>
1618 <hr /><hr />
1619 <a NAME="LinkedResource" ID="LinkedResource"></a>
1620 <h2>LinkedResource</h2>
1621 <p>
1622 Class defining a data structure for linked resources.
1623 </p>
1624 <h3>Derived from</h3>
1625 object
1626 <h3>Class Attributes</h3>
1627 <table>
1628 <tr><td>None</td></tr>
1629 </table>
1630 <h3>Class Methods</h3>
1631 <table>
1632 <tr><td>None</td></tr>
1633 </table>
1634 <h3>Methods</h3>
1635 <table>
1636 <tr>
1637 <td><a href="#LinkedResource.__init__">LinkedResource</a></td>
1638 <td>Constructor</td>
1639 </tr>
1640 </table>
1641 <h3>Static Methods</h3>
1642 <table>
1643 <tr><td>None</td></tr>
1644 </table>
1645 <a NAME="LinkedResource.__init__" ID="LinkedResource.__init__"></a>
1646 <h4>LinkedResource (Constructor)</h4>
1647 <b>LinkedResource</b>(<i></i>)
1648 <p>
1649 Constructor
1650 </p>
1651 <div align="right"><a href="#top">Up</a></div>
1652 <hr /><hr />
1653 <a NAME="contentSniff" ID="contentSniff"></a>
1654 <h2>contentSniff</h2>
1655 <b>contentSniff</b>(<i>data</i>)
1656 <p>
1657 Module function to do some content sniffing to check, if the data is HTML.
1658 </p><dl>
1659 <dt><i>data</i></dt>
1660 <dd>
1661 data block to sniff at (string)
1662 </dd>
1663 </dl><dl>
1664 <dt>Returns:</dt>
1665 <dd>
1666 flag indicating HTML content (boolean)
1667 </dd>
1668 </dl>
1669 <div align="right"><a href="#top">Up</a></div>
1670 <hr />
1671 </body></html>

Mercurial Repository: eric

eric ide

mercurial