--- a/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</h1>
-
<p>
Module implementing a dialog to enter the parameters for eric7_api.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricapiConfigDialog">EricapiConfigDialog</a></td>
<td>Class implementing a dialog to enter the parameters for eric7_api.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricapiConfigDialog" ID="EricapiConfigDialog"></a>
<h2>EricapiConfigDialog</h2>
-
<p>
Class implementing a dialog to enter the parameters for eric7_api.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_EricapiConfigDialog
<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="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td>
<td>Constructor</td>
@@ -99,19 +96,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="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a>
<h4>EricapiConfigDialog (Constructor)</h4>
<b>EricapiConfigDialog</b>(<i>project, parms=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -130,7 +128,6 @@
<a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a>
<h4>EricapiConfigDialog.__initializeDefaults</h4>
<b>__initializeDefaults</b>(<i></i>)
-
<p>
Private method to set the default values.
</p>
@@ -138,20 +135,20 @@
These are needed later on to generate the commandline
parameters.
</p>
+
<a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a>
<h4>EricapiConfigDialog.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="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a>
<h4>EricapiConfigDialog.generateParameters</h4>
<b>generateParameters</b>(<i></i>)
-
<p>
Public method that generates the command line parameters.
</p>
@@ -162,6 +159,7 @@
dictionary can be passed back upon object generation to overwrite
the default settings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -178,7 +176,6 @@
<a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a>
<h4>EricapiConfigDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
-
<p>
Private slot to add the directory displayed to the listview.
</p>
@@ -186,20 +183,21 @@
The directory in the ignore directories
line edit is moved to the listbox above and the edit is cleared.
</p>
+
<a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a>
<h4>EricapiConfigDialog.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="EricapiConfigDialog.on_ignoreDirPicker_pathSelected" ID="EricapiConfigDialog.on_ignoreDirPicker_pathSelected"></a>
<h4>EricapiConfigDialog.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>
@@ -210,17 +208,17 @@
<a NAME="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog" ID="EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog"></a>
<h4>EricapiConfigDialog.on_outputFilePicker_aboutToShowPathPickerDialog</h4>
<b>on_outputFilePicker_aboutToShowPathPickerDialog</b>(<i></i>)
-
<p>
Private slot called before the file selection dialog is shown.
</p>
+
<a NAME="EricapiConfigDialog.on_outputFilePicker_pathSelected" ID="EricapiConfigDialog.on_outputFilePicker_pathSelected"></a>
<h4>EricapiConfigDialog.on_outputFilePicker_pathSelected</h4>
<b>on_outputFilePicker_pathSelected</b>(<i>path</i>)
-
<p>
Private slot handling the selection of an output file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -231,10 +229,10 @@
<a NAME="EricapiConfigDialog.on_outputFilePicker_textChanged" ID="EricapiConfigDialog.on_outputFilePicker_textChanged"></a>
<h4>EricapiConfigDialog.on_outputFilePicker_textChanged</h4>
<b>on_outputFilePicker_textChanged</b>(<i>filename</i>)
-
<p>
Private slot to enable/disable the "OK" button.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -245,10 +243,10 @@
<a NAME="EricapiConfigDialog.on_startDirPicker_pathSelected" ID="EricapiConfigDialog.on_startDirPicker_pathSelected"></a>
<h4>EricapiConfigDialog.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>
@@ -258,4 +256,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
