src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget.html

<!DOCTYPE html>
<html><head>
<title>eric7.QtHelpInterface.QtHelpDocumentationSettingsWidget</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<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>

<dt>documentationSettingsChanged(settings)</dt>
<dd>
emitted to signal a change
        of the documentation configuration
</dd>
</dl>
<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>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.__applyDocumentsListFilter">__applyDocumentsListFilter</a></td>
<td>Private slot to apply the current documents filter.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.__registerDocumentation">__registerDocumentation</a></td>
<td>Private method to register a given list of documentations.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.documentationSettings">documentationSettings</a></td>
<td>Public method to get the reference to the QtHelp documentation configuration object.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_addDocumentsButton_clicked">on_addDocumentsButton_clicked</a></td>
<td>Private slot to add QtHelp documents to the help database.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_addPluginButton_clicked">on_addPluginButton_clicked</a></td>
<td>Private slot to add QtHelp documents provided by plug-ins to the help database.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td>
<td>Private slot handling a change of the documents selection.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_filterEdit_textChanged">on_filterEdit_textChanged</a></td>
<td>Private slot to react on changes of the document filter text.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_managePluginButton_clicked">on_managePluginButton_clicked</a></td>
<td>Private slot to manage the QtHelp documents provided by plug-ins.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.on_removeDocumentsButton_clicked">on_removeDocumentsButton_clicked</a></td>
<td>Private slot to remove a document from the help database.</td>
</tr>
<tr>
<td><a href="#QtHelpDocumentationSettingsWidget.setDocumentationSettings">setDocumentationSettings</a></td>
<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>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<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>
<dd>
list of documentation files to be registered
</dd>
</dl>
<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>
reference to the created QtHelpDocumentationSettings object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QtHelpDocumentationSettings
</dd>
</dl>
<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>
<dd>
current entry of the filter (unused)
</dd>
</dl>
<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>
<dd>
reference to the created QtHelpDocumentationSettings
            object
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>