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 9454
- f3cf935c0c66
- parent 9344
- 52990830b13f
- child 9461
- 24c0c1066090
equal
deleted
inserted
replaced
| 9453:e5065dde905d | 9454:f3cf935c0c66 |
|---|---|
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.CodeFormatting.BlackFormattingDialog</h1> | 9 <h1>eric7.CodeFormatting.BlackFormattingDialog</h1> |
| 10 | 10 |
| 11 <p> | 11 <p> |
| 12 Module implementing a dialog showing the code formatting progress and the result. | 12 Module implementing a dialog showing the Black code formatting progress and the results. |
| 13 </p> | 13 </p> |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 |
| 16 <table> | 16 <table> |
| 17 <tr><td>None</td></tr> | 17 <tr><td>None</td></tr> |
| 20 | 20 |
| 21 <table> | 21 <table> |
| 22 | 22 |
| 23 <tr> | 23 <tr> |
| 24 <td><a href="#BlackFormattingDialog">BlackFormattingDialog</a></td> | 24 <td><a href="#BlackFormattingDialog">BlackFormattingDialog</a></td> |
| 25 <td>Class implementing a dialog showing the code formatting progress and the result.</td> | 25 <td>Class implementing a dialog showing the Black code formatting progress and the results.</td> |
| 26 </tr> | 26 </tr> |
| 27 <tr> | 27 <tr> |
| 28 <td><a href="#BlackMultiprocessingReport">BlackMultiprocessingReport</a></td> | 28 <td><a href="#BlackMultiprocessingReport">BlackMultiprocessingReport</a></td> |
| 29 <td>Class extending the black Report to work with multiprocessing.</td> | 29 <td>Class extending the black Report to work with multiprocessing.</td> |
| 30 </tr> | 30 </tr> |
| 50 <hr /> | 50 <hr /> |
| 51 <a NAME="BlackFormattingDialog" ID="BlackFormattingDialog"></a> | 51 <a NAME="BlackFormattingDialog" ID="BlackFormattingDialog"></a> |
| 52 <h2>BlackFormattingDialog</h2> | 52 <h2>BlackFormattingDialog</h2> |
| 53 | 53 |
| 54 <p> | 54 <p> |
| 55 Class implementing a dialog showing the code formatting progress and the result. | 55 Class implementing a dialog showing the Black code formatting progress and the |
| 56 results. | |
| 56 </p> | 57 </p> |
| 57 <h3>Derived from</h3> | 58 <h3>Derived from</h3> |
| 58 QDialog, Ui_BlackFormattingDialog | 59 QDialog, Ui_BlackFormattingDialog |
| 59 <h3>Class Attributes</h3> | 60 <h3>Class Attributes</h3> |
| 60 | 61 |
| 98 <td><a href="#BlackFormattingDialog.__handleBlackFormattingResult">__handleBlackFormattingResult</a></td> | 99 <td><a href="#BlackFormattingDialog.__handleBlackFormattingResult">__handleBlackFormattingResult</a></td> |
| 99 <td>Private slot to handle the result of a black reformatting action.</td> | 100 <td>Private slot to handle the result of a black reformatting action.</td> |
| 100 </tr> | 101 </tr> |
| 101 <tr> | 102 <tr> |
| 102 <td><a href="#BlackFormattingDialog.__performAction">__performAction</a></td> | 103 <td><a href="#BlackFormattingDialog.__performAction">__performAction</a></td> |
| 103 <td>Private method to exceute the requested formatting action.</td> | 104 <td>Private method to execute the requested formatting action.</td> |
| 104 </tr> | 105 </tr> |
| 105 <tr> | 106 <tr> |
| 106 <td><a href="#BlackFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td> | 107 <td><a href="#BlackFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td> |
| 107 <td>Private method to populate the status filter combo box with allowed selections.</td> | 108 <td>Private method to populate the status filter combo box with allowed selections.</td> |
| 108 </tr> | 109 </tr> |
| 258 </p> | 259 </p> |
| 259 <dl> | 260 <dl> |
| 260 | 261 |
| 261 <dt><i>status</i> (str)</dt> | 262 <dt><i>status</i> (str)</dt> |
| 262 <dd> | 263 <dd> |
| 263 status of the performed action (one of 'changed', 'unchanged', | 264 status of the performed action (one of 'changed', 'failed', |
| 264 'unmodified', 'failed' or 'ignored') | 265 'ignored', 'unchanged' or 'unmodified') |
| 265 </dd> | 266 </dd> |
| 266 <dt><i>filename</i> (str)</dt> | 267 <dt><i>filename</i> (str)</dt> |
| 267 <dd> | 268 <dd> |
| 268 name of the processed file | 269 name of the processed file |
| 269 </dd> | 270 </dd> |
| 275 <a NAME="BlackFormattingDialog.__performAction" ID="BlackFormattingDialog.__performAction"></a> | 276 <a NAME="BlackFormattingDialog.__performAction" ID="BlackFormattingDialog.__performAction"></a> |
| 276 <h4>BlackFormattingDialog.__performAction</h4> | 277 <h4>BlackFormattingDialog.__performAction</h4> |
| 277 <b>__performAction</b>(<i></i>) | 278 <b>__performAction</b>(<i></i>) |
| 278 | 279 |
| 279 <p> | 280 <p> |
| 280 Private method to exceute the requested formatting action. | 281 Private method to execute the requested formatting action. |
| 281 </p> | 282 </p> |
| 282 <a NAME="BlackFormattingDialog.__populateStatusFilterCombo" ID="BlackFormattingDialog.__populateStatusFilterCombo"></a> | 283 <a NAME="BlackFormattingDialog.__populateStatusFilterCombo" ID="BlackFormattingDialog.__populateStatusFilterCombo"></a> |
| 283 <h4>BlackFormattingDialog.__populateStatusFilterCombo</h4> | 284 <h4>BlackFormattingDialog.__populateStatusFilterCombo</h4> |
| 284 <b>__populateStatusFilterCombo</b>(<i></i>) | 285 <b>__populateStatusFilterCombo</b>(<i></i>) |
| 285 | 286 |
