--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog</h1>
-
<p>
Module implementing a dialog to enter the parameters for eric7_doc.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricdocConfigDialog">EricdocConfigDialog</a></td>
<td>Class implementing a dialog to enter the parameters for eric7_doc.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricdocConfigDialog" ID="EricdocConfigDialog"></a>
<h2>EricdocConfigDialog</h2>
-
<p>
Class implementing a dialog to enter the parameters for eric7_doc.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_EricdocConfigDialog
<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="#EricdocConfigDialog.__init__">EricdocConfigDialog</a></td>
<td>Constructor</td>
@@ -159,19 +156,20 @@
<td>Private slot handling the selection of a start directory.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a>
<h4>EricdocConfigDialog (Constructor)</h4>
<b>EricdocConfigDialog</b>(<i>project, parms=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -190,15 +188,14 @@
<a NAME="EricdocConfigDialog.__checkQtHelpOptions" ID="EricdocConfigDialog.__checkQtHelpOptions"></a>
<h4>EricdocConfigDialog.__checkQtHelpOptions</h4>
<b>__checkQtHelpOptions</b>(<i></i>)
-
<p>
Private slot to check the QtHelp options and set the ok button
accordingly.
</p>
+
<a NAME="EricdocConfigDialog.__initializeDefaults" ID="EricdocConfigDialog.__initializeDefaults"></a>
<h4>EricdocConfigDialog.__initializeDefaults</h4>
<b>__initializeDefaults</b>(<i></i>)
-
<p>
Private method to set the default values.
</p>
@@ -206,13 +203,14 @@
These are needed later on to generate the commandline
parameters.
</p>
+
<a NAME="EricdocConfigDialog.__selectColor" ID="EricdocConfigDialog.__selectColor"></a>
<h4>EricdocConfigDialog.__selectColor</h4>
<b>__selectColor</b>(<i>colorKey</i>)
-
<p>
Private method to select a color.
</p>
+
<dl>
<dt><i>colorKey</i> (str)</dt>
@@ -223,17 +221,16 @@
<a NAME="EricdocConfigDialog.accept" ID="EricdocConfigDialog.accept"></a>
<h4>EricdocConfigDialog.accept</h4>
<b>accept</b>(<i></i>)
-
<p>
Public slot called by the Ok button.
</p>
<p>
It saves the values in the parameters dictionary.
</p>
+
<a NAME="EricdocConfigDialog.generateParameters" ID="EricdocConfigDialog.generateParameters"></a>
<h4>EricdocConfigDialog.generateParameters</h4>
<b>generateParameters</b>(<i></i>)
-
<p>
Public method that generates the commandline parameters.
</p>
@@ -244,6 +241,7 @@
dictionary can be passed back upon object generation to overwrite
the default settings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -260,7 +258,6 @@
<a NAME="EricdocConfigDialog.on_addButton_clicked" ID="EricdocConfigDialog.on_addButton_clicked"></a>
<h4>EricdocConfigDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
-
<p>
Private slot to add the directory displayed to the listview.
</p>
@@ -268,41 +265,42 @@
The directory in the ignore directories
line edit is moved to the listbox above and the edit is cleared.
</p>
+
<a NAME="EricdocConfigDialog.on_bodyBgButton_clicked" ID="EricdocConfigDialog.on_bodyBgButton_clicked"></a>
<h4>EricdocConfigDialog.on_bodyBgButton_clicked</h4>
<b>on_bodyBgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the body background color.
</p>
+
<a NAME="EricdocConfigDialog.on_bodyFgButton_clicked" ID="EricdocConfigDialog.on_bodyFgButton_clicked"></a>
<h4>EricdocConfigDialog.on_bodyFgButton_clicked</h4>
<b>on_bodyFgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the body foreground color.
</p>
+
<a NAME="EricdocConfigDialog.on_cfBgButton_clicked" ID="EricdocConfigDialog.on_cfBgButton_clicked"></a>
<h4>EricdocConfigDialog.on_cfBgButton_clicked</h4>
<b>on_cfBgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the class/function header background color.
</p>
+
<a NAME="EricdocConfigDialog.on_cfFgButton_clicked" ID="EricdocConfigDialog.on_cfFgButton_clicked"></a>
<h4>EricdocConfigDialog.on_cfFgButton_clicked</h4>
<b>on_cfFgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the class/function header foreground color.
</p>
+
<a NAME="EricdocConfigDialog.on_cssPicker_pathSelected" ID="EricdocConfigDialog.on_cssPicker_pathSelected"></a>
<h4>EricdocConfigDialog.on_cssPicker_pathSelected</h4>
<b>on_cssPicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of a css style sheet.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -313,17 +311,17 @@
<a NAME="EricdocConfigDialog.on_deleteButton_clicked" ID="EricdocConfigDialog.on_deleteButton_clicked"></a>
<h4>EricdocConfigDialog.on_deleteButton_clicked</h4>
<b>on_deleteButton_clicked</b>(<i></i>)
-
<p>
Private slot to delete the currently selected directory of the listbox.
</p>
+
<a NAME="EricdocConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricdocConfigDialog.on_ignoreDirPicker_pathSelected"></a>
<h4>EricdocConfigDialog.on_ignoreDirPicker_pathSelected</h4>
<b>on_ignoreDirPicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of a directory to be ignored.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -334,45 +332,45 @@
<a NAME="EricdocConfigDialog.on_l1BgButton_clicked" ID="EricdocConfigDialog.on_l1BgButton_clicked"></a>
<h4>EricdocConfigDialog.on_l1BgButton_clicked</h4>
<b>on_l1BgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the level 1 header background color.
</p>
+
<a NAME="EricdocConfigDialog.on_l1FgButton_clicked" ID="EricdocConfigDialog.on_l1FgButton_clicked"></a>
<h4>EricdocConfigDialog.on_l1FgButton_clicked</h4>
<b>on_l1FgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the level 1 header foreground color.
</p>
+
<a NAME="EricdocConfigDialog.on_l2BgButton_clicked" ID="EricdocConfigDialog.on_l2BgButton_clicked"></a>
<h4>EricdocConfigDialog.on_l2BgButton_clicked</h4>
<b>on_l2BgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the level 2 header background color.
</p>
+
<a NAME="EricdocConfigDialog.on_l2FgButton_clicked" ID="EricdocConfigDialog.on_l2FgButton_clicked"></a>
<h4>EricdocConfigDialog.on_l2FgButton_clicked</h4>
<b>on_l2FgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the level 2 header foreground color.
</p>
+
<a NAME="EricdocConfigDialog.on_linkFgButton_clicked" ID="EricdocConfigDialog.on_linkFgButton_clicked"></a>
<h4>EricdocConfigDialog.on_linkFgButton_clicked</h4>
<b>on_linkFgButton_clicked</b>(<i></i>)
-
<p>
Private slot to select the foreground color of links.
</p>
+
<a NAME="EricdocConfigDialog.on_outputDirPicker_pathSelected" ID="EricdocConfigDialog.on_outputDirPicker_pathSelected"></a>
<h4>EricdocConfigDialog.on_outputDirPicker_pathSelected</h4>
<b>on_outputDirPicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of an output directory.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -383,11 +381,11 @@
<a NAME="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected" ID="EricdocConfigDialog.on_qtHelpDirPicker_pathSelected"></a>
<h4>EricdocConfigDialog.on_qtHelpDirPicker_pathSelected</h4>
<b>on_qtHelpDirPicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of the output directory for the
QtHelp files.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -398,10 +396,10 @@
<a NAME="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpFolderEdit_textChanged"></a>
<h4>EricdocConfigDialog.on_qtHelpFolderEdit_textChanged</h4>
<b>on_qtHelpFolderEdit_textChanged</b>(<i>txt</i>)
-
<p>
Private slot to check the virtual folder.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -412,10 +410,10 @@
<a NAME="EricdocConfigDialog.on_qtHelpGroup_toggled" ID="EricdocConfigDialog.on_qtHelpGroup_toggled"></a>
<h4>EricdocConfigDialog.on_qtHelpGroup_toggled</h4>
<b>on_qtHelpGroup_toggled</b>(<i>enabled</i>)
-
<p>
Private slot to toggle the generation of QtHelp files.
</p>
+
<dl>
<dt><i>enabled</i> (bool)</dt>
@@ -426,10 +424,10 @@
<a NAME="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged"></a>
<h4>EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged</h4>
<b>on_qtHelpNamespaceEdit_textChanged</b>(<i>txt</i>)
-
<p>
Private slot to check the namespace.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -440,10 +438,10 @@
<a NAME="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged" ID="EricdocConfigDialog.on_qtHelpTitleEdit_textChanged"></a>
<h4>EricdocConfigDialog.on_qtHelpTitleEdit_textChanged</h4>
<b>on_qtHelpTitleEdit_textChanged</b>(<i>txt</i>)
-
<p>
Private slot to check the title.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -454,10 +452,10 @@
<a NAME="EricdocConfigDialog.on_startDirPicker_pathSelected" ID="EricdocConfigDialog.on_startDirPicker_pathSelected"></a>
<h4>EricdocConfigDialog.on_startDirPicker_pathSelected</h4>
<b>on_startDirPicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of a start directory.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -467,4 +465,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
