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

changeset 7986
2971d5d19951
parent 7632
7ac16bf7695b
child 7989
a21d673a8f99
equal deleted inserted replaced
7985:3a1ca2452c30 7986:2971d5d19951
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>
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
480 </dd> 500 </dd>
481 </dl> 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>Returns:</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
519 </dd>
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>)
485 524
486 <p> 525 <p>
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>
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