Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Helpviewer.HelpBrowserWV.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Helpviewer.HelpBrowserWV</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Helpviewer.HelpBrowserWV</h1>
24 <p>
25 Module implementing the helpbrowser using QWebView.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HelpBrowser">HelpBrowser</a></td>
35 <td>Class implementing the helpbrowser widget.</td>
36 </tr><tr>
37 <td><a href="#HelpWebPage">HelpWebPage</a></td>
38 <td>Class implementing an enhanced web page.</td>
39 </tr><tr>
40 <td><a href="#JavaScriptEricObject">JavaScriptEricObject</a></td>
41 <td>Class implementing an external javascript object to search via the startpage.</td>
42 </tr><tr>
43 <td><a href="#JavaScriptExternalObject">JavaScriptExternalObject</a></td>
44 <td>Class implementing an external javascript object to add search providers.</td>
45 </tr><tr>
46 <td><a href="#LinkedResource">LinkedResource</a></td>
47 <td>Class defining a data structure for linked resources.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <hr /><hr />
55 <a NAME="HelpBrowser" ID="HelpBrowser"></a>
56 <h2>HelpBrowser</h2>
57 <p>
58 Class implementing the helpbrowser widget.
59 </p><p>
60 This is a subclass of the Qt QWebView to implement an
61 interface compatible with the QTextBrowser based variant.
62 </p><h4>Signals</h4>
63 <dl>
64 <dt>backwardAvailable(bool)</dt>
65 <dd>
66 emitted after the current URL has changed
67 </dd><dt>forwardAvailable(bool)</dt>
68 <dd>
69 emitted after the current URL has changed
70 </dd><dt>highlighted(const QString&)</dt>
71 <dd>
72 emitted, when the mouse hovers over a link
73 </dd><dt>search(const QUrl &)</dt>
74 <dd>
75 emitted, when a search is requested
76 </dd><dt>sourceChanged(const QUrl &)</dt>
77 <dd>
78 emitted after the current URL has changed
79 </dd>
80 </dl>
81 <h3>Derived from</h3>
82 QWebView
83 <h3>Class Attributes</h3>
84 <table>
85 <tr><td>None</td></tr>
86 </table>
87 <h3>Methods</h3>
88 <table>
89 <tr>
90 <td><a href="#HelpBrowser.__init__">HelpBrowser</a></td>
91 <td>Constructor</td>
92 </tr><tr>
93 <td><a href="#HelpBrowser.__addBookmark">__addBookmark</a></td>
94 <td>Private slot to bookmark the current link.</td>
95 </tr><tr>
96 <td><a href="#HelpBrowser.__addExternalBinding">__addExternalBinding</a></td>
97 <td>Private slot to add javascript bindings for adding search providers.</td>
98 </tr><tr>
99 <td><a href="#HelpBrowser.__applyZoom">__applyZoom</a></td>
100 <td>Private slot to apply the current zoom factor.</td>
101 </tr><tr>
102 <td><a href="#HelpBrowser.__blockImage">__blockImage</a></td>
103 <td>Private slot to add a block rule for an image URL.</td>
104 </tr><tr>
105 <td><a href="#HelpBrowser.__bookmarkLink">__bookmarkLink</a></td>
106 <td>Private slot to bookmark a link via the context menu.</td>
107 </tr><tr>
108 <td><a href="#HelpBrowser.__copyImage">__copyImage</a></td>
109 <td>Private slot to copy an image to the clipboard.</td>
110 </tr><tr>
111 <td><a href="#HelpBrowser.__copyImageLocation">__copyImageLocation</a></td>
112 <td>Private slot to copy an image location to the clipboard.</td>
113 </tr><tr>
114 <td><a href="#HelpBrowser.__copyLink">__copyLink</a></td>
115 <td>Private slot to copy a link to the clipboard.</td>
116 </tr><tr>
117 <td><a href="#HelpBrowser.__currentEngineChanged">__currentEngineChanged</a></td>
118 <td>Private slot to track a change of the current search engine.</td>
119 </tr><tr>
120 <td><a href="#HelpBrowser.__downloadDone">__downloadDone</a></td>
121 <td>Private slot to handle the done signal of the download dialogs.</td>
122 </tr><tr>
123 <td><a href="#HelpBrowser.__downloadImage">__downloadImage</a></td>
124 <td>Private slot to download an image and save it to disk.</td>
125 </tr><tr>
126 <td><a href="#HelpBrowser.__downloadLink">__downloadLink</a></td>
127 <td>Private slot to download a link and save it to disk.</td>
128 </tr><tr>
129 <td><a href="#HelpBrowser.__downloadRequested">__downloadRequested</a></td>
130 <td>Private slot to handle a download request.</td>
131 </tr><tr>
132 <td><a href="#HelpBrowser.__iconChanged">__iconChanged</a></td>
133 <td>Private slot to handle the icon change.</td>
134 </tr><tr>
135 <td><a href="#HelpBrowser.__levelForZoom">__levelForZoom</a></td>
136 <td>Private method determining the zoom level index given a zoom factor.</td>
137 </tr><tr>
138 <td><a href="#HelpBrowser.__linkHovered">__linkHovered</a></td>
139 <td>Private slot to handle the linkHovered signal.</td>
140 </tr><tr>
141 <td><a href="#HelpBrowser.__loadFinished">__loadFinished</a></td>
142 <td>Private method to handle the loadFinished signal.</td>
143 </tr><tr>
144 <td><a href="#HelpBrowser.__loadProgress">__loadProgress</a></td>
145 <td>Private method to handle the loadProgress signal.</td>
146 </tr><tr>
147 <td><a href="#HelpBrowser.__loadStarted">__loadStarted</a></td>
148 <td>Private method to handle the loadStarted signal.</td>
149 </tr><tr>
150 <td><a href="#HelpBrowser.__openLinkInNewTab">__openLinkInNewTab</a></td>
151 <td>Private method called by the context menu to open a link in a new window.</td>
152 </tr><tr>
153 <td><a href="#HelpBrowser.__searchRequested">__searchRequested</a></td>
154 <td>Private slot to search for some text with a selected search engine.</td>
155 </tr><tr>
156 <td><a href="#HelpBrowser.__statusBarMessage">__statusBarMessage</a></td>
157 <td>Private slot to handle the statusBarMessage signal.</td>
158 </tr><tr>
159 <td><a href="#HelpBrowser.__unsupportedContent">__unsupportedContent</a></td>
160 <td>Private slot to handle the unsupportedContent signal.</td>
161 </tr><tr>
162 <td><a href="#HelpBrowser.__urlChanged">__urlChanged</a></td>
163 <td>Private slot to handle the urlChanged signal.</td>
164 </tr><tr>
165 <td><a href="#HelpBrowser.__webInspector">__webInspector</a></td>
166 <td>Private slot to show the web inspector window.</td>
167 </tr><tr>
168 <td><a href="#HelpBrowser.backward">backward</a></td>
169 <td>Public slot to move backwards in history.</td>
170 </tr><tr>
171 <td><a href="#HelpBrowser.clearHistory">clearHistory</a></td>
172 <td>Public slot to clear the history.</td>
173 </tr><tr>
174 <td><a href="#HelpBrowser.contextMenuEvent">contextMenuEvent</a></td>
175 <td>Protected method called to create a context menu.</td>
176 </tr><tr>
177 <td><a href="#HelpBrowser.copy">copy</a></td>
178 <td>Public slot to copy the selected text.</td>
179 </tr><tr>
180 <td><a href="#HelpBrowser.createWindow">createWindow</a></td>
181 <td>Protected method called, when a new window should be created.</td>
182 </tr><tr>
183 <td><a href="#HelpBrowser.documentTitle">documentTitle</a></td>
184 <td>Public method to return the title of the loaded page.</td>
185 </tr><tr>
186 <td><a href="#HelpBrowser.findNextPrev">findNextPrev</a></td>
187 <td>Public slot to find the next occurrence of a text.</td>
188 </tr><tr>
189 <td><a href="#HelpBrowser.forward">forward</a></td>
190 <td>Public slot to move forward in history.</td>
191 </tr><tr>
192 <td><a href="#HelpBrowser.hasSelection">hasSelection</a></td>
193 <td>Public method to determine, if there is some text selected.</td>
194 </tr><tr>
195 <td><a href="#HelpBrowser.home">home</a></td>
196 <td>Public slot to move to the first page loaded.</td>
197 </tr><tr>
198 <td><a href="#HelpBrowser.isBackwardAvailable">isBackwardAvailable</a></td>
199 <td>Public method to determine, if a backwards move in history is possible.</td>
200 </tr><tr>
201 <td><a href="#HelpBrowser.isForwardAvailable">isForwardAvailable</a></td>
202 <td>Public method to determine, if a forward move in history is possible.</td>
203 </tr><tr>
204 <td><a href="#HelpBrowser.isLoading">isLoading</a></td>
205 <td>Public method to get the loading state.</td>
206 </tr><tr>
207 <td><a href="#HelpBrowser.keyPressEvent">keyPressEvent</a></td>
208 <td>Protected method called by a key press.</td>
209 </tr><tr>
210 <td><a href="#HelpBrowser.keyReleaseEvent">keyReleaseEvent</a></td>
211 <td>Protected method called by a key release.</td>
212 </tr><tr>
213 <td><a href="#HelpBrowser.linkedResources">linkedResources</a></td>
214 <td>Public method to extract linked resources.</td>
215 </tr><tr>
216 <td><a href="#HelpBrowser.preferencesChanged">preferencesChanged</a></td>
217 <td>Public method to indicate a change of the settings.</td>
218 </tr><tr>
219 <td><a href="#HelpBrowser.reload">reload</a></td>
220 <td>Public slot to reload the current page.</td>
221 </tr><tr>
222 <td><a href="#HelpBrowser.saveAs">saveAs</a></td>
223 <td>Public method to save the current page to a file.</td>
224 </tr><tr>
225 <td><a href="#HelpBrowser.setSource">setSource</a></td>
226 <td>Public method used to set the source to be displayed.</td>
227 </tr><tr>
228 <td><a href="#HelpBrowser.source">source</a></td>
229 <td>Public method to return the URL of the loaded page.</td>
230 </tr><tr>
231 <td><a href="#HelpBrowser.wheelEvent">wheelEvent</a></td>
232 <td>Protected method to handle wheel events.</td>
233 </tr><tr>
234 <td><a href="#HelpBrowser.zoomIn">zoomIn</a></td>
235 <td>Public slot to zoom into the page.</td>
236 </tr><tr>
237 <td><a href="#HelpBrowser.zoomOut">zoomOut</a></td>
238 <td>Public slot to zoom out of the page.</td>
239 </tr><tr>
240 <td><a href="#HelpBrowser.zoomReset">zoomReset</a></td>
241 <td>Public method to reset the zoom factor.</td>
242 </tr>
243 </table>
244 <a NAME="HelpBrowser.__init__" ID="HelpBrowser.__init__"></a>
245 <h4>HelpBrowser (Constructor)</h4>
246 <b>HelpBrowser</b>(<i>parent = None, name = ""</i>)
247 <p>
248 Constructor
249 </p><dl>
250 <dt><i>parent</i></dt>
251 <dd>
252 parent widget of this window (QWidget)
253 </dd><dt><i>name</i></dt>
254 <dd>
255 name of this window (string)
256 </dd>
257 </dl><a NAME="HelpBrowser.__addBookmark" ID="HelpBrowser.__addBookmark"></a>
258 <h4>HelpBrowser.__addBookmark</h4>
259 <b>__addBookmark</b>(<i></i>)
260 <p>
261 Private slot to bookmark the current link.
262 </p><a NAME="HelpBrowser.__addExternalBinding" ID="HelpBrowser.__addExternalBinding"></a>
263 <h4>HelpBrowser.__addExternalBinding</h4>
264 <b>__addExternalBinding</b>(<i>frame = None</i>)
265 <p>
266 Private slot to add javascript bindings for adding search providers.
267 </p><dl>
268 <dt><i>frame</i></dt>
269 <dd>
270 reference to the web frame (QWebFrame)
271 </dd>
272 </dl><a NAME="HelpBrowser.__applyZoom" ID="HelpBrowser.__applyZoom"></a>
273 <h4>HelpBrowser.__applyZoom</h4>
274 <b>__applyZoom</b>(<i></i>)
275 <p>
276 Private slot to apply the current zoom factor.
277 </p><a NAME="HelpBrowser.__blockImage" ID="HelpBrowser.__blockImage"></a>
278 <h4>HelpBrowser.__blockImage</h4>
279 <b>__blockImage</b>(<i></i>)
280 <p>
281 Private slot to add a block rule for an image URL.
282 </p><a NAME="HelpBrowser.__bookmarkLink" ID="HelpBrowser.__bookmarkLink"></a>
283 <h4>HelpBrowser.__bookmarkLink</h4>
284 <b>__bookmarkLink</b>(<i></i>)
285 <p>
286 Private slot to bookmark a link via the context menu.
287 </p><a NAME="HelpBrowser.__copyImage" ID="HelpBrowser.__copyImage"></a>
288 <h4>HelpBrowser.__copyImage</h4>
289 <b>__copyImage</b>(<i></i>)
290 <p>
291 Private slot to copy an image to the clipboard.
292 </p><a NAME="HelpBrowser.__copyImageLocation" ID="HelpBrowser.__copyImageLocation"></a>
293 <h4>HelpBrowser.__copyImageLocation</h4>
294 <b>__copyImageLocation</b>(<i></i>)
295 <p>
296 Private slot to copy an image location to the clipboard.
297 </p><a NAME="HelpBrowser.__copyLink" ID="HelpBrowser.__copyLink"></a>
298 <h4>HelpBrowser.__copyLink</h4>
299 <b>__copyLink</b>(<i></i>)
300 <p>
301 Private slot to copy a link to the clipboard.
302 </p><a NAME="HelpBrowser.__currentEngineChanged" ID="HelpBrowser.__currentEngineChanged"></a>
303 <h4>HelpBrowser.__currentEngineChanged</h4>
304 <b>__currentEngineChanged</b>(<i></i>)
305 <p>
306 Private slot to track a change of the current search engine.
307 </p><a NAME="HelpBrowser.__downloadDone" ID="HelpBrowser.__downloadDone"></a>
308 <h4>HelpBrowser.__downloadDone</h4>
309 <b>__downloadDone</b>(<i></i>)
310 <p>
311 Private slot to handle the done signal of the download dialogs.
312 </p><a NAME="HelpBrowser.__downloadImage" ID="HelpBrowser.__downloadImage"></a>
313 <h4>HelpBrowser.__downloadImage</h4>
314 <b>__downloadImage</b>(<i></i>)
315 <p>
316 Private slot to download an image and save it to disk.
317 </p><a NAME="HelpBrowser.__downloadLink" ID="HelpBrowser.__downloadLink"></a>
318 <h4>HelpBrowser.__downloadLink</h4>
319 <b>__downloadLink</b>(<i></i>)
320 <p>
321 Private slot to download a link and save it to disk.
322 </p><a NAME="HelpBrowser.__downloadRequested" ID="HelpBrowser.__downloadRequested"></a>
323 <h4>HelpBrowser.__downloadRequested</h4>
324 <b>__downloadRequested</b>(<i>request</i>)
325 <p>
326 Private slot to handle a download request.
327 </p><dl>
328 <dt><i>request</i></dt>
329 <dd>
330 reference to the request object (QNetworkRequest)
331 </dd>
332 </dl><a NAME="HelpBrowser.__iconChanged" ID="HelpBrowser.__iconChanged"></a>
333 <h4>HelpBrowser.__iconChanged</h4>
334 <b>__iconChanged</b>(<i></i>)
335 <p>
336 Private slot to handle the icon change.
337 </p><a NAME="HelpBrowser.__levelForZoom" ID="HelpBrowser.__levelForZoom"></a>
338 <h4>HelpBrowser.__levelForZoom</h4>
339 <b>__levelForZoom</b>(<i>zoom</i>)
340 <p>
341 Private method determining the zoom level index given a zoom factor.
342 </p><dl>
343 <dt><i>zoom</i></dt>
344 <dd>
345 zoom factor (integer)
346 </dd>
347 </dl><dl>
348 <dt>Returns:</dt>
349 <dd>
350 index of zoom factor (integer)
351 </dd>
352 </dl><a NAME="HelpBrowser.__linkHovered" ID="HelpBrowser.__linkHovered"></a>
353 <h4>HelpBrowser.__linkHovered</h4>
354 <b>__linkHovered</b>(<i>link, title, textContent</i>)
355 <p>
356 Private slot to handle the linkHovered signal.
357 </p><dl>
358 <dt><i>link</i></dt>
359 <dd>
360 the URL of the link (string)
361 </dd><dt><i>title</i></dt>
362 <dd>
363 the link title (string)
364 </dd><dt><i>textContent</i></dt>
365 <dd>
366 text content of the link (string)
367 </dd>
368 </dl><a NAME="HelpBrowser.__loadFinished" ID="HelpBrowser.__loadFinished"></a>
369 <h4>HelpBrowser.__loadFinished</h4>
370 <b>__loadFinished</b>(<i>ok</i>)
371 <p>
372 Private method to handle the loadFinished signal.
373 </p><dl>
374 <dt><i>ok</i></dt>
375 <dd>
376 flag indicating the result (boolean)
377 </dd>
378 </dl><a NAME="HelpBrowser.__loadProgress" ID="HelpBrowser.__loadProgress"></a>
379 <h4>HelpBrowser.__loadProgress</h4>
380 <b>__loadProgress</b>(<i>progress</i>)
381 <p>
382 Private method to handle the loadProgress signal.
383 </p><dl>
384 <dt><i>progress</i></dt>
385 <dd>
386 progress value (integer)
387 </dd>
388 </dl><a NAME="HelpBrowser.__loadStarted" ID="HelpBrowser.__loadStarted"></a>
389 <h4>HelpBrowser.__loadStarted</h4>
390 <b>__loadStarted</b>(<i></i>)
391 <p>
392 Private method to handle the loadStarted signal.
393 </p><a NAME="HelpBrowser.__openLinkInNewTab" ID="HelpBrowser.__openLinkInNewTab"></a>
394 <h4>HelpBrowser.__openLinkInNewTab</h4>
395 <b>__openLinkInNewTab</b>(<i></i>)
396 <p>
397 Private method called by the context menu to open a link in a new window.
398 </p><a NAME="HelpBrowser.__searchRequested" ID="HelpBrowser.__searchRequested"></a>
399 <h4>HelpBrowser.__searchRequested</h4>
400 <b>__searchRequested</b>(<i>act</i>)
401 <p>
402 Private slot to search for some text with a selected search engine.
403 </p><dl>
404 <dt><i>act</i></dt>
405 <dd>
406 reference to the action that triggered this slot (QAction)
407 </dd>
408 </dl><a NAME="HelpBrowser.__statusBarMessage" ID="HelpBrowser.__statusBarMessage"></a>
409 <h4>HelpBrowser.__statusBarMessage</h4>
410 <b>__statusBarMessage</b>(<i>text</i>)
411 <p>
412 Private slot to handle the statusBarMessage signal.
413 </p><dl>
414 <dt><i>text</i></dt>
415 <dd>
416 text to be shown in the status bar (string)
417 </dd>
418 </dl><a NAME="HelpBrowser.__unsupportedContent" ID="HelpBrowser.__unsupportedContent"></a>
419 <h4>HelpBrowser.__unsupportedContent</h4>
420 <b>__unsupportedContent</b>(<i>reply, requestFilename = None, download = False</i>)
421 <p>
422 Private slot to handle the unsupportedContent signal.
423 </p><dl>
424 <dt><i>reply</i></dt>
425 <dd>
426 reference to the reply object (QNetworkReply)
427 </dd><dt><i>requestFilename=</i></dt>
428 <dd>
429 indicating to ask for a filename
430 (boolean or None). If it is None, the behavior is determined
431 by a configuration option.
432 </dd><dt><i>download=</i></dt>
433 <dd>
434 flag indicating a download operation (boolean)
435 </dd>
436 </dl><a NAME="HelpBrowser.__urlChanged" ID="HelpBrowser.__urlChanged"></a>
437 <h4>HelpBrowser.__urlChanged</h4>
438 <b>__urlChanged</b>(<i>url</i>)
439 <p>
440 Private slot to handle the urlChanged signal.
441 </p><dl>
442 <dt><i>url</i></dt>
443 <dd>
444 the new url (QUrl)
445 </dd>
446 </dl><a NAME="HelpBrowser.__webInspector" ID="HelpBrowser.__webInspector"></a>
447 <h4>HelpBrowser.__webInspector</h4>
448 <b>__webInspector</b>(<i></i>)
449 <p>
450 Private slot to show the web inspector window.
451 </p><a NAME="HelpBrowser.backward" ID="HelpBrowser.backward"></a>
452 <h4>HelpBrowser.backward</h4>
453 <b>backward</b>(<i></i>)
454 <p>
455 Public slot to move backwards in history.
456 </p><a NAME="HelpBrowser.clearHistory" ID="HelpBrowser.clearHistory"></a>
457 <h4>HelpBrowser.clearHistory</h4>
458 <b>clearHistory</b>(<i></i>)
459 <p>
460 Public slot to clear the history.
461 </p><a NAME="HelpBrowser.contextMenuEvent" ID="HelpBrowser.contextMenuEvent"></a>
462 <h4>HelpBrowser.contextMenuEvent</h4>
463 <b>contextMenuEvent</b>(<i>evt</i>)
464 <p>
465 Protected method called to create a context menu.
466 </p><p>
467 This method is overridden from QWebView.
468 </p><dl>
469 <dt><i>evt</i></dt>
470 <dd>
471 reference to the context menu event object (QContextMenuEvent)
472 </dd>
473 </dl><a NAME="HelpBrowser.copy" ID="HelpBrowser.copy"></a>
474 <h4>HelpBrowser.copy</h4>
475 <b>copy</b>(<i></i>)
476 <p>
477 Public slot to copy the selected text.
478 </p><a NAME="HelpBrowser.createWindow" ID="HelpBrowser.createWindow"></a>
479 <h4>HelpBrowser.createWindow</h4>
480 <b>createWindow</b>(<i>windowType</i>)
481 <p>
482 Protected method called, when a new window should be created.
483 </p><dl>
484 <dt><i>windowType</i></dt>
485 <dd>
486 type of the requested window (QWebPage.WebWindowType)
487 </dd>
488 </dl><a NAME="HelpBrowser.documentTitle" ID="HelpBrowser.documentTitle"></a>
489 <h4>HelpBrowser.documentTitle</h4>
490 <b>documentTitle</b>(<i></i>)
491 <p>
492 Public method to return the title of the loaded page.
493 </p><dl>
494 <dt>Returns:</dt>
495 <dd>
496 title (string)
497 </dd>
498 </dl><a NAME="HelpBrowser.findNextPrev" ID="HelpBrowser.findNextPrev"></a>
499 <h4>HelpBrowser.findNextPrev</h4>
500 <b>findNextPrev</b>(<i>txt, case, backwards, wrap</i>)
501 <p>
502 Public slot to find the next occurrence of a text.
503 </p><dl>
504 <dt><i>txt</i></dt>
505 <dd>
506 text to search for (string)
507 </dd><dt><i>case</i></dt>
508 <dd>
509 flag indicating a case sensitive search (boolean)
510 </dd><dt><i>backwards</i></dt>
511 <dd>
512 flag indicating a backwards search (boolean)
513 </dd><dt><i>wrap</i></dt>
514 <dd>
515 flag indicating to wrap around (boolean)
516 </dd>
517 </dl><a NAME="HelpBrowser.forward" ID="HelpBrowser.forward"></a>
518 <h4>HelpBrowser.forward</h4>
519 <b>forward</b>(<i></i>)
520 <p>
521 Public slot to move forward in history.
522 </p><a NAME="HelpBrowser.hasSelection" ID="HelpBrowser.hasSelection"></a>
523 <h4>HelpBrowser.hasSelection</h4>
524 <b>hasSelection</b>(<i></i>)
525 <p>
526 Public method to determine, if there is some text selected.
527 </p><dl>
528 <dt>Returns:</dt>
529 <dd>
530 flag indicating text has been selected (boolean)
531 </dd>
532 </dl><a NAME="HelpBrowser.home" ID="HelpBrowser.home"></a>
533 <h4>HelpBrowser.home</h4>
534 <b>home</b>(<i></i>)
535 <p>
536 Public slot to move to the first page loaded.
537 </p><a NAME="HelpBrowser.isBackwardAvailable" ID="HelpBrowser.isBackwardAvailable"></a>
538 <h4>HelpBrowser.isBackwardAvailable</h4>
539 <b>isBackwardAvailable</b>(<i></i>)
540 <p>
541 Public method to determine, if a backwards move in history is possible.
542 </p><dl>
543 <dt>Returns:</dt>
544 <dd>
545 flag indicating move backwards is possible (boolean)
546 </dd>
547 </dl><a NAME="HelpBrowser.isForwardAvailable" ID="HelpBrowser.isForwardAvailable"></a>
548 <h4>HelpBrowser.isForwardAvailable</h4>
549 <b>isForwardAvailable</b>(<i></i>)
550 <p>
551 Public method to determine, if a forward move in history is possible.
552 </p><dl>
553 <dt>Returns:</dt>
554 <dd>
555 flag indicating move forward is possible (boolean)
556 </dd>
557 </dl><a NAME="HelpBrowser.isLoading" ID="HelpBrowser.isLoading"></a>
558 <h4>HelpBrowser.isLoading</h4>
559 <b>isLoading</b>(<i></i>)
560 <p>
561 Public method to get the loading state.
562 </p><dl>
563 <dt>Returns:</dt>
564 <dd>
565 flag indicating the loading state (boolean)
566 </dd>
567 </dl><a NAME="HelpBrowser.keyPressEvent" ID="HelpBrowser.keyPressEvent"></a>
568 <h4>HelpBrowser.keyPressEvent</h4>
569 <b>keyPressEvent</b>(<i>evt</i>)
570 <p>
571 Protected method called by a key press.
572 </p><p>
573 This method is overridden from QTextBrowser.
574 </p><dl>
575 <dt><i>evt</i></dt>
576 <dd>
577 the key event (QKeyEvent)
578 </dd>
579 </dl><a NAME="HelpBrowser.keyReleaseEvent" ID="HelpBrowser.keyReleaseEvent"></a>
580 <h4>HelpBrowser.keyReleaseEvent</h4>
581 <b>keyReleaseEvent</b>(<i>evt</i>)
582 <p>
583 Protected method called by a key release.
584 </p><p>
585 This method is overridden from QTextBrowser.
586 </p><dl>
587 <dt><i>evt</i></dt>
588 <dd>
589 the key event (QKeyEvent)
590 </dd>
591 </dl><a NAME="HelpBrowser.linkedResources" ID="HelpBrowser.linkedResources"></a>
592 <h4>HelpBrowser.linkedResources</h4>
593 <b>linkedResources</b>(<i>relation = ""</i>)
594 <p>
595 Public method to extract linked resources.
596 </p><dl>
597 <dt><i>relation</i></dt>
598 <dd>
599 relation to extract (string)
600 </dd>
601 </dl><dl>
602 <dt>Returns:</dt>
603 <dd>
604 list of linked resources (list of LinkedResource)
605 </dd>
606 </dl><a NAME="HelpBrowser.preferencesChanged" ID="HelpBrowser.preferencesChanged"></a>
607 <h4>HelpBrowser.preferencesChanged</h4>
608 <b>preferencesChanged</b>(<i></i>)
609 <p>
610 Public method to indicate a change of the settings.
611 </p><a NAME="HelpBrowser.reload" ID="HelpBrowser.reload"></a>
612 <h4>HelpBrowser.reload</h4>
613 <b>reload</b>(<i></i>)
614 <p>
615 Public slot to reload the current page.
616 </p><a NAME="HelpBrowser.saveAs" ID="HelpBrowser.saveAs"></a>
617 <h4>HelpBrowser.saveAs</h4>
618 <b>saveAs</b>(<i></i>)
619 <p>
620 Public method to save the current page to a file.
621 </p><a NAME="HelpBrowser.setSource" ID="HelpBrowser.setSource"></a>
622 <h4>HelpBrowser.setSource</h4>
623 <b>setSource</b>(<i>name</i>)
624 <p>
625 Public method used to set the source to be displayed.
626 </p><dl>
627 <dt><i>name</i></dt>
628 <dd>
629 filename to be shown (QUrl)
630 </dd>
631 </dl><a NAME="HelpBrowser.source" ID="HelpBrowser.source"></a>
632 <h4>HelpBrowser.source</h4>
633 <b>source</b>(<i></i>)
634 <p>
635 Public method to return the URL of the loaded page.
636 </p><dl>
637 <dt>Returns:</dt>
638 <dd>
639 URL loaded in the help browser (QUrl)
640 </dd>
641 </dl><a NAME="HelpBrowser.wheelEvent" ID="HelpBrowser.wheelEvent"></a>
642 <h4>HelpBrowser.wheelEvent</h4>
643 <b>wheelEvent</b>(<i>evt</i>)
644 <p>
645 Protected method to handle wheel events.
646 </p><dl>
647 <dt><i>evt</i></dt>
648 <dd>
649 reference to the wheel event (QWheelEvent)
650 </dd>
651 </dl><a NAME="HelpBrowser.zoomIn" ID="HelpBrowser.zoomIn"></a>
652 <h4>HelpBrowser.zoomIn</h4>
653 <b>zoomIn</b>(<i></i>)
654 <p>
655 Public slot to zoom into the page.
656 </p><a NAME="HelpBrowser.zoomOut" ID="HelpBrowser.zoomOut"></a>
657 <h4>HelpBrowser.zoomOut</h4>
658 <b>zoomOut</b>(<i></i>)
659 <p>
660 Public slot to zoom out of the page.
661 </p><a NAME="HelpBrowser.zoomReset" ID="HelpBrowser.zoomReset"></a>
662 <h4>HelpBrowser.zoomReset</h4>
663 <b>zoomReset</b>(<i></i>)
664 <p>
665 Public method to reset the zoom factor.
666 </p>
667 <div align="right"><a href="#top">Up</a></div>
668 <hr /><hr />
669 <a NAME="HelpWebPage" ID="HelpWebPage"></a>
670 <h2>HelpWebPage</h2>
671 <p>
672 Class implementing an enhanced web page.
673 </p>
674 <h3>Derived from</h3>
675 QWebPage
676 <h3>Class Attributes</h3>
677 <table>
678 <tr><td>None</td></tr>
679 </table>
680 <h3>Methods</h3>
681 <table>
682 <tr>
683 <td><a href="#HelpWebPage.__init__">HelpWebPage</a></td>
684 <td>Constructor</td>
685 </tr><tr>
686 <td><a href="#HelpWebPage.acceptNavigationRequest">acceptNavigationRequest</a></td>
687 <td>Protected method to determine, if a request may be accepted.</td>
688 </tr><tr>
689 <td><a href="#HelpWebPage.pageAttributeId">pageAttributeId</a></td>
690 <td>Public method to get the attribute id of the page attribute.</td>
691 </tr><tr>
692 <td><a href="#HelpWebPage.populateNetworkRequest">populateNetworkRequest</a></td>
693 <td>Public method to add data to a network request.</td>
694 </tr>
695 </table>
696 <a NAME="HelpWebPage.__init__" ID="HelpWebPage.__init__"></a>
697 <h4>HelpWebPage (Constructor)</h4>
698 <b>HelpWebPage</b>(<i>parent = None</i>)
699 <p>
700 Constructor
701 </p><dl>
702 <dt><i>parent</i></dt>
703 <dd>
704 parent widget of this window (QWidget)
705 </dd>
706 </dl><a NAME="HelpWebPage.acceptNavigationRequest" ID="HelpWebPage.acceptNavigationRequest"></a>
707 <h4>HelpWebPage.acceptNavigationRequest</h4>
708 <b>acceptNavigationRequest</b>(<i>frame, request, type_</i>)
709 <p>
710 Protected method to determine, if a request may be accepted.
711 </p><dl>
712 <dt><i>frame</i></dt>
713 <dd>
714 reference to the frame sending the request (QWebFrame)
715 </dd><dt><i>request</i></dt>
716 <dd>
717 reference to the request object (QNetworkRequest)
718 </dd><dt><i>type_</i></dt>
719 <dd>
720 type of the navigation request (QWebPage.NavigationType)
721 </dd>
722 </dl><dl>
723 <dt>Returns:</dt>
724 <dd>
725 flag indicating acceptance (boolean)
726 </dd>
727 </dl><a NAME="HelpWebPage.pageAttributeId" ID="HelpWebPage.pageAttributeId"></a>
728 <h4>HelpWebPage.pageAttributeId</h4>
729 <b>pageAttributeId</b>(<i></i>)
730 <p>
731 Public method to get the attribute id of the page attribute.
732 </p><dl>
733 <dt>Returns:</dt>
734 <dd>
735 attribute id of the page attribute (integer)
736 </dd>
737 </dl><a NAME="HelpWebPage.populateNetworkRequest" ID="HelpWebPage.populateNetworkRequest"></a>
738 <h4>HelpWebPage.populateNetworkRequest</h4>
739 <b>populateNetworkRequest</b>(<i>request</i>)
740 <p>
741 Public method to add data to a network request.
742 </p><dl>
743 <dt><i>request</i></dt>
744 <dd>
745 reference to the network request object (QNetworkRequest)
746 </dd>
747 </dl>
748 <div align="right"><a href="#top">Up</a></div>
749 <hr /><hr />
750 <a NAME="JavaScriptEricObject" ID="JavaScriptEricObject"></a>
751 <h2>JavaScriptEricObject</h2>
752 <p>
753 Class implementing an external javascript object to search via the startpage.
754 </p>
755 <h3>Derived from</h3>
756 QObject
757 <h3>Class Attributes</h3>
758 <table>
759 <tr><td>translations</td></tr>
760 </table>
761 <h3>Methods</h3>
762 <table>
763 <tr>
764 <td><a href="#JavaScriptEricObject.providerString">providerString</a></td>
765 <td>Public method to get a string for the search provider.</td>
766 </tr><tr>
767 <td><a href="#JavaScriptEricObject.searchUrl">searchUrl</a></td>
768 <td>Public method to get the search URL for the given search term.</td>
769 </tr><tr>
770 <td><a href="#JavaScriptEricObject.translate">translate</a></td>
771 <td>Public method to translate the given string.</td>
772 </tr>
773 </table>
774 <a NAME="JavaScriptEricObject.providerString" ID="JavaScriptEricObject.providerString"></a>
775 <h4>JavaScriptEricObject.providerString</h4>
776 <b>providerString</b>(<i></i>)
777 <p>
778 Public method to get a string for the search provider.
779 </p><dl>
780 <dt>Returns:</dt>
781 <dd>
782 string for the search provider (string)
783 </dd>
784 </dl><a NAME="JavaScriptEricObject.searchUrl" ID="JavaScriptEricObject.searchUrl"></a>
785 <h4>JavaScriptEricObject.searchUrl</h4>
786 <b>searchUrl</b>(<i>searchStr</i>)
787 <p>
788 Public method to get the search URL for the given search term.
789 </p><dl>
790 <dt><i>searchStr</i></dt>
791 <dd>
792 search term (string)
793 </dd>
794 </dl><dl>
795 <dt>Returns:</dt>
796 <dd>
797 search URL (string)
798 </dd>
799 </dl><a NAME="JavaScriptEricObject.translate" ID="JavaScriptEricObject.translate"></a>
800 <h4>JavaScriptEricObject.translate</h4>
801 <b>translate</b>(<i>trans</i>)
802 <p>
803 Public method to translate the given string.
804 </p><dl>
805 <dt><i>trans</i></dt>
806 <dd>
807 string to be translated (string)
808 </dd>
809 </dl><dl>
810 <dt>Returns:</dt>
811 <dd>
812 translation (string)
813 </dd>
814 </dl>
815 <div align="right"><a href="#top">Up</a></div>
816 <hr /><hr />
817 <a NAME="JavaScriptExternalObject" ID="JavaScriptExternalObject"></a>
818 <h2>JavaScriptExternalObject</h2>
819 <p>
820 Class implementing an external javascript object to add search providers.
821 </p>
822 <h3>Derived from</h3>
823 QObject
824 <h3>Class Attributes</h3>
825 <table>
826 <tr><td>None</td></tr>
827 </table>
828 <h3>Methods</h3>
829 <table>
830 <tr>
831 <td><a href="#JavaScriptExternalObject.AddSearchProvider">AddSearchProvider</a></td>
832 <td>Public slot to add a search provider.</td>
833 </tr>
834 </table>
835 <a NAME="JavaScriptExternalObject.AddSearchProvider" ID="JavaScriptExternalObject.AddSearchProvider"></a>
836 <h4>JavaScriptExternalObject.AddSearchProvider</h4>
837 <b>AddSearchProvider</b>(<i>url</i>)
838 <p>
839 Public slot to add a search provider.
840 </p><dl>
841 <dt><i>url</i></dt>
842 <dd>
843 url of the XML file defining the search provider (string)
844 </dd>
845 </dl>
846 <div align="right"><a href="#top">Up</a></div>
847 <hr /><hr />
848 <a NAME="LinkedResource" ID="LinkedResource"></a>
849 <h2>LinkedResource</h2>
850 <p>
851 Class defining a data structure for linked resources.
852 </p>
853 <h3>Derived from</h3>
854 object
855 <h3>Class Attributes</h3>
856 <table>
857 <tr><td>None</td></tr>
858 </table>
859 <h3>Methods</h3>
860 <table>
861 <tr>
862 <td><a href="#LinkedResource.__init__">LinkedResource</a></td>
863 <td>Constructor</td>
864 </tr>
865 </table>
866 <a NAME="LinkedResource.__init__" ID="LinkedResource.__init__"></a>
867 <h4>LinkedResource (Constructor)</h4>
868 <b>LinkedResource</b>(<i></i>)
869 <p>
870 Constructor
871 </p>
872 <div align="right"><a href="#top">Up</a></div>
873 <hr />
874 </body></html>

Mercurial Repository: eric

eric ide

mercurial