Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html
eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html
- changeset 7610
- df7025fe26a3
- parent 7609
- d5aff4fd0ef8
- child 7624
- 6eabbcf3bdf8
equal
deleted
inserted
replaced
| 7609:d5aff4fd0ef8 | 7610:df7025fe26a3 |
|---|---|
| 55 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 56 QDialog, Ui_CodeStyleCheckerDialog | 56 QDialog, Ui_CodeStyleCheckerDialog |
| 57 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | 58 |
| 59 <table> | 59 <table> |
| 60 <tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr> | 60 <tr><td>argsRole</td></tr><tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr> |
| 61 </table> | 61 </table> |
| 62 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | 63 |
| 64 <table> | 64 <table> |
| 65 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 91 <tr> | 91 <tr> |
| 92 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td> | 92 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td> |
| 93 <td>Private slot to create a new error item in the result list.</td> | 93 <td>Private slot to create a new error item in the result list.</td> |
| 94 </tr> | 94 </tr> |
| 95 <tr> | 95 <tr> |
| 96 <td><a href="#CodeStyleCheckerDialog.__createFileErrorItem">__createFileErrorItem</a></td> | |
| 97 <td>Private method to create an error entry for a given file.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 96 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td> | 100 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td> |
| 97 <td>Private method to create an entry in the result list.</td> | 101 <td>Private method to create an entry in the result list.</td> |
| 98 </tr> | 102 </tr> |
| 99 <tr> | 103 <tr> |
| 100 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td> | 104 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td> |
| 349 <dt><i>message</i> (str)</dt> | 353 <dt><i>message</i> (str)</dt> |
| 350 <dd> | 354 <dd> |
| 351 error message | 355 error message |
| 352 </dd> | 356 </dd> |
| 353 </dl> | 357 </dl> |
| 358 <a NAME="CodeStyleCheckerDialog.__createFileErrorItem" ID="CodeStyleCheckerDialog.__createFileErrorItem"></a> | |
| 359 <h4>CodeStyleCheckerDialog.__createFileErrorItem</h4> | |
| 360 <b>__createFileErrorItem</b>(<i>filename, message</i>) | |
| 361 | |
| 362 <p> | |
| 363 Private method to create an error entry for a given file. | |
| 364 </p> | |
| 365 <dl> | |
| 366 | |
| 367 <dt><i>filename</i> (str)</dt> | |
| 368 <dd> | |
| 369 file name of the file | |
| 370 </dd> | |
| 371 <dt><i>message</i> (str)</dt> | |
| 372 <dd> | |
| 373 error message text | |
| 374 </dd> | |
| 375 </dl> | |
| 354 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> | 376 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> |
| 355 <h4>CodeStyleCheckerDialog.__createResultItem</h4> | 377 <h4>CodeStyleCheckerDialog.__createResultItem</h4> |
| 356 <b>__createResultItem</b>(<i>filename, line, pos, message, fixed, autofixing, ignored</i>) | 378 <b>__createResultItem</b>(<i>filename, result</i>) |
| 357 | 379 |
| 358 <p> | 380 <p> |
| 359 Private method to create an entry in the result list. | 381 Private method to create an entry in the result list. |
| 360 </p> | 382 </p> |
| 361 <dl> | 383 <dl> |
| 362 | 384 |
| 363 <dt><i>filename</i> (str)</dt> | 385 <dt><i>filename</i> (str)</dt> |
| 364 <dd> | 386 <dd> |
| 365 file name of the file | 387 file name of the file |
| 366 </dd> | 388 </dd> |
| 367 <dt><i>line</i> (int or str)</dt> | 389 <dt><i>result</i> (dict)</dt> |
| 368 <dd> | 390 <dd> |
| 369 line number of issue | 391 dictionary containing check result data |
| 370 </dd> | |
| 371 <dt><i>pos</i> (int or str)</dt> | |
| 372 <dd> | |
| 373 character position of issue | |
| 374 </dd> | |
| 375 <dt><i>message</i> (str)</dt> | |
| 376 <dd> | |
| 377 message text | |
| 378 </dd> | |
| 379 <dt><i>fixed</i> (bool)</dt> | |
| 380 <dd> | |
| 381 flag indicating a fixed issue | |
| 382 </dd> | |
| 383 <dt><i>autofixing</i> (bool)</dt> | |
| 384 <dd> | |
| 385 flag indicating, that we are fixing issues | |
| 386 automatically | |
| 387 </dd> | |
| 388 <dt><i>ignored</i> (bool)</dt> | |
| 389 <dd> | |
| 390 flag indicating an ignored issue | |
| 391 </dd> | 392 </dd> |
| 392 </dl> | 393 </dl> |
| 393 <dl> | 394 <dl> |
| 394 <dt>Returns:</dt> | 395 <dt>Returns:</dt> |
| 395 <dd> | 396 <dd> |
| 595 bool | 596 bool |
| 596 </dd> | 597 </dd> |
| 597 </dl> | 598 </dl> |
| 598 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a> | 599 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a> |
| 599 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4> | 600 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4> |
| 600 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>) | 601 <b>__modifyFixedResultItem</b>(<i>itm, result</i>) |
| 601 | 602 |
| 602 <p> | 603 <p> |
| 603 Private method to modify a result list entry to show its | 604 Private method to modify a result list entry to show its |
| 604 positive fixed state. | 605 positive fixed state. |
| 605 </p> | 606 </p> |
| 607 | 608 |
| 608 <dt><i>itm</i> (QTreeWidgetItem)</dt> | 609 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
| 609 <dd> | 610 <dd> |
| 610 reference to the item to modify | 611 reference to the item to modify |
| 611 </dd> | 612 </dd> |
| 612 <dt><i>text</i> (str)</dt> | 613 <dt><i>result</i> (dict)</dt> |
| 613 <dd> | 614 <dd> |
| 614 text to be appended | 615 dictionary containing check result data |
| 615 </dd> | |
| 616 <dt><i>fixed</i> (bool)</dt> | |
| 617 <dd> | |
| 618 flag indicating a fixed issue | |
| 619 </dd> | 616 </dd> |
| 620 </dl> | 617 </dl> |
| 621 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a> | 618 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a> |
| 622 <h4>CodeStyleCheckerDialog.__modifyOptions</h4> | 619 <h4>CodeStyleCheckerDialog.__modifyOptions</h4> |
| 623 <b>__modifyOptions</b>(<i>source</i>) | 620 <b>__modifyOptions</b>(<i>source</i>) |
| 686 </dd> | 683 </dd> |
| 687 <dt><i>fixes</i> (int)</dt> | 684 <dt><i>fixes</i> (int)</dt> |
| 688 <dd> | 685 <dd> |
| 689 number of applied fixes | 686 number of applied fixes |
| 690 </dd> | 687 </dd> |
| 691 <dt><i>results</i> (tuplt of tuple of (int, int, str, bool, bool, bool))</dt> | 688 <dt><i>results</i> (dict)</dt> |
| 692 <dd> | 689 <dd> |
| 693 tuple for each found violation of style (tuple of | 690 dictionary containing check result data |
| 694 lineno, position, text, ignored, fixed, autofixing) | |
| 695 </dd> | 691 </dd> |
| 696 </dl> | 692 </dl> |
| 697 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> | 693 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> |
| 698 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> | 694 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> |
| 699 <b>__resetStatistics</b>(<i></i>) | 695 <b>__resetStatistics</b>(<i></i>) |
