diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html
--- a/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,57 +7,55 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpViewerWidget</h1>
-
<p>
Module implementing an embedded viewer for QtHelp and local HTML files.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>WEBENGINE_AVAILABLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HelpViewerWidget">HelpViewerWidget</a></td>
<td>Class implementing an embedded viewer for QtHelp and local HTML files.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HelpViewerWidget" ID="HelpViewerWidget"></a>
<h2>HelpViewerWidget</h2>
-
<p>
Class implementing an embedded viewer for QtHelp and local HTML files.
</p>
+
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
-
<table>
-<tr><td>EmpytDocument_Dark</td></tr><tr><td>EmpytDocument_Light</td></tr><tr><td>MaxHistoryItems</td></tr>
+<tr><td>EmpytDocument_Dark</td></tr>
+<tr><td>EmpytDocument_Light</td></tr>
+<tr><td>MaxHistoryItems</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#HelpViewerWidget.emptyDocument">emptyDocument</a></td>
<td>Class method to get the HTML code for an empty page.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#HelpViewerWidget.__init__">HelpViewerWidget</a></td>
<td>Constructor</td>
@@ -299,19 +297,20 @@
<td>Public method to get the web settings of the current profile.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HelpViewerWidget.emptyDocument" ID="HelpViewerWidget.emptyDocument"></a>
<h4>HelpViewerWidget.emptyDocument (class method)</h4>
<b>emptyDocument</b>(<i></i>)
-
<p>
Class method to get the HTML code for an empty page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -327,10 +326,10 @@
<a NAME="HelpViewerWidget.__init__" ID="HelpViewerWidget.__init__"></a>
<h4>HelpViewerWidget (Constructor)</h4>
<b>HelpViewerWidget</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget (optional))</dt>
@@ -341,17 +340,17 @@
<a NAME="HelpViewerWidget.__activateCurrentPage" ID="HelpViewerWidget.__activateCurrentPage"></a>
<h4>HelpViewerWidget.__activateCurrentPage</h4>
<b>__activateCurrentPage</b>(<i></i>)
-
<p>
Private slot to activate the current page.
</p>
+
<a NAME="HelpViewerWidget.__addNavigationButton" ID="HelpViewerWidget.__addNavigationButton"></a>
<h4>HelpViewerWidget.__addNavigationButton</h4>
<b>__addNavigationButton</b>(<i>iconName, toolTip</i>)
-
<p>
Private method to create and add a navigation button.
</p>
+
<dl>
<dt><i>iconName</i> (str)</dt>
@@ -378,45 +377,45 @@
<a NAME="HelpViewerWidget.__addNewPage" ID="HelpViewerWidget.__addNewPage"></a>
<h4>HelpViewerWidget.__addNewPage</h4>
<b>__addNewPage</b>(<i></i>)
-
<p>
Private slot to add a new empty page.
</p>
+
<a NAME="HelpViewerWidget.__backward" ID="HelpViewerWidget.__backward"></a>
<h4>HelpViewerWidget.__backward</h4>
<b>__backward</b>(<i></i>)
-
<p>
Private slot to move one page backward.
</p>
+
<a NAME="HelpViewerWidget.__checkActionButtons" ID="HelpViewerWidget.__checkActionButtons"></a>
<h4>HelpViewerWidget.__checkActionButtons</h4>
<b>__checkActionButtons</b>(<i></i>)
-
<p>
Private slot to set the enabled state of the action buttons.
</p>
+
<a NAME="HelpViewerWidget.__clearHistory" ID="HelpViewerWidget.__clearHistory"></a>
<h4>HelpViewerWidget.__clearHistory</h4>
<b>__clearHistory</b>(<i></i>)
-
<p>
Private slot to clear the history of the current viewer.
</p>
+
<a NAME="HelpViewerWidget.__configureHelpDocumentation" ID="HelpViewerWidget.__configureHelpDocumentation"></a>
<h4>HelpViewerWidget.__configureHelpDocumentation</h4>
<b>__configureHelpDocumentation</b>(<i></i>)
-
<p>
Private slot to open the Help Documentation configuration page.
</p>
+
<a NAME="HelpViewerWidget.__currentFilterChanged" ID="HelpViewerWidget.__currentFilterChanged"></a>
<h4>HelpViewerWidget.__currentFilterChanged</h4>
<b>__currentFilterChanged</b>(<i>filter_</i>)
-
<p>
Private slot handling a change of the active QtHelp filter.
</p>
+
<dl>
<dt><i>filter_</i> (str)</dt>
@@ -427,17 +426,17 @@
<a NAME="HelpViewerWidget.__currentPageChanged" ID="HelpViewerWidget.__currentPageChanged"></a>
<h4>HelpViewerWidget.__currentPageChanged</h4>
<b>__currentPageChanged</b>(<i></i>)
-
<p>
Private slot handling the selection of another page.
</p>
+
<a NAME="HelpViewerWidget.__docsInstalled" ID="HelpViewerWidget.__docsInstalled"></a>
<h4>HelpViewerWidget.__docsInstalled</h4>
<b>__docsInstalled</b>(<i>installed</i>)
-
<p>
Private slot handling the end of documentation installation.
</p>
+
<dl>
<dt><i>installed</i> (bool)</dt>
@@ -448,10 +447,10 @@
<a NAME="HelpViewerWidget.__filterQtHelpDocumentation" ID="HelpViewerWidget.__filterQtHelpDocumentation"></a>
<h4>HelpViewerWidget.__filterQtHelpDocumentation</h4>
<b>__filterQtHelpDocumentation</b>(<i>index</i>)
-
<p>
Private slot to filter the QtHelp documentation.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -462,17 +461,17 @@
<a NAME="HelpViewerWidget.__forward" ID="HelpViewerWidget.__forward"></a>
<h4>HelpViewerWidget.__forward</h4>
<b>__forward</b>(<i></i>)
-
<p>
Private slot to move one page foreward.
</p>
+
<a NAME="HelpViewerWidget.__getQtHelpCollectionFileName" ID="HelpViewerWidget.__getQtHelpCollectionFileName"></a>
<h4>HelpViewerWidget.__getQtHelpCollectionFileName</h4>
<b>__getQtHelpCollectionFileName</b>(<i></i>)
-
<p>
Private method to determine the name of the QtHelp collection file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -488,38 +487,38 @@
<a NAME="HelpViewerWidget.__helpTopicSelected" ID="HelpViewerWidget.__helpTopicSelected"></a>
<h4>HelpViewerWidget.__helpTopicSelected</h4>
<b>__helpTopicSelected</b>(<i></i>)
-
<p>
Private slot handling the selection of a new help topic.
</p>
+
<a NAME="HelpViewerWidget.__indexingFinished" ID="HelpViewerWidget.__indexingFinished"></a>
<h4>HelpViewerWidget.__indexingFinished</h4>
<b>__indexingFinished</b>(<i></i>)
-
<p>
Private slot handling the end of the indexing process.
</p>
+
<a NAME="HelpViewerWidget.__indexingStarted" ID="HelpViewerWidget.__indexingStarted"></a>
<h4>HelpViewerWidget.__indexingStarted</h4>
<b>__indexingStarted</b>(<i></i>)
-
<p>
Private slot handling the start of the indexing process.
</p>
+
<a NAME="HelpViewerWidget.__initActionsMenu" ID="HelpViewerWidget.__initActionsMenu"></a>
<h4>HelpViewerWidget.__initActionsMenu</h4>
<b>__initActionsMenu</b>(<i></i>)
-
<p>
Private method to initialize the actions menu.
</p>
+
<a NAME="HelpViewerWidget.__initFilterWidget" ID="HelpViewerWidget.__initFilterWidget"></a>
<h4>HelpViewerWidget.__initFilterWidget</h4>
<b>__initFilterWidget</b>(<i></i>)
-
<p>
Private method to initialize the filter selection widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -535,18 +534,18 @@
<a NAME="HelpViewerWidget.__initHelpEngine" ID="HelpViewerWidget.__initHelpEngine"></a>
<h4>HelpViewerWidget.__initHelpEngine</h4>
<b>__initHelpEngine</b>(<i></i>)
-
<p>
Private method to initialize the QtHelp related stuff.
</p>
+
<a NAME="HelpViewerWidget.__initIndexingProgress" ID="HelpViewerWidget.__initIndexingProgress"></a>
<h4>HelpViewerWidget.__initIndexingProgress</h4>
<b>__initIndexingProgress</b>(<i></i>)
-
<p>
Private method to initialize the help documents indexing progress
widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -562,39 +561,39 @@
<a NAME="HelpViewerWidget.__initQWebEngine" ID="HelpViewerWidget.__initQWebEngine"></a>
<h4>HelpViewerWidget.__initQWebEngine</h4>
<b>__initQWebEngine</b>(<i></i>)
-
<p>
Private method to initialize global QWebEngine related objects.
</p>
+
<a NAME="HelpViewerWidget.__initQWebEngineSettings" ID="HelpViewerWidget.__initQWebEngineSettings"></a>
<h4>HelpViewerWidget.__initQWebEngineSettings</h4>
<b>__initQWebEngineSettings</b>(<i></i>)
-
<p>
Private method to set the global web settings.
</p>
+
<a NAME="HelpViewerWidget.__lookForNewDocumentation" ID="HelpViewerWidget.__lookForNewDocumentation"></a>
<h4>HelpViewerWidget.__lookForNewDocumentation</h4>
<b>__lookForNewDocumentation</b>(<i></i>)
-
<p>
Private slot to look for new documentation to be loaded into the
help database.
</p>
+
<a NAME="HelpViewerWidget.__manageQtHelpDocuments" ID="HelpViewerWidget.__manageQtHelpDocuments"></a>
<h4>HelpViewerWidget.__manageQtHelpDocuments</h4>
<b>__manageQtHelpDocuments</b>(<i></i>)
-
<p>
Private slot to manage the QtHelp documentation database.
</p>
+
<a NAME="HelpViewerWidget.__navigationMenuActionTriggered" ID="HelpViewerWidget.__navigationMenuActionTriggered"></a>
<h4>HelpViewerWidget.__navigationMenuActionTriggered</h4>
<b>__navigationMenuActionTriggered</b>(<i>act</i>)
-
<p>
Private slot to go to the selected page.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -605,10 +604,10 @@
<a NAME="HelpViewerWidget.__newViewer" ID="HelpViewerWidget.__newViewer"></a>
<h4>HelpViewerWidget.__newViewer</h4>
<b>__newViewer</b>(<i></i>)
-
<p>
Private method to create a new help viewer.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -625,52 +624,52 @@
<a NAME="HelpViewerWidget.__openFile" ID="HelpViewerWidget.__openFile"></a>
<h4>HelpViewerWidget.__openFile</h4>
<b>__openFile</b>(<i></i>)
-
<p>
Private slot to open a local help file (*.html).
</p>
+
<a NAME="HelpViewerWidget.__populateHelpSelector" ID="HelpViewerWidget.__populateHelpSelector"></a>
<h4>HelpViewerWidget.__populateHelpSelector</h4>
<b>__populateHelpSelector</b>(<i></i>)
-
<p>
Private method to populate the help selection combo box.
</p>
+
<a NAME="HelpViewerWidget.__populateNavigationStack" ID="HelpViewerWidget.__populateNavigationStack"></a>
<h4>HelpViewerWidget.__populateNavigationStack</h4>
<b>__populateNavigationStack</b>(<i></i>)
-
<p>
Private method to populate the stack of navigation widgets.
</p>
+
<a NAME="HelpViewerWidget.__reload" ID="HelpViewerWidget.__reload"></a>
<h4>HelpViewerWidget.__reload</h4>
<b>__reload</b>(<i></i>)
-
<p>
Private slot to reload the current page.
</p>
+
<a NAME="HelpViewerWidget.__removeOldDocumentation" ID="HelpViewerWidget.__removeOldDocumentation"></a>
<h4>HelpViewerWidget.__removeOldDocumentation</h4>
<b>__removeOldDocumentation</b>(<i></i>)
-
<p>
Private slot to remove non-existing documentation from the help engine.
</p>
+
<a NAME="HelpViewerWidget.__searchWidgetClosed" ID="HelpViewerWidget.__searchWidgetClosed"></a>
<h4>HelpViewerWidget.__searchWidgetClosed</h4>
<b>__searchWidgetClosed</b>(<i></i>)
-
<p>
Private slot to handle the closing of the search widget.
</p>
+
<a NAME="HelpViewerWidget.__selectNavigationWidget" ID="HelpViewerWidget.__selectNavigationWidget"></a>
<h4>HelpViewerWidget.__selectNavigationWidget</h4>
<b>__selectNavigationWidget</b>(<i>button</i>)
-
<p>
Private slot to select the navigation widget.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -681,31 +680,31 @@
<a NAME="HelpViewerWidget.__setupFilterCombo" ID="HelpViewerWidget.__setupFilterCombo"></a>
<h4>HelpViewerWidget.__setupFilterCombo</h4>
<b>__setupFilterCombo</b>(<i></i>)
-
<p>
Private slot to setup the filter combo box.
</p>
+
<a NAME="HelpViewerWidget.__showBackMenu" ID="HelpViewerWidget.__showBackMenu"></a>
<h4>HelpViewerWidget.__showBackMenu</h4>
<b>__showBackMenu</b>(<i></i>)
-
<p>
Private slot showing the backward navigation menu.
</p>
+
<a NAME="HelpViewerWidget.__showForwardMenu" ID="HelpViewerWidget.__showForwardMenu"></a>
<h4>HelpViewerWidget.__showForwardMenu</h4>
<b>__showForwardMenu</b>(<i></i>)
-
<p>
Private slot showing the forward navigation menu.
</p>
+
<a NAME="HelpViewerWidget.__showInstallationError" ID="HelpViewerWidget.__showInstallationError"></a>
<h4>HelpViewerWidget.__showInstallationError</h4>
<b>__showInstallationError</b>(<i>message</i>)
-
<p>
Private slot to show installation errors.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -716,10 +715,10 @@
<a NAME="HelpViewerWidget.__warning" ID="HelpViewerWidget.__warning"></a>
<h4>HelpViewerWidget.__warning</h4>
<b>__warning</b>(<i>msg</i>)
-
<p>
Private slot handling warnings of the help engine.
</p>
+
<dl>
<dt><i>msg</i> (str)</dt>
@@ -730,31 +729,31 @@
<a NAME="HelpViewerWidget.__zoomIn" ID="HelpViewerWidget.__zoomIn"></a>
<h4>HelpViewerWidget.__zoomIn</h4>
<b>__zoomIn</b>(<i></i>)
-
<p>
Private slot to zoom in.
</p>
+
<a NAME="HelpViewerWidget.__zoomOut" ID="HelpViewerWidget.__zoomOut"></a>
<h4>HelpViewerWidget.__zoomOut</h4>
<b>__zoomOut</b>(<i></i>)
-
<p>
Private slot to zoom out.
</p>
+
<a NAME="HelpViewerWidget.__zoomReset" ID="HelpViewerWidget.__zoomReset"></a>
<h4>HelpViewerWidget.__zoomReset</h4>
<b>__zoomReset</b>(<i></i>)
-
<p>
Private slot to reset the zoom level.
</p>
+
<a NAME="HelpViewerWidget.activate" ID="HelpViewerWidget.activate"></a>
<h4>HelpViewerWidget.activate</h4>
<b>activate</b>(<i>searchWord=None, url=None</i>)
-
<p>
Public method to activate the widget and search for a given word.
</p>
+
<dl>
<dt><i>searchWord</i> (str (optional))</dt>
@@ -769,10 +768,10 @@
<a NAME="HelpViewerWidget.addPage" ID="HelpViewerWidget.addPage"></a>
<h4>HelpViewerWidget.addPage</h4>
<b>addPage</b>(<i>url=None, background=False</i>)
-
<p>
Public method to add a new help page with the given URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl (optional))</dt>
@@ -800,10 +799,10 @@
<a NAME="HelpViewerWidget.bookmarkPage" ID="HelpViewerWidget.bookmarkPage"></a>
<h4>HelpViewerWidget.bookmarkPage</h4>
<b>bookmarkPage</b>(<i>title, url</i>)
-
<p>
Public method to bookmark a page with the given data.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -818,31 +817,31 @@
<a NAME="HelpViewerWidget.closeAllPages" ID="HelpViewerWidget.closeAllPages"></a>
<h4>HelpViewerWidget.closeAllPages</h4>
<b>closeAllPages</b>(<i></i>)
-
<p>
Public slot to close all pages.
</p>
+
<a NAME="HelpViewerWidget.closeCurrentPage" ID="HelpViewerWidget.closeCurrentPage"></a>
<h4>HelpViewerWidget.closeCurrentPage</h4>
<b>closeCurrentPage</b>(<i></i>)
-
<p>
Public slot to close the current page.
</p>
+
<a NAME="HelpViewerWidget.closeOtherPages" ID="HelpViewerWidget.closeOtherPages"></a>
<h4>HelpViewerWidget.closeOtherPages</h4>
<b>closeOtherPages</b>(<i></i>)
-
<p>
Public slot to close all other pages.
</p>
+
<a NAME="HelpViewerWidget.currentViewer" ID="HelpViewerWidget.currentViewer"></a>
<h4>HelpViewerWidget.currentViewer</h4>
<b>currentViewer</b>(<i></i>)
-
<p>
Public method to get the active viewer.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -858,10 +857,10 @@
<a NAME="HelpViewerWidget.openPagesCount" ID="HelpViewerWidget.openPagesCount"></a>
<h4>HelpViewerWidget.openPagesCount</h4>
<b>openPagesCount</b>(<i></i>)
-
<p>
Public method to get the count of open pages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -877,10 +876,10 @@
<a NAME="HelpViewerWidget.openUrl" ID="HelpViewerWidget.openUrl"></a>
<h4>HelpViewerWidget.openUrl</h4>
<b>openUrl</b>(<i>url</i>)
-
<p>
Public slot to load a URL in the current page.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -891,10 +890,10 @@
<a NAME="HelpViewerWidget.openUrlNewBackgroundPage" ID="HelpViewerWidget.openUrlNewBackgroundPage"></a>
<h4>HelpViewerWidget.openUrlNewBackgroundPage</h4>
<b>openUrlNewBackgroundPage</b>(<i>url</i>)
-
<p>
Public slot to load a URL in a new background page.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -905,10 +904,10 @@
<a NAME="HelpViewerWidget.openUrlNewPage" ID="HelpViewerWidget.openUrlNewPage"></a>
<h4>HelpViewerWidget.openUrlNewPage</h4>
<b>openUrlNewPage</b>(<i>url</i>)
-
<p>
Public slot to load a URL in a new page.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -919,24 +918,24 @@
<a NAME="HelpViewerWidget.searchNext" ID="HelpViewerWidget.searchNext"></a>
<h4>HelpViewerWidget.searchNext</h4>
<b>searchNext</b>(<i></i>)
-
<p>
Public slot to find the next occurrence of the current search term.
</p>
+
<a NAME="HelpViewerWidget.searchPrev" ID="HelpViewerWidget.searchPrev"></a>
<h4>HelpViewerWidget.searchPrev</h4>
<b>searchPrev</b>(<i></i>)
-
<p>
Public slot to find the previous occurrence of the current search term.
</p>
+
<a NAME="HelpViewerWidget.searchQtHelp" ID="HelpViewerWidget.searchQtHelp"></a>
<h4>HelpViewerWidget.searchQtHelp</h4>
<b>searchQtHelp</b>(<i>searchExpression</i>)
-
<p>
Public slot to search for a given search expression.
</p>
+
<dl>
<dt><i>searchExpression</i> (str)</dt>
@@ -947,10 +946,10 @@
<a NAME="HelpViewerWidget.showHideSearch" ID="HelpViewerWidget.showHideSearch"></a>
<h4>HelpViewerWidget.showHideSearch</h4>
<b>showHideSearch</b>(<i>visible</i>)
-
<p>
Public slot to show or hide the search widget.
</p>
+
<dl>
<dt><i>visible</i> (bool)</dt>
@@ -961,17 +960,17 @@
<a NAME="HelpViewerWidget.shutdown" ID="HelpViewerWidget.shutdown"></a>
<h4>HelpViewerWidget.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method to perform shut down actions.
</p>
+
<a NAME="HelpViewerWidget.webProfile" ID="HelpViewerWidget.webProfile"></a>
<h4>HelpViewerWidget.webProfile</h4>
<b>webProfile</b>(<i></i>)
-
<p>
Public method to get a reference to the global web profile object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -987,10 +986,10 @@
<a NAME="HelpViewerWidget.webSettings" ID="HelpViewerWidget.webSettings"></a>
<h4>HelpViewerWidget.webSettings</h4>
<b>webSettings</b>(<i></i>)
-
<p>
Public method to get the web settings of the current profile.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1005,4 +1004,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
