--- a/src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget</h1>
-
<p>
Module implementing a widget to manage the QtHelp documentation settings.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget">QtHelpDocumentationSettingsWidget</a></td>
<td>Class implementing a widget to manage the QtHelp documentation settings.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="QtHelpDocumentationSettingsWidget" ID="QtHelpDocumentationSettingsWidget"></a>
<h2>QtHelpDocumentationSettingsWidget</h2>
-
<p>
Class implementing a widget to manage the QtHelp documentation settings.
</p>
+
<h3>Signals</h3>
<dl>
@@ -50,19 +49,17 @@
<h3>Derived from</h3>
QWidget, Ui_QtHelpDocumentationSettingsWidget
<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="#QtHelpDocumentationSettingsWidget.__init__">QtHelpDocumentationSettingsWidget</a></td>
<td>Constructor</td>
@@ -108,19 +105,20 @@
<td>Public method to set the reference to the QtHelp documentation configuration object.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="QtHelpDocumentationSettingsWidget.__init__" ID="QtHelpDocumentationSettingsWidget.__init__"></a>
<h4>QtHelpDocumentationSettingsWidget (Constructor)</h4>
<b>QtHelpDocumentationSettingsWidget</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget (optional))</dt>
@@ -131,17 +129,17 @@
<a NAME="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter" ID="QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter"></a>
<h4>QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter</h4>
<b>__applyDocumentsListFilter</b>(<i></i>)
-
<p>
Private slot to apply the current documents filter.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.__registerDocumentation" ID="QtHelpDocumentationSettingsWidget.__registerDocumentation"></a>
<h4>QtHelpDocumentationSettingsWidget.__registerDocumentation</h4>
<b>__registerDocumentation</b>(<i>filenames</i>)
-
<p>
Private method to register a given list of documentations.
</p>
+
<dl>
<dt><i>filenames</i> (list of str)</dt>
@@ -152,11 +150,11 @@
<a NAME="QtHelpDocumentationSettingsWidget.documentationSettings" ID="QtHelpDocumentationSettingsWidget.documentationSettings"></a>
<h4>QtHelpDocumentationSettingsWidget.documentationSettings</h4>
<b>documentationSettings</b>(<i></i>)
-
<p>
Public method to get the reference to the QtHelp documentation
configuration object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -172,32 +170,32 @@
<a NAME="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked"></a>
<h4>QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked</h4>
<b>on_addDocumentsButton_clicked</b>(<i></i>)
-
<p>
Private slot to add QtHelp documents to the help database.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked"></a>
<h4>QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked</h4>
<b>on_addPluginButton_clicked</b>(<i></i>)
-
<p>
Private slot to add QtHelp documents provided by plug-ins to
the help database.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged"></a>
<h4>QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged</h4>
<b>on_documentsList_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot handling a change of the documents selection.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged" ID="QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged"></a>
<h4>QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged</h4>
<b>on_filterEdit_textChanged</b>(<i>txt</i>)
-
<p>
Private slot to react on changes of the document filter text.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -208,25 +206,25 @@
<a NAME="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked"></a>
<h4>QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked</h4>
<b>on_managePluginButton_clicked</b>(<i></i>)
-
<p>
Private slot to manage the QtHelp documents provided by plug-ins.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked" ID="QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked"></a>
<h4>QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked</h4>
<b>on_removeDocumentsButton_clicked</b>(<i></i>)
-
<p>
Private slot to remove a document from the help database.
</p>
+
<a NAME="QtHelpDocumentationSettingsWidget.setDocumentationSettings" ID="QtHelpDocumentationSettingsWidget.setDocumentationSettings"></a>
<h4>QtHelpDocumentationSettingsWidget.setDocumentationSettings</h4>
<b>setDocumentationSettings</b>(<i>settings</i>)
-
<p>
Public method to set the reference to the QtHelp documentation
configuration object.
</p>
+
<dl>
<dt><i>settings</i> (QtHelpDocumentationSettings)</dt>
@@ -237,4 +235,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
