Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.CodeFormatting.IsortConfigurationDialog.html
src/eric7/Documentation/Source/eric7.CodeFormatting.IsortConfigurationDialog.html
- branch
- eric7
- changeset 9454
- f3cf935c0c66
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9453:e5065dde905d | 9454:f3cf935c0c66 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.CodeFormatting.IsortConfigurationDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.CodeFormatting.IsortConfigurationDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the parameters for an isort formatting run. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#IsortConfigurationDialog">IsortConfigurationDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the parameters for an isort formatting run.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="IsortConfigurationDialog" ID="IsortConfigurationDialog"></a> | |
| 36 <h2>IsortConfigurationDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the parameters for an isort formatting run. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_IsortConfigurationDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#IsortConfigurationDialog.__init__">IsortConfigurationDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#IsortConfigurationDialog.__createTomlSnippet">__createTomlSnippet</a></td> | |
| 63 <td>Private slot to generate a TOML snippet of the current configuration.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#IsortConfigurationDialog.__getConfigurationDict">__getConfigurationDict</a></td> | |
| 67 <td>Private method to assemble and return a dictionary containing the entered non-default configuration parameters.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#IsortConfigurationDialog.__loadConfiguration">__loadConfiguration</a></td> | |
| 71 <td>Private method to load the configuration section with data of the given dictionary.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#IsortConfigurationDialog.__populateMultiLineComboBox">__populateMultiLineComboBox</a></td> | |
| 75 <td>Private method to populate the multi line output selector.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#IsortConfigurationDialog.getConfiguration">getConfiguration</a></td> | |
| 79 <td>Public method to get the current configuration parameters.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#IsortConfigurationDialog.on_profileComboBox_editTextChanged">on_profileComboBox_editTextChanged</a></td> | |
| 83 <td>Private slot to react upon changes of the selected/entered profile.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#IsortConfigurationDialog.on_sourceComboBox_currentTextChanged">on_sourceComboBox_currentTextChanged</a></td> | |
| 87 <td>Private slot to handle the selection of a configuration source.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="IsortConfigurationDialog.__init__" ID="IsortConfigurationDialog.__init__"></a> | |
| 97 <h4>IsortConfigurationDialog (Constructor)</h4> | |
| 98 <b>IsortConfigurationDialog</b>(<i>withProject=True, onlyProject=False, parent=None</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>withProject</i> (bool (optional))</dt> | |
| 106 <dd> | |
| 107 flag indicating to look for project configurations | |
| 108 (defaults to True) | |
| 109 </dd> | |
| 110 <dt><i>onlyProject</i> (bool (optional))</dt> | |
| 111 <dd> | |
| 112 flag indicating to only look for project configurations | |
| 113 (defaults to False) | |
| 114 </dd> | |
| 115 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 116 <dd> | |
| 117 reference to the parent widget (defaults to None) | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="IsortConfigurationDialog.__createTomlSnippet" ID="IsortConfigurationDialog.__createTomlSnippet"></a> | |
| 121 <h4>IsortConfigurationDialog.__createTomlSnippet</h4> | |
| 122 <b>__createTomlSnippet</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Private slot to generate a TOML snippet of the current configuration. | |
| 126 </p> | |
| 127 <p> | |
| 128 Note: Only non-default values are included in this snippet. | |
| 129 </p> | |
| 130 <p> | |
| 131 The code snippet is copied to the clipboard and may be placed inside the | |
| 132 'pyproject.toml' file. | |
| 133 </p> | |
| 134 <a NAME="IsortConfigurationDialog.__getConfigurationDict" ID="IsortConfigurationDialog.__getConfigurationDict"></a> | |
| 135 <h4>IsortConfigurationDialog.__getConfigurationDict</h4> | |
| 136 <b>__getConfigurationDict</b>(<i></i>) | |
| 137 | |
| 138 <p> | |
| 139 Private method to assemble and return a dictionary containing the entered | |
| 140 non-default configuration parameters. | |
| 141 </p> | |
| 142 <dl> | |
| 143 <dt>Return:</dt> | |
| 144 <dd> | |
| 145 dictionary containing the non-default configuration parameters | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <dl> | |
| 149 <dt>Return Type:</dt> | |
| 150 <dd> | |
| 151 dict | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <a NAME="IsortConfigurationDialog.__loadConfiguration" ID="IsortConfigurationDialog.__loadConfiguration"></a> | |
| 155 <h4>IsortConfigurationDialog.__loadConfiguration</h4> | |
| 156 <b>__loadConfiguration</b>(<i>confDict</i>) | |
| 157 | |
| 158 <p> | |
| 159 Private method to load the configuration section with data of the given | |
| 160 dictionary. | |
| 161 </p> | |
| 162 <p> | |
| 163 Note: Default values will be loaded for missing parameters. | |
| 164 </p> | |
| 165 <dl> | |
| 166 | |
| 167 <dt><i>confDict</i> (dict)</dt> | |
| 168 <dd> | |
| 169 reference to the data to be loaded | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="IsortConfigurationDialog.__populateMultiLineComboBox" ID="IsortConfigurationDialog.__populateMultiLineComboBox"></a> | |
| 173 <h4>IsortConfigurationDialog.__populateMultiLineComboBox</h4> | |
| 174 <b>__populateMultiLineComboBox</b>(<i></i>) | |
| 175 | |
| 176 <p> | |
| 177 Private method to populate the multi line output selector. | |
| 178 </p> | |
| 179 <a NAME="IsortConfigurationDialog.getConfiguration" ID="IsortConfigurationDialog.getConfiguration"></a> | |
| 180 <h4>IsortConfigurationDialog.getConfiguration</h4> | |
| 181 <b>getConfiguration</b>(<i>saveToProject=False</i>) | |
| 182 | |
| 183 <p> | |
| 184 Public method to get the current configuration parameters. | |
| 185 </p> | |
| 186 <dl> | |
| 187 | |
| 188 <dt><i>saveToProject</i> (bool (optional))</dt> | |
| 189 <dd> | |
| 190 flag indicating to save the configuration data in the | |
| 191 project file (defaults to False) | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <dl> | |
| 195 <dt>Return:</dt> | |
| 196 <dd> | |
| 197 dictionary containing the configuration parameters | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <dl> | |
| 201 <dt>Return Type:</dt> | |
| 202 <dd> | |
| 203 dict | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <a NAME="IsortConfigurationDialog.on_profileComboBox_editTextChanged" ID="IsortConfigurationDialog.on_profileComboBox_editTextChanged"></a> | |
| 207 <h4>IsortConfigurationDialog.on_profileComboBox_editTextChanged</h4> | |
| 208 <b>on_profileComboBox_editTextChanged</b>(<i>profileName</i>) | |
| 209 | |
| 210 <p> | |
| 211 Private slot to react upon changes of the selected/entered profile. | |
| 212 </p> | |
| 213 <dl> | |
| 214 | |
| 215 <dt><i>profileName</i> (str)</dt> | |
| 216 <dd> | |
| 217 name of the current profile | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <a NAME="IsortConfigurationDialog.on_sourceComboBox_currentTextChanged" ID="IsortConfigurationDialog.on_sourceComboBox_currentTextChanged"></a> | |
| 221 <h4>IsortConfigurationDialog.on_sourceComboBox_currentTextChanged</h4> | |
| 222 <b>on_sourceComboBox_currentTextChanged</b>(<i>selection</i>) | |
| 223 | |
| 224 <p> | |
| 225 Private slot to handle the selection of a configuration source. | |
| 226 </p> | |
| 227 <dl> | |
| 228 | |
| 229 <dt><i>selection</i> (str)</dt> | |
| 230 <dd> | |
| 231 text of the currently selected item | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <div align="right"><a href="#top">Up</a></div> | |
| 235 <hr /> | |
| 236 </body></html> |
