src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.WebBrowserTabWidget</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.WebBrowserTabWidget</h1>
10
11 <p>
12 Module implementing the central widget showing the web pages.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#WebBrowserTabWidget">WebBrowserTabWidget</a></td>
25 <td>Class implementing the central widget showing the web pages.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31
32 <tr>
33 <td><a href="#isCupsAvailable">isCupsAvailable</a></td>
34 <td>Static method to test the availability of CUPS.</td>
35 </tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="WebBrowserTabWidget" ID="WebBrowserTabWidget"></a>
40 <h2>WebBrowserTabWidget</h2>
41
42 <p>
43 Class implementing the central widget showing the web pages.
44 </p>
45 <h3>Signals</h3>
46 <dl>
47
48 <dt>browserClosed(QWidget)</dt>
49 <dd>
50 emitted after a browser was closed
51 </dd>
52 <dt>browserOpened(QWidget)</dt>
53 <dd>
54 emitted after a new browser was created
55 </dd>
56 <dt>browserZoomValueChanged(int)</dt>
57 <dd>
58 emitted to signal a change of the
59 current browser's zoom level
60 </dd>
61 <dt>currentUrlChanged(QUrl)</dt>
62 <dd>
63 emitted after the URL of the current
64 browser has changed
65 </dd>
66 <dt>showMessage(str)</dt>
67 <dd>
68 emitted to show a message in the main window
69 status bar
70 </dd>
71 <dt>sourceChanged(WebBrowserView, QUrl)</dt>
72 <dd>
73 emitted after the URL of a
74 browser has changed
75 </dd>
76 <dt>titleChanged(WebBrowserView, str)</dt>
77 <dd>
78 emitted after the title of a
79 browser has changed
80 </dd>
81 </dl>
82 <h3>Derived from</h3>
83 EricTabWidget
84 <h3>Class Attributes</h3>
85
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <h3>Class Methods</h3>
90
91 <table>
92 <tr><td>None</td></tr>
93 </table>
94 <h3>Methods</h3>
95
96 <table>
97
98 <tr>
99 <td><a href="#WebBrowserTabWidget.__init__">WebBrowserTabWidget</a></td>
100 <td>Constructor</td>
101 </tr>
102 <tr>
103 <td><a href="#WebBrowserTabWidget.__aboutToShowClosedTabsMenu">__aboutToShowClosedTabsMenu</a></td>
104 <td>Private slot to populate the closed tabs menu.</td>
105 </tr>
106 <tr>
107 <td><a href="#WebBrowserTabWidget.__closedTabAvailable">__closedTabAvailable</a></td>
108 <td>Private slot to handle changes of the availability of closed tabs.</td>
109 </tr>
110 <tr>
111 <td><a href="#WebBrowserTabWidget.__currentChanged">__currentChanged</a></td>
112 <td>Private slot to handle an index change.</td>
113 </tr>
114 <tr>
115 <td><a href="#WebBrowserTabWidget.__elide">__elide</a></td>
116 <td>Private method to elide some text.</td>
117 </tr>
118 <tr>
119 <td><a href="#WebBrowserTabWidget.__guessUrlFromPath">__guessUrlFromPath</a></td>
120 <td>Private method to guess an URL given a path string.</td>
121 </tr>
122 <tr>
123 <td><a href="#WebBrowserTabWidget.__iconChanged">__iconChanged</a></td>
124 <td>Private slot to handle a change of the web site icon.</td>
125 </tr>
126 <tr>
127 <td><a href="#WebBrowserTabWidget.__initTabContextMenu">__initTabContextMenu</a></td>
128 <td>Private method to create the tab context menu.</td>
129 </tr>
130 <tr>
131 <td><a href="#WebBrowserTabWidget.__lineEditReturnPressed">__lineEditReturnPressed</a></td>
132 <td>Private slot to handle the entering of an URL.</td>
133 </tr>
134 <tr>
135 <td><a href="#WebBrowserTabWidget.__loadFinished">__loadFinished</a></td>
136 <td>Private method to handle the loadFinished signal.</td>
137 </tr>
138 <tr>
139 <td><a href="#WebBrowserTabWidget.__loadProgress">__loadProgress</a></td>
140 <td>Private method to handle the loadProgress signal.</td>
141 </tr>
142 <tr>
143 <td><a href="#WebBrowserTabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
144 <td>Private slot called to handle the navigation button menu selection.</td>
145 </tr>
146 <tr>
147 <td><a href="#WebBrowserTabWidget.__newBrowser">__newBrowser</a></td>
148 <td>Private slot to open a new browser tab.</td>
149 </tr>
150 <tr>
151 <td><a href="#WebBrowserTabWidget.__pathSelected">__pathSelected</a></td>
152 <td>Private slot called when a URL is selected from the completer.</td>
153 </tr>
154 <tr>
155 <td><a href="#WebBrowserTabWidget.__pdfGeneratedForSave">__pdfGeneratedForSave</a></td>
156 <td>Private slot to save the generated PDF data to a file.</td>
157 </tr>
158 <tr>
159 <td><a href="#WebBrowserTabWidget.__printPreviewRequested">__printPreviewRequested</a></td>
160 <td>Private slot to generate the print preview.</td>
161 </tr>
162 <tr>
163 <td><a href="#WebBrowserTabWidget.__recentlyAudibleChanged">__recentlyAudibleChanged</a></td>
164 <td>Private slot to react on the audible state of a page.</td>
165 </tr>
166 <tr>
167 <td><a href="#WebBrowserTabWidget.__showContextMenu">__showContextMenu</a></td>
168 <td>Private slot to show the tab context menu.</td>
169 </tr>
170 <tr>
171 <td><a href="#WebBrowserTabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
172 <td>Private slot to show the navigation button menu.</td>
173 </tr>
174 <tr>
175 <td><a href="#WebBrowserTabWidget.__sourceChanged">__sourceChanged</a></td>
176 <td>Private slot to handle a change of a browsers source.</td>
177 </tr>
178 <tr>
179 <td><a href="#WebBrowserTabWidget.__tabContextMenuAudioMute">__tabContextMenuAudioMute</a></td>
180 <td>Private method to mute or unmute the selected tab.</td>
181 </tr>
182 <tr>
183 <td><a href="#WebBrowserTabWidget.__tabContextMenuClone">__tabContextMenuClone</a></td>
184 <td>Private method to clone the selected tab.</td>
185 </tr>
186 <tr>
187 <td><a href="#WebBrowserTabWidget.__tabContextMenuClose">__tabContextMenuClose</a></td>
188 <td>Private method to close the selected tab.</td>
189 </tr>
190 <tr>
191 <td><a href="#WebBrowserTabWidget.__tabContextMenuCloseOthers">__tabContextMenuCloseOthers</a></td>
192 <td>Private slot to close all other tabs.</td>
193 </tr>
194 <tr>
195 <td><a href="#WebBrowserTabWidget.__tabContextMenuMoveLeft">__tabContextMenuMoveLeft</a></td>
196 <td>Private method to move a tab one position to the left.</td>
197 </tr>
198 <tr>
199 <td><a href="#WebBrowserTabWidget.__tabContextMenuMoveRight">__tabContextMenuMoveRight</a></td>
200 <td>Private method to move a tab one position to the right.</td>
201 </tr>
202 <tr>
203 <td><a href="#WebBrowserTabWidget.__tabContextMenuPrint">__tabContextMenuPrint</a></td>
204 <td>Private method to print the selected tab.</td>
205 </tr>
206 <tr>
207 <td><a href="#WebBrowserTabWidget.__tabContextMenuPrintPdf">__tabContextMenuPrintPdf</a></td>
208 <td>Private method to print the selected tab as PDF.</td>
209 </tr>
210 <tr>
211 <td><a href="#WebBrowserTabWidget.__tabContextMenuPrintPreview">__tabContextMenuPrintPreview</a></td>
212 <td>Private method to show a print preview of the selected tab.</td>
213 </tr>
214 <tr>
215 <td><a href="#WebBrowserTabWidget.__titleChanged">__titleChanged</a></td>
216 <td>Private slot to handle a change of a browsers title.</td>
217 </tr>
218 <tr>
219 <td><a href="#WebBrowserTabWidget.__windowCloseRequested">__windowCloseRequested</a></td>
220 <td>Private slot to handle the windowCloseRequested signal of a browser.</td>
221 </tr>
222 <tr>
223 <td><a href="#WebBrowserTabWidget.browserAt">browserAt</a></td>
224 <td>Public method to get a reference to the browser with the given index.</td>
225 </tr>
226 <tr>
227 <td><a href="#WebBrowserTabWidget.browsers">browsers</a></td>
228 <td>Public method to get a list of references to all browsers.</td>
229 </tr>
230 <tr>
231 <td><a href="#WebBrowserTabWidget.canRestoreClosedTab">canRestoreClosedTab</a></td>
232 <td>Public method to check, if closed tabs can be restored.</td>
233 </tr>
234 <tr>
235 <td><a href="#WebBrowserTabWidget.clearClosedTabsList">clearClosedTabsList</a></td>
236 <td>Public slot to clear the list of closed tabs.</td>
237 </tr>
238 <tr>
239 <td><a href="#WebBrowserTabWidget.closeAllBrowsers">closeAllBrowsers</a></td>
240 <td>Public slot called to handle the close all action.</td>
241 </tr>
242 <tr>
243 <td><a href="#WebBrowserTabWidget.closeBrowser">closeBrowser</a></td>
244 <td>Public slot called to handle the close action.</td>
245 </tr>
246 <tr>
247 <td><a href="#WebBrowserTabWidget.closeBrowserAt">closeBrowserAt</a></td>
248 <td>Public slot to close a browser based on its index.</td>
249 </tr>
250 <tr>
251 <td><a href="#WebBrowserTabWidget.closeBrowserView">closeBrowserView</a></td>
252 <td>Public method to close the given browser.</td>
253 </tr>
254 <tr>
255 <td><a href="#WebBrowserTabWidget.closedTabsManager">closedTabsManager</a></td>
256 <td>Public slot to get a reference to the closed tabs manager.</td>
257 </tr>
258 <tr>
259 <td><a href="#WebBrowserTabWidget.currentBrowser">currentBrowser</a></td>
260 <td>Public method to get a reference to the current browser.</td>
261 </tr>
262 <tr>
263 <td><a href="#WebBrowserTabWidget.currentUrlBar">currentUrlBar</a></td>
264 <td>Public method to get a reference to the current url bar.</td>
265 </tr>
266 <tr>
267 <td><a href="#WebBrowserTabWidget.getSessionData">getSessionData</a></td>
268 <td>Public method to populate the session data.</td>
269 </tr>
270 <tr>
271 <td><a href="#WebBrowserTabWidget.getSourceFileList">getSourceFileList</a></td>
272 <td>Public method to get a list of all opened Qt help files.</td>
273 </tr>
274 <tr>
275 <td><a href="#WebBrowserTabWidget.loadFromSessionData">loadFromSessionData</a></td>
276 <td>Public method to load the session data.</td>
277 </tr>
278 <tr>
279 <td><a href="#WebBrowserTabWidget.newBrowser">newBrowser</a></td>
280 <td>Public method to create a new web browser tab.</td>
281 </tr>
282 <tr>
283 <td><a href="#WebBrowserTabWidget.newBrowserAfter">newBrowserAfter</a></td>
284 <td>Public method to create a new web browser tab after a given one.</td>
285 </tr>
286 <tr>
287 <td><a href="#WebBrowserTabWidget.preferencesChanged">preferencesChanged</a></td>
288 <td>Public slot to handle a change of preferences.</td>
289 </tr>
290 <tr>
291 <td><a href="#WebBrowserTabWidget.printBrowser">printBrowser</a></td>
292 <td>Public slot called to print the displayed page.</td>
293 </tr>
294 <tr>
295 <td><a href="#WebBrowserTabWidget.printBrowserPdf">printBrowserPdf</a></td>
296 <td>Public slot called to print the displayed page to PDF.</td>
297 </tr>
298 <tr>
299 <td><a href="#WebBrowserTabWidget.printPreviewBrowser">printPreviewBrowser</a></td>
300 <td>Public slot called to show a print preview of the displayed file.</td>
301 </tr>
302 <tr>
303 <td><a href="#WebBrowserTabWidget.reloadAllBrowsers">reloadAllBrowsers</a></td>
304 <td>Public slot to reload all browsers.</td>
305 </tr>
306 <tr>
307 <td><a href="#WebBrowserTabWidget.restoreAllClosedTabs">restoreAllClosedTabs</a></td>
308 <td>Public slot to restore all closed tabs.</td>
309 </tr>
310 <tr>
311 <td><a href="#WebBrowserTabWidget.restoreClosedTab">restoreClosedTab</a></td>
312 <td>Public slot to restore the most recently closed tab.</td>
313 </tr>
314 <tr>
315 <td><a href="#WebBrowserTabWidget.shallShutDown">shallShutDown</a></td>
316 <td>Public method to check, if the application should be shut down.</td>
317 </tr>
318 <tr>
319 <td><a href="#WebBrowserTabWidget.stackedUrlBar">stackedUrlBar</a></td>
320 <td>Public method to get a reference to the stacked url bar.</td>
321 </tr>
322 <tr>
323 <td><a href="#WebBrowserTabWidget.urlBarForView">urlBarForView</a></td>
324 <td>Public method to get a reference to the UrlBar associated with the given view.</td>
325 </tr>
326 </table>
327 <h3>Static Methods</h3>
328
329 <table>
330 <tr><td>None</td></tr>
331 </table>
332
333 <a NAME="WebBrowserTabWidget.__init__" ID="WebBrowserTabWidget.__init__"></a>
334 <h4>WebBrowserTabWidget (Constructor)</h4>
335 <b>WebBrowserTabWidget</b>(<i>parent</i>)
336
337 <p>
338 Constructor
339 </p>
340 <dl>
341
342 <dt><i>parent</i></dt>
343 <dd>
344 reference to the parent widget (QWidget)
345 </dd>
346 </dl>
347 <a NAME="WebBrowserTabWidget.__aboutToShowClosedTabsMenu" ID="WebBrowserTabWidget.__aboutToShowClosedTabsMenu"></a>
348 <h4>WebBrowserTabWidget.__aboutToShowClosedTabsMenu</h4>
349 <b>__aboutToShowClosedTabsMenu</b>(<i></i>)
350
351 <p>
352 Private slot to populate the closed tabs menu.
353 </p>
354 <a NAME="WebBrowserTabWidget.__closedTabAvailable" ID="WebBrowserTabWidget.__closedTabAvailable"></a>
355 <h4>WebBrowserTabWidget.__closedTabAvailable</h4>
356 <b>__closedTabAvailable</b>(<i>avail</i>)
357
358 <p>
359 Private slot to handle changes of the availability of closed tabs.
360 </p>
361 <dl>
362
363 <dt><i>avail</i></dt>
364 <dd>
365 flag indicating the availability of closed tabs (boolean)
366 </dd>
367 </dl>
368 <a NAME="WebBrowserTabWidget.__currentChanged" ID="WebBrowserTabWidget.__currentChanged"></a>
369 <h4>WebBrowserTabWidget.__currentChanged</h4>
370 <b>__currentChanged</b>(<i>index</i>)
371
372 <p>
373 Private slot to handle an index change.
374 </p>
375 <dl>
376
377 <dt><i>index</i></dt>
378 <dd>
379 new index (integer)
380 </dd>
381 </dl>
382 <a NAME="WebBrowserTabWidget.__elide" ID="WebBrowserTabWidget.__elide"></a>
383 <h4>WebBrowserTabWidget.__elide</h4>
384 <b>__elide</b>(<i>txt, mode=Qt.TextElideMode.ElideRight, length=40</i>)
385
386 <p>
387 Private method to elide some text.
388 </p>
389 <dl>
390
391 <dt><i>txt</i></dt>
392 <dd>
393 text to be elided (string)
394 </dd>
395 <dt><i>mode</i></dt>
396 <dd>
397 elide mode (Qt.TextElideMode)
398 </dd>
399 <dt><i>length</i></dt>
400 <dd>
401 amount of characters to be used (integer)
402 </dd>
403 </dl>
404 <dl>
405 <dt>Return:</dt>
406 <dd>
407 the elided text (string)
408 </dd>
409 </dl>
410 <a NAME="WebBrowserTabWidget.__guessUrlFromPath" ID="WebBrowserTabWidget.__guessUrlFromPath"></a>
411 <h4>WebBrowserTabWidget.__guessUrlFromPath</h4>
412 <b>__guessUrlFromPath</b>(<i>path</i>)
413
414 <p>
415 Private method to guess an URL given a path string.
416 </p>
417 <dl>
418
419 <dt><i>path</i></dt>
420 <dd>
421 path string to guess an URL for (string)
422 </dd>
423 </dl>
424 <dl>
425 <dt>Return:</dt>
426 <dd>
427 guessed URL (QUrl)
428 </dd>
429 </dl>
430 <a NAME="WebBrowserTabWidget.__iconChanged" ID="WebBrowserTabWidget.__iconChanged"></a>
431 <h4>WebBrowserTabWidget.__iconChanged</h4>
432 <b>__iconChanged</b>(<i>browser</i>)
433
434 <p>
435 Private slot to handle a change of the web site icon.
436 </p>
437 <dl>
438
439 <dt><i>browser</i> (WebBrowserView)</dt>
440 <dd>
441 reference to the web browser
442 </dd>
443 </dl>
444 <a NAME="WebBrowserTabWidget.__initTabContextMenu" ID="WebBrowserTabWidget.__initTabContextMenu"></a>
445 <h4>WebBrowserTabWidget.__initTabContextMenu</h4>
446 <b>__initTabContextMenu</b>(<i></i>)
447
448 <p>
449 Private method to create the tab context menu.
450 </p>
451 <a NAME="WebBrowserTabWidget.__lineEditReturnPressed" ID="WebBrowserTabWidget.__lineEditReturnPressed"></a>
452 <h4>WebBrowserTabWidget.__lineEditReturnPressed</h4>
453 <b>__lineEditReturnPressed</b>(<i>edit</i>)
454
455 <p>
456 Private slot to handle the entering of an URL.
457 </p>
458 <dl>
459
460 <dt><i>edit</i> (UrlBar)</dt>
461 <dd>
462 reference to the line edit
463 </dd>
464 </dl>
465 <a NAME="WebBrowserTabWidget.__loadFinished" ID="WebBrowserTabWidget.__loadFinished"></a>
466 <h4>WebBrowserTabWidget.__loadFinished</h4>
467 <b>__loadFinished</b>(<i>ok, browser</i>)
468
469 <p>
470 Private method to handle the loadFinished signal.
471 </p>
472 <dl>
473
474 <dt><i>ok</i> (bool)</dt>
475 <dd>
476 flag indicating the result
477 </dd>
478 <dt><i>browser</i> (WebBrowserView)</dt>
479 <dd>
480 reference to the web browser
481 </dd>
482 </dl>
483 <a NAME="WebBrowserTabWidget.__loadProgress" ID="WebBrowserTabWidget.__loadProgress"></a>
484 <h4>WebBrowserTabWidget.__loadProgress</h4>
485 <b>__loadProgress</b>(<i>progress, browser</i>)
486
487 <p>
488 Private method to handle the loadProgress signal.
489 </p>
490 <p>
491 Note: This works around wegengine not sending a loadFinished
492 signal for navigation on the same page.
493 </p>
494 <dl>
495
496 <dt><i>progress</i> (int)</dt>
497 <dd>
498 load progress in percent
499 </dd>
500 <dt><i>browser</i> (WebBrowserView)</dt>
501 <dd>
502 reference to the web browser
503 </dd>
504 </dl>
505 <a NAME="WebBrowserTabWidget.__navigationMenuTriggered" ID="WebBrowserTabWidget.__navigationMenuTriggered"></a>
506 <h4>WebBrowserTabWidget.__navigationMenuTriggered</h4>
507 <b>__navigationMenuTriggered</b>(<i>act</i>)
508
509 <p>
510 Private slot called to handle the navigation button menu selection.
511 </p>
512 <dl>
513
514 <dt><i>act</i></dt>
515 <dd>
516 reference to the selected action (QAction)
517 </dd>
518 </dl>
519 <a NAME="WebBrowserTabWidget.__newBrowser" ID="WebBrowserTabWidget.__newBrowser"></a>
520 <h4>WebBrowserTabWidget.__newBrowser</h4>
521 <b>__newBrowser</b>(<i></i>)
522
523 <p>
524 Private slot to open a new browser tab.
525 </p>
526 <a NAME="WebBrowserTabWidget.__pathSelected" ID="WebBrowserTabWidget.__pathSelected"></a>
527 <h4>WebBrowserTabWidget.__pathSelected</h4>
528 <b>__pathSelected</b>(<i>path</i>)
529
530 <p>
531 Private slot called when a URL is selected from the completer.
532 </p>
533 <dl>
534
535 <dt><i>path</i></dt>
536 <dd>
537 path to be shown (string)
538 </dd>
539 </dl>
540 <a NAME="WebBrowserTabWidget.__pdfGeneratedForSave" ID="WebBrowserTabWidget.__pdfGeneratedForSave"></a>
541 <h4>WebBrowserTabWidget.__pdfGeneratedForSave</h4>
542 <b>__pdfGeneratedForSave</b>(<i>filePath, pdfData</i>)
543
544 <p>
545 Private slot to save the generated PDF data to a file.
546 </p>
547 <dl>
548
549 <dt><i>filePath</i> (str)</dt>
550 <dd>
551 path to save the PDF to
552 </dd>
553 <dt><i>pdfData</i> (QByteArray)</dt>
554 <dd>
555 generated PDF document
556 </dd>
557 </dl>
558 <a NAME="WebBrowserTabWidget.__printPreviewRequested" ID="WebBrowserTabWidget.__printPreviewRequested"></a>
559 <h4>WebBrowserTabWidget.__printPreviewRequested</h4>
560 <b>__printPreviewRequested</b>(<i>printer, browser</i>)
561
562 <p>
563 Private slot to generate the print preview.
564 </p>
565 <dl>
566
567 <dt><i>printer</i> (QPrinter)</dt>
568 <dd>
569 reference to the printer object
570 </dd>
571 <dt><i>browser</i> (WebBrowserView)</dt>
572 <dd>
573 reference to the browser to be printed
574 </dd>
575 </dl>
576 <a NAME="WebBrowserTabWidget.__recentlyAudibleChanged" ID="WebBrowserTabWidget.__recentlyAudibleChanged"></a>
577 <h4>WebBrowserTabWidget.__recentlyAudibleChanged</h4>
578 <b>__recentlyAudibleChanged</b>(<i>recentlyAudible, page</i>)
579
580 <p>
581 Private slot to react on the audible state of a page.
582 </p>
583 <dl>
584
585 <dt><i>recentlyAudible</i> (bool)</dt>
586 <dd>
587 flag indicating the new audible state
588 </dd>
589 <dt><i>page</i> (WebBrowserPage)</dt>
590 <dd>
591 reference to the web page
592 </dd>
593 </dl>
594 <a NAME="WebBrowserTabWidget.__showContextMenu" ID="WebBrowserTabWidget.__showContextMenu"></a>
595 <h4>WebBrowserTabWidget.__showContextMenu</h4>
596 <b>__showContextMenu</b>(<i>coord, index</i>)
597
598 <p>
599 Private slot to show the tab context menu.
600 </p>
601 <dl>
602
603 <dt><i>coord</i></dt>
604 <dd>
605 the position of the mouse pointer (QPoint)
606 </dd>
607 <dt><i>index</i></dt>
608 <dd>
609 index of the tab the menu is requested for (integer)
610 </dd>
611 </dl>
612 <a NAME="WebBrowserTabWidget.__showNavigationMenu" ID="WebBrowserTabWidget.__showNavigationMenu"></a>
613 <h4>WebBrowserTabWidget.__showNavigationMenu</h4>
614 <b>__showNavigationMenu</b>(<i></i>)
615
616 <p>
617 Private slot to show the navigation button menu.
618 </p>
619 <a NAME="WebBrowserTabWidget.__sourceChanged" ID="WebBrowserTabWidget.__sourceChanged"></a>
620 <h4>WebBrowserTabWidget.__sourceChanged</h4>
621 <b>__sourceChanged</b>(<i>url, browser</i>)
622
623 <p>
624 Private slot to handle a change of a browsers source.
625 </p>
626 <dl>
627
628 <dt><i>url</i> (QUrl)</dt>
629 <dd>
630 URL of the new site
631 </dd>
632 <dt><i>browser</i> (WebBrowserView)</dt>
633 <dd>
634 reference to the web browser
635 </dd>
636 </dl>
637 <a NAME="WebBrowserTabWidget.__tabContextMenuAudioMute" ID="WebBrowserTabWidget.__tabContextMenuAudioMute"></a>
638 <h4>WebBrowserTabWidget.__tabContextMenuAudioMute</h4>
639 <b>__tabContextMenuAudioMute</b>(<i></i>)
640
641 <p>
642 Private method to mute or unmute the selected tab.
643 </p>
644 <a NAME="WebBrowserTabWidget.__tabContextMenuClone" ID="WebBrowserTabWidget.__tabContextMenuClone"></a>
645 <h4>WebBrowserTabWidget.__tabContextMenuClone</h4>
646 <b>__tabContextMenuClone</b>(<i></i>)
647
648 <p>
649 Private method to clone the selected tab.
650 </p>
651 <a NAME="WebBrowserTabWidget.__tabContextMenuClose" ID="WebBrowserTabWidget.__tabContextMenuClose"></a>
652 <h4>WebBrowserTabWidget.__tabContextMenuClose</h4>
653 <b>__tabContextMenuClose</b>(<i></i>)
654
655 <p>
656 Private method to close the selected tab.
657 </p>
658 <a NAME="WebBrowserTabWidget.__tabContextMenuCloseOthers" ID="WebBrowserTabWidget.__tabContextMenuCloseOthers"></a>
659 <h4>WebBrowserTabWidget.__tabContextMenuCloseOthers</h4>
660 <b>__tabContextMenuCloseOthers</b>(<i></i>)
661
662 <p>
663 Private slot to close all other tabs.
664 </p>
665 <a NAME="WebBrowserTabWidget.__tabContextMenuMoveLeft" ID="WebBrowserTabWidget.__tabContextMenuMoveLeft"></a>
666 <h4>WebBrowserTabWidget.__tabContextMenuMoveLeft</h4>
667 <b>__tabContextMenuMoveLeft</b>(<i></i>)
668
669 <p>
670 Private method to move a tab one position to the left.
671 </p>
672 <a NAME="WebBrowserTabWidget.__tabContextMenuMoveRight" ID="WebBrowserTabWidget.__tabContextMenuMoveRight"></a>
673 <h4>WebBrowserTabWidget.__tabContextMenuMoveRight</h4>
674 <b>__tabContextMenuMoveRight</b>(<i></i>)
675
676 <p>
677 Private method to move a tab one position to the right.
678 </p>
679 <a NAME="WebBrowserTabWidget.__tabContextMenuPrint" ID="WebBrowserTabWidget.__tabContextMenuPrint"></a>
680 <h4>WebBrowserTabWidget.__tabContextMenuPrint</h4>
681 <b>__tabContextMenuPrint</b>(<i></i>)
682
683 <p>
684 Private method to print the selected tab.
685 </p>
686 <a NAME="WebBrowserTabWidget.__tabContextMenuPrintPdf" ID="WebBrowserTabWidget.__tabContextMenuPrintPdf"></a>
687 <h4>WebBrowserTabWidget.__tabContextMenuPrintPdf</h4>
688 <b>__tabContextMenuPrintPdf</b>(<i></i>)
689
690 <p>
691 Private method to print the selected tab as PDF.
692 </p>
693 <a NAME="WebBrowserTabWidget.__tabContextMenuPrintPreview" ID="WebBrowserTabWidget.__tabContextMenuPrintPreview"></a>
694 <h4>WebBrowserTabWidget.__tabContextMenuPrintPreview</h4>
695 <b>__tabContextMenuPrintPreview</b>(<i></i>)
696
697 <p>
698 Private method to show a print preview of the selected tab.
699 </p>
700 <a NAME="WebBrowserTabWidget.__titleChanged" ID="WebBrowserTabWidget.__titleChanged"></a>
701 <h4>WebBrowserTabWidget.__titleChanged</h4>
702 <b>__titleChanged</b>(<i>title, browser</i>)
703
704 <p>
705 Private slot to handle a change of a browsers title.
706 </p>
707 <dl>
708
709 <dt><i>title</i> (str)</dt>
710 <dd>
711 new title
712 </dd>
713 <dt><i>browser</i> (WebBrowserView)</dt>
714 <dd>
715 reference to the web browser
716 </dd>
717 </dl>
718 <a NAME="WebBrowserTabWidget.__windowCloseRequested" ID="WebBrowserTabWidget.__windowCloseRequested"></a>
719 <h4>WebBrowserTabWidget.__windowCloseRequested</h4>
720 <b>__windowCloseRequested</b>(<i>page</i>)
721
722 <p>
723 Private slot to handle the windowCloseRequested signal of a browser.
724 </p>
725 <dl>
726
727 <dt><i>page</i> (WebBrowserPage)</dt>
728 <dd>
729 reference to the web page
730 </dd>
731 </dl>
732 <a NAME="WebBrowserTabWidget.browserAt" ID="WebBrowserTabWidget.browserAt"></a>
733 <h4>WebBrowserTabWidget.browserAt</h4>
734 <b>browserAt</b>(<i>index</i>)
735
736 <p>
737 Public method to get a reference to the browser with the given index.
738 </p>
739 <dl>
740
741 <dt><i>index</i></dt>
742 <dd>
743 index of the browser to get (integer)
744 </dd>
745 </dl>
746 <dl>
747 <dt>Return:</dt>
748 <dd>
749 reference to the indexed browser (WebBrowserView)
750 </dd>
751 </dl>
752 <a NAME="WebBrowserTabWidget.browsers" ID="WebBrowserTabWidget.browsers"></a>
753 <h4>WebBrowserTabWidget.browsers</h4>
754 <b>browsers</b>(<i></i>)
755
756 <p>
757 Public method to get a list of references to all browsers.
758 </p>
759 <dl>
760 <dt>Return:</dt>
761 <dd>
762 list of references to browsers (list of WebBrowserView)
763 </dd>
764 </dl>
765 <a NAME="WebBrowserTabWidget.canRestoreClosedTab" ID="WebBrowserTabWidget.canRestoreClosedTab"></a>
766 <h4>WebBrowserTabWidget.canRestoreClosedTab</h4>
767 <b>canRestoreClosedTab</b>(<i></i>)
768
769 <p>
770 Public method to check, if closed tabs can be restored.
771 </p>
772 <dl>
773 <dt>Return:</dt>
774 <dd>
775 flag indicating that closed tabs can be restored (boolean)
776 </dd>
777 </dl>
778 <a NAME="WebBrowserTabWidget.clearClosedTabsList" ID="WebBrowserTabWidget.clearClosedTabsList"></a>
779 <h4>WebBrowserTabWidget.clearClosedTabsList</h4>
780 <b>clearClosedTabsList</b>(<i></i>)
781
782 <p>
783 Public slot to clear the list of closed tabs.
784 </p>
785 <a NAME="WebBrowserTabWidget.closeAllBrowsers" ID="WebBrowserTabWidget.closeAllBrowsers"></a>
786 <h4>WebBrowserTabWidget.closeAllBrowsers</h4>
787 <b>closeAllBrowsers</b>(<i>shutdown=False</i>)
788
789 <p>
790 Public slot called to handle the close all action.
791 </p>
792 <dl>
793
794 <dt><i>shutdown</i> (bool)</dt>
795 <dd>
796 flag indicating a shutdown action
797 </dd>
798 </dl>
799 <a NAME="WebBrowserTabWidget.closeBrowser" ID="WebBrowserTabWidget.closeBrowser"></a>
800 <h4>WebBrowserTabWidget.closeBrowser</h4>
801 <b>closeBrowser</b>(<i></i>)
802
803 <p>
804 Public slot called to handle the close action.
805 </p>
806 <a NAME="WebBrowserTabWidget.closeBrowserAt" ID="WebBrowserTabWidget.closeBrowserAt"></a>
807 <h4>WebBrowserTabWidget.closeBrowserAt</h4>
808 <b>closeBrowserAt</b>(<i>index, shutdown=False</i>)
809
810 <p>
811 Public slot to close a browser based on its index.
812 </p>
813 <dl>
814
815 <dt><i>index</i> (int)</dt>
816 <dd>
817 index of browser to close
818 </dd>
819 <dt><i>shutdown</i> (bool)</dt>
820 <dd>
821 flag indicating a shutdown action
822 </dd>
823 </dl>
824 <a NAME="WebBrowserTabWidget.closeBrowserView" ID="WebBrowserTabWidget.closeBrowserView"></a>
825 <h4>WebBrowserTabWidget.closeBrowserView</h4>
826 <b>closeBrowserView</b>(<i>browser</i>)
827
828 <p>
829 Public method to close the given browser.
830 </p>
831 <dl>
832
833 <dt><i>browser</i> (WebBrowserView)</dt>
834 <dd>
835 reference to the web browser view to be closed
836 </dd>
837 </dl>
838 <a NAME="WebBrowserTabWidget.closedTabsManager" ID="WebBrowserTabWidget.closedTabsManager"></a>
839 <h4>WebBrowserTabWidget.closedTabsManager</h4>
840 <b>closedTabsManager</b>(<i></i>)
841
842 <p>
843 Public slot to get a reference to the closed tabs manager.
844 </p>
845 <dl>
846 <dt>Return:</dt>
847 <dd>
848 reference to the closed tabs manager (ClosedTabsManager)
849 </dd>
850 </dl>
851 <a NAME="WebBrowserTabWidget.currentBrowser" ID="WebBrowserTabWidget.currentBrowser"></a>
852 <h4>WebBrowserTabWidget.currentBrowser</h4>
853 <b>currentBrowser</b>(<i></i>)
854
855 <p>
856 Public method to get a reference to the current browser.
857 </p>
858 <dl>
859 <dt>Return:</dt>
860 <dd>
861 reference to the current browser (WebBrowserView)
862 </dd>
863 </dl>
864 <a NAME="WebBrowserTabWidget.currentUrlBar" ID="WebBrowserTabWidget.currentUrlBar"></a>
865 <h4>WebBrowserTabWidget.currentUrlBar</h4>
866 <b>currentUrlBar</b>(<i></i>)
867
868 <p>
869 Public method to get a reference to the current url bar.
870 </p>
871 <dl>
872 <dt>Return:</dt>
873 <dd>
874 reference to the current url bar (UrlBar)
875 </dd>
876 </dl>
877 <a NAME="WebBrowserTabWidget.getSessionData" ID="WebBrowserTabWidget.getSessionData"></a>
878 <h4>WebBrowserTabWidget.getSessionData</h4>
879 <b>getSessionData</b>(<i></i>)
880
881 <p>
882 Public method to populate the session data.
883 </p>
884 <dl>
885 <dt>Return:</dt>
886 <dd>
887 dictionary containing the session data
888 </dd>
889 </dl>
890 <dl>
891 <dt>Return Type:</dt>
892 <dd>
893 dict
894 </dd>
895 </dl>
896 <a NAME="WebBrowserTabWidget.getSourceFileList" ID="WebBrowserTabWidget.getSourceFileList"></a>
897 <h4>WebBrowserTabWidget.getSourceFileList</h4>
898 <b>getSourceFileList</b>(<i></i>)
899
900 <p>
901 Public method to get a list of all opened Qt help files.
902 </p>
903 <dl>
904 <dt>Return:</dt>
905 <dd>
906 dictionary with tab id as key and host/namespace as value
907 </dd>
908 </dl>
909 <a NAME="WebBrowserTabWidget.loadFromSessionData" ID="WebBrowserTabWidget.loadFromSessionData"></a>
910 <h4>WebBrowserTabWidget.loadFromSessionData</h4>
911 <b>loadFromSessionData</b>(<i>sessionData</i>)
912
913 <p>
914 Public method to load the session data.
915 </p>
916 <dl>
917
918 <dt><i>sessionData</i> (dict)</dt>
919 <dd>
920 dictionary containing the session data as
921 generated by getSessionData()
922 </dd>
923 </dl>
924 <a NAME="WebBrowserTabWidget.newBrowser" ID="WebBrowserTabWidget.newBrowser"></a>
925 <h4>WebBrowserTabWidget.newBrowser</h4>
926 <b>newBrowser</b>(<i>link=None, position=-1, background=False, restoreSession=False</i>)
927
928 <p>
929 Public method to create a new web browser tab.
930 </p>
931 <dl>
932
933 <dt><i>link</i> (str or QUrl)</dt>
934 <dd>
935 link to be shown
936 </dd>
937 <dt><i>position</i> (int)</dt>
938 <dd>
939 position to create the new tab at or -1 to add it
940 to the end
941 </dd>
942 <dt><i>background</i> (bool)</dt>
943 <dd>
944 flag indicating to open the tab in the
945 background
946 </dd>
947 <dt><i>restoreSession</i> (bool)</dt>
948 <dd>
949 flag indicating a restore session action
950 </dd>
951 </dl>
952 <dl>
953 <dt>Return:</dt>
954 <dd>
955 reference to the new browser
956 </dd>
957 </dl>
958 <dl>
959 <dt>Return Type:</dt>
960 <dd>
961 WebBrowserView
962 </dd>
963 </dl>
964 <a NAME="WebBrowserTabWidget.newBrowserAfter" ID="WebBrowserTabWidget.newBrowserAfter"></a>
965 <h4>WebBrowserTabWidget.newBrowserAfter</h4>
966 <b>newBrowserAfter</b>(<i>browser, link=None, background=False</i>)
967
968 <p>
969 Public method to create a new web browser tab after a given one.
970 </p>
971 <dl>
972
973 <dt><i>browser</i></dt>
974 <dd>
975 reference to the browser to add after (WebBrowserView)
976 </dd>
977 <dt><i>link</i></dt>
978 <dd>
979 link to be shown (string or QUrl)
980 </dd>
981 <dt><i>background</i></dt>
982 <dd>
983 flag indicating to open the tab in the
984 background (bool)
985 </dd>
986 </dl>
987 <dl>
988 <dt>Return:</dt>
989 <dd>
990 reference to the new browser
991 </dd>
992 </dl>
993 <dl>
994 <dt>Return Type:</dt>
995 <dd>
996 WebBrowserView
997 </dd>
998 </dl>
999 <a NAME="WebBrowserTabWidget.preferencesChanged" ID="WebBrowserTabWidget.preferencesChanged"></a>
1000 <h4>WebBrowserTabWidget.preferencesChanged</h4>
1001 <b>preferencesChanged</b>(<i></i>)
1002
1003 <p>
1004 Public slot to handle a change of preferences.
1005 </p>
1006 <a NAME="WebBrowserTabWidget.printBrowser" ID="WebBrowserTabWidget.printBrowser"></a>
1007 <h4>WebBrowserTabWidget.printBrowser</h4>
1008 <b>printBrowser</b>(<i>browser=None</i>)
1009
1010 <p>
1011 Public slot called to print the displayed page.
1012 </p>
1013 <dl>
1014
1015 <dt><i>browser</i></dt>
1016 <dd>
1017 reference to the browser to be printed (WebBrowserView)
1018 </dd>
1019 </dl>
1020 <a NAME="WebBrowserTabWidget.printBrowserPdf" ID="WebBrowserTabWidget.printBrowserPdf"></a>
1021 <h4>WebBrowserTabWidget.printBrowserPdf</h4>
1022 <b>printBrowserPdf</b>(<i>browser=None</i>)
1023
1024 <p>
1025 Public slot called to print the displayed page to PDF.
1026 </p>
1027 <dl>
1028
1029 <dt><i>browser</i></dt>
1030 <dd>
1031 reference to the browser to be printed (HelpBrowser)
1032 </dd>
1033 </dl>
1034 <a NAME="WebBrowserTabWidget.printPreviewBrowser" ID="WebBrowserTabWidget.printPreviewBrowser"></a>
1035 <h4>WebBrowserTabWidget.printPreviewBrowser</h4>
1036 <b>printPreviewBrowser</b>(<i>browser=None</i>)
1037
1038 <p>
1039 Public slot called to show a print preview of the displayed file.
1040 </p>
1041 <dl>
1042
1043 <dt><i>browser</i></dt>
1044 <dd>
1045 reference to the browser to be printed (WebBrowserView)
1046 </dd>
1047 </dl>
1048 <a NAME="WebBrowserTabWidget.reloadAllBrowsers" ID="WebBrowserTabWidget.reloadAllBrowsers"></a>
1049 <h4>WebBrowserTabWidget.reloadAllBrowsers</h4>
1050 <b>reloadAllBrowsers</b>(<i></i>)
1051
1052 <p>
1053 Public slot to reload all browsers.
1054 </p>
1055 <a NAME="WebBrowserTabWidget.restoreAllClosedTabs" ID="WebBrowserTabWidget.restoreAllClosedTabs"></a>
1056 <h4>WebBrowserTabWidget.restoreAllClosedTabs</h4>
1057 <b>restoreAllClosedTabs</b>(<i></i>)
1058
1059 <p>
1060 Public slot to restore all closed tabs.
1061 </p>
1062 <a NAME="WebBrowserTabWidget.restoreClosedTab" ID="WebBrowserTabWidget.restoreClosedTab"></a>
1063 <h4>WebBrowserTabWidget.restoreClosedTab</h4>
1064 <b>restoreClosedTab</b>(<i>act</i>)
1065
1066 <p>
1067 Public slot to restore the most recently closed tab.
1068 </p>
1069 <dl>
1070
1071 <dt><i>act</i> (QAction)</dt>
1072 <dd>
1073 reference to the action that triggered
1074 </dd>
1075 </dl>
1076 <a NAME="WebBrowserTabWidget.shallShutDown" ID="WebBrowserTabWidget.shallShutDown"></a>
1077 <h4>WebBrowserTabWidget.shallShutDown</h4>
1078 <b>shallShutDown</b>(<i></i>)
1079
1080 <p>
1081 Public method to check, if the application should be shut down.
1082 </p>
1083 <dl>
1084 <dt>Return:</dt>
1085 <dd>
1086 flag indicating a shut down (boolean)
1087 </dd>
1088 </dl>
1089 <a NAME="WebBrowserTabWidget.stackedUrlBar" ID="WebBrowserTabWidget.stackedUrlBar"></a>
1090 <h4>WebBrowserTabWidget.stackedUrlBar</h4>
1091 <b>stackedUrlBar</b>(<i></i>)
1092
1093 <p>
1094 Public method to get a reference to the stacked url bar.
1095 </p>
1096 <dl>
1097 <dt>Return:</dt>
1098 <dd>
1099 reference to the stacked url bar (StackedUrlBar)
1100 </dd>
1101 </dl>
1102 <a NAME="WebBrowserTabWidget.urlBarForView" ID="WebBrowserTabWidget.urlBarForView"></a>
1103 <h4>WebBrowserTabWidget.urlBarForView</h4>
1104 <b>urlBarForView</b>(<i>view</i>)
1105
1106 <p>
1107 Public method to get a reference to the UrlBar associated with the
1108 given view.
1109 </p>
1110 <dl>
1111
1112 <dt><i>view</i> (WebBrowserView)</dt>
1113 <dd>
1114 reference to the view to get the urlbar for
1115 </dd>
1116 </dl>
1117 <dl>
1118 <dt>Return:</dt>
1119 <dd>
1120 reference to the associated urlbar
1121 </dd>
1122 </dl>
1123 <dl>
1124 <dt>Return Type:</dt>
1125 <dd>
1126 UrlBar
1127 </dd>
1128 </dl>
1129 <div align="right"><a href="#top">Up</a></div>
1130 <hr />
1131 <hr />
1132 <a NAME="isCupsAvailable" ID="isCupsAvailable"></a>
1133 <h2>isCupsAvailable</h2>
1134 <b>isCupsAvailable</b>(<i></i>)
1135
1136 <p>
1137 Static method to test the availability of CUPS.
1138 </p>
1139 <dl>
1140 <dt>Return:</dt>
1141 <dd>
1142 flag indicating the availability of CUPS
1143 </dd>
1144 </dl>
1145 <dl>
1146 <dt>Return Type:</dt>
1147 <dd>
1148 bool
1149 </dd>
1150 </dl>
1151 <div align="right"><a href="#top">Up</a></div>
1152 <hr />
1153 </body></html>

eric ide

mercurial