eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8199
f6db89b067e7
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
111 <tr> 111 <tr>
112 <td><a href="#CodeStyleCheckerDialog.__getCategories">__getCategories</a></td> 112 <td><a href="#CodeStyleCheckerDialog.__getCategories">__getCategories</a></td>
113 <td>Private method to get the enabled or disabled checker categories.</td> 113 <td>Private method to get the enabled or disabled checker categories.</td>
114 </tr> 114 </tr>
115 <tr> 115 <tr>
116 <td><a href="#CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList">__getCommentedCodeCheckerWhiteList</a></td>
117 <td>Private method to get the list of commented code whitelist patterns.</td>
118 </tr>
119 <tr>
116 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td> 120 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
117 <td>Private method to get the applicable eol string.</td> 121 <td>Private method to get the applicable eol string.</td>
118 </tr> 122 </tr>
119 <tr> 123 <tr>
120 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td> 124 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
131 <tr> 135 <tr>
132 <td><a href="#CodeStyleCheckerDialog.__initCategoriesList">__initCategoriesList</a></td> 136 <td><a href="#CodeStyleCheckerDialog.__initCategoriesList">__initCategoriesList</a></td>
133 <td>Private method to set the enabled status of the checker categories.</td> 137 <td>Private method to set the enabled status of the checker categories.</td>
134 </tr> 138 </tr>
135 <tr> 139 <tr>
140 <td><a href="#CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList">__initCommentedCodeCheckerWhiteList</a></td>
141 <td>Private method to populate the list of commented code whitelist patterns.</td>
142 </tr>
143 <tr>
136 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td> 144 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
137 <td>Private method to set the selected status of the future imports.</td> 145 <td>Private method to set the selected status of the future imports.</td>
138 </tr> 146 </tr>
139 <tr> 147 <tr>
140 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td> 148 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td>
195 <tr> 203 <tr>
196 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td> 204 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td>
197 <td>Private slot to add a built-in assignment to be ignored.</td> 205 <td>Private slot to add a built-in assignment to be ignored.</td>
198 </tr> 206 </tr>
199 <tr> 207 <tr>
208 <td><a href="#CodeStyleCheckerDialog.on_addWhitelistButton_clicked">on_addWhitelistButton_clicked</a></td>
209 <td>Private slot to add a commented code whitelist pattern.</td>
210 </tr>
211 <tr>
200 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td> 212 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td>
201 <td>Private slot to react upon changes of the selected builtin assignments.</td> 213 <td>Private slot to react upon changes of the selected builtin assignments.</td>
202 </tr> 214 </tr>
203 <tr> 215 <tr>
204 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 216 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
211 <tr> 223 <tr>
212 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td> 224 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td>
213 <td>Private slot to delete the selected items from the list.</td> 225 <td>Private slot to delete the selected items from the list.</td>
214 </tr> 226 </tr>
215 <tr> 227 <tr>
228 <td><a href="#CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked">on_deleteWhitelistButton_clicked</a></td>
229 <td>Private slot to delete the selected items from the list.</td>
230 </tr>
231 <tr>
216 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td> 232 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
217 <td>Private slot to select the message codes to be excluded via a selection dialog.</td> 233 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
218 </tr> 234 </tr>
219 <tr> 235 <tr>
220 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td> 236 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
265 <td>Private slot to show the statistics dialog.</td> 281 <td>Private slot to show the statistics dialog.</td>
266 </tr> 282 </tr>
267 <tr> 283 <tr>
268 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td> 284 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
269 <td>Private slot to store the current configuration values as default values.</td> 285 <td>Private slot to store the current configuration values as default values.</td>
286 </tr>
287 <tr>
288 <td><a href="#CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged">on_whitelistWidget_itemSelectionChanged</a></td>
289 <td>Private slot to react upon changes of the selected whitelist patterns.</td>
270 </tr> 290 </tr>
271 <tr> 291 <tr>
272 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td> 292 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td>
273 <td>Public method to prepare the dialog with a list of filenames.</td> 293 <td>Public method to prepare the dialog with a list of filenames.</td>
274 </tr> 294 </tr>
312 332
313 <p> 333 <p>
314 Private method to assemble the list of excluded checks. 334 Private method to assemble the list of excluded checks.
315 </p> 335 </p>
316 <dl> 336 <dl>
317 <dt>Returns:</dt> 337 <dt>Return:</dt>
318 <dd> 338 <dd>
319 list of excluded checks as a comma separated string. 339 list of excluded checks as a comma separated string.
320 </dd> 340 </dd>
321 </dl> 341 </dl>
322 <dl> 342 <dl>
407 <dd> 427 <dd>
408 dictionary containing check result data 428 dictionary containing check result data
409 </dd> 429 </dd>
410 </dl> 430 </dl>
411 <dl> 431 <dl>
412 <dt>Returns:</dt> 432 <dt>Return:</dt>
413 <dd> 433 <dd>
414 reference to the created item 434 reference to the created item
415 </dd> 435 </dd>
416 </dl> 436 </dl>
417 <dl> 437 <dl>
435 <p> 455 <p>
436 Private method to get a dictionary containing the builtins assignments 456 Private method to get a dictionary containing the builtins assignments
437 to be ignored. 457 to be ignored.
438 </p> 458 </p>
439 <dl> 459 <dl>
440 <dt>Returns:</dt> 460 <dt>Return:</dt>
441 <dd> 461 <dd>
442 dictionary containing the builtins assignments to be ignored 462 dictionary containing the builtins assignments to be ignored
443 </dd> 463 </dd>
444 </dl> 464 </dl>
445 <dl> 465 <dl>
466 flag indicating to return the checker categories as a 486 flag indicating to return the checker categories as a
467 Python list 487 Python list
468 </dd> 488 </dd>
469 </dl> 489 </dl>
470 <dl> 490 <dl>
471 <dt>Returns:</dt> 491 <dt>Return:</dt>
472 <dd> 492 <dd>
473 checker categories as a list or comma separated string 493 checker categories as a list or comma separated string
474 </dd> 494 </dd>
475 </dl> 495 </dl>
476 <dl> 496 <dl>
477 <dt>Return Type:</dt> 497 <dt>Return Type:</dt>
478 <dd> 498 <dd>
479 str or list of str 499 str or list of str
500 </dd>
501 </dl>
502 <a NAME="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList"></a>
503 <h4>CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList</h4>
504 <b>__getCommentedCodeCheckerWhiteList</b>(<i></i>)
505
506 <p>
507 Private method to get the list of commented code whitelist patterns.
508 </p>
509 <dl>
510 <dt>Return:</dt>
511 <dd>
512 list of commented code whitelist patterns
513 </dd>
514 </dl>
515 <dl>
516 <dt>Return Type:</dt>
517 <dd>
518 list of str
480 </dd> 519 </dd>
481 </dl> 520 </dl>
482 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a> 521 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
483 <h4>CodeStyleCheckerDialog.__getEol</h4> 522 <h4>CodeStyleCheckerDialog.__getEol</h4>
484 <b>__getEol</b>(<i>fn</i>) 523 <b>__getEol</b>(<i>fn</i>)
492 <dd> 531 <dd>
493 filename where to determine the line ending 532 filename where to determine the line ending
494 </dd> 533 </dd>
495 </dl> 534 </dl>
496 <dl> 535 <dl>
497 <dt>Returns:</dt> 536 <dt>Return:</dt>
498 <dd> 537 <dd>
499 eol string 538 eol string
500 </dd> 539 </dd>
501 </dl> 540 </dl>
502 <dl> 541 <dl>
511 550
512 <p> 551 <p>
513 Private method to extract all selected items for fixable issues. 552 Private method to extract all selected items for fixable issues.
514 </p> 553 </p>
515 <dl> 554 <dl>
516 <dt>Returns:</dt> 555 <dt>Return:</dt>
517 <dd> 556 <dd>
518 selected items for fixable issues 557 selected items for fixable issues
519 </dd> 558 </dd>
520 </dl> 559 </dl>
521 <dl> 560 <dl>
530 569
531 <p> 570 <p>
532 Private method to get the expected future imports. 571 Private method to get the expected future imports.
533 </p> 572 </p>
534 <dl> 573 <dl>
535 <dt>Returns:</dt> 574 <dt>Return:</dt>
536 <dd> 575 <dd>
537 expected future imports as a comma separated string 576 expected future imports as a comma separated string
538 </dd> 577 </dd>
539 </dl> 578 </dl>
540 <dl> 579 <dl>
571 <dd> 610 <dd>
572 comma separated list of enabled checker 611 comma separated list of enabled checker
573 categories 612 categories
574 </dd> 613 </dd>
575 </dl> 614 </dl>
615 <a NAME="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList"></a>
616 <h4>CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList</h4>
617 <b>__initCommentedCodeCheckerWhiteList</b>(<i>whitelist</i>)
618
619 <p>
620 Private method to populate the list of commented code whitelist
621 patterns.
622 </p>
623 <dl>
624
625 <dt><i>whitelist</i> (list of str)</dt>
626 <dd>
627 list of commented code whitelist patterns
628 </dd>
629 </dl>
576 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a> 630 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
577 <h4>CodeStyleCheckerDialog.__initFuturesList</h4> 631 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
578 <b>__initFuturesList</b>(<i>selectedFutures</i>) 632 <b>__initFuturesList</b>(<i>selectedFutures</i>)
579 633
580 <p> 634 <p>
600 <dd> 654 <dd>
601 item to be checked 655 item to be checked
602 </dd> 656 </dd>
603 </dl> 657 </dl>
604 <dl> 658 <dl>
605 <dt>Returns:</dt> 659 <dt>Return:</dt>
606 <dd> 660 <dd>
607 flag indicating a fixable issue 661 flag indicating a fixable issue
608 </dd> 662 </dd>
609 </dl> 663 </dl>
610 <dl> 664 <dl>
650 <dd> 704 <dd>
651 source text 705 source text
652 </dd> 706 </dd>
653 </dl> 707 </dl>
654 <dl> 708 <dl>
655 <dt>Returns:</dt> 709 <dt>Return:</dt>
656 <dd> 710 <dd>
657 list of checker options 711 list of checker options
658 </dd> 712 </dd>
659 </dl> 713 </dl>
660 <dl> 714 <dl>
838 <b>on_addBuiltinButton_clicked</b>(<i></i>) 892 <b>on_addBuiltinButton_clicked</b>(<i></i>)
839 893
840 <p> 894 <p>
841 Private slot to add a built-in assignment to be ignored. 895 Private slot to add a built-in assignment to be ignored.
842 </p> 896 </p>
897 <a NAME="CodeStyleCheckerDialog.on_addWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_addWhitelistButton_clicked"></a>
898 <h4>CodeStyleCheckerDialog.on_addWhitelistButton_clicked</h4>
899 <b>on_addWhitelistButton_clicked</b>(<i></i>)
900
901 <p>
902 Private slot to add a commented code whitelist pattern.
903 </p>
843 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a> 904 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
844 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4> 905 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
845 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>) 906 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
846 907
847 <p> 908 <p>
873 <b>on_deleteBuiltinButton_clicked</b>(<i></i>) 934 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
874 935
875 <p> 936 <p>
876 Private slot to delete the selected items from the list. 937 Private slot to delete the selected items from the list.
877 </p> 938 </p>
939 <a NAME="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked"></a>
940 <h4>CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked</h4>
941 <b>on_deleteWhitelistButton_clicked</b>(<i></i>)
942
943 <p>
944 Private slot to delete the selected items from the list.
945 </p>
878 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a> 946 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
879 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4> 947 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
880 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>) 948 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
881 949
882 <p> 950 <p>
991 1059
992 <p> 1060 <p>
993 Private slot to store the current configuration values as 1061 Private slot to store the current configuration values as
994 default values. 1062 default values.
995 </p> 1063 </p>
1064 <a NAME="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged"></a>
1065 <h4>CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged</h4>
1066 <b>on_whitelistWidget_itemSelectionChanged</b>(<i></i>)
1067
1068 <p>
1069 Private slot to react upon changes of the selected whitelist patterns.
1070 </p>
996 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a> 1071 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
997 <h4>CodeStyleCheckerDialog.prepare</h4> 1072 <h4>CodeStyleCheckerDialog.prepare</h4>
998 <b>prepare</b>(<i>fileList, project</i>) 1073 <b>prepare</b>(<i>fileList, project</i>)
999 1074
1000 <p> 1075 <p>

eric ide

mercurial