Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html

branch
eric7
changeset 10479
856476537696
parent 10070
9f5758c0fec1
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1> 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the results of the code style check. 11 Module implementing a dialog to show the results of the code style check.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td> 22 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td>
25 <td>Class implementing a dialog to show the results of the code style check.</td> 23 <td>Class implementing a dialog to show the results of the code style check.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a> 34 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a>
36 <h2>CodeStyleCheckerDialog</h2> 35 <h2>CodeStyleCheckerDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the results of the code style check. 37 Class implementing a dialog to show the results of the code style check.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_CodeStyleCheckerDialog 41 QDialog, Ui_CodeStyleCheckerDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>argsRole</td></tr><tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>cryptoBitSelectionsDsaRsa</td></tr><tr><td>cryptoBitSelectionsEc</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> 44 <tr><td>argsRole</td></tr>
45 <tr><td>availableFutures</td></tr>
46 <tr><td>checkCategories</td></tr>
47 <tr><td>codeRole</td></tr>
48 <tr><td>cryptoBitSelectionsDsaRsa</td></tr>
49 <tr><td>cryptoBitSelectionsEc</td></tr>
50 <tr><td>filenameRole</td></tr>
51 <tr><td>fixableRole</td></tr>
52 <tr><td>hasResults</td></tr>
53 <tr><td>ignoredRole</td></tr>
54 <tr><td>lineRole</td></tr>
55 <tr><td>messageRole</td></tr>
56 <tr><td>noFiles</td></tr>
57 <tr><td>noResults</td></tr>
58 <tr><td>positionRole</td></tr>
47 </table> 59 </table>
60
48 <h3>Class Methods</h3> 61 <h3>Class Methods</h3>
49
50 <table> 62 <table>
51 <tr><td>None</td></tr> 63 <tr><td>None</td></tr>
52 </table> 64 </table>
65
53 <h3>Methods</h3> 66 <h3>Methods</h3>
54
55 <table> 67 <table>
56
57 <tr> 68 <tr>
58 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td> 69 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td>
59 <td>Constructor</td> 70 <td>Constructor</td>
60 </tr> 71 </tr>
61 <tr> 72 <tr>
305 <tr> 316 <tr>
306 <td><a href="#CodeStyleCheckerDialog.start">start</a></td> 317 <td><a href="#CodeStyleCheckerDialog.start">start</a></td>
307 <td>Public slot to start the code style check.</td> 318 <td>Public slot to start the code style check.</td>
308 </tr> 319 </tr>
309 </table> 320 </table>
321
310 <h3>Static Methods</h3> 322 <h3>Static Methods</h3>
311
312 <table> 323 <table>
313 <tr><td>None</td></tr> 324 <tr><td>None</td></tr>
314 </table> 325 </table>
315 326
327
316 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a> 328 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a>
317 <h4>CodeStyleCheckerDialog (Constructor)</h4> 329 <h4>CodeStyleCheckerDialog (Constructor)</h4>
318 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, project=None, parent=None</i>) 330 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, project=None, parent=None</i>)
319
320 <p> 331 <p>
321 Constructor 332 Constructor
322 </p> 333 </p>
334
323 <dl> 335 <dl>
324 336
325 <dt><i>styleCheckService</i> (CodeStyleCheckService)</dt> 337 <dt><i>styleCheckService</i> (CodeStyleCheckService)</dt>
326 <dd> 338 <dd>
327 reference to the service 339 reference to the service
337 </dd> 349 </dd>
338 </dl> 350 </dl>
339 <a NAME="CodeStyleCheckerDialog.__assembleExcludeMessages" ID="CodeStyleCheckerDialog.__assembleExcludeMessages"></a> 351 <a NAME="CodeStyleCheckerDialog.__assembleExcludeMessages" ID="CodeStyleCheckerDialog.__assembleExcludeMessages"></a>
340 <h4>CodeStyleCheckerDialog.__assembleExcludeMessages</h4> 352 <h4>CodeStyleCheckerDialog.__assembleExcludeMessages</h4>
341 <b>__assembleExcludeMessages</b>(<i></i>) 353 <b>__assembleExcludeMessages</b>(<i></i>)
342
343 <p> 354 <p>
344 Private method to assemble the list of excluded checks. 355 Private method to assemble the list of excluded checks.
345 </p> 356 </p>
357
346 <dl> 358 <dl>
347 <dt>Return:</dt> 359 <dt>Return:</dt>
348 <dd> 360 <dd>
349 list of excluded checks as a comma separated string. 361 list of excluded checks as a comma separated string.
350 </dd> 362 </dd>
356 </dd> 368 </dd>
357 </dl> 369 </dl>
358 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a> 370 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
359 <h4>CodeStyleCheckerDialog.__batchFinished</h4> 371 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
360 <b>__batchFinished</b>(<i></i>) 372 <b>__batchFinished</b>(<i></i>)
361
362 <p> 373 <p>
363 Private slot handling the completion of a batch job. 374 Private slot handling the completion of a batch job.
364 </p> 375 </p>
376
365 <a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a> 377 <a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a>
366 <h4>CodeStyleCheckerDialog.__cleanupData</h4> 378 <h4>CodeStyleCheckerDialog.__cleanupData</h4>
367 <b>__cleanupData</b>(<i></i>) 379 <b>__cleanupData</b>(<i></i>)
368
369 <p> 380 <p>
370 Private method to clean the loaded/entered data of redundant entries. 381 Private method to clean the loaded/entered data of redundant entries.
371 </p> 382 </p>
383
372 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a> 384 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
373 <h4>CodeStyleCheckerDialog.__clearErrors</h4> 385 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
374 <b>__clearErrors</b>(<i>files</i>) 386 <b>__clearErrors</b>(<i>files</i>)
375
376 <p> 387 <p>
377 Private method to clear all warning markers of open editors to be 388 Private method to clear all warning markers of open editors to be
378 checked. 389 checked.
379 </p> 390 </p>
391
380 <dl> 392 <dl>
381 393
382 <dt><i>files</i> (list of str)</dt> 394 <dt><i>files</i> (list of str)</dt>
383 <dd> 395 <dd>
384 list of files to be checked 396 list of files to be checked
385 </dd> 397 </dd>
386 </dl> 398 </dl>
387 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a> 399 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
388 <h4>CodeStyleCheckerDialog.__createErrorItem</h4> 400 <h4>CodeStyleCheckerDialog.__createErrorItem</h4>
389 <b>__createErrorItem</b>(<i>filename, message</i>) 401 <b>__createErrorItem</b>(<i>filename, message</i>)
390
391 <p> 402 <p>
392 Private slot to create a new error item in the result list. 403 Private slot to create a new error item in the result list.
393 </p> 404 </p>
405
394 <dl> 406 <dl>
395 407
396 <dt><i>filename</i> (str)</dt> 408 <dt><i>filename</i> (str)</dt>
397 <dd> 409 <dd>
398 name of the file 410 name of the file
403 </dd> 415 </dd>
404 </dl> 416 </dl>
405 <a NAME="CodeStyleCheckerDialog.__createFileErrorItem" ID="CodeStyleCheckerDialog.__createFileErrorItem"></a> 417 <a NAME="CodeStyleCheckerDialog.__createFileErrorItem" ID="CodeStyleCheckerDialog.__createFileErrorItem"></a>
406 <h4>CodeStyleCheckerDialog.__createFileErrorItem</h4> 418 <h4>CodeStyleCheckerDialog.__createFileErrorItem</h4>
407 <b>__createFileErrorItem</b>(<i>filename, message</i>) 419 <b>__createFileErrorItem</b>(<i>filename, message</i>)
408
409 <p> 420 <p>
410 Private method to create an error entry for a given file. 421 Private method to create an error entry for a given file.
411 </p> 422 </p>
423
412 <dl> 424 <dl>
413 425
414 <dt><i>filename</i> (str)</dt> 426 <dt><i>filename</i> (str)</dt>
415 <dd> 427 <dd>
416 file name of the file 428 file name of the file
421 </dd> 433 </dd>
422 </dl> 434 </dl>
423 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> 435 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a>
424 <h4>CodeStyleCheckerDialog.__createResultItem</h4> 436 <h4>CodeStyleCheckerDialog.__createResultItem</h4>
425 <b>__createResultItem</b>(<i>filename, result</i>) 437 <b>__createResultItem</b>(<i>filename, result</i>)
426
427 <p> 438 <p>
428 Private method to create an entry in the result list. 439 Private method to create an entry in the result list.
429 </p> 440 </p>
441
430 <dl> 442 <dl>
431 443
432 <dt><i>filename</i> (str)</dt> 444 <dt><i>filename</i> (str)</dt>
433 <dd> 445 <dd>
434 file name of the file 446 file name of the file
451 </dd> 463 </dd>
452 </dl> 464 </dl>
453 <a NAME="CodeStyleCheckerDialog.__defaultStatistics" ID="CodeStyleCheckerDialog.__defaultStatistics"></a> 465 <a NAME="CodeStyleCheckerDialog.__defaultStatistics" ID="CodeStyleCheckerDialog.__defaultStatistics"></a>
454 <h4>CodeStyleCheckerDialog.__defaultStatistics</h4> 466 <h4>CodeStyleCheckerDialog.__defaultStatistics</h4>
455 <b>__defaultStatistics</b>(<i></i>) 467 <b>__defaultStatistics</b>(<i></i>)
456
457 <p> 468 <p>
458 Private method to return the default statistics entry. 469 Private method to return the default statistics entry.
459 </p> 470 </p>
471
460 <dl> 472 <dl>
461 <dt>Return:</dt> 473 <dt>Return:</dt>
462 <dd> 474 <dd>
463 dictionary with default statistics entry 475 dictionary with default statistics entry
464 </dd> 476 </dd>
470 </dd> 482 </dd>
471 </dl> 483 </dl>
472 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a> 484 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
473 <h4>CodeStyleCheckerDialog.__finish</h4> 485 <h4>CodeStyleCheckerDialog.__finish</h4>
474 <b>__finish</b>(<i></i>) 486 <b>__finish</b>(<i></i>)
475
476 <p> 487 <p>
477 Private slot called when the code style check finished or the user 488 Private slot called when the code style check finished or the user
478 pressed the cancel button. 489 pressed the cancel button.
479 </p> 490 </p>
491
480 <a NAME="CodeStyleCheckerDialog.__getBanRelativeImportsValue" ID="CodeStyleCheckerDialog.__getBanRelativeImportsValue"></a> 492 <a NAME="CodeStyleCheckerDialog.__getBanRelativeImportsValue" ID="CodeStyleCheckerDialog.__getBanRelativeImportsValue"></a>
481 <h4>CodeStyleCheckerDialog.__getBanRelativeImportsValue</h4> 493 <h4>CodeStyleCheckerDialog.__getBanRelativeImportsValue</h4>
482 <b>__getBanRelativeImportsValue</b>(<i></i>) 494 <b>__getBanRelativeImportsValue</b>(<i></i>)
483
484 <p> 495 <p>
485 Private method to get the value corresponding the selected button. 496 Private method to get the value corresponding the selected button.
486 </p> 497 </p>
498
487 <dl> 499 <dl>
488 <dt>Return:</dt> 500 <dt>Return:</dt>
489 <dd> 501 <dd>
490 value for the BanRelativeImports argument 502 value for the BanRelativeImports argument
491 </dd> 503 </dd>
497 </dd> 509 </dd>
498 </dl> 510 </dl>
499 <a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a> 511 <a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a>
500 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4> 512 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4>
501 <b>__getBuiltinsIgnoreList</b>(<i></i>) 513 <b>__getBuiltinsIgnoreList</b>(<i></i>)
502
503 <p> 514 <p>
504 Private method to get a dictionary containing the builtins assignments 515 Private method to get a dictionary containing the builtins assignments
505 to be ignored. 516 to be ignored.
506 </p> 517 </p>
518
507 <dl> 519 <dl>
508 <dt>Return:</dt> 520 <dt>Return:</dt>
509 <dd> 521 <dd>
510 dictionary containing the builtins assignments to be ignored 522 dictionary containing the builtins assignments to be ignored
511 </dd> 523 </dd>
517 </dd> 529 </dd>
518 </dl> 530 </dl>
519 <a NAME="CodeStyleCheckerDialog.__getCategories" ID="CodeStyleCheckerDialog.__getCategories"></a> 531 <a NAME="CodeStyleCheckerDialog.__getCategories" ID="CodeStyleCheckerDialog.__getCategories"></a>
520 <h4>CodeStyleCheckerDialog.__getCategories</h4> 532 <h4>CodeStyleCheckerDialog.__getCategories</h4>
521 <b>__getCategories</b>(<i>enabled, asList=False</i>) 533 <b>__getCategories</b>(<i>enabled, asList=False</i>)
522
523 <p> 534 <p>
524 Private method to get the enabled or disabled checker categories. 535 Private method to get the enabled or disabled checker categories.
525 </p> 536 </p>
537
526 <dl> 538 <dl>
527 539
528 <dt><i>enabled</i> (bool)</dt> 540 <dt><i>enabled</i> (bool)</dt>
529 <dd> 541 <dd>
530 flag indicating to return enabled categories 542 flag indicating to return enabled categories
548 </dd> 560 </dd>
549 </dl> 561 </dl>
550 <a NAME="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList"></a> 562 <a NAME="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList"></a>
551 <h4>CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList</h4> 563 <h4>CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList</h4>
552 <b>__getCommentedCodeCheckerWhiteList</b>(<i></i>) 564 <b>__getCommentedCodeCheckerWhiteList</b>(<i></i>)
553
554 <p> 565 <p>
555 Private method to get the list of commented code whitelist patterns. 566 Private method to get the list of commented code whitelist patterns.
556 </p> 567 </p>
568
557 <dl> 569 <dl>
558 <dt>Return:</dt> 570 <dt>Return:</dt>
559 <dd> 571 <dd>
560 list of commented code whitelist patterns 572 list of commented code whitelist patterns
561 </dd> 573 </dd>
567 </dd> 579 </dd>
568 </dl> 580 </dl>
569 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a> 581 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
570 <h4>CodeStyleCheckerDialog.__getEol</h4> 582 <h4>CodeStyleCheckerDialog.__getEol</h4>
571 <b>__getEol</b>(<i>fn</i>) 583 <b>__getEol</b>(<i>fn</i>)
572
573 <p> 584 <p>
574 Private method to get the applicable eol string. 585 Private method to get the applicable eol string.
575 </p> 586 </p>
587
576 <dl> 588 <dl>
577 589
578 <dt><i>fn</i> (str)</dt> 590 <dt><i>fn</i> (str)</dt>
579 <dd> 591 <dd>
580 filename where to determine the line ending 592 filename where to determine the line ending
593 </dd> 605 </dd>
594 </dl> 606 </dl>
595 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a> 607 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
596 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4> 608 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4>
597 <b>__getSelectedFixableItems</b>(<i></i>) 609 <b>__getSelectedFixableItems</b>(<i></i>)
598
599 <p> 610 <p>
600 Private method to extract all selected items for fixable issues. 611 Private method to extract all selected items for fixable issues.
601 </p> 612 </p>
613
602 <dl> 614 <dl>
603 <dt>Return:</dt> 615 <dt>Return:</dt>
604 <dd> 616 <dd>
605 selected items for fixable issues 617 selected items for fixable issues
606 </dd> 618 </dd>
612 </dd> 624 </dd>
613 </dl> 625 </dl>
614 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a> 626 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a>
615 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4> 627 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4>
616 <b>__getSelectedFutureImports</b>(<i></i>) 628 <b>__getSelectedFutureImports</b>(<i></i>)
617
618 <p> 629 <p>
619 Private method to get the expected future imports. 630 Private method to get the expected future imports.
620 </p> 631 </p>
632
621 <dl> 633 <dl>
622 <dt>Return:</dt> 634 <dt>Return:</dt>
623 <dd> 635 <dd>
624 expected future imports as a comma separated string 636 expected future imports as a comma separated string
625 </dd> 637 </dd>
631 </dd> 643 </dd>
632 </dl> 644 </dl>
633 <a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a> 645 <a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a>
634 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4> 646 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4>
635 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>) 647 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>)
636
637 <p> 648 <p>
638 Private method to populate the list of shadowed builtins to be ignored. 649 Private method to populate the list of shadowed builtins to be ignored.
639 </p> 650 </p>
651
640 <dl> 652 <dl>
641 653
642 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt> 654 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt>
643 <dd> 655 <dd>
644 dictionary containing the builtins 656 dictionary containing the builtins
646 </dd> 658 </dd>
647 </dl> 659 </dl>
648 <a NAME="CodeStyleCheckerDialog.__initCategoriesList" ID="CodeStyleCheckerDialog.__initCategoriesList"></a> 660 <a NAME="CodeStyleCheckerDialog.__initCategoriesList" ID="CodeStyleCheckerDialog.__initCategoriesList"></a>
649 <h4>CodeStyleCheckerDialog.__initCategoriesList</h4> 661 <h4>CodeStyleCheckerDialog.__initCategoriesList</h4>
650 <b>__initCategoriesList</b>(<i>enabledCategories</i>) 662 <b>__initCategoriesList</b>(<i>enabledCategories</i>)
651
652 <p> 663 <p>
653 Private method to set the enabled status of the checker categories. 664 Private method to set the enabled status of the checker categories.
654 </p> 665 </p>
666
655 <dl> 667 <dl>
656 668
657 <dt><i>enabledCategories</i> (str)</dt> 669 <dt><i>enabledCategories</i> (str)</dt>
658 <dd> 670 <dd>
659 comma separated list of enabled checker 671 comma separated list of enabled checker
661 </dd> 673 </dd>
662 </dl> 674 </dl>
663 <a NAME="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList"></a> 675 <a NAME="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList"></a>
664 <h4>CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList</h4> 676 <h4>CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList</h4>
665 <b>__initCommentedCodeCheckerWhiteList</b>(<i>whitelist</i>) 677 <b>__initCommentedCodeCheckerWhiteList</b>(<i>whitelist</i>)
666
667 <p> 678 <p>
668 Private method to populate the list of commented code whitelist 679 Private method to populate the list of commented code whitelist
669 patterns. 680 patterns.
670 </p> 681 </p>
682
671 <dl> 683 <dl>
672 684
673 <dt><i>whitelist</i> (list of str)</dt> 685 <dt><i>whitelist</i> (list of str)</dt>
674 <dd> 686 <dd>
675 list of commented code whitelist patterns 687 list of commented code whitelist patterns
676 </dd> 688 </dd>
677 </dl> 689 </dl>
678 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a> 690 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
679 <h4>CodeStyleCheckerDialog.__initFuturesList</h4> 691 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
680 <b>__initFuturesList</b>(<i>selectedFutures</i>) 692 <b>__initFuturesList</b>(<i>selectedFutures</i>)
681
682 <p> 693 <p>
683 Private method to set the selected status of the future imports. 694 Private method to set the selected status of the future imports.
684 </p> 695 </p>
696
685 <dl> 697 <dl>
686 698
687 <dt><i>selectedFutures</i> (str)</dt> 699 <dt><i>selectedFutures</i> (str)</dt>
688 <dd> 700 <dd>
689 comma separated list of expected future imports 701 comma separated list of expected future imports
690 </dd> 702 </dd>
691 </dl> 703 </dl>
692 <a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a> 704 <a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a>
693 <h4>CodeStyleCheckerDialog.__itemFixable</h4> 705 <h4>CodeStyleCheckerDialog.__itemFixable</h4>
694 <b>__itemFixable</b>(<i>itm</i>) 706 <b>__itemFixable</b>(<i>itm</i>)
695
696 <p> 707 <p>
697 Private method to check, if an item has a fixable issue. 708 Private method to check, if an item has a fixable issue.
698 </p> 709 </p>
710
699 <dl> 711 <dl>
700 712
701 <dt><i>itm</i> (QTreeWidgetItem)</dt> 713 <dt><i>itm</i> (QTreeWidgetItem)</dt>
702 <dd> 714 <dd>
703 item to be checked 715 item to be checked
716 </dd> 728 </dd>
717 </dl> 729 </dl>
718 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a> 730 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
719 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4> 731 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
720 <b>__modifyFixedResultItem</b>(<i>itm, result</i>) 732 <b>__modifyFixedResultItem</b>(<i>itm, result</i>)
721
722 <p> 733 <p>
723 Private method to modify a result list entry to show its 734 Private method to modify a result list entry to show its
724 positive fixed state. 735 positive fixed state.
725 </p> 736 </p>
737
726 <dl> 738 <dl>
727 739
728 <dt><i>itm</i> (QTreeWidgetItem)</dt> 740 <dt><i>itm</i> (QTreeWidgetItem)</dt>
729 <dd> 741 <dd>
730 reference to the item to modify 742 reference to the item to modify
735 </dd> 747 </dd>
736 </dl> 748 </dl>
737 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a> 749 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
738 <h4>CodeStyleCheckerDialog.__modifyOptions</h4> 750 <h4>CodeStyleCheckerDialog.__modifyOptions</h4>
739 <b>__modifyOptions</b>(<i>source</i>) 751 <b>__modifyOptions</b>(<i>source</i>)
740
741 <p> 752 <p>
742 Private method to modify the options based on eflag: entries. 753 Private method to modify the options based on eflag: entries.
743 </p> 754 </p>
744 <p> 755 <p>
745 This method looks for comment lines like '# eflag: noqa = M601' 756 This method looks for comment lines like '# eflag: noqa = M601'
746 at the end of the source in order to extend the list of excluded 757 at the end of the source in order to extend the list of excluded
747 messages for one file only. 758 messages for one file only.
748 </p> 759 </p>
760
749 <dl> 761 <dl>
750 762
751 <dt><i>source</i> (list of str or str)</dt> 763 <dt><i>source</i> (list of str or str)</dt>
752 <dd> 764 <dd>
753 source text 765 source text
766 </dd> 778 </dd>
767 </dl> 779 </dl>
768 <a NAME="CodeStyleCheckerDialog.__prepareProgress" ID="CodeStyleCheckerDialog.__prepareProgress"></a> 780 <a NAME="CodeStyleCheckerDialog.__prepareProgress" ID="CodeStyleCheckerDialog.__prepareProgress"></a>
769 <h4>CodeStyleCheckerDialog.__prepareProgress</h4> 781 <h4>CodeStyleCheckerDialog.__prepareProgress</h4>
770 <b>__prepareProgress</b>(<i></i>) 782 <b>__prepareProgress</b>(<i></i>)
771
772 <p> 783 <p>
773 Private method to prepare the progress tab for the next run. 784 Private method to prepare the progress tab for the next run.
774 </p> 785 </p>
786
775 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a> 787 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
776 <h4>CodeStyleCheckerDialog.__processError</h4> 788 <h4>CodeStyleCheckerDialog.__processError</h4>
777 <b>__processError</b>(<i>fn, msg</i>) 789 <b>__processError</b>(<i>fn, msg</i>)
778
779 <p> 790 <p>
780 Private slot to process an error indication from the service. 791 Private slot to process an error indication from the service.
781 </p> 792 </p>
793
782 <dl> 794 <dl>
783 795
784 <dt><i>fn</i> (str)</dt> 796 <dt><i>fn</i> (str)</dt>
785 <dd> 797 <dd>
786 filename of the file 798 filename of the file
791 </dd> 803 </dd>
792 </dl> 804 </dl>
793 <a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a> 805 <a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a>
794 <h4>CodeStyleCheckerDialog.__processResult</h4> 806 <h4>CodeStyleCheckerDialog.__processResult</h4>
795 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>) 807 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>)
796
797 <p> 808 <p>
798 Private slot called after perfoming a style check on one file. 809 Private slot called after perfoming a style check on one file.
799 </p> 810 </p>
811
800 <dl> 812 <dl>
801 813
802 <dt><i>fn</i> (str)</dt> 814 <dt><i>fn</i> (str)</dt>
803 <dd> 815 <dd>
804 filename of the just checked file 816 filename of the just checked file
817 </dd> 829 </dd>
818 </dl> 830 </dl>
819 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> 831 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
820 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> 832 <h4>CodeStyleCheckerDialog.__resetStatistics</h4>
821 <b>__resetStatistics</b>(<i></i>) 833 <b>__resetStatistics</b>(<i></i>)
822
823 <p> 834 <p>
824 Private slot to reset the statistics data. 835 Private slot to reset the statistics data.
825 </p> 836 </p>
837
826 <a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a> 838 <a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a>
827 <h4>CodeStyleCheckerDialog.__resort</h4> 839 <h4>CodeStyleCheckerDialog.__resort</h4>
828 <b>__resort</b>(<i></i>) 840 <b>__resort</b>(<i></i>)
829
830 <p> 841 <p>
831 Private method to resort the tree. 842 Private method to resort the tree.
832 </p> 843 </p>
844
833 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a> 845 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
834 <h4>CodeStyleCheckerDialog.__selectCodes</h4> 846 <h4>CodeStyleCheckerDialog.__selectCodes</h4>
835 <b>__selectCodes</b>(<i>edit, categories, showFixCodes</i>) 847 <b>__selectCodes</b>(<i>edit, categories, showFixCodes</i>)
836
837 <p> 848 <p>
838 Private method to select message codes via a selection dialog. 849 Private method to select message codes via a selection dialog.
839 </p> 850 </p>
851
840 <dl> 852 <dl>
841 853
842 <dt><i>edit</i> (QLineEdit)</dt> 854 <dt><i>edit</i> (QLineEdit)</dt>
843 <dd> 855 <dd>
844 reference of the line edit to be populated 856 reference of the line edit to be populated
854 </dd> 866 </dd>
855 </dl> 867 </dl>
856 <a NAME="CodeStyleCheckerDialog.__setBanRelativeImports" ID="CodeStyleCheckerDialog.__setBanRelativeImports"></a> 868 <a NAME="CodeStyleCheckerDialog.__setBanRelativeImports" ID="CodeStyleCheckerDialog.__setBanRelativeImports"></a>
857 <h4>CodeStyleCheckerDialog.__setBanRelativeImports</h4> 869 <h4>CodeStyleCheckerDialog.__setBanRelativeImports</h4>
858 <b>__setBanRelativeImports</b>(<i>value</i>) 870 <b>__setBanRelativeImports</b>(<i>value</i>)
859
860 <p> 871 <p>
861 Private method to set the button according to the ban relative imports 872 Private method to set the button according to the ban relative imports
862 setting. 873 setting.
863 </p> 874 </p>
875
864 <dl> 876 <dl>
865 877
866 <dt><i>value</i> (str)</dt> 878 <dt><i>value</i> (str)</dt>
867 <dd> 879 <dd>
868 value of the ban relative imports setting 880 value of the ban relative imports setting
869 </dd> 881 </dd>
870 </dl> 882 </dl>
871 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a> 883 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
872 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4> 884 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4>
873 <b>__updateFixerStatistics</b>(<i>fixer</i>) 885 <b>__updateFixerStatistics</b>(<i>fixer</i>)
874
875 <p> 886 <p>
876 Private method to update the collected fixer related statistics. 887 Private method to update the collected fixer related statistics.
877 </p> 888 </p>
889
878 <dl> 890 <dl>
879 891
880 <dt><i>fixer</i> (CodeStyleFixer)</dt> 892 <dt><i>fixer</i> (CodeStyleFixer)</dt>
881 <dd> 893 <dd>
882 reference to the code style fixer 894 reference to the code style fixer
883 </dd> 895 </dd>
884 </dl> 896 </dl>
885 <a NAME="CodeStyleCheckerDialog.__updateProgress" ID="CodeStyleCheckerDialog.__updateProgress"></a> 897 <a NAME="CodeStyleCheckerDialog.__updateProgress" ID="CodeStyleCheckerDialog.__updateProgress"></a>
886 <h4>CodeStyleCheckerDialog.__updateProgress</h4> 898 <h4>CodeStyleCheckerDialog.__updateProgress</h4>
887 <b>__updateProgress</b>(<i>fn</i>) 899 <b>__updateProgress</b>(<i>fn</i>)
888
889 <p> 900 <p>
890 Private method to update the progress tab. 901 Private method to update the progress tab.
891 </p> 902 </p>
903
892 <dl> 904 <dl>
893 905
894 <dt><i>fn</i> (str)</dt> 906 <dt><i>fn</i> (str)</dt>
895 <dd> 907 <dd>
896 filename of the just checked file 908 filename of the just checked file
897 </dd> 909 </dd>
898 </dl> 910 </dl>
899 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a> 911 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
900 <h4>CodeStyleCheckerDialog.__updateStatistics</h4> 912 <h4>CodeStyleCheckerDialog.__updateStatistics</h4>
901 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors, securityOk</i>) 913 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors, securityOk</i>)
902
903 <p> 914 <p>
904 Private method to update the collected statistics. 915 Private method to update the collected statistics.
905 </p> 916 </p>
917
906 <dl> 918 <dl>
907 919
908 <dt><i>statistics</i> (dict)</dt> 920 <dt><i>statistics</i> (dict)</dt>
909 <dd> 921 <dd>
910 dictionary of statistical data with 922 dictionary of statistical data with
924 </dd> 936 </dd>
925 </dl> 937 </dl>
926 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a> 938 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
927 <h4>CodeStyleCheckerDialog.check</h4> 939 <h4>CodeStyleCheckerDialog.check</h4>
928 <b>check</b>(<i>codestring=""</i>) 940 <b>check</b>(<i>codestring=""</i>)
929
930 <p> 941 <p>
931 Public method to start a style check for one file. 942 Public method to start a style check for one file.
932 </p> 943 </p>
933 <p> 944 <p>
934 The results are reported to the __processResult slot. 945 The results are reported to the __processResult slot.
935 </p> 946 </p>
947
936 <dl> 948 <dl>
937 949
938 <dt><i>codestring</i> (str)</dt> 950 <dt><i>codestring</i> (str)</dt>
939 <dd> 951 <dd>
940 optional sourcestring 952 optional sourcestring
941 </dd> 953 </dd>
942 </dl> 954 </dl>
943 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a> 955 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
944 <h4>CodeStyleCheckerDialog.checkBatch</h4> 956 <h4>CodeStyleCheckerDialog.checkBatch</h4>
945 <b>checkBatch</b>(<i></i>) 957 <b>checkBatch</b>(<i></i>)
946
947 <p> 958 <p>
948 Public method to start a style check batch job. 959 Public method to start a style check batch job.
949 </p> 960 </p>
950 <p> 961 <p>
951 The results are reported to the __processResult slot. 962 The results are reported to the __processResult slot.
952 </p> 963 </p>
964
953 <a NAME="CodeStyleCheckerDialog.closeEvent" ID="CodeStyleCheckerDialog.closeEvent"></a> 965 <a NAME="CodeStyleCheckerDialog.closeEvent" ID="CodeStyleCheckerDialog.closeEvent"></a>
954 <h4>CodeStyleCheckerDialog.closeEvent</h4> 966 <h4>CodeStyleCheckerDialog.closeEvent</h4>
955 <b>closeEvent</b>(<i>evt</i>) 967 <b>closeEvent</b>(<i>evt</i>)
956
957 <p> 968 <p>
958 Protected method to handle a close event. 969 Protected method to handle a close event.
959 </p> 970 </p>
971
960 <dl> 972 <dl>
961 973
962 <dt><i>evt</i> (QCloseEvent)</dt> 974 <dt><i>evt</i> (QCloseEvent)</dt>
963 <dd> 975 <dd>
964 reference to the close event 976 reference to the close event
965 </dd> 977 </dd>
966 </dl> 978 </dl>
967 <a NAME="CodeStyleCheckerDialog.getDefaults" ID="CodeStyleCheckerDialog.getDefaults"></a> 979 <a NAME="CodeStyleCheckerDialog.getDefaults" ID="CodeStyleCheckerDialog.getDefaults"></a>
968 <h4>CodeStyleCheckerDialog.getDefaults</h4> 980 <h4>CodeStyleCheckerDialog.getDefaults</h4>
969 <b>getDefaults</b>(<i></i>) 981 <b>getDefaults</b>(<i></i>)
970
971 <p> 982 <p>
972 Public method to get a dictionary containing the default values. 983 Public method to get a dictionary containing the default values.
973 </p> 984 </p>
985
974 <dl> 986 <dl>
975 <dt>Return:</dt> 987 <dt>Return:</dt>
976 <dd> 988 <dd>
977 dictionary containing the default values 989 dictionary containing the default values
978 </dd> 990 </dd>
984 </dd> 996 </dd>
985 </dl> 997 </dl>
986 <a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a> 998 <a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a>
987 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4> 999 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4>
988 <b>on_addBuiltinButton_clicked</b>(<i></i>) 1000 <b>on_addBuiltinButton_clicked</b>(<i></i>)
989
990 <p> 1001 <p>
991 Private slot to add a built-in assignment to be ignored. 1002 Private slot to add a built-in assignment to be ignored.
992 </p> 1003 </p>
1004
993 <a NAME="CodeStyleCheckerDialog.on_addWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_addWhitelistButton_clicked"></a> 1005 <a NAME="CodeStyleCheckerDialog.on_addWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_addWhitelistButton_clicked"></a>
994 <h4>CodeStyleCheckerDialog.on_addWhitelistButton_clicked</h4> 1006 <h4>CodeStyleCheckerDialog.on_addWhitelistButton_clicked</h4>
995 <b>on_addWhitelistButton_clicked</b>(<i></i>) 1007 <b>on_addWhitelistButton_clicked</b>(<i></i>)
996
997 <p> 1008 <p>
998 Private slot to add a commented code whitelist pattern. 1009 Private slot to add a commented code whitelist pattern.
999 </p> 1010 </p>
1011
1000 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a> 1012 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
1001 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4> 1013 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
1002 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>) 1014 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
1003
1004 <p> 1015 <p>
1005 Private slot to react upon changes of the selected builtin assignments. 1016 Private slot to react upon changes of the selected builtin assignments.
1006 </p> 1017 </p>
1018
1007 <a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a> 1019 <a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a>
1008 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4> 1020 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4>
1009 <b>on_buttonBox_clicked</b>(<i>button</i>) 1021 <b>on_buttonBox_clicked</b>(<i>button</i>)
1010
1011 <p> 1022 <p>
1012 Private slot called by a button of the button box clicked. 1023 Private slot called by a button of the button box clicked.
1013 </p> 1024 </p>
1025
1014 <dl> 1026 <dl>
1015 1027
1016 <dt><i>button</i> (QAbstractButton)</dt> 1028 <dt><i>button</i> (QAbstractButton)</dt>
1017 <dd> 1029 <dd>
1018 button that was clicked 1030 button that was clicked
1019 </dd> 1031 </dd>
1020 </dl> 1032 </dl>
1021 <a NAME="CodeStyleCheckerDialog.on_cancelButton_clicked" ID="CodeStyleCheckerDialog.on_cancelButton_clicked"></a> 1033 <a NAME="CodeStyleCheckerDialog.on_cancelButton_clicked" ID="CodeStyleCheckerDialog.on_cancelButton_clicked"></a>
1022 <h4>CodeStyleCheckerDialog.on_cancelButton_clicked</h4> 1034 <h4>CodeStyleCheckerDialog.on_cancelButton_clicked</h4>
1023 <b>on_cancelButton_clicked</b>(<i></i>) 1035 <b>on_cancelButton_clicked</b>(<i></i>)
1024
1025 <p> 1036 <p>
1026 Private slot to handle the "Cancel" button press. 1037 Private slot to handle the "Cancel" button press.
1027 </p> 1038 </p>
1039
1028 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a> 1040 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
1029 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4> 1041 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4>
1030 <b>on_deleteBuiltinButton_clicked</b>(<i></i>) 1042 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
1031
1032 <p> 1043 <p>
1033 Private slot to delete the selected items from the list. 1044 Private slot to delete the selected items from the list.
1034 </p> 1045 </p>
1046
1035 <a NAME="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked"></a> 1047 <a NAME="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked"></a>
1036 <h4>CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked</h4> 1048 <h4>CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked</h4>
1037 <b>on_deleteWhitelistButton_clicked</b>(<i></i>) 1049 <b>on_deleteWhitelistButton_clicked</b>(<i></i>)
1038
1039 <p> 1050 <p>
1040 Private slot to delete the selected items from the list. 1051 Private slot to delete the selected items from the list.
1041 </p> 1052 </p>
1053
1042 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a> 1054 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
1043 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4> 1055 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
1044 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>) 1056 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
1045
1046 <p> 1057 <p>
1047 Private slot to select the message codes to be excluded via a 1058 Private slot to select the message codes to be excluded via a
1048 selection dialog. 1059 selection dialog.
1049 </p> 1060 </p>
1061
1050 <a NAME="CodeStyleCheckerDialog.on_filterButton_clicked" ID="CodeStyleCheckerDialog.on_filterButton_clicked"></a> 1062 <a NAME="CodeStyleCheckerDialog.on_filterButton_clicked" ID="CodeStyleCheckerDialog.on_filterButton_clicked"></a>
1051 <h4>CodeStyleCheckerDialog.on_filterButton_clicked</h4> 1063 <h4>CodeStyleCheckerDialog.on_filterButton_clicked</h4>
1052 <b>on_filterButton_clicked</b>(<i></i>) 1064 <b>on_filterButton_clicked</b>(<i></i>)
1053
1054 <p> 1065 <p>
1055 Private slot to filter the list of messages based on selected message 1066 Private slot to filter the list of messages based on selected message
1056 code. 1067 code.
1057 </p> 1068 </p>
1069
1058 <a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a> 1070 <a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a>
1059 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4> 1071 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4>
1060 <b>on_fixButton_clicked</b>(<i></i>) 1072 <b>on_fixButton_clicked</b>(<i></i>)
1061
1062 <p> 1073 <p>
1063 Private slot to fix selected issues. 1074 Private slot to fix selected issues.
1064 </p> 1075 </p>
1065 <p> 1076 <p>
1066 Build a dictionary of issues to fix. Update the initialized __options. 1077 Build a dictionary of issues to fix. Update the initialized __options.
1067 Then call check with the dict as keyparam to fix selected issues. 1078 Then call check with the dict as keyparam to fix selected issues.
1068 </p> 1079 </p>
1080
1069 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a> 1081 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
1070 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4> 1082 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
1071 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>) 1083 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
1072
1073 <p> 1084 <p>
1074 Private slot to select the issue codes to be fixed via a 1085 Private slot to select the issue codes to be fixed via a
1075 selection dialog. 1086 selection dialog.
1076 </p> 1087 </p>
1088
1077 <a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a> 1089 <a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a>
1078 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4> 1090 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4>
1079 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>) 1091 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>)
1080
1081 <p> 1092 <p>
1082 Private slot to select the message codes to be included via a 1093 Private slot to select the message codes to be included via a
1083 selection dialog. 1094 selection dialog.
1084 </p> 1095 </p>
1096
1085 <a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a> 1097 <a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a>
1086 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4> 1098 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4>
1087 <b>on_loadDefaultButton_clicked</b>(<i></i>) 1099 <b>on_loadDefaultButton_clicked</b>(<i></i>)
1088
1089 <p> 1100 <p>
1090 Private slot to load the default configuration values. 1101 Private slot to load the default configuration values.
1091 </p> 1102 </p>
1103
1092 <a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a> 1104 <a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a>
1093 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4> 1105 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4>
1094 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>) 1106 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
1095
1096 <p> 1107 <p>
1097 Private slot to select the issue codes not to be fixed via a 1108 Private slot to select the issue codes not to be fixed via a
1098 selection dialog. 1109 selection dialog.
1099 </p> 1110 </p>
1111
1100 <a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a> 1112 <a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a>
1101 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4> 1113 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4>
1102 <b>on_resetDefaultButton_clicked</b>(<i></i>) 1114 <b>on_resetDefaultButton_clicked</b>(<i></i>)
1103
1104 <p> 1115 <p>
1105 Private slot to reset the configuration values to their default values. 1116 Private slot to reset the configuration values to their default values.
1106 </p> 1117 </p>
1118
1107 <a NAME="CodeStyleCheckerDialog.on_restartButton_clicked" ID="CodeStyleCheckerDialog.on_restartButton_clicked"></a> 1119 <a NAME="CodeStyleCheckerDialog.on_restartButton_clicked" ID="CodeStyleCheckerDialog.on_restartButton_clicked"></a>
1108 <h4>CodeStyleCheckerDialog.on_restartButton_clicked</h4> 1120 <h4>CodeStyleCheckerDialog.on_restartButton_clicked</h4>
1109 <b>on_restartButton_clicked</b>(<i></i>) 1121 <b>on_restartButton_clicked</b>(<i></i>)
1110
1111 <p> 1122 <p>
1112 Private slot to restart a code style check run. 1123 Private slot to restart a code style check run.
1113 </p> 1124 </p>
1125
1114 <a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a> 1126 <a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a>
1115 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4> 1127 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4>
1116 <b>on_resultList_itemActivated</b>(<i>item, column</i>) 1128 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
1117
1118 <p> 1129 <p>
1119 Private slot to handle the activation of an item. 1130 Private slot to handle the activation of an item.
1120 </p> 1131 </p>
1132
1121 <dl> 1133 <dl>
1122 1134
1123 <dt><i>item</i> (QTreeWidgetItem)</dt> 1135 <dt><i>item</i> (QTreeWidgetItem)</dt>
1124 <dd> 1136 <dd>
1125 reference to the activated item 1137 reference to the activated item
1130 </dd> 1142 </dd>
1131 </dl> 1143 </dl>
1132 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a> 1144 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
1133 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4> 1145 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4>
1134 <b>on_resultList_itemSelectionChanged</b>(<i></i>) 1146 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
1135
1136 <p> 1147 <p>
1137 Private slot to change the dialog state depending on the selection. 1148 Private slot to change the dialog state depending on the selection.
1138 </p> 1149 </p>
1150
1139 <a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a> 1151 <a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a>
1140 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4> 1152 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4>
1141 <b>on_showButton_clicked</b>(<i></i>) 1153 <b>on_showButton_clicked</b>(<i></i>)
1142
1143 <p> 1154 <p>
1144 Private slot to handle the "Show" button press. 1155 Private slot to handle the "Show" button press.
1145 </p> 1156 </p>
1157
1146 <a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a> 1158 <a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a>
1147 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4> 1159 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4>
1148 <b>on_startButton_clicked</b>(<i></i>) 1160 <b>on_startButton_clicked</b>(<i></i>)
1149
1150 <p> 1161 <p>
1151 Private slot to start a code style check run. 1162 Private slot to start a code style check run.
1152 </p> 1163 </p>
1164
1153 <a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a> 1165 <a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a>
1154 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4> 1166 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4>
1155 <b>on_statisticsButton_clicked</b>(<i></i>) 1167 <b>on_statisticsButton_clicked</b>(<i></i>)
1156
1157 <p> 1168 <p>
1158 Private slot to show the statistics dialog. 1169 Private slot to show the statistics dialog.
1159 </p> 1170 </p>
1171
1160 <a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a> 1172 <a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a>
1161 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4> 1173 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4>
1162 <b>on_storeDefaultButton_clicked</b>(<i></i>) 1174 <b>on_storeDefaultButton_clicked</b>(<i></i>)
1163
1164 <p> 1175 <p>
1165 Private slot to store the current configuration values as 1176 Private slot to store the current configuration values as
1166 default values. 1177 default values.
1167 </p> 1178 </p>
1179
1168 <a NAME="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged"></a> 1180 <a NAME="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged"></a>
1169 <h4>CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged</h4> 1181 <h4>CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged</h4>
1170 <b>on_whitelistWidget_itemSelectionChanged</b>(<i></i>) 1182 <b>on_whitelistWidget_itemSelectionChanged</b>(<i></i>)
1171
1172 <p> 1183 <p>
1173 Private slot to react upon changes of the selected whitelist patterns. 1184 Private slot to react upon changes of the selected whitelist patterns.
1174 </p> 1185 </p>
1186
1175 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a> 1187 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
1176 <h4>CodeStyleCheckerDialog.prepare</h4> 1188 <h4>CodeStyleCheckerDialog.prepare</h4>
1177 <b>prepare</b>(<i>fileList, project</i>) 1189 <b>prepare</b>(<i>fileList, project</i>)
1178
1179 <p> 1190 <p>
1180 Public method to prepare the dialog with a list of filenames. 1191 Public method to prepare the dialog with a list of filenames.
1181 </p> 1192 </p>
1193
1182 <dl> 1194 <dl>
1183 1195
1184 <dt><i>fileList</i> (list of str)</dt> 1196 <dt><i>fileList</i> (list of str)</dt>
1185 <dd> 1197 <dd>
1186 list of filenames 1198 list of filenames
1191 </dd> 1203 </dd>
1192 </dl> 1204 </dl>
1193 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a> 1205 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
1194 <h4>CodeStyleCheckerDialog.start</h4> 1206 <h4>CodeStyleCheckerDialog.start</h4>
1195 <b>start</b>(<i>fn, save=False, repeat=None</i>) 1207 <b>start</b>(<i>fn, save=False, repeat=None</i>)
1196
1197 <p> 1208 <p>
1198 Public slot to start the code style check. 1209 Public slot to start the code style check.
1199 </p> 1210 </p>
1211
1200 <dl> 1212 <dl>
1201 1213
1202 <dt><i>fn</i> (str or list of str)</dt> 1214 <dt><i>fn</i> (str or list of str)</dt>
1203 <dd> 1215 <dd>
1204 file or list of files or directory to be checked 1216 file or list of files or directory to be checked

Mercurial Repository: eric

eric ide

mercurial