--- a/src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpIndexWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QtHelpInterface.HelpIndexWidget</h1>
-
<p>
Module implementing a window for showing the QtHelp index.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HelpIndexWidget">HelpIndexWidget</a></td>
<td>Class implementing a window for showing the QtHelp index.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HelpIndexWidget" ID="HelpIndexWidget"></a>
<h2>HelpIndexWidget</h2>
-
<p>
Class implementing a window for showing the QtHelp index.
</p>
+
<h3>Signals</h3>
<dl>
@@ -66,19 +65,17 @@
<h3>Derived from</h3>
QWidget
<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="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
<td>Constructor</td>
@@ -120,19 +117,20 @@
<td>Protected method handling focus in events.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
<h4>HelpIndexWidget (Constructor)</h4>
<b>HelpIndexWidget</b>(<i>engine, internal=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>engine</i> (QHelpEngine)</dt>
@@ -151,17 +149,17 @@
<a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
<h4>HelpIndexWidget.__disableSearchEdit</h4>
<b>__disableSearchEdit</b>(<i></i>)
-
<p>
Private slot to enable the search edit.
</p>
+
<a NAME="HelpIndexWidget.__documentActivated" ID="HelpIndexWidget.__documentActivated"></a>
<h4>HelpIndexWidget.__documentActivated</h4>
<b>__documentActivated</b>(<i>document, keyword, modifiers=None</i>)
-
<p>
Private slot to handle the activation of a keyword entry.
</p>
+
<dl>
<dt><i>document</i> (QHelpLink)</dt>
@@ -181,11 +179,11 @@
<a NAME="HelpIndexWidget.__documentsActivated" ID="HelpIndexWidget.__documentsActivated"></a>
<h4>HelpIndexWidget.__documentsActivated</h4>
<b>__documentsActivated</b>(<i>documents, helpKeyword</i>)
-
<p>
Private slot to handle the activation of an entry with multiple help
documents.
</p>
+
<dl>
<dt><i>documents</i> (list of QHelpLink)</dt>
@@ -200,17 +198,17 @@
<a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
<h4>HelpIndexWidget.__enableSearchEdit</h4>
<b>__enableSearchEdit</b>(<i></i>)
-
<p>
Private slot to enable the search edit.
</p>
+
<a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
<h4>HelpIndexWidget.__filterIndices</h4>
<b>__filterIndices</b>(<i>indexFilter</i>)
-
<p>
Private slot to filter the indexes according to the given filter.
</p>
+
<dl>
<dt><i>indexFilter</i> (str)</dt>
@@ -221,11 +219,11 @@
<a NAME="HelpIndexWidget.__selectDocument" ID="HelpIndexWidget.__selectDocument"></a>
<h4>HelpIndexWidget.__selectDocument</h4>
<b>__selectDocument</b>(<i>documents, helpKeyword</i>)
-
<p>
Private method to give the user a chance to select among the
given documents.
</p>
+
<dl>
<dt><i>documents</i> (list of QHelpLink)</dt>
@@ -252,10 +250,10 @@
<a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
<h4>HelpIndexWidget.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>pos</i>)
-
<p>
Private slot showing the context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -266,10 +264,10 @@
<a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
<h4>HelpIndexWidget.eventFilter</h4>
<b>eventFilter</b>(<i>watched, event</i>)
-
<p>
Public method called to filter the event queue.
</p>
+
<dl>
<dt><i>watched</i> (QObject)</dt>
@@ -296,10 +294,10 @@
<a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
<h4>HelpIndexWidget.focusInEvent</h4>
<b>focusInEvent</b>(<i>evt</i>)
-
<p>
Protected method handling focus in events.
</p>
+
<dl>
<dt><i>evt</i> (QFocusEvent)</dt>
@@ -309,4 +307,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
