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

changeset 5623
f4d7cfdadc3f
parent 5291
e93d14b48c34
equal deleted inserted replaced
5622:c4806baecec6 5623:f4d7cfdadc3f
73 <td>Private method to create an entry in the result list.</td> 73 <td>Private method to create an entry in the result list.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td> 75 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td>
76 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td> 76 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td>
79 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td>
80 </tr><tr>
78 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td> 81 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
79 <td>Private method to get the applicable eol string.</td> 82 <td>Private method to get the applicable eol string.</td>
80 </tr><tr> 83 </tr><tr>
81 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td> 84 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
82 <td>Private method to extract all selected items for fixable issues.</td> 85 <td>Private method to extract all selected items for fixable issues.</td>
83 </tr><tr> 86 </tr><tr>
84 <td><a href="#CodeStyleCheckerDialog.__getSelectedFutureImports">__getSelectedFutureImports</a></td> 87 <td><a href="#CodeStyleCheckerDialog.__getSelectedFutureImports">__getSelectedFutureImports</a></td>
85 <td>Private method to get the expected future imports.</td> 88 <td>Private method to get the expected future imports.</td>
86 </tr><tr> 89 </tr><tr>
90 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td>
91 <td>Private method to populate the list of shadowed builtins to be ignored.</td>
92 </tr><tr>
87 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td> 93 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
88 <td>Private method to set the selected status of the future imports.</td> 94 <td>Private method to set the selected status of the future imports.</td>
89 </tr><tr> 95 </tr><tr>
90 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td> 96 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td>
91 <td>Private method to check, if an item has a fixable issue.</td> 97 <td>Private method to check, if an item has a fixable issue.</td>
121 <td>Public method to start a style check for one file.</td> 127 <td>Public method to start a style check for one file.</td>
122 </tr><tr> 128 </tr><tr>
123 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td> 129 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td>
124 <td>Public method to start a style check batch job.</td> 130 <td>Public method to start a style check batch job.</td>
125 </tr><tr> 131 </tr><tr>
132 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td>
133 <td>Private slot to add a built-in assignment to be ignored.</td>
134 </tr><tr>
135 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td>
136 <td>Private slot to react upon changes of the selected builtin assignments.</td>
137 </tr><tr>
126 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 138 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
127 <td>Private slot called by a button of the button box clicked.</td> 139 <td>Private slot called by a button of the button box clicked.</td>
140 </tr><tr>
141 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td>
142 <td>Private slot to delete the selected items from the list.</td>
128 </tr><tr> 143 </tr><tr>
129 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td> 144 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
130 <td>Private slot to select the message codes to be excluded via a selection dialog.</td> 145 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
131 </tr><tr> 146 </tr><tr>
132 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td> 147 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
257 <h4>CodeStyleCheckerDialog.__finish</h4> 272 <h4>CodeStyleCheckerDialog.__finish</h4>
258 <b>__finish</b>(<i></i>) 273 <b>__finish</b>(<i></i>)
259 <p> 274 <p>
260 Private slot called when the code style check finished or the user 275 Private slot called when the code style check finished or the user
261 pressed the cancel button. 276 pressed the cancel button.
262 </p><a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a> 277 </p><a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a>
278 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4>
279 <b>__getBuiltinsIgnoreList</b>(<i></i>)
280 <p>
281 Private method to get a dictionary containing the builtins assignments
282 to be ignored.
283 </p><dl>
284 <dt>Returns:</dt>
285 <dd>
286 dictionary containing the builtins assignments to be ignored
287 </dd>
288 </dl><dl>
289 <dt>Return Type:</dt>
290 <dd>
291 dict of list of str
292 </dd>
293 </dl><a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
263 <h4>CodeStyleCheckerDialog.__getEol</h4> 294 <h4>CodeStyleCheckerDialog.__getEol</h4>
264 <b>__getEol</b>(<i>fn</i>) 295 <b>__getEol</b>(<i>fn</i>)
265 <p> 296 <p>
266 Private method to get the applicable eol string. 297 Private method to get the applicable eol string.
267 </p><dl> 298 </p><dl>
296 </dd> 327 </dd>
297 </dl><dl> 328 </dl><dl>
298 <dt>Return Type:</dt> 329 <dt>Return Type:</dt>
299 <dd> 330 <dd>
300 str 331 str
332 </dd>
333 </dl><a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a>
334 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4>
335 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>)
336 <p>
337 Private method to populate the list of shadowed builtins to be ignored.
338 </p><dl>
339 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt>
340 <dd>
341 dictionary containing the builtins
342 assignments to be ignored
301 </dd> 343 </dd>
302 </dl><a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a> 344 </dl><a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
303 <h4>CodeStyleCheckerDialog.__initFuturesList</h4> 345 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
304 <b>__initFuturesList</b>(<i>selectedFutures</i>) 346 <b>__initFuturesList</b>(<i>selectedFutures</i>)
305 <p> 347 <p>
462 <b>checkBatch</b>(<i></i>) 504 <b>checkBatch</b>(<i></i>)
463 <p> 505 <p>
464 Public method to start a style check batch job. 506 Public method to start a style check batch job.
465 </p><p> 507 </p><p>
466 The results are reported to the __processResult slot. 508 The results are reported to the __processResult slot.
509 </p><a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a>
510 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4>
511 <b>on_addBuiltinButton_clicked</b>(<i></i>)
512 <p>
513 Private slot to add a built-in assignment to be ignored.
514 </p><a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
515 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
516 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
517 <p>
518 Private slot to react upon changes of the selected builtin assignments.
467 </p><a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a> 519 </p><a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a>
468 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4> 520 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4>
469 <b>on_buttonBox_clicked</b>(<i>button</i>) 521 <b>on_buttonBox_clicked</b>(<i>button</i>)
470 <p> 522 <p>
471 Private slot called by a button of the button box clicked. 523 Private slot called by a button of the button box clicked.
472 </p><dl> 524 </p><dl>
473 <dt><i>button</i></dt> 525 <dt><i>button</i></dt>
474 <dd> 526 <dd>
475 button that was clicked (QAbstractButton) 527 button that was clicked (QAbstractButton)
476 </dd> 528 </dd>
477 </dl><a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a> 529 </dl><a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
530 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4>
531 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
532 <p>
533 Private slot to delete the selected items from the list.
534 </p><a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
478 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4> 535 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
479 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>) 536 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
480 <p> 537 <p>
481 Private slot to select the message codes to be excluded via a 538 Private slot to select the message codes to be excluded via a
482 selection dialog. 539 selection dialog.

eric ide

mercurial