Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html

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

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

Mercurial Repository: eric

eric ide

mercurial