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

branch
eric7
changeset 10436
f6881d10e995
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10435:c712d09cc839 10436:f6881d10e995
325 <p> 325 <p>
326 Constructor 326 Constructor
327 </p> 327 </p>
328 <dl> 328 <dl>
329 329
330 <dt><i>parent</i></dt> 330 <dt><i>parent</i> (QWidget)</dt>
331 <dd> 331 <dd>
332 reference to the parent widget (QWidget) 332 reference to the parent widget
333 </dd> 333 </dd>
334 </dl> 334 </dl>
335 <a NAME="WebBrowserTabWidget.__aboutToShowClosedTabsMenu" ID="WebBrowserTabWidget.__aboutToShowClosedTabsMenu"></a> 335 <a NAME="WebBrowserTabWidget.__aboutToShowClosedTabsMenu" ID="WebBrowserTabWidget.__aboutToShowClosedTabsMenu"></a>
336 <h4>WebBrowserTabWidget.__aboutToShowClosedTabsMenu</h4> 336 <h4>WebBrowserTabWidget.__aboutToShowClosedTabsMenu</h4>
337 <b>__aboutToShowClosedTabsMenu</b>(<i></i>) 337 <b>__aboutToShowClosedTabsMenu</b>(<i></i>)
346 <p> 346 <p>
347 Private slot to handle changes of the availability of closed tabs. 347 Private slot to handle changes of the availability of closed tabs.
348 </p> 348 </p>
349 <dl> 349 <dl>
350 350
351 <dt><i>avail</i></dt> 351 <dt><i>avail</i> (bool)</dt>
352 <dd> 352 <dd>
353 flag indicating the availability of closed tabs (boolean) 353 flag indicating the availability of closed tabs
354 </dd> 354 </dd>
355 </dl> 355 </dl>
356 <a NAME="WebBrowserTabWidget.__currentChanged" ID="WebBrowserTabWidget.__currentChanged"></a> 356 <a NAME="WebBrowserTabWidget.__currentChanged" ID="WebBrowserTabWidget.__currentChanged"></a>
357 <h4>WebBrowserTabWidget.__currentChanged</h4> 357 <h4>WebBrowserTabWidget.__currentChanged</h4>
358 <b>__currentChanged</b>(<i>index</i>) 358 <b>__currentChanged</b>(<i>index</i>)
360 <p> 360 <p>
361 Private slot to handle an index change. 361 Private slot to handle an index change.
362 </p> 362 </p>
363 <dl> 363 <dl>
364 364
365 <dt><i>index</i></dt> 365 <dt><i>index</i> (int)</dt>
366 <dd> 366 <dd>
367 new index (integer) 367 new index
368 </dd> 368 </dd>
369 </dl> 369 </dl>
370 <a NAME="WebBrowserTabWidget.__elide" ID="WebBrowserTabWidget.__elide"></a> 370 <a NAME="WebBrowserTabWidget.__elide" ID="WebBrowserTabWidget.__elide"></a>
371 <h4>WebBrowserTabWidget.__elide</h4> 371 <h4>WebBrowserTabWidget.__elide</h4>
372 <b>__elide</b>(<i>txt, mode=Qt.TextElideMode.ElideRight, length=40</i>) 372 <b>__elide</b>(<i>txt, mode=Qt.TextElideMode.ElideRight, length=40</i>)
374 <p> 374 <p>
375 Private method to elide some text. 375 Private method to elide some text.
376 </p> 376 </p>
377 <dl> 377 <dl>
378 378
379 <dt><i>txt</i></dt> 379 <dt><i>txt</i> (str)</dt>
380 <dd> 380 <dd>
381 text to be elided (string) 381 text to be elided
382 </dd> 382 </dd>
383 <dt><i>mode</i></dt> 383 <dt><i>mode</i> (Qt.TextElideMode)</dt>
384 <dd> 384 <dd>
385 elide mode (Qt.TextElideMode) 385 elide mode
386 </dd> 386 </dd>
387 <dt><i>length</i></dt> 387 <dt><i>length</i> (int)</dt>
388 <dd> 388 <dd>
389 amount of characters to be used (integer) 389 amount of characters to be used
390 </dd> 390 </dd>
391 </dl> 391 </dl>
392 <dl> 392 <dl>
393 <dt>Return:</dt> 393 <dt>Return:</dt>
394 <dd> 394 <dd>
395 the elided text (string) 395 the elided text
396 </dd>
397 </dl>
398 <dl>
399 <dt>Return Type:</dt>
400 <dd>
401 str
396 </dd> 402 </dd>
397 </dl> 403 </dl>
398 <a NAME="WebBrowserTabWidget.__guessUrlFromPath" ID="WebBrowserTabWidget.__guessUrlFromPath"></a> 404 <a NAME="WebBrowserTabWidget.__guessUrlFromPath" ID="WebBrowserTabWidget.__guessUrlFromPath"></a>
399 <h4>WebBrowserTabWidget.__guessUrlFromPath</h4> 405 <h4>WebBrowserTabWidget.__guessUrlFromPath</h4>
400 <b>__guessUrlFromPath</b>(<i>path</i>) 406 <b>__guessUrlFromPath</b>(<i>path</i>)
402 <p> 408 <p>
403 Private method to guess an URL given a path string. 409 Private method to guess an URL given a path string.
404 </p> 410 </p>
405 <dl> 411 <dl>
406 412
407 <dt><i>path</i></dt> 413 <dt><i>path</i> (str)</dt>
408 <dd> 414 <dd>
409 path string to guess an URL for (string) 415 path string to guess an URL for
410 </dd> 416 </dd>
411 </dl> 417 </dl>
412 <dl> 418 <dl>
413 <dt>Return:</dt> 419 <dt>Return:</dt>
414 <dd> 420 <dd>
415 guessed URL (QUrl) 421 guessed URL
422 </dd>
423 </dl>
424 <dl>
425 <dt>Return Type:</dt>
426 <dd>
427 QUrl
416 </dd> 428 </dd>
417 </dl> 429 </dl>
418 <a NAME="WebBrowserTabWidget.__iconChanged" ID="WebBrowserTabWidget.__iconChanged"></a> 430 <a NAME="WebBrowserTabWidget.__iconChanged" ID="WebBrowserTabWidget.__iconChanged"></a>
419 <h4>WebBrowserTabWidget.__iconChanged</h4> 431 <h4>WebBrowserTabWidget.__iconChanged</h4>
420 <b>__iconChanged</b>(<i>browser</i>) 432 <b>__iconChanged</b>(<i>browser</i>)
497 <p> 509 <p>
498 Private slot called to handle the navigation button menu selection. 510 Private slot called to handle the navigation button menu selection.
499 </p> 511 </p>
500 <dl> 512 <dl>
501 513
502 <dt><i>act</i></dt> 514 <dt><i>act</i> (QAction)</dt>
503 <dd> 515 <dd>
504 reference to the selected action (QAction) 516 reference to the selected action
505 </dd> 517 </dd>
506 </dl> 518 </dl>
507 <a NAME="WebBrowserTabWidget.__newBrowser" ID="WebBrowserTabWidget.__newBrowser"></a> 519 <a NAME="WebBrowserTabWidget.__newBrowser" ID="WebBrowserTabWidget.__newBrowser"></a>
508 <h4>WebBrowserTabWidget.__newBrowser</h4> 520 <h4>WebBrowserTabWidget.__newBrowser</h4>
509 <b>__newBrowser</b>(<i></i>) 521 <b>__newBrowser</b>(<i></i>)
518 <p> 530 <p>
519 Private slot called when a URL is selected from the completer. 531 Private slot called when a URL is selected from the completer.
520 </p> 532 </p>
521 <dl> 533 <dl>
522 534
523 <dt><i>path</i></dt> 535 <dt><i>path</i> (str)</dt>
524 <dd> 536 <dd>
525 path to be shown (string) 537 path to be shown
526 </dd> 538 </dd>
527 </dl> 539 </dl>
528 <a NAME="WebBrowserTabWidget.__recentlyAudibleChanged" ID="WebBrowserTabWidget.__recentlyAudibleChanged"></a> 540 <a NAME="WebBrowserTabWidget.__recentlyAudibleChanged" ID="WebBrowserTabWidget.__recentlyAudibleChanged"></a>
529 <h4>WebBrowserTabWidget.__recentlyAudibleChanged</h4> 541 <h4>WebBrowserTabWidget.__recentlyAudibleChanged</h4>
530 <b>__recentlyAudibleChanged</b>(<i>recentlyAudible, page</i>) 542 <b>__recentlyAudibleChanged</b>(<i>recentlyAudible, page</i>)
550 <p> 562 <p>
551 Private slot to show the tab context menu. 563 Private slot to show the tab context menu.
552 </p> 564 </p>
553 <dl> 565 <dl>
554 566
555 <dt><i>coord</i></dt> 567 <dt><i>coord</i> (QPoint)</dt>
556 <dd> 568 <dd>
557 the position of the mouse pointer (QPoint) 569 the position of the mouse pointer
558 </dd> 570 </dd>
559 <dt><i>index</i></dt> 571 <dt><i>index</i> (int)</dt>
560 <dd> 572 <dd>
561 index of the tab the menu is requested for (integer) 573 index of the tab the menu is requested for
562 </dd> 574 </dd>
563 </dl> 575 </dl>
564 <a NAME="WebBrowserTabWidget.__showNavigationMenu" ID="WebBrowserTabWidget.__showNavigationMenu"></a> 576 <a NAME="WebBrowserTabWidget.__showNavigationMenu" ID="WebBrowserTabWidget.__showNavigationMenu"></a>
565 <h4>WebBrowserTabWidget.__showNavigationMenu</h4> 577 <h4>WebBrowserTabWidget.__showNavigationMenu</h4>
566 <b>__showNavigationMenu</b>(<i></i>) 578 <b>__showNavigationMenu</b>(<i></i>)
688 <p> 700 <p>
689 Public method to get a reference to the browser with the given index. 701 Public method to get a reference to the browser with the given index.
690 </p> 702 </p>
691 <dl> 703 <dl>
692 704
693 <dt><i>index</i></dt> 705 <dt><i>index</i> (int)</dt>
694 <dd> 706 <dd>
695 index of the browser to get (integer) 707 index of the browser to get
696 </dd> 708 </dd>
697 </dl> 709 </dl>
698 <dl> 710 <dl>
699 <dt>Return:</dt> 711 <dt>Return:</dt>
700 <dd> 712 <dd>
701 reference to the indexed browser (WebBrowserView) 713 reference to the indexed browser
714 </dd>
715 </dl>
716 <dl>
717 <dt>Return Type:</dt>
718 <dd>
719 WebBrowserView
702 </dd> 720 </dd>
703 </dl> 721 </dl>
704 <a NAME="WebBrowserTabWidget.browsers" ID="WebBrowserTabWidget.browsers"></a> 722 <a NAME="WebBrowserTabWidget.browsers" ID="WebBrowserTabWidget.browsers"></a>
705 <h4>WebBrowserTabWidget.browsers</h4> 723 <h4>WebBrowserTabWidget.browsers</h4>
706 <b>browsers</b>(<i></i>) 724 <b>browsers</b>(<i></i>)
709 Public method to get a list of references to all browsers. 727 Public method to get a list of references to all browsers.
710 </p> 728 </p>
711 <dl> 729 <dl>
712 <dt>Return:</dt> 730 <dt>Return:</dt>
713 <dd> 731 <dd>
714 list of references to browsers (list of WebBrowserView) 732 list of references to browsers
733 </dd>
734 </dl>
735 <dl>
736 <dt>Return Type:</dt>
737 <dd>
738 list of WebBrowserView
715 </dd> 739 </dd>
716 </dl> 740 </dl>
717 <a NAME="WebBrowserTabWidget.canRestoreClosedTab" ID="WebBrowserTabWidget.canRestoreClosedTab"></a> 741 <a NAME="WebBrowserTabWidget.canRestoreClosedTab" ID="WebBrowserTabWidget.canRestoreClosedTab"></a>
718 <h4>WebBrowserTabWidget.canRestoreClosedTab</h4> 742 <h4>WebBrowserTabWidget.canRestoreClosedTab</h4>
719 <b>canRestoreClosedTab</b>(<i></i>) 743 <b>canRestoreClosedTab</b>(<i></i>)
722 Public method to check, if closed tabs can be restored. 746 Public method to check, if closed tabs can be restored.
723 </p> 747 </p>
724 <dl> 748 <dl>
725 <dt>Return:</dt> 749 <dt>Return:</dt>
726 <dd> 750 <dd>
727 flag indicating that closed tabs can be restored (boolean) 751 flag indicating that closed tabs can be restored
752 </dd>
753 </dl>
754 <dl>
755 <dt>Return Type:</dt>
756 <dd>
757 bool
728 </dd> 758 </dd>
729 </dl> 759 </dl>
730 <a NAME="WebBrowserTabWidget.clearClosedTabsList" ID="WebBrowserTabWidget.clearClosedTabsList"></a> 760 <a NAME="WebBrowserTabWidget.clearClosedTabsList" ID="WebBrowserTabWidget.clearClosedTabsList"></a>
731 <h4>WebBrowserTabWidget.clearClosedTabsList</h4> 761 <h4>WebBrowserTabWidget.clearClosedTabsList</h4>
732 <b>clearClosedTabsList</b>(<i></i>) 762 <b>clearClosedTabsList</b>(<i></i>)
795 Public slot to get a reference to the closed tabs manager. 825 Public slot to get a reference to the closed tabs manager.
796 </p> 826 </p>
797 <dl> 827 <dl>
798 <dt>Return:</dt> 828 <dt>Return:</dt>
799 <dd> 829 <dd>
800 reference to the closed tabs manager (ClosedTabsManager) 830 reference to the closed tabs manager
831 </dd>
832 </dl>
833 <dl>
834 <dt>Return Type:</dt>
835 <dd>
836 ClosedTabsManager
801 </dd> 837 </dd>
802 </dl> 838 </dl>
803 <a NAME="WebBrowserTabWidget.currentBrowser" ID="WebBrowserTabWidget.currentBrowser"></a> 839 <a NAME="WebBrowserTabWidget.currentBrowser" ID="WebBrowserTabWidget.currentBrowser"></a>
804 <h4>WebBrowserTabWidget.currentBrowser</h4> 840 <h4>WebBrowserTabWidget.currentBrowser</h4>
805 <b>currentBrowser</b>(<i></i>) 841 <b>currentBrowser</b>(<i></i>)
808 Public method to get a reference to the current browser. 844 Public method to get a reference to the current browser.
809 </p> 845 </p>
810 <dl> 846 <dl>
811 <dt>Return:</dt> 847 <dt>Return:</dt>
812 <dd> 848 <dd>
813 reference to the current browser (WebBrowserView) 849 reference to the current browser
850 </dd>
851 </dl>
852 <dl>
853 <dt>Return Type:</dt>
854 <dd>
855 WebBrowserView
814 </dd> 856 </dd>
815 </dl> 857 </dl>
816 <a NAME="WebBrowserTabWidget.currentUrlBar" ID="WebBrowserTabWidget.currentUrlBar"></a> 858 <a NAME="WebBrowserTabWidget.currentUrlBar" ID="WebBrowserTabWidget.currentUrlBar"></a>
817 <h4>WebBrowserTabWidget.currentUrlBar</h4> 859 <h4>WebBrowserTabWidget.currentUrlBar</h4>
818 <b>currentUrlBar</b>(<i></i>) 860 <b>currentUrlBar</b>(<i></i>)
821 Public method to get a reference to the current url bar. 863 Public method to get a reference to the current url bar.
822 </p> 864 </p>
823 <dl> 865 <dl>
824 <dt>Return:</dt> 866 <dt>Return:</dt>
825 <dd> 867 <dd>
826 reference to the current url bar (UrlBar) 868 reference to the current url bar
869 </dd>
870 </dl>
871 <dl>
872 <dt>Return Type:</dt>
873 <dd>
874 UrlBar
827 </dd> 875 </dd>
828 </dl> 876 </dl>
829 <a NAME="WebBrowserTabWidget.getSessionData" ID="WebBrowserTabWidget.getSessionData"></a> 877 <a NAME="WebBrowserTabWidget.getSessionData" ID="WebBrowserTabWidget.getSessionData"></a>
830 <h4>WebBrowserTabWidget.getSessionData</h4> 878 <h4>WebBrowserTabWidget.getSessionData</h4>
831 <b>getSessionData</b>(<i></i>) 879 <b>getSessionData</b>(<i></i>)
856 <dt>Return:</dt> 904 <dt>Return:</dt>
857 <dd> 905 <dd>
858 dictionary with tab id as key and host/namespace as value 906 dictionary with tab id as key and host/namespace as value
859 </dd> 907 </dd>
860 </dl> 908 </dl>
909 <dl>
910 <dt>Return Type:</dt>
911 <dd>
912 dict
913 </dd>
914 </dl>
861 <a NAME="WebBrowserTabWidget.loadFromSessionData" ID="WebBrowserTabWidget.loadFromSessionData"></a> 915 <a NAME="WebBrowserTabWidget.loadFromSessionData" ID="WebBrowserTabWidget.loadFromSessionData"></a>
862 <h4>WebBrowserTabWidget.loadFromSessionData</h4> 916 <h4>WebBrowserTabWidget.loadFromSessionData</h4>
863 <b>loadFromSessionData</b>(<i>sessionData</i>) 917 <b>loadFromSessionData</b>(<i>sessionData</i>)
864 918
865 <p> 919 <p>
920 <p> 974 <p>
921 Public method to create a new web browser tab after a given one. 975 Public method to create a new web browser tab after a given one.
922 </p> 976 </p>
923 <dl> 977 <dl>
924 978
925 <dt><i>browser</i></dt> 979 <dt><i>browser</i> (WebBrowserView)</dt>
926 <dd> 980 <dd>
927 reference to the browser to add after (WebBrowserView) 981 reference to the browser to add after
928 </dd> 982 </dd>
929 <dt><i>link</i></dt> 983 <dt><i>link</i> (str or QUrl)</dt>
930 <dd> 984 <dd>
931 link to be shown (string or QUrl) 985 link to be shown
932 </dd> 986 </dd>
933 <dt><i>background</i></dt> 987 <dt><i>background</i> (bool)</dt>
934 <dd> 988 <dd>
935 flag indicating to open the tab in the 989 flag indicating to open the tab in the background
936 background (bool)
937 </dd> 990 </dd>
938 </dl> 991 </dl>
939 <dl> 992 <dl>
940 <dt>Return:</dt> 993 <dt>Return:</dt>
941 <dd> 994 <dd>
962 <p> 1015 <p>
963 Public slot called to print the displayed page. 1016 Public slot called to print the displayed page.
964 </p> 1017 </p>
965 <dl> 1018 <dl>
966 1019
967 <dt><i>browser</i></dt> 1020 <dt><i>browser</i> (WebBrowserView)</dt>
968 <dd> 1021 <dd>
969 reference to the browser to be printed (WebBrowserView) 1022 reference to the browser to be printed
970 </dd> 1023 </dd>
971 </dl> 1024 </dl>
972 <a NAME="WebBrowserTabWidget.printBrowserPdf" ID="WebBrowserTabWidget.printBrowserPdf"></a> 1025 <a NAME="WebBrowserTabWidget.printBrowserPdf" ID="WebBrowserTabWidget.printBrowserPdf"></a>
973 <h4>WebBrowserTabWidget.printBrowserPdf</h4> 1026 <h4>WebBrowserTabWidget.printBrowserPdf</h4>
974 <b>printBrowserPdf</b>(<i>browser=None</i>) 1027 <b>printBrowserPdf</b>(<i>browser=None</i>)
976 <p> 1029 <p>
977 Public slot called to print the displayed page to PDF. 1030 Public slot called to print the displayed page to PDF.
978 </p> 1031 </p>
979 <dl> 1032 <dl>
980 1033
981 <dt><i>browser</i></dt> 1034 <dt><i>browser</i> (WebBrowserView)</dt>
982 <dd> 1035 <dd>
983 reference to the browser to be printed (HelpBrowser) 1036 reference to the browser to be printed
984 </dd> 1037 </dd>
985 </dl> 1038 </dl>
986 <a NAME="WebBrowserTabWidget.printPreviewBrowser" ID="WebBrowserTabWidget.printPreviewBrowser"></a> 1039 <a NAME="WebBrowserTabWidget.printPreviewBrowser" ID="WebBrowserTabWidget.printPreviewBrowser"></a>
987 <h4>WebBrowserTabWidget.printPreviewBrowser</h4> 1040 <h4>WebBrowserTabWidget.printPreviewBrowser</h4>
988 <b>printPreviewBrowser</b>(<i>browser=None</i>) 1041 <b>printPreviewBrowser</b>(<i>browser=None</i>)
990 <p> 1043 <p>
991 Public slot called to show a print preview of the displayed file. 1044 Public slot called to show a print preview of the displayed file.
992 </p> 1045 </p>
993 <dl> 1046 <dl>
994 1047
995 <dt><i>browser</i></dt> 1048 <dt><i>browser</i> (WebBrowserView)</dt>
996 <dd> 1049 <dd>
997 reference to the browser to be printed (WebBrowserView) 1050 reference to the browser to be printed
998 </dd> 1051 </dd>
999 </dl> 1052 </dl>
1000 <a NAME="WebBrowserTabWidget.reloadAllBrowsers" ID="WebBrowserTabWidget.reloadAllBrowsers"></a> 1053 <a NAME="WebBrowserTabWidget.reloadAllBrowsers" ID="WebBrowserTabWidget.reloadAllBrowsers"></a>
1001 <h4>WebBrowserTabWidget.reloadAllBrowsers</h4> 1054 <h4>WebBrowserTabWidget.reloadAllBrowsers</h4>
1002 <b>reloadAllBrowsers</b>(<i></i>) 1055 <b>reloadAllBrowsers</b>(<i></i>)
1033 Public method to check, if the application should be shut down. 1086 Public method to check, if the application should be shut down.
1034 </p> 1087 </p>
1035 <dl> 1088 <dl>
1036 <dt>Return:</dt> 1089 <dt>Return:</dt>
1037 <dd> 1090 <dd>
1038 flag indicating a shut down (boolean) 1091 flag indicating a shut down
1092 </dd>
1093 </dl>
1094 <dl>
1095 <dt>Return Type:</dt>
1096 <dd>
1097 bool
1039 </dd> 1098 </dd>
1040 </dl> 1099 </dl>
1041 <a NAME="WebBrowserTabWidget.stackedUrlBar" ID="WebBrowserTabWidget.stackedUrlBar"></a> 1100 <a NAME="WebBrowserTabWidget.stackedUrlBar" ID="WebBrowserTabWidget.stackedUrlBar"></a>
1042 <h4>WebBrowserTabWidget.stackedUrlBar</h4> 1101 <h4>WebBrowserTabWidget.stackedUrlBar</h4>
1043 <b>stackedUrlBar</b>(<i></i>) 1102 <b>stackedUrlBar</b>(<i></i>)
1046 Public method to get a reference to the stacked url bar. 1105 Public method to get a reference to the stacked url bar.
1047 </p> 1106 </p>
1048 <dl> 1107 <dl>
1049 <dt>Return:</dt> 1108 <dt>Return:</dt>
1050 <dd> 1109 <dd>
1051 reference to the stacked url bar (StackedUrlBar) 1110 reference to the stacked url bar
1111 </dd>
1112 </dl>
1113 <dl>
1114 <dt>Return Type:</dt>
1115 <dd>
1116 StackedUrlBar
1052 </dd> 1117 </dd>
1053 </dl> 1118 </dl>
1054 <a NAME="WebBrowserTabWidget.urlBarForView" ID="WebBrowserTabWidget.urlBarForView"></a> 1119 <a NAME="WebBrowserTabWidget.urlBarForView" ID="WebBrowserTabWidget.urlBarForView"></a>
1055 <h4>WebBrowserTabWidget.urlBarForView</h4> 1120 <h4>WebBrowserTabWidget.urlBarForView</h4>
1056 <b>urlBarForView</b>(<i>view</i>) 1121 <b>urlBarForView</b>(<i>view</i>)

eric ide

mercurial