--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserTabWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.WebBrowserTabWidget</h1>
-
<p>
Module implementing the central widget showing the web pages.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#WebBrowserTabWidget">WebBrowserTabWidget</a></td>
<td>Class implementing the central widget showing the web pages.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="WebBrowserTabWidget" ID="WebBrowserTabWidget"></a>
<h2>WebBrowserTabWidget</h2>
-
<p>
Class implementing the central widget showing the web pages.
</p>
+
<h3>Signals</h3>
<dl>
@@ -78,19 +77,17 @@
<h3>Derived from</h3>
EricTabWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#WebBrowserTabWidget.__init__">WebBrowserTabWidget</a></td>
<td>Constructor</td>
@@ -312,19 +309,20 @@
<td>Public method to get a reference to the UrlBar associated with the given view.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="WebBrowserTabWidget.__init__" ID="WebBrowserTabWidget.__init__"></a>
<h4>WebBrowserTabWidget (Constructor)</h4>
<b>WebBrowserTabWidget</b>(<i>parent</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -335,17 +333,17 @@
<a NAME="WebBrowserTabWidget.__aboutToShowClosedTabsMenu" ID="WebBrowserTabWidget.__aboutToShowClosedTabsMenu"></a>
<h4>WebBrowserTabWidget.__aboutToShowClosedTabsMenu</h4>
<b>__aboutToShowClosedTabsMenu</b>(<i></i>)
-
<p>
Private slot to populate the closed tabs menu.
</p>
+
<a NAME="WebBrowserTabWidget.__closedTabAvailable" ID="WebBrowserTabWidget.__closedTabAvailable"></a>
<h4>WebBrowserTabWidget.__closedTabAvailable</h4>
<b>__closedTabAvailable</b>(<i>avail</i>)
-
<p>
Private slot to handle changes of the availability of closed tabs.
</p>
+
<dl>
<dt><i>avail</i> (bool)</dt>
@@ -356,10 +354,10 @@
<a NAME="WebBrowserTabWidget.__currentChanged" ID="WebBrowserTabWidget.__currentChanged"></a>
<h4>WebBrowserTabWidget.__currentChanged</h4>
<b>__currentChanged</b>(<i>index</i>)
-
<p>
Private slot to handle an index change.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -370,10 +368,10 @@
<a NAME="WebBrowserTabWidget.__elide" ID="WebBrowserTabWidget.__elide"></a>
<h4>WebBrowserTabWidget.__elide</h4>
<b>__elide</b>(<i>txt, mode=Qt.TextElideMode.ElideRight, length=40</i>)
-
<p>
Private method to elide some text.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -404,10 +402,10 @@
<a NAME="WebBrowserTabWidget.__guessUrlFromPath" ID="WebBrowserTabWidget.__guessUrlFromPath"></a>
<h4>WebBrowserTabWidget.__guessUrlFromPath</h4>
<b>__guessUrlFromPath</b>(<i>path</i>)
-
<p>
Private method to guess an URL given a path string.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -430,10 +428,10 @@
<a NAME="WebBrowserTabWidget.__iconChanged" ID="WebBrowserTabWidget.__iconChanged"></a>
<h4>WebBrowserTabWidget.__iconChanged</h4>
<b>__iconChanged</b>(<i>browser</i>)
-
<p>
Private slot to handle a change of the web site icon.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -444,17 +442,17 @@
<a NAME="WebBrowserTabWidget.__initTabContextMenu" ID="WebBrowserTabWidget.__initTabContextMenu"></a>
<h4>WebBrowserTabWidget.__initTabContextMenu</h4>
<b>__initTabContextMenu</b>(<i></i>)
-
<p>
Private method to create the tab context menu.
</p>
+
<a NAME="WebBrowserTabWidget.__lineEditReturnPressed" ID="WebBrowserTabWidget.__lineEditReturnPressed"></a>
<h4>WebBrowserTabWidget.__lineEditReturnPressed</h4>
<b>__lineEditReturnPressed</b>(<i>edit</i>)
-
<p>
Private slot to handle the entering of an URL.
</p>
+
<dl>
<dt><i>edit</i> (UrlBar)</dt>
@@ -465,10 +463,10 @@
<a NAME="WebBrowserTabWidget.__loadFinished" ID="WebBrowserTabWidget.__loadFinished"></a>
<h4>WebBrowserTabWidget.__loadFinished</h4>
<b>__loadFinished</b>(<i>ok, browser</i>)
-
<p>
Private method to handle the loadFinished signal.
</p>
+
<dl>
<dt><i>ok</i> (bool)</dt>
@@ -483,7 +481,6 @@
<a NAME="WebBrowserTabWidget.__loadProgress" ID="WebBrowserTabWidget.__loadProgress"></a>
<h4>WebBrowserTabWidget.__loadProgress</h4>
<b>__loadProgress</b>(<i>progress, browser</i>)
-
<p>
Private method to handle the loadProgress signal.
</p>
@@ -491,6 +488,7 @@
Note: This works around wegengine not sending a loadFinished
signal for navigation on the same page.
</p>
+
<dl>
<dt><i>progress</i> (int)</dt>
@@ -505,10 +503,10 @@
<a NAME="WebBrowserTabWidget.__navigationMenuTriggered" ID="WebBrowserTabWidget.__navigationMenuTriggered"></a>
<h4>WebBrowserTabWidget.__navigationMenuTriggered</h4>
<b>__navigationMenuTriggered</b>(<i>act</i>)
-
<p>
Private slot called to handle the navigation button menu selection.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -519,17 +517,17 @@
<a NAME="WebBrowserTabWidget.__newBrowser" ID="WebBrowserTabWidget.__newBrowser"></a>
<h4>WebBrowserTabWidget.__newBrowser</h4>
<b>__newBrowser</b>(<i></i>)
-
<p>
Private slot to open a new browser tab.
</p>
+
<a NAME="WebBrowserTabWidget.__pathSelected" ID="WebBrowserTabWidget.__pathSelected"></a>
<h4>WebBrowserTabWidget.__pathSelected</h4>
<b>__pathSelected</b>(<i>path</i>)
-
<p>
Private slot called when a URL is selected from the completer.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -540,10 +538,10 @@
<a NAME="WebBrowserTabWidget.__recentlyAudibleChanged" ID="WebBrowserTabWidget.__recentlyAudibleChanged"></a>
<h4>WebBrowserTabWidget.__recentlyAudibleChanged</h4>
<b>__recentlyAudibleChanged</b>(<i>recentlyAudible, page</i>)
-
<p>
Private slot to react on the audible state of a page.
</p>
+
<dl>
<dt><i>recentlyAudible</i> (bool)</dt>
@@ -558,10 +556,10 @@
<a NAME="WebBrowserTabWidget.__showContextMenu" ID="WebBrowserTabWidget.__showContextMenu"></a>
<h4>WebBrowserTabWidget.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord, index</i>)
-
<p>
Private slot to show the tab context menu.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -576,17 +574,17 @@
<a NAME="WebBrowserTabWidget.__showNavigationMenu" ID="WebBrowserTabWidget.__showNavigationMenu"></a>
<h4>WebBrowserTabWidget.__showNavigationMenu</h4>
<b>__showNavigationMenu</b>(<i></i>)
-
<p>
Private slot to show the navigation button menu.
</p>
+
<a NAME="WebBrowserTabWidget.__sourceChanged" ID="WebBrowserTabWidget.__sourceChanged"></a>
<h4>WebBrowserTabWidget.__sourceChanged</h4>
<b>__sourceChanged</b>(<i>url, browser</i>)
-
<p>
Private slot to handle a change of a browsers source.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -601,73 +599,73 @@
<a NAME="WebBrowserTabWidget.__tabContextMenuAudioMute" ID="WebBrowserTabWidget.__tabContextMenuAudioMute"></a>
<h4>WebBrowserTabWidget.__tabContextMenuAudioMute</h4>
<b>__tabContextMenuAudioMute</b>(<i></i>)
-
<p>
Private method to mute or unmute the selected tab.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuClone" ID="WebBrowserTabWidget.__tabContextMenuClone"></a>
<h4>WebBrowserTabWidget.__tabContextMenuClone</h4>
<b>__tabContextMenuClone</b>(<i></i>)
-
<p>
Private method to clone the selected tab.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuClose" ID="WebBrowserTabWidget.__tabContextMenuClose"></a>
<h4>WebBrowserTabWidget.__tabContextMenuClose</h4>
<b>__tabContextMenuClose</b>(<i></i>)
-
<p>
Private method to close the selected tab.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuCloseOthers" ID="WebBrowserTabWidget.__tabContextMenuCloseOthers"></a>
<h4>WebBrowserTabWidget.__tabContextMenuCloseOthers</h4>
<b>__tabContextMenuCloseOthers</b>(<i></i>)
-
<p>
Private slot to close all other tabs.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuMoveLeft" ID="WebBrowserTabWidget.__tabContextMenuMoveLeft"></a>
<h4>WebBrowserTabWidget.__tabContextMenuMoveLeft</h4>
<b>__tabContextMenuMoveLeft</b>(<i></i>)
-
<p>
Private method to move a tab one position to the left.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuMoveRight" ID="WebBrowserTabWidget.__tabContextMenuMoveRight"></a>
<h4>WebBrowserTabWidget.__tabContextMenuMoveRight</h4>
<b>__tabContextMenuMoveRight</b>(<i></i>)
-
<p>
Private method to move a tab one position to the right.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuPrint" ID="WebBrowserTabWidget.__tabContextMenuPrint"></a>
<h4>WebBrowserTabWidget.__tabContextMenuPrint</h4>
<b>__tabContextMenuPrint</b>(<i></i>)
-
<p>
Private method to print the selected tab.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuPrintPdf" ID="WebBrowserTabWidget.__tabContextMenuPrintPdf"></a>
<h4>WebBrowserTabWidget.__tabContextMenuPrintPdf</h4>
<b>__tabContextMenuPrintPdf</b>(<i></i>)
-
<p>
Private method to print the selected tab as PDF.
</p>
+
<a NAME="WebBrowserTabWidget.__tabContextMenuPrintPreview" ID="WebBrowserTabWidget.__tabContextMenuPrintPreview"></a>
<h4>WebBrowserTabWidget.__tabContextMenuPrintPreview</h4>
<b>__tabContextMenuPrintPreview</b>(<i></i>)
-
<p>
Private method to show a print preview of the selected tab.
</p>
+
<a NAME="WebBrowserTabWidget.__titleChanged" ID="WebBrowserTabWidget.__titleChanged"></a>
<h4>WebBrowserTabWidget.__titleChanged</h4>
<b>__titleChanged</b>(<i>title, browser</i>)
-
<p>
Private slot to handle a change of a browsers title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -682,10 +680,10 @@
<a NAME="WebBrowserTabWidget.__windowCloseRequested" ID="WebBrowserTabWidget.__windowCloseRequested"></a>
<h4>WebBrowserTabWidget.__windowCloseRequested</h4>
<b>__windowCloseRequested</b>(<i>page</i>)
-
<p>
Private slot to handle the windowCloseRequested signal of a browser.
</p>
+
<dl>
<dt><i>page</i> (WebBrowserPage)</dt>
@@ -696,10 +694,10 @@
<a NAME="WebBrowserTabWidget.browserAt" ID="WebBrowserTabWidget.browserAt"></a>
<h4>WebBrowserTabWidget.browserAt</h4>
<b>browserAt</b>(<i>index</i>)
-
<p>
Public method to get a reference to the browser with the given index.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -722,10 +720,10 @@
<a NAME="WebBrowserTabWidget.browsers" ID="WebBrowserTabWidget.browsers"></a>
<h4>WebBrowserTabWidget.browsers</h4>
<b>browsers</b>(<i></i>)
-
<p>
Public method to get a list of references to all browsers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -741,10 +739,10 @@
<a NAME="WebBrowserTabWidget.canRestoreClosedTab" ID="WebBrowserTabWidget.canRestoreClosedTab"></a>
<h4>WebBrowserTabWidget.canRestoreClosedTab</h4>
<b>canRestoreClosedTab</b>(<i></i>)
-
<p>
Public method to check, if closed tabs can be restored.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -760,17 +758,17 @@
<a NAME="WebBrowserTabWidget.clearClosedTabsList" ID="WebBrowserTabWidget.clearClosedTabsList"></a>
<h4>WebBrowserTabWidget.clearClosedTabsList</h4>
<b>clearClosedTabsList</b>(<i></i>)
-
<p>
Public slot to clear the list of closed tabs.
</p>
+
<a NAME="WebBrowserTabWidget.closeAllBrowsers" ID="WebBrowserTabWidget.closeAllBrowsers"></a>
<h4>WebBrowserTabWidget.closeAllBrowsers</h4>
<b>closeAllBrowsers</b>(<i>shutdown=False</i>)
-
<p>
Public slot called to handle the close all action.
</p>
+
<dl>
<dt><i>shutdown</i> (bool)</dt>
@@ -781,17 +779,17 @@
<a NAME="WebBrowserTabWidget.closeBrowser" ID="WebBrowserTabWidget.closeBrowser"></a>
<h4>WebBrowserTabWidget.closeBrowser</h4>
<b>closeBrowser</b>(<i></i>)
-
<p>
Public slot called to handle the close action.
</p>
+
<a NAME="WebBrowserTabWidget.closeBrowserAt" ID="WebBrowserTabWidget.closeBrowserAt"></a>
<h4>WebBrowserTabWidget.closeBrowserAt</h4>
<b>closeBrowserAt</b>(<i>index, shutdown=False</i>)
-
<p>
Public slot to close a browser based on its index.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -806,10 +804,10 @@
<a NAME="WebBrowserTabWidget.closeBrowserView" ID="WebBrowserTabWidget.closeBrowserView"></a>
<h4>WebBrowserTabWidget.closeBrowserView</h4>
<b>closeBrowserView</b>(<i>browser</i>)
-
<p>
Public method to close the given browser.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -820,10 +818,10 @@
<a NAME="WebBrowserTabWidget.closedTabsManager" ID="WebBrowserTabWidget.closedTabsManager"></a>
<h4>WebBrowserTabWidget.closedTabsManager</h4>
<b>closedTabsManager</b>(<i></i>)
-
<p>
Public slot to get a reference to the closed tabs manager.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -839,10 +837,10 @@
<a NAME="WebBrowserTabWidget.currentBrowser" ID="WebBrowserTabWidget.currentBrowser"></a>
<h4>WebBrowserTabWidget.currentBrowser</h4>
<b>currentBrowser</b>(<i></i>)
-
<p>
Public method to get a reference to the current browser.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -858,10 +856,10 @@
<a NAME="WebBrowserTabWidget.currentUrlBar" ID="WebBrowserTabWidget.currentUrlBar"></a>
<h4>WebBrowserTabWidget.currentUrlBar</h4>
<b>currentUrlBar</b>(<i></i>)
-
<p>
Public method to get a reference to the current url bar.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -877,10 +875,10 @@
<a NAME="WebBrowserTabWidget.getSessionData" ID="WebBrowserTabWidget.getSessionData"></a>
<h4>WebBrowserTabWidget.getSessionData</h4>
<b>getSessionData</b>(<i></i>)
-
<p>
Public method to populate the session data.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -896,10 +894,10 @@
<a NAME="WebBrowserTabWidget.getSourceFileList" ID="WebBrowserTabWidget.getSourceFileList"></a>
<h4>WebBrowserTabWidget.getSourceFileList</h4>
<b>getSourceFileList</b>(<i></i>)
-
<p>
Public method to get a list of all opened Qt help files.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -915,10 +913,10 @@
<a NAME="WebBrowserTabWidget.loadFromSessionData" ID="WebBrowserTabWidget.loadFromSessionData"></a>
<h4>WebBrowserTabWidget.loadFromSessionData</h4>
<b>loadFromSessionData</b>(<i>sessionData</i>)
-
<p>
Public method to load the session data.
</p>
+
<dl>
<dt><i>sessionData</i> (dict)</dt>
@@ -930,10 +928,10 @@
<a NAME="WebBrowserTabWidget.newBrowser" ID="WebBrowserTabWidget.newBrowser"></a>
<h4>WebBrowserTabWidget.newBrowser</h4>
<b>newBrowser</b>(<i>link=None, position=-1, background=False, restoreSession=False</i>)
-
<p>
Public method to create a new web browser tab.
</p>
+
<dl>
<dt><i>link</i> (str or QUrl)</dt>
@@ -970,10 +968,10 @@
<a NAME="WebBrowserTabWidget.newBrowserAfter" ID="WebBrowserTabWidget.newBrowserAfter"></a>
<h4>WebBrowserTabWidget.newBrowserAfter</h4>
<b>newBrowserAfter</b>(<i>browser, link=None, background=False</i>)
-
<p>
Public method to create a new web browser tab after a given one.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -1004,17 +1002,17 @@
<a NAME="WebBrowserTabWidget.preferencesChanged" ID="WebBrowserTabWidget.preferencesChanged"></a>
<h4>WebBrowserTabWidget.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of preferences.
</p>
+
<a NAME="WebBrowserTabWidget.printBrowser" ID="WebBrowserTabWidget.printBrowser"></a>
<h4>WebBrowserTabWidget.printBrowser</h4>
<b>printBrowser</b>(<i>browser=None</i>)
-
<p>
Public slot called to print the displayed page.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -1025,10 +1023,10 @@
<a NAME="WebBrowserTabWidget.printBrowserPdf" ID="WebBrowserTabWidget.printBrowserPdf"></a>
<h4>WebBrowserTabWidget.printBrowserPdf</h4>
<b>printBrowserPdf</b>(<i>browser=None</i>)
-
<p>
Public slot called to print the displayed page to PDF.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -1039,10 +1037,10 @@
<a NAME="WebBrowserTabWidget.printPreviewBrowser" ID="WebBrowserTabWidget.printPreviewBrowser"></a>
<h4>WebBrowserTabWidget.printPreviewBrowser</h4>
<b>printPreviewBrowser</b>(<i>browser=None</i>)
-
<p>
Public slot called to show a print preview of the displayed file.
</p>
+
<dl>
<dt><i>browser</i> (WebBrowserView)</dt>
@@ -1053,24 +1051,24 @@
<a NAME="WebBrowserTabWidget.reloadAllBrowsers" ID="WebBrowserTabWidget.reloadAllBrowsers"></a>
<h4>WebBrowserTabWidget.reloadAllBrowsers</h4>
<b>reloadAllBrowsers</b>(<i></i>)
-
<p>
Public slot to reload all browsers.
</p>
+
<a NAME="WebBrowserTabWidget.restoreAllClosedTabs" ID="WebBrowserTabWidget.restoreAllClosedTabs"></a>
<h4>WebBrowserTabWidget.restoreAllClosedTabs</h4>
<b>restoreAllClosedTabs</b>(<i></i>)
-
<p>
Public slot to restore all closed tabs.
</p>
+
<a NAME="WebBrowserTabWidget.restoreClosedTab" ID="WebBrowserTabWidget.restoreClosedTab"></a>
<h4>WebBrowserTabWidget.restoreClosedTab</h4>
<b>restoreClosedTab</b>(<i>act</i>)
-
<p>
Public slot to restore the most recently closed tab.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -1081,10 +1079,10 @@
<a NAME="WebBrowserTabWidget.shallShutDown" ID="WebBrowserTabWidget.shallShutDown"></a>
<h4>WebBrowserTabWidget.shallShutDown</h4>
<b>shallShutDown</b>(<i></i>)
-
<p>
Public method to check, if the application should be shut down.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1100,10 +1098,10 @@
<a NAME="WebBrowserTabWidget.stackedUrlBar" ID="WebBrowserTabWidget.stackedUrlBar"></a>
<h4>WebBrowserTabWidget.stackedUrlBar</h4>
<b>stackedUrlBar</b>(<i></i>)
-
<p>
Public method to get a reference to the stacked url bar.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1119,11 +1117,11 @@
<a NAME="WebBrowserTabWidget.urlBarForView" ID="WebBrowserTabWidget.urlBarForView"></a>
<h4>WebBrowserTabWidget.urlBarForView</h4>
<b>urlBarForView</b>(<i>view</i>)
-
<p>
Public method to get a reference to the UrlBar associated with the
given view.
</p>
+
<dl>
<dt><i>view</i> (WebBrowserView)</dt>
@@ -1145,4 +1143,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
