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 9209
b99e7fd55fd3
parent 8877
548d45c3f571
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1>
10
11 <p>
12 Module implementing a dialog to show the results of the code style check.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td>
25 <td>Class implementing a dialog to show the results of the code style check.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a>
36 <h2>CodeStyleCheckerDialog</h2>
37
38 <p>
39 Class implementing a dialog to show the results of the code style check.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_CodeStyleCheckerDialog
43 <h3>Class Attributes</h3>
44
45 <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>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#CodeStyleCheckerDialog.__assembleExcludeMessages">__assembleExcludeMessages</a></td>
63 <td>Private method to assemble the list of excluded checks.</td>
64 </tr>
65 <tr>
66 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
67 <td>Private slot handling the completion of a batch job.</td>
68 </tr>
69 <tr>
70 <td><a href="#CodeStyleCheckerDialog.__cleanupData">__cleanupData</a></td>
71 <td>Private method to clean the loaded/entered data of redundant entries.</td>
72 </tr>
73 <tr>
74 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
75 <td>Private method to clear all warning markers of open editors to be checked.</td>
76 </tr>
77 <tr>
78 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td>
79 <td>Private slot to create a new error item in the result list.</td>
80 </tr>
81 <tr>
82 <td><a href="#CodeStyleCheckerDialog.__createFileErrorItem">__createFileErrorItem</a></td>
83 <td>Private method to create an error entry for a given file.</td>
84 </tr>
85 <tr>
86 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td>
87 <td>Private method to create an entry in the result list.</td>
88 </tr>
89 <tr>
90 <td><a href="#CodeStyleCheckerDialog.__defaultStatistics">__defaultStatistics</a></td>
91 <td>Private method to return the default statistics entry.</td>
92 </tr>
93 <tr>
94 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td>
95 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td>
96 </tr>
97 <tr>
98 <td><a href="#CodeStyleCheckerDialog.__getBanRelativeImportsValue">__getBanRelativeImportsValue</a></td>
99 <td>Private method to get the value corresponding the selected button.</td>
100 </tr>
101 <tr>
102 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td>
103 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td>
104 </tr>
105 <tr>
106 <td><a href="#CodeStyleCheckerDialog.__getCategories">__getCategories</a></td>
107 <td>Private method to get the enabled or disabled checker categories.</td>
108 </tr>
109 <tr>
110 <td><a href="#CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList">__getCommentedCodeCheckerWhiteList</a></td>
111 <td>Private method to get the list of commented code whitelist patterns.</td>
112 </tr>
113 <tr>
114 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
115 <td>Private method to get the applicable eol string.</td>
116 </tr>
117 <tr>
118 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
119 <td>Private method to extract all selected items for fixable issues.</td>
120 </tr>
121 <tr>
122 <td><a href="#CodeStyleCheckerDialog.__getSelectedFutureImports">__getSelectedFutureImports</a></td>
123 <td>Private method to get the expected future imports.</td>
124 </tr>
125 <tr>
126 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td>
127 <td>Private method to populate the list of shadowed builtins to be ignored.</td>
128 </tr>
129 <tr>
130 <td><a href="#CodeStyleCheckerDialog.__initCategoriesList">__initCategoriesList</a></td>
131 <td>Private method to set the enabled status of the checker categories.</td>
132 </tr>
133 <tr>
134 <td><a href="#CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList">__initCommentedCodeCheckerWhiteList</a></td>
135 <td>Private method to populate the list of commented code whitelist patterns.</td>
136 </tr>
137 <tr>
138 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
139 <td>Private method to set the selected status of the future imports.</td>
140 </tr>
141 <tr>
142 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td>
143 <td>Private method to check, if an item has a fixable issue.</td>
144 </tr>
145 <tr>
146 <td><a href="#CodeStyleCheckerDialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td>
147 <td>Private method to modify a result list entry to show its positive fixed state.</td>
148 </tr>
149 <tr>
150 <td><a href="#CodeStyleCheckerDialog.__modifyOptions">__modifyOptions</a></td>
151 <td>Private method to modify the options based on eflag: entries.</td>
152 </tr>
153 <tr>
154 <td><a href="#CodeStyleCheckerDialog.__prepareProgress">__prepareProgress</a></td>
155 <td>Private method to prepare the progress tab for the next run.</td>
156 </tr>
157 <tr>
158 <td><a href="#CodeStyleCheckerDialog.__processError">__processError</a></td>
159 <td>Private slot to process an error indication from the service.</td>
160 </tr>
161 <tr>
162 <td><a href="#CodeStyleCheckerDialog.__processResult">__processResult</a></td>
163 <td>Private slot called after perfoming a style check on one file.</td>
164 </tr>
165 <tr>
166 <td><a href="#CodeStyleCheckerDialog.__resetStatistics">__resetStatistics</a></td>
167 <td>Private slot to reset the statistics data.</td>
168 </tr>
169 <tr>
170 <td><a href="#CodeStyleCheckerDialog.__resort">__resort</a></td>
171 <td>Private method to resort the tree.</td>
172 </tr>
173 <tr>
174 <td><a href="#CodeStyleCheckerDialog.__selectCodes">__selectCodes</a></td>
175 <td>Private method to select message codes via a selection dialog.</td>
176 </tr>
177 <tr>
178 <td><a href="#CodeStyleCheckerDialog.__setBanRelativeImports">__setBanRelativeImports</a></td>
179 <td>Private method to set the button according to the ban relative imports setting.</td>
180 </tr>
181 <tr>
182 <td><a href="#CodeStyleCheckerDialog.__updateFixerStatistics">__updateFixerStatistics</a></td>
183 <td>Private method to update the collected fixer related statistics.</td>
184 </tr>
185 <tr>
186 <td><a href="#CodeStyleCheckerDialog.__updateProgress">__updateProgress</a></td>
187 <td>Private method to update the progress tab.</td>
188 </tr>
189 <tr>
190 <td><a href="#CodeStyleCheckerDialog.__updateStatistics">__updateStatistics</a></td>
191 <td>Private method to update the collected statistics.</td>
192 </tr>
193 <tr>
194 <td><a href="#CodeStyleCheckerDialog.check">check</a></td>
195 <td>Public method to start a style check for one file.</td>
196 </tr>
197 <tr>
198 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td>
199 <td>Public method to start a style check batch job.</td>
200 </tr>
201 <tr>
202 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td>
203 <td>Private slot to add a built-in assignment to be ignored.</td>
204 </tr>
205 <tr>
206 <td><a href="#CodeStyleCheckerDialog.on_addWhitelistButton_clicked">on_addWhitelistButton_clicked</a></td>
207 <td>Private slot to add a commented code whitelist pattern.</td>
208 </tr>
209 <tr>
210 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td>
211 <td>Private slot to react upon changes of the selected builtin assignments.</td>
212 </tr>
213 <tr>
214 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
215 <td>Private slot called by a button of the button box clicked.</td>
216 </tr>
217 <tr>
218 <td><a href="#CodeStyleCheckerDialog.on_cancelButton_clicked">on_cancelButton_clicked</a></td>
219 <td>Private slot to handle the "Cancel" button press.</td>
220 </tr>
221 <tr>
222 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td>
223 <td>Private slot to delete the selected items from the list.</td>
224 </tr>
225 <tr>
226 <td><a href="#CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked">on_deleteWhitelistButton_clicked</a></td>
227 <td>Private slot to delete the selected items from the list.</td>
228 </tr>
229 <tr>
230 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
231 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
232 </tr>
233 <tr>
234 <td><a href="#CodeStyleCheckerDialog.on_filterButton_clicked">on_filterButton_clicked</a></td>
235 <td>Private slot to filter the list of messages based on selected message code.</td>
236 </tr>
237 <tr>
238 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
239 <td>Private slot to fix selected issues.</td>
240 </tr>
241 <tr>
242 <td><a href="#CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td>
243 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td>
244 </tr>
245 <tr>
246 <td><a href="#CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td>
247 <td>Private slot to select the message codes to be included via a selection dialog.</td>
248 </tr>
249 <tr>
250 <td><a href="#CodeStyleCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
251 <td>Private slot to load the default configuration values.</td>
252 </tr>
253 <tr>
254 <td><a href="#CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td>
255 <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td>
256 </tr>
257 <tr>
258 <td><a href="#CodeStyleCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td>
259 <td>Private slot to reset the configuration values to their default values.</td>
260 </tr>
261 <tr>
262 <td><a href="#CodeStyleCheckerDialog.on_restartButton_clicked">on_restartButton_clicked</a></td>
263 <td>Private slot to restart a code style check run.</td>
264 </tr>
265 <tr>
266 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
267 <td>Private slot to handle the activation of an item.</td>
268 </tr>
269 <tr>
270 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
271 <td>Private slot to change the dialog state depending on the selection.</td>
272 </tr>
273 <tr>
274 <td><a href="#CodeStyleCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td>
275 <td>Private slot to handle the "Show" button press.</td>
276 </tr>
277 <tr>
278 <td><a href="#CodeStyleCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td>
279 <td>Private slot to start a code style check run.</td>
280 </tr>
281 <tr>
282 <td><a href="#CodeStyleCheckerDialog.on_statisticsButton_clicked">on_statisticsButton_clicked</a></td>
283 <td>Private slot to show the statistics dialog.</td>
284 </tr>
285 <tr>
286 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
287 <td>Private slot to store the current configuration values as default values.</td>
288 </tr>
289 <tr>
290 <td><a href="#CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged">on_whitelistWidget_itemSelectionChanged</a></td>
291 <td>Private slot to react upon changes of the selected whitelist patterns.</td>
292 </tr>
293 <tr>
294 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td>
295 <td>Public method to prepare the dialog with a list of filenames.</td>
296 </tr>
297 <tr>
298 <td><a href="#CodeStyleCheckerDialog.start">start</a></td>
299 <td>Public slot to start the code style check.</td>
300 </tr>
301 </table>
302 <h3>Static Methods</h3>
303
304 <table>
305 <tr><td>None</td></tr>
306 </table>
307
308 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a>
309 <h4>CodeStyleCheckerDialog (Constructor)</h4>
310 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, project=None, parent=None</i>)
311
312 <p>
313 Constructor
314 </p>
315 <dl>
316
317 <dt><i>styleCheckService</i> (CodeStyleCheckService)</dt>
318 <dd>
319 reference to the service
320 </dd>
321 <dt><i>project</i> (Project)</dt>
322 <dd>
323 reference to the project if called on project or project
324 browser level
325 </dd>
326 <dt><i>parent</i> (QWidget)</dt>
327 <dd>
328 reference to the parent widget
329 </dd>
330 </dl>
331 <a NAME="CodeStyleCheckerDialog.__assembleExcludeMessages" ID="CodeStyleCheckerDialog.__assembleExcludeMessages"></a>
332 <h4>CodeStyleCheckerDialog.__assembleExcludeMessages</h4>
333 <b>__assembleExcludeMessages</b>(<i></i>)
334
335 <p>
336 Private method to assemble the list of excluded checks.
337 </p>
338 <dl>
339 <dt>Return:</dt>
340 <dd>
341 list of excluded checks as a comma separated string.
342 </dd>
343 </dl>
344 <dl>
345 <dt>Return Type:</dt>
346 <dd>
347 str
348 </dd>
349 </dl>
350 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
351 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
352 <b>__batchFinished</b>(<i></i>)
353
354 <p>
355 Private slot handling the completion of a batch job.
356 </p>
357 <a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a>
358 <h4>CodeStyleCheckerDialog.__cleanupData</h4>
359 <b>__cleanupData</b>(<i></i>)
360
361 <p>
362 Private method to clean the loaded/entered data of redundant entries.
363 </p>
364 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
365 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
366 <b>__clearErrors</b>(<i>files</i>)
367
368 <p>
369 Private method to clear all warning markers of open editors to be
370 checked.
371 </p>
372 <dl>
373
374 <dt><i>files</i> (list of str)</dt>
375 <dd>
376 list of files to be checked
377 </dd>
378 </dl>
379 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
380 <h4>CodeStyleCheckerDialog.__createErrorItem</h4>
381 <b>__createErrorItem</b>(<i>filename, message</i>)
382
383 <p>
384 Private slot to create a new error item in the result list.
385 </p>
386 <dl>
387
388 <dt><i>filename</i> (str)</dt>
389 <dd>
390 name of the file
391 </dd>
392 <dt><i>message</i> (str)</dt>
393 <dd>
394 error message
395 </dd>
396 </dl>
397 <a NAME="CodeStyleCheckerDialog.__createFileErrorItem" ID="CodeStyleCheckerDialog.__createFileErrorItem"></a>
398 <h4>CodeStyleCheckerDialog.__createFileErrorItem</h4>
399 <b>__createFileErrorItem</b>(<i>filename, message</i>)
400
401 <p>
402 Private method to create an error entry for a given file.
403 </p>
404 <dl>
405
406 <dt><i>filename</i> (str)</dt>
407 <dd>
408 file name of the file
409 </dd>
410 <dt><i>message</i> (str)</dt>
411 <dd>
412 error message text
413 </dd>
414 </dl>
415 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a>
416 <h4>CodeStyleCheckerDialog.__createResultItem</h4>
417 <b>__createResultItem</b>(<i>filename, result</i>)
418
419 <p>
420 Private method to create an entry in the result list.
421 </p>
422 <dl>
423
424 <dt><i>filename</i> (str)</dt>
425 <dd>
426 file name of the file
427 </dd>
428 <dt><i>result</i> (dict)</dt>
429 <dd>
430 dictionary containing check result data
431 </dd>
432 </dl>
433 <dl>
434 <dt>Return:</dt>
435 <dd>
436 reference to the created item
437 </dd>
438 </dl>
439 <dl>
440 <dt>Return Type:</dt>
441 <dd>
442 QTreeWidgetItem
443 </dd>
444 </dl>
445 <a NAME="CodeStyleCheckerDialog.__defaultStatistics" ID="CodeStyleCheckerDialog.__defaultStatistics"></a>
446 <h4>CodeStyleCheckerDialog.__defaultStatistics</h4>
447 <b>__defaultStatistics</b>(<i></i>)
448
449 <p>
450 Private method to return the default statistics entry.
451 </p>
452 <dl>
453 <dt>Return:</dt>
454 <dd>
455 dictionary with default statistics entry
456 </dd>
457 </dl>
458 <dl>
459 <dt>Return Type:</dt>
460 <dd>
461 dict
462 </dd>
463 </dl>
464 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
465 <h4>CodeStyleCheckerDialog.__finish</h4>
466 <b>__finish</b>(<i></i>)
467
468 <p>
469 Private slot called when the code style check finished or the user
470 pressed the cancel button.
471 </p>
472 <a NAME="CodeStyleCheckerDialog.__getBanRelativeImportsValue" ID="CodeStyleCheckerDialog.__getBanRelativeImportsValue"></a>
473 <h4>CodeStyleCheckerDialog.__getBanRelativeImportsValue</h4>
474 <b>__getBanRelativeImportsValue</b>(<i></i>)
475
476 <p>
477 Private method to get the value corresponding the selected button.
478 </p>
479 <dl>
480 <dt>Return:</dt>
481 <dd>
482 value for the BanRelativeImports argument
483 </dd>
484 </dl>
485 <dl>
486 <dt>Return Type:</dt>
487 <dd>
488 str
489 </dd>
490 </dl>
491 <a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a>
492 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4>
493 <b>__getBuiltinsIgnoreList</b>(<i></i>)
494
495 <p>
496 Private method to get a dictionary containing the builtins assignments
497 to be ignored.
498 </p>
499 <dl>
500 <dt>Return:</dt>
501 <dd>
502 dictionary containing the builtins assignments to be ignored
503 </dd>
504 </dl>
505 <dl>
506 <dt>Return Type:</dt>
507 <dd>
508 dict of list of str
509 </dd>
510 </dl>
511 <a NAME="CodeStyleCheckerDialog.__getCategories" ID="CodeStyleCheckerDialog.__getCategories"></a>
512 <h4>CodeStyleCheckerDialog.__getCategories</h4>
513 <b>__getCategories</b>(<i>enabled, asList=False</i>)
514
515 <p>
516 Private method to get the enabled or disabled checker categories.
517 </p>
518 <dl>
519
520 <dt><i>enabled</i> (bool)</dt>
521 <dd>
522 flag indicating to return enabled categories
523 </dd>
524 <dt><i>asList</i> (bool)</dt>
525 <dd>
526 flag indicating to return the checker categories as a
527 Python list
528 </dd>
529 </dl>
530 <dl>
531 <dt>Return:</dt>
532 <dd>
533 checker categories as a list or comma separated string
534 </dd>
535 </dl>
536 <dl>
537 <dt>Return Type:</dt>
538 <dd>
539 str or list of str
540 </dd>
541 </dl>
542 <a NAME="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList"></a>
543 <h4>CodeStyleCheckerDialog.__getCommentedCodeCheckerWhiteList</h4>
544 <b>__getCommentedCodeCheckerWhiteList</b>(<i></i>)
545
546 <p>
547 Private method to get the list of commented code whitelist patterns.
548 </p>
549 <dl>
550 <dt>Return:</dt>
551 <dd>
552 list of commented code whitelist patterns
553 </dd>
554 </dl>
555 <dl>
556 <dt>Return Type:</dt>
557 <dd>
558 list of str
559 </dd>
560 </dl>
561 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
562 <h4>CodeStyleCheckerDialog.__getEol</h4>
563 <b>__getEol</b>(<i>fn</i>)
564
565 <p>
566 Private method to get the applicable eol string.
567 </p>
568 <dl>
569
570 <dt><i>fn</i> (str)</dt>
571 <dd>
572 filename where to determine the line ending
573 </dd>
574 </dl>
575 <dl>
576 <dt>Return:</dt>
577 <dd>
578 eol string
579 </dd>
580 </dl>
581 <dl>
582 <dt>Return Type:</dt>
583 <dd>
584 str
585 </dd>
586 </dl>
587 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
588 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4>
589 <b>__getSelectedFixableItems</b>(<i></i>)
590
591 <p>
592 Private method to extract all selected items for fixable issues.
593 </p>
594 <dl>
595 <dt>Return:</dt>
596 <dd>
597 selected items for fixable issues
598 </dd>
599 </dl>
600 <dl>
601 <dt>Return Type:</dt>
602 <dd>
603 list of QTreeWidgetItem
604 </dd>
605 </dl>
606 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a>
607 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4>
608 <b>__getSelectedFutureImports</b>(<i></i>)
609
610 <p>
611 Private method to get the expected future imports.
612 </p>
613 <dl>
614 <dt>Return:</dt>
615 <dd>
616 expected future imports as a comma separated string
617 </dd>
618 </dl>
619 <dl>
620 <dt>Return Type:</dt>
621 <dd>
622 str
623 </dd>
624 </dl>
625 <a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a>
626 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4>
627 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>)
628
629 <p>
630 Private method to populate the list of shadowed builtins to be ignored.
631 </p>
632 <dl>
633
634 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt>
635 <dd>
636 dictionary containing the builtins
637 assignments to be ignored
638 </dd>
639 </dl>
640 <a NAME="CodeStyleCheckerDialog.__initCategoriesList" ID="CodeStyleCheckerDialog.__initCategoriesList"></a>
641 <h4>CodeStyleCheckerDialog.__initCategoriesList</h4>
642 <b>__initCategoriesList</b>(<i>enabledCategories</i>)
643
644 <p>
645 Private method to set the enabled status of the checker categories.
646 </p>
647 <dl>
648
649 <dt><i>enabledCategories</i> (str)</dt>
650 <dd>
651 comma separated list of enabled checker
652 categories
653 </dd>
654 </dl>
655 <a NAME="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList" ID="CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList"></a>
656 <h4>CodeStyleCheckerDialog.__initCommentedCodeCheckerWhiteList</h4>
657 <b>__initCommentedCodeCheckerWhiteList</b>(<i>whitelist</i>)
658
659 <p>
660 Private method to populate the list of commented code whitelist
661 patterns.
662 </p>
663 <dl>
664
665 <dt><i>whitelist</i> (list of str)</dt>
666 <dd>
667 list of commented code whitelist patterns
668 </dd>
669 </dl>
670 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
671 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
672 <b>__initFuturesList</b>(<i>selectedFutures</i>)
673
674 <p>
675 Private method to set the selected status of the future imports.
676 </p>
677 <dl>
678
679 <dt><i>selectedFutures</i> (str)</dt>
680 <dd>
681 comma separated list of expected future imports
682 </dd>
683 </dl>
684 <a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a>
685 <h4>CodeStyleCheckerDialog.__itemFixable</h4>
686 <b>__itemFixable</b>(<i>itm</i>)
687
688 <p>
689 Private method to check, if an item has a fixable issue.
690 </p>
691 <dl>
692
693 <dt><i>itm</i> (QTreeWidgetItem)</dt>
694 <dd>
695 item to be checked
696 </dd>
697 </dl>
698 <dl>
699 <dt>Return:</dt>
700 <dd>
701 flag indicating a fixable issue
702 </dd>
703 </dl>
704 <dl>
705 <dt>Return Type:</dt>
706 <dd>
707 bool
708 </dd>
709 </dl>
710 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
711 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
712 <b>__modifyFixedResultItem</b>(<i>itm, result</i>)
713
714 <p>
715 Private method to modify a result list entry to show its
716 positive fixed state.
717 </p>
718 <dl>
719
720 <dt><i>itm</i> (QTreeWidgetItem)</dt>
721 <dd>
722 reference to the item to modify
723 </dd>
724 <dt><i>result</i> (dict)</dt>
725 <dd>
726 dictionary containing check result data
727 </dd>
728 </dl>
729 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
730 <h4>CodeStyleCheckerDialog.__modifyOptions</h4>
731 <b>__modifyOptions</b>(<i>source</i>)
732
733 <p>
734 Private method to modify the options based on eflag: entries.
735 </p>
736 <p>
737 This method looks for comment lines like '# eflag: noqa = M601'
738 at the end of the source in order to extend the list of excluded
739 messages for one file only.
740 </p>
741 <dl>
742
743 <dt><i>source</i> (list of str or str)</dt>
744 <dd>
745 source text
746 </dd>
747 </dl>
748 <dl>
749 <dt>Return:</dt>
750 <dd>
751 list of checker options
752 </dd>
753 </dl>
754 <dl>
755 <dt>Return Type:</dt>
756 <dd>
757 list
758 </dd>
759 </dl>
760 <a NAME="CodeStyleCheckerDialog.__prepareProgress" ID="CodeStyleCheckerDialog.__prepareProgress"></a>
761 <h4>CodeStyleCheckerDialog.__prepareProgress</h4>
762 <b>__prepareProgress</b>(<i></i>)
763
764 <p>
765 Private method to prepare the progress tab for the next run.
766 </p>
767 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
768 <h4>CodeStyleCheckerDialog.__processError</h4>
769 <b>__processError</b>(<i>fn, msg</i>)
770
771 <p>
772 Private slot to process an error indication from the service.
773 </p>
774 <dl>
775
776 <dt><i>fn</i> (str)</dt>
777 <dd>
778 filename of the file
779 </dd>
780 <dt><i>msg</i> (str)</dt>
781 <dd>
782 error message
783 </dd>
784 </dl>
785 <a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a>
786 <h4>CodeStyleCheckerDialog.__processResult</h4>
787 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>)
788
789 <p>
790 Private slot called after perfoming a style check on one file.
791 </p>
792 <dl>
793
794 <dt><i>fn</i> (str)</dt>
795 <dd>
796 filename of the just checked file
797 </dd>
798 <dt><i>codeStyleCheckerStats</i> (dict)</dt>
799 <dd>
800 stats of style and name check
801 </dd>
802 <dt><i>fixes</i> (int)</dt>
803 <dd>
804 number of applied fixes
805 </dd>
806 <dt><i>results</i> (dict)</dt>
807 <dd>
808 dictionary containing check result data
809 </dd>
810 </dl>
811 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
812 <h4>CodeStyleCheckerDialog.__resetStatistics</h4>
813 <b>__resetStatistics</b>(<i></i>)
814
815 <p>
816 Private slot to reset the statistics data.
817 </p>
818 <a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a>
819 <h4>CodeStyleCheckerDialog.__resort</h4>
820 <b>__resort</b>(<i></i>)
821
822 <p>
823 Private method to resort the tree.
824 </p>
825 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
826 <h4>CodeStyleCheckerDialog.__selectCodes</h4>
827 <b>__selectCodes</b>(<i>edit, categories, showFixCodes</i>)
828
829 <p>
830 Private method to select message codes via a selection dialog.
831 </p>
832 <dl>
833
834 <dt><i>edit</i> (QLineEdit)</dt>
835 <dd>
836 reference of the line edit to be populated
837 </dd>
838 <dt><i>categories</i> (list of str)</dt>
839 <dd>
840 list of message categories to omit
841 </dd>
842 <dt><i>showFixCodes</i> (bool)</dt>
843 <dd>
844 flag indicating to show a list of fixable
845 issues
846 </dd>
847 </dl>
848 <a NAME="CodeStyleCheckerDialog.__setBanRelativeImports" ID="CodeStyleCheckerDialog.__setBanRelativeImports"></a>
849 <h4>CodeStyleCheckerDialog.__setBanRelativeImports</h4>
850 <b>__setBanRelativeImports</b>(<i>value</i>)
851
852 <p>
853 Private method to set the button according to the ban relative imports
854 setting.
855 </p>
856 <dl>
857
858 <dt><i>value</i> (str)</dt>
859 <dd>
860 value of the ban relative imports setting
861 </dd>
862 </dl>
863 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
864 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4>
865 <b>__updateFixerStatistics</b>(<i>fixer</i>)
866
867 <p>
868 Private method to update the collected fixer related statistics.
869 </p>
870 <dl>
871
872 <dt><i>fixer</i> (CodeStyleFixer)</dt>
873 <dd>
874 reference to the code style fixer
875 </dd>
876 </dl>
877 <a NAME="CodeStyleCheckerDialog.__updateProgress" ID="CodeStyleCheckerDialog.__updateProgress"></a>
878 <h4>CodeStyleCheckerDialog.__updateProgress</h4>
879 <b>__updateProgress</b>(<i>fn</i>)
880
881 <p>
882 Private method to update the progress tab.
883 </p>
884 <dl>
885
886 <dt><i>fn</i> (str)</dt>
887 <dd>
888 filename of the just checked file
889 </dd>
890 </dl>
891 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
892 <h4>CodeStyleCheckerDialog.__updateStatistics</h4>
893 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors, securityOk</i>)
894
895 <p>
896 Private method to update the collected statistics.
897 </p>
898 <dl>
899
900 <dt><i>statistics</i> (dict)</dt>
901 <dd>
902 dictionary of statistical data with
903 message code as key and message count as value
904 </dd>
905 <dt><i>fixer</i> (CodeStyleFixer)</dt>
906 <dd>
907 reference to the code style fixer
908 </dd>
909 <dt><i>ignoredErrors</i> (int)</dt>
910 <dd>
911 number of ignored errors
912 </dd>
913 <dt><i>securityOk</i> (int)</dt>
914 <dd>
915 number of acknowledged security reports
916 </dd>
917 </dl>
918 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
919 <h4>CodeStyleCheckerDialog.check</h4>
920 <b>check</b>(<i>codestring=''</i>)
921
922 <p>
923 Public method to start a style check for one file.
924 </p>
925 <p>
926 The results are reported to the __processResult slot.
927 </p>
928 <dl>
929
930 <dt><i>codestring</i> (str)</dt>
931 <dd>
932 optional sourcestring
933 </dd>
934 </dl>
935 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
936 <h4>CodeStyleCheckerDialog.checkBatch</h4>
937 <b>checkBatch</b>(<i></i>)
938
939 <p>
940 Public method to start a style check batch job.
941 </p>
942 <p>
943 The results are reported to the __processResult slot.
944 </p>
945 <a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a>
946 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4>
947 <b>on_addBuiltinButton_clicked</b>(<i></i>)
948
949 <p>
950 Private slot to add a built-in assignment to be ignored.
951 </p>
952 <a NAME="CodeStyleCheckerDialog.on_addWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_addWhitelistButton_clicked"></a>
953 <h4>CodeStyleCheckerDialog.on_addWhitelistButton_clicked</h4>
954 <b>on_addWhitelistButton_clicked</b>(<i></i>)
955
956 <p>
957 Private slot to add a commented code whitelist pattern.
958 </p>
959 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
960 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
961 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
962
963 <p>
964 Private slot to react upon changes of the selected builtin assignments.
965 </p>
966 <a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a>
967 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4>
968 <b>on_buttonBox_clicked</b>(<i>button</i>)
969
970 <p>
971 Private slot called by a button of the button box clicked.
972 </p>
973 <dl>
974
975 <dt><i>button</i> (QAbstractButton)</dt>
976 <dd>
977 button that was clicked
978 </dd>
979 </dl>
980 <a NAME="CodeStyleCheckerDialog.on_cancelButton_clicked" ID="CodeStyleCheckerDialog.on_cancelButton_clicked"></a>
981 <h4>CodeStyleCheckerDialog.on_cancelButton_clicked</h4>
982 <b>on_cancelButton_clicked</b>(<i></i>)
983
984 <p>
985 Private slot to handle the "Cancel" button press.
986 </p>
987 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
988 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4>
989 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
990
991 <p>
992 Private slot to delete the selected items from the list.
993 </p>
994 <a NAME="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked" ID="CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked"></a>
995 <h4>CodeStyleCheckerDialog.on_deleteWhitelistButton_clicked</h4>
996 <b>on_deleteWhitelistButton_clicked</b>(<i></i>)
997
998 <p>
999 Private slot to delete the selected items from the list.
1000 </p>
1001 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
1002 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
1003 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
1004
1005 <p>
1006 Private slot to select the message codes to be excluded via a
1007 selection dialog.
1008 </p>
1009 <a NAME="CodeStyleCheckerDialog.on_filterButton_clicked" ID="CodeStyleCheckerDialog.on_filterButton_clicked"></a>
1010 <h4>CodeStyleCheckerDialog.on_filterButton_clicked</h4>
1011 <b>on_filterButton_clicked</b>(<i></i>)
1012
1013 <p>
1014 Private slot to filter the list of messages based on selected message
1015 code.
1016 </p>
1017 <a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a>
1018 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4>
1019 <b>on_fixButton_clicked</b>(<i></i>)
1020
1021 <p>
1022 Private slot to fix selected issues.
1023 </p>
1024 <p>
1025 Build a dictionary of issues to fix. Update the initialized __options.
1026 Then call check with the dict as keyparam to fix selected issues.
1027 </p>
1028 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
1029 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
1030 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
1031
1032 <p>
1033 Private slot to select the issue codes to be fixed via a
1034 selection dialog.
1035 </p>
1036 <a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a>
1037 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4>
1038 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>)
1039
1040 <p>
1041 Private slot to select the message codes to be included via a
1042 selection dialog.
1043 </p>
1044 <a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a>
1045 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4>
1046 <b>on_loadDefaultButton_clicked</b>(<i></i>)
1047
1048 <p>
1049 Private slot to load the default configuration values.
1050 </p>
1051 <a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a>
1052 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4>
1053 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
1054
1055 <p>
1056 Private slot to select the issue codes not to be fixed via a
1057 selection dialog.
1058 </p>
1059 <a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a>
1060 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4>
1061 <b>on_resetDefaultButton_clicked</b>(<i></i>)
1062
1063 <p>
1064 Private slot to reset the configuration values to their default values.
1065 </p>
1066 <a NAME="CodeStyleCheckerDialog.on_restartButton_clicked" ID="CodeStyleCheckerDialog.on_restartButton_clicked"></a>
1067 <h4>CodeStyleCheckerDialog.on_restartButton_clicked</h4>
1068 <b>on_restartButton_clicked</b>(<i></i>)
1069
1070 <p>
1071 Private slot to restart a code style check run.
1072 </p>
1073 <a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a>
1074 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4>
1075 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
1076
1077 <p>
1078 Private slot to handle the activation of an item.
1079 </p>
1080 <dl>
1081
1082 <dt><i>item</i> (QTreeWidgetItem)</dt>
1083 <dd>
1084 reference to the activated item
1085 </dd>
1086 <dt><i>column</i> (int)</dt>
1087 <dd>
1088 column the item was activated in
1089 </dd>
1090 </dl>
1091 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
1092 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4>
1093 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
1094
1095 <p>
1096 Private slot to change the dialog state depending on the selection.
1097 </p>
1098 <a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a>
1099 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4>
1100 <b>on_showButton_clicked</b>(<i></i>)
1101
1102 <p>
1103 Private slot to handle the "Show" button press.
1104 </p>
1105 <a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a>
1106 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4>
1107 <b>on_startButton_clicked</b>(<i></i>)
1108
1109 <p>
1110 Private slot to start a code style check run.
1111 </p>
1112 <a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a>
1113 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4>
1114 <b>on_statisticsButton_clicked</b>(<i></i>)
1115
1116 <p>
1117 Private slot to show the statistics dialog.
1118 </p>
1119 <a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a>
1120 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4>
1121 <b>on_storeDefaultButton_clicked</b>(<i></i>)
1122
1123 <p>
1124 Private slot to store the current configuration values as
1125 default values.
1126 </p>
1127 <a NAME="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged"></a>
1128 <h4>CodeStyleCheckerDialog.on_whitelistWidget_itemSelectionChanged</h4>
1129 <b>on_whitelistWidget_itemSelectionChanged</b>(<i></i>)
1130
1131 <p>
1132 Private slot to react upon changes of the selected whitelist patterns.
1133 </p>
1134 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
1135 <h4>CodeStyleCheckerDialog.prepare</h4>
1136 <b>prepare</b>(<i>fileList, project</i>)
1137
1138 <p>
1139 Public method to prepare the dialog with a list of filenames.
1140 </p>
1141 <dl>
1142
1143 <dt><i>fileList</i> (list of str)</dt>
1144 <dd>
1145 list of filenames
1146 </dd>
1147 <dt><i>project</i> (Project)</dt>
1148 <dd>
1149 reference to the project object
1150 </dd>
1151 </dl>
1152 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
1153 <h4>CodeStyleCheckerDialog.start</h4>
1154 <b>start</b>(<i>fn, save=False, repeat=None</i>)
1155
1156 <p>
1157 Public slot to start the code style check.
1158 </p>
1159 <dl>
1160
1161 <dt><i>fn</i> (str or list of str)</dt>
1162 <dd>
1163 file or list of files or directory to be checked
1164 </dd>
1165 <dt><i>save</i> (bool)</dt>
1166 <dd>
1167 flag indicating to save the given file/file list/directory
1168 </dd>
1169 <dt><i>repeat</i> (None or bool)</dt>
1170 <dd>
1171 state of the repeat check box if it is not None
1172 </dd>
1173 </dl>
1174 <div align="right"><a href="#top">Up</a></div>
1175 <hr />
1176 </body></html>

Mercurial Repository: eric

eric ide

mercurial