Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html
src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html
- branch
- eric7
- changeset 9236
- db53a9efe7ef
- parent 9215
- 30d7f7fd2b4a
- child 9295
- d14096c04126
equal
deleted
inserted
replaced
| 9235:b5fe898e171f | 9236:db53a9efe7ef |
|---|---|
| 45 <h3>Derived from</h3> | 45 <h3>Derived from</h3> |
| 46 QDialog, Ui_BlackFormattingDialog | 46 QDialog, Ui_BlackFormattingDialog |
| 47 <h3>Class Attributes</h3> | 47 <h3>Class Attributes</h3> |
| 48 | 48 |
| 49 <table> | 49 <table> |
| 50 <tr><td>DataRole</td></tr><tr><td>DataTypeRole</td></tr> | 50 <tr><td>DataRole</td></tr><tr><td>DataTypeRole</td></tr><tr><td>FileNameColumn</td></tr><tr><td>StatusColumn</td></tr> |
| 51 </table> | 51 </table> |
| 52 <h3>Class Methods</h3> | 52 <h3>Class Methods</h3> |
| 53 | 53 |
| 54 <table> | 54 <table> |
| 55 <tr><td>None</td></tr> | 55 <tr><td>None</td></tr> |
| 77 <tr> | 77 <tr> |
| 78 <td><a href="#BlackFormattingDialog.__formatFiles">__formatFiles</a></td> | 78 <td><a href="#BlackFormattingDialog.__formatFiles">__formatFiles</a></td> |
| 79 <td>Private method to format the list of files according the configuration.</td> | 79 <td>Private method to format the list of files according the configuration.</td> |
| 80 </tr> | 80 </tr> |
| 81 <tr> | 81 <tr> |
| 82 <td><a href="#BlackFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td> | |
| 83 <td>Private method to populate the status filter combo box with allowed selections.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 82 <td><a href="#BlackFormattingDialog.__resizeColumns">__resizeColumns</a></td> | 86 <td><a href="#BlackFormattingDialog.__resizeColumns">__resizeColumns</a></td> |
| 83 <td>Private method to resize the columns of the result list.</td> | 87 <td>Private method to resize the columns of the result list.</td> |
| 84 </tr> | 88 </tr> |
| 85 <tr> | 89 <tr> |
| 86 <td><a href="#BlackFormattingDialog.__resort">__resort</a></td> | 90 <td><a href="#BlackFormattingDialog.__resort">__resort</a></td> |
| 87 <td>Private method to resort the result list.</td> | 91 <td>Private method to resort the result list.</td> |
| 88 </tr> | 92 </tr> |
| 89 <tr> | 93 <tr> |
| 90 <td><a href="#BlackFormattingDialog.__updateStatistics">__updateStatistics</a></td> | 94 <td><a href="#BlackFormattingDialog.__updateStatistics">__updateStatistics</a></td> |
| 91 <td>Private method to update the statistics about the recent formatting run.</td> | 95 <td>Private method to update the statistics about the recent formatting run and make them visible.</td> |
| 92 </tr> | 96 </tr> |
| 93 <tr> | 97 <tr> |
| 94 <td><a href="#BlackFormattingDialog.addResultEntry">addResultEntry</a></td> | 98 <td><a href="#BlackFormattingDialog.addResultEntry">addResultEntry</a></td> |
| 95 <td>Public method to add an entry to the result list.</td> | 99 <td>Public method to add an entry to the result list.</td> |
| 96 </tr> | 100 </tr> |
| 104 </tr> | 108 </tr> |
| 105 <tr> | 109 <tr> |
| 106 <td><a href="#BlackFormattingDialog.on_resultsList_itemDoubleClicked">on_resultsList_itemDoubleClicked</a></td> | 110 <td><a href="#BlackFormattingDialog.on_resultsList_itemDoubleClicked">on_resultsList_itemDoubleClicked</a></td> |
| 107 <td>Private slot handling a double click of a result item.</td> | 111 <td>Private slot handling a double click of a result item.</td> |
| 108 </tr> | 112 </tr> |
| 113 <tr> | |
| 114 <td><a href="#BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged">on_statusFilterComboBox_currentTextChanged</a></td> | |
| 115 <td>Private slot handling the selection of a status for items to be shown.</td> | |
| 116 </tr> | |
| 109 </table> | 117 </table> |
| 110 <h3>Static Methods</h3> | 118 <h3>Static Methods</h3> |
| 111 | 119 |
| 112 <table> | 120 <table> |
| 113 <tr><td>None</td></tr> | 121 <tr><td>None</td></tr> |
| 114 </table> | 122 </table> |
| 115 | 123 |
| 116 <a NAME="BlackFormattingDialog.__init__" ID="BlackFormattingDialog.__init__"></a> | 124 <a NAME="BlackFormattingDialog.__init__" ID="BlackFormattingDialog.__init__"></a> |
| 117 <h4>BlackFormattingDialog (Constructor)</h4> | 125 <h4>BlackFormattingDialog (Constructor)</h4> |
| 118 <b>BlackFormattingDialog</b>(<i>configuration, filesList, project=None, action=BlackFormattingAction.Format, parent=None</i>) | 126 <b>BlackFormattingDialog</b>(<i>configuration, filesList, project=None, action=BlackFormattingAction.Format, parent=None, </i>) |
| 119 | 127 |
| 120 <p> | 128 <p> |
| 121 Constructor | 129 Constructor |
| 122 </p> | 130 </p> |
| 123 <dl> | 131 <dl> |
| 209 <b>__formatFiles</b>(<i></i>) | 217 <b>__formatFiles</b>(<i></i>) |
| 210 | 218 |
| 211 <p> | 219 <p> |
| 212 Private method to format the list of files according the configuration. | 220 Private method to format the list of files according the configuration. |
| 213 </p> | 221 </p> |
| 222 <a NAME="BlackFormattingDialog.__populateStatusFilterCombo" ID="BlackFormattingDialog.__populateStatusFilterCombo"></a> | |
| 223 <h4>BlackFormattingDialog.__populateStatusFilterCombo</h4> | |
| 224 <b>__populateStatusFilterCombo</b>(<i></i>) | |
| 225 | |
| 226 <p> | |
| 227 Private method to populate the status filter combo box with allowed selections. | |
| 228 </p> | |
| 214 <a NAME="BlackFormattingDialog.__resizeColumns" ID="BlackFormattingDialog.__resizeColumns"></a> | 229 <a NAME="BlackFormattingDialog.__resizeColumns" ID="BlackFormattingDialog.__resizeColumns"></a> |
| 215 <h4>BlackFormattingDialog.__resizeColumns</h4> | 230 <h4>BlackFormattingDialog.__resizeColumns</h4> |
| 216 <b>__resizeColumns</b>(<i></i>) | 231 <b>__resizeColumns</b>(<i></i>) |
| 217 | 232 |
| 218 <p> | 233 <p> |
| 228 <a NAME="BlackFormattingDialog.__updateStatistics" ID="BlackFormattingDialog.__updateStatistics"></a> | 243 <a NAME="BlackFormattingDialog.__updateStatistics" ID="BlackFormattingDialog.__updateStatistics"></a> |
| 229 <h4>BlackFormattingDialog.__updateStatistics</h4> | 244 <h4>BlackFormattingDialog.__updateStatistics</h4> |
| 230 <b>__updateStatistics</b>(<i></i>) | 245 <b>__updateStatistics</b>(<i></i>) |
| 231 | 246 |
| 232 <p> | 247 <p> |
| 233 Private method to update the statistics about the recent formatting run. | 248 Private method to update the statistics about the recent formatting run and |
| 249 make them visible. | |
| 234 </p> | 250 </p> |
| 235 <a NAME="BlackFormattingDialog.addResultEntry" ID="BlackFormattingDialog.addResultEntry"></a> | 251 <a NAME="BlackFormattingDialog.addResultEntry" ID="BlackFormattingDialog.addResultEntry"></a> |
| 236 <h4>BlackFormattingDialog.addResultEntry</h4> | 252 <h4>BlackFormattingDialog.addResultEntry</h4> |
| 237 <b>addResultEntry</b>(<i>status, fileName, isError=False, data=None</i>) | 253 <b>addResultEntry</b>(<i>status, fileName, isError=False, data=None</i>) |
| 238 | 254 |
| 301 reference to the double clicked item | 317 reference to the double clicked item |
| 302 </dd> | 318 </dd> |
| 303 <dt><i>column</i> (int)</dt> | 319 <dt><i>column</i> (int)</dt> |
| 304 <dd> | 320 <dd> |
| 305 column number that was double clicked | 321 column number that was double clicked |
| 322 </dd> | |
| 323 </dl> | |
| 324 <a NAME="BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged" ID="BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged"></a> | |
| 325 <h4>BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged</h4> | |
| 326 <b>on_statusFilterComboBox_currentTextChanged</b>(<i>status</i>) | |
| 327 | |
| 328 <p> | |
| 329 Private slot handling the selection of a status for items to be shown. | |
| 330 </p> | |
| 331 <dl> | |
| 332 | |
| 333 <dt><i>status</i> (str)</dt> | |
| 334 <dd> | |
| 335 selected status | |
| 306 </dd> | 336 </dd> |
| 307 </dl> | 337 </dl> |
| 308 <div align="right"><a href="#top">Up</a></div> | 338 <div align="right"><a href="#top">Up</a></div> |
| 309 <hr /> | 339 <hr /> |
| 310 <hr /> | 340 <hr /> |
