Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial