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

branch
eric7
changeset 9686
2eee7a645cba
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog.html	Mon Jan 09 11:22:56 2023 +0100
@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog</h1>
+
+<p>
+Module implementing a dialog to manage the QtHelp documentation database.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#QtHelpDocumentationConfigurationDialog">QtHelpDocumentationConfigurationDialog</a></td>
+<td>Class implementing a dialog to manage the QtHelp documentation database.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="QtHelpDocumentationConfigurationDialog" ID="QtHelpDocumentationConfigurationDialog"></a>
+<h2>QtHelpDocumentationConfigurationDialog</h2>
+
+<p>
+    Class implementing a dialog to manage the QtHelp documentation database.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_QtHelpDocumentationConfigurationDialog
+<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="#QtHelpDocumentationConfigurationDialog.__init__">QtHelpDocumentationConfigurationDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#QtHelpDocumentationConfigurationDialog.__applyConfiguration">__applyConfiguration</a></td>
+<td>Private method to apply the current QtHelp documentation configuration.</td>
+</tr>
+<tr>
+<td><a href="#QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged">__documentationSettingsChanged</a></td>
+<td>Private slot to handle a change of the QtHelp documentation configuration.</td>
+</tr>
+<tr>
+<td><a href="#QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="QtHelpDocumentationConfigurationDialog.__init__" ID="QtHelpDocumentationConfigurationDialog.__init__"></a>
+<h4>QtHelpDocumentationConfigurationDialog (Constructor)</h4>
+<b>QtHelpDocumentationConfigurationDialog</b>(<i>engine, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>engine</i> (QHelpEngineCore)</dt>
+<dd>
+reference to the Qt help engine
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="QtHelpDocumentationConfigurationDialog.__applyConfiguration" ID="QtHelpDocumentationConfigurationDialog.__applyConfiguration"></a>
+<h4>QtHelpDocumentationConfigurationDialog.__applyConfiguration</h4>
+<b>__applyConfiguration</b>(<i></i>)
+
+<p>
+        Private method to apply the current QtHelp documentation configuration.
+</p>
+<a NAME="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged" ID="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged"></a>
+<h4>QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged</h4>
+<b>__documentationSettingsChanged</b>(<i>settings</i>)
+
+<p>
+        Private slot to handle a change of the QtHelp documentation
+        configuration.
+</p>
+<dl>
+
+<dt><i>settings</i> (QtHelpDocumentationSettings)</dt>
+<dd>
+reference to the documentation settings object
+</dd>
+</dl>
+<a NAME="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked" ID="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked"></a>
+<h4>QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+
+<p>
+        Private slot called by a button of the button box clicked.
+</p>
+<dl>
+
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+button that was clicked
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial