--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.IsortConfigurationDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.IsortConfigurationDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CodeFormatting.IsortConfigurationDialog</h1>
-
<p>
Module implementing a dialog to enter the parameters for an isort formatting run.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#IsortConfigurationDialog">IsortConfigurationDialog</a></td>
<td>Class implementing a dialog to enter the parameters for an isort formatting run.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="IsortConfigurationDialog" ID="IsortConfigurationDialog"></a>
<h2>IsortConfigurationDialog</h2>
-
<p>
Class implementing a dialog to enter the parameters for an isort formatting run.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_IsortConfigurationDialog
<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="#IsortConfigurationDialog.__init__">IsortConfigurationDialog</a></td>
<td>Constructor</td>
@@ -87,19 +84,20 @@
<td>Private slot to handle the selection of a configuration source.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="IsortConfigurationDialog.__init__" ID="IsortConfigurationDialog.__init__"></a>
<h4>IsortConfigurationDialog (Constructor)</h4>
<b>IsortConfigurationDialog</b>(<i>withProject=True, onlyProject=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>withProject</i> (bool (optional))</dt>
@@ -120,7 +118,6 @@
<a NAME="IsortConfigurationDialog.__createTomlSnippet" ID="IsortConfigurationDialog.__createTomlSnippet"></a>
<h4>IsortConfigurationDialog.__createTomlSnippet</h4>
<b>__createTomlSnippet</b>(<i></i>)
-
<p>
Private slot to generate a TOML snippet of the current configuration.
</p>
@@ -131,14 +128,15 @@
The code snippet is copied to the clipboard and may be placed inside the
'pyproject.toml' file.
</p>
+
<a NAME="IsortConfigurationDialog.__getConfigurationDict" ID="IsortConfigurationDialog.__getConfigurationDict"></a>
<h4>IsortConfigurationDialog.__getConfigurationDict</h4>
<b>__getConfigurationDict</b>(<i></i>)
-
<p>
Private method to assemble and return a dictionary containing the entered
non-default configuration parameters.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -154,7 +152,6 @@
<a NAME="IsortConfigurationDialog.__loadConfiguration" ID="IsortConfigurationDialog.__loadConfiguration"></a>
<h4>IsortConfigurationDialog.__loadConfiguration</h4>
<b>__loadConfiguration</b>(<i>confDict</i>)
-
<p>
Private method to load the configuration section with data of the given
dictionary.
@@ -162,6 +159,7 @@
<p>
Note: Default values will be loaded for missing parameters.
</p>
+
<dl>
<dt><i>confDict</i> (dict)</dt>
@@ -172,17 +170,17 @@
<a NAME="IsortConfigurationDialog.__populateMultiLineComboBox" ID="IsortConfigurationDialog.__populateMultiLineComboBox"></a>
<h4>IsortConfigurationDialog.__populateMultiLineComboBox</h4>
<b>__populateMultiLineComboBox</b>(<i></i>)
-
<p>
Private method to populate the multi line output selector.
</p>
+
<a NAME="IsortConfigurationDialog.getConfiguration" ID="IsortConfigurationDialog.getConfiguration"></a>
<h4>IsortConfigurationDialog.getConfiguration</h4>
<b>getConfiguration</b>(<i>saveToProject=False</i>)
-
<p>
Public method to get the current configuration parameters.
</p>
+
<dl>
<dt><i>saveToProject</i> (bool (optional))</dt>
@@ -206,10 +204,10 @@
<a NAME="IsortConfigurationDialog.on_profileComboBox_editTextChanged" ID="IsortConfigurationDialog.on_profileComboBox_editTextChanged"></a>
<h4>IsortConfigurationDialog.on_profileComboBox_editTextChanged</h4>
<b>on_profileComboBox_editTextChanged</b>(<i>profileName</i>)
-
<p>
Private slot to react upon changes of the selected/entered profile.
</p>
+
<dl>
<dt><i>profileName</i> (str)</dt>
@@ -220,10 +218,10 @@
<a NAME="IsortConfigurationDialog.on_sourceComboBox_currentTextChanged" ID="IsortConfigurationDialog.on_sourceComboBox_currentTextChanged"></a>
<h4>IsortConfigurationDialog.on_sourceComboBox_currentTextChanged</h4>
<b>on_sourceComboBox_currentTextChanged</b>(<i>selection</i>)
-
<p>
Private slot to handle the selection of a configuration source.
</p>
+
<dl>
<dt><i>selection</i> (str)</dt>
@@ -233,4 +231,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
