Mercurial Repositories > eric / file comparison

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

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

changeset 7609
d5aff4fd0ef8
parent 7602
44998fccbf6f
child 7610
df7025fe26a3
equal deleted inserted replaced
7606:a3a4760b59ec 7609:d5aff4fd0ef8
55 <h3>Derived from</h3> 55 <h3>Derived from</h3>
56 QDialog, Ui_CodeStyleCheckerDialog 56 QDialog, Ui_CodeStyleCheckerDialog
57 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58 58
59 <table> 59 <table>
60 <tr><td>availableFutures</td></tr><tr><td>codeRole</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> 60 <tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</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>
61 </table> 61 </table>
62 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63 63
64 <table> 64 <table>
65 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
71 <tr> 71 <tr>
72 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td> 72 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td>
73 <td>Constructor</td> 73 <td>Constructor</td>
74 </tr> 74 </tr>
75 <tr> 75 <tr>
76 <td><a href="#CodeStyleCheckerDialog.__assembleExcludeMessages">__assembleExcludeMessages</a></td>
77 <td>Private method to assemble the list of excluded checks.</td>
78 </tr>
79 <tr>
76 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td> 80 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
77 <td>Private slot handling the completion of a batch job.</td> 81 <td>Private slot handling the completion of a batch job.</td>
78 </tr> 82 </tr>
79 <tr> 83 <tr>
84 <td><a href="#CodeStyleCheckerDialog.__cleanupData">__cleanupData</a></td>
85 <td>Private method to clean the loaded/entered data of redundant entries.</td>
86 </tr>
87 <tr>
80 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td> 88 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
81 <td>Private method to clear all warning markers of open editors to be checked.</td> 89 <td>Private method to clear all warning markers of open editors to be checked.</td>
82 </tr> 90 </tr>
83 <tr> 91 <tr>
84 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td> 92 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td>
95 <tr> 103 <tr>
96 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td> 104 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td>
97 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td> 105 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td>
98 </tr> 106 </tr>
99 <tr> 107 <tr>
108 <td><a href="#CodeStyleCheckerDialog.__getCategories">__getCategories</a></td>
109 <td>Private method to get the enabled or disabled checker categories.</td>
110 </tr>
111 <tr>
100 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td> 112 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
101 <td>Private method to get the applicable eol string.</td> 113 <td>Private method to get the applicable eol string.</td>
102 </tr> 114 </tr>
103 <tr> 115 <tr>
104 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td> 116 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
109 <td>Private method to get the expected future imports.</td> 121 <td>Private method to get the expected future imports.</td>
110 </tr> 122 </tr>
111 <tr> 123 <tr>
112 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td> 124 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td>
113 <td>Private method to populate the list of shadowed builtins to be ignored.</td> 125 <td>Private method to populate the list of shadowed builtins to be ignored.</td>
126 </tr>
127 <tr>
128 <td><a href="#CodeStyleCheckerDialog.__initCategoriesList">__initCategoriesList</a></td>
129 <td>Private method to set the enabled status of the checker categories.</td>
114 </tr> 130 </tr>
115 <tr> 131 <tr>
116 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td> 132 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
117 <td>Private method to set the selected status of the future imports.</td> 133 <td>Private method to set the selected status of the future imports.</td>
118 </tr> 134 </tr>
258 <p> 274 <p>
259 Constructor 275 Constructor
260 </p> 276 </p>
261 <dl> 277 <dl>
262 278
263 <dt><i>styleCheckService</i></dt> 279 <dt><i>styleCheckService</i> (CodeStyleCheckService)</dt>
264 <dd> 280 <dd>
265 reference to the service 281 reference to the service
266 (CodeStyleCheckService) 282 </dd>
267 </dd> 283 <dt><i>parent</i> (QWidget)</dt>
268 <dt><i>parent</i></dt> 284 <dd>
269 <dd> 285 reference to the parent widget
270 reference to the parent widget (QWidget) 286 </dd>
287 </dl>
288 <a NAME="CodeStyleCheckerDialog.__assembleExcludeMessages" ID="CodeStyleCheckerDialog.__assembleExcludeMessages"></a>
289 <h4>CodeStyleCheckerDialog.__assembleExcludeMessages</h4>
290 <b>__assembleExcludeMessages</b>(<i></i>)
291
292 <p>
293 Private method to assemble the list of excluded checks.
294 </p>
295 <dl>
296 <dt>Returns:</dt>
297 <dd>
298 list of excluded checks as a comma separated string.
299 </dd>
300 </dl>
301 <dl>
302 <dt>Return Type:</dt>
303 <dd>
304 str
271 </dd> 305 </dd>
272 </dl> 306 </dl>
273 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a> 307 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
274 <h4>CodeStyleCheckerDialog.__batchFinished</h4> 308 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
275 <b>__batchFinished</b>(<i></i>) 309 <b>__batchFinished</b>(<i></i>)
276 310
277 <p> 311 <p>
278 Private slot handling the completion of a batch job. 312 Private slot handling the completion of a batch job.
279 </p> 313 </p>
314 <a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a>
315 <h4>CodeStyleCheckerDialog.__cleanupData</h4>
316 <b>__cleanupData</b>(<i></i>)
317
318 <p>
319 Private method to clean the loaded/entered data of redundant entries.
320 </p>
280 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a> 321 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
281 <h4>CodeStyleCheckerDialog.__clearErrors</h4> 322 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
282 <b>__clearErrors</b>(<i>files</i>) 323 <b>__clearErrors</b>(<i>files</i>)
283 324
284 <p> 325 <p>
285 Private method to clear all warning markers of open editors to be 326 Private method to clear all warning markers of open editors to be
286 checked. 327 checked.
287 </p> 328 </p>
288 <dl> 329 <dl>
289 330
290 <dt><i>files</i></dt> 331 <dt><i>files</i> (list of str)</dt>
291 <dd> 332 <dd>
292 list of files to be checked (list of string) 333 list of files to be checked
293 </dd> 334 </dd>
294 </dl> 335 </dl>
295 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a> 336 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
296 <h4>CodeStyleCheckerDialog.__createErrorItem</h4> 337 <h4>CodeStyleCheckerDialog.__createErrorItem</h4>
297 <b>__createErrorItem</b>(<i>filename, message</i>) 338 <b>__createErrorItem</b>(<i>filename, message</i>)
317 <p> 358 <p>
318 Private method to create an entry in the result list. 359 Private method to create an entry in the result list.
319 </p> 360 </p>
320 <dl> 361 <dl>
321 362
322 <dt><i>filename</i></dt> 363 <dt><i>filename</i> (str)</dt>
323 <dd> 364 <dd>
324 file name of the file (string) 365 file name of the file
325 </dd> 366 </dd>
326 <dt><i>line</i></dt> 367 <dt><i>line</i> (int or str)</dt>
327 <dd> 368 <dd>
328 line number of issue (integer or string) 369 line number of issue
329 </dd> 370 </dd>
330 <dt><i>pos</i></dt> 371 <dt><i>pos</i> (int or str)</dt>
331 <dd> 372 <dd>
332 character position of issue (integer or string) 373 character position of issue
333 </dd> 374 </dd>
334 <dt><i>message</i></dt> 375 <dt><i>message</i> (str)</dt>
335 <dd> 376 <dd>
336 message text (string) 377 message text
337 </dd> 378 </dd>
338 <dt><i>fixed</i></dt> 379 <dt><i>fixed</i> (bool)</dt>
339 <dd> 380 <dd>
340 flag indicating a fixed issue (boolean) 381 flag indicating a fixed issue
341 </dd> 382 </dd>
342 <dt><i>autofixing</i></dt> 383 <dt><i>autofixing</i> (bool)</dt>
343 <dd> 384 <dd>
344 flag indicating, that we are fixing issues 385 flag indicating, that we are fixing issues
345 automatically (boolean) 386 automatically
346 </dd> 387 </dd>
347 <dt><i>ignored</i></dt> 388 <dt><i>ignored</i> (bool)</dt>
348 <dd> 389 <dd>
349 flag indicating an ignored issue (boolean) 390 flag indicating an ignored issue
350 </dd> 391 </dd>
351 </dl> 392 </dl>
352 <dl> 393 <dl>
353 <dt>Returns:</dt> 394 <dt>Returns:</dt>
354 <dd> 395 <dd>
355 reference to the created item (QTreeWidgetItem) 396 reference to the created item
397 </dd>
398 </dl>
399 <dl>
400 <dt>Return Type:</dt>
401 <dd>
402 QTreeWidgetItem
356 </dd> 403 </dd>
357 </dl> 404 </dl>
358 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a> 405 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
359 <h4>CodeStyleCheckerDialog.__finish</h4> 406 <h4>CodeStyleCheckerDialog.__finish</h4>
360 <b>__finish</b>(<i></i>) 407 <b>__finish</b>(<i></i>)
381 <dt>Return Type:</dt> 428 <dt>Return Type:</dt>
382 <dd> 429 <dd>
383 dict of list of str 430 dict of list of str
384 </dd> 431 </dd>
385 </dl> 432 </dl>
433 <a NAME="CodeStyleCheckerDialog.__getCategories" ID="CodeStyleCheckerDialog.__getCategories"></a>
434 <h4>CodeStyleCheckerDialog.__getCategories</h4>
435 <b>__getCategories</b>(<i>enabled, asList=False</i>)
436
437 <p>
438 Private method to get the enabled or disabled checker categories.
439 </p>
440 <dl>
441
442 <dt><i>enabled</i> (bool)</dt>
443 <dd>
444 flag indicating to return enabled categories
445 </dd>
446 <dt><i>asList</i> (bool)</dt>
447 <dd>
448 flag indicating to return the checker categories as a
449 Python list
450 </dd>
451 </dl>
452 <dl>
453 <dt>Returns:</dt>
454 <dd>
455 checker categories as a list or comma separated string
456 </dd>
457 </dl>
458 <dl>
459 <dt>Return Type:</dt>
460 <dd>
461 str or list of str
462 </dd>
463 </dl>
386 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a> 464 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
387 <h4>CodeStyleCheckerDialog.__getEol</h4> 465 <h4>CodeStyleCheckerDialog.__getEol</h4>
388 <b>__getEol</b>(<i>fn</i>) 466 <b>__getEol</b>(<i>fn</i>)
389 467
390 <p> 468 <p>
391 Private method to get the applicable eol string. 469 Private method to get the applicable eol string.
392 </p> 470 </p>
393 <dl> 471 <dl>
394 472
395 <dt><i>fn</i></dt> 473 <dt><i>fn</i> (str)</dt>
396 <dd> 474 <dd>
397 filename where to determine the line ending (str) 475 filename where to determine the line ending
398 </dd> 476 </dd>
399 </dl> 477 </dl>
400 <dl> 478 <dl>
401 <dt>Returns:</dt> 479 <dt>Returns:</dt>
402 <dd> 480 <dd>
403 eol string (string) 481 eol string
482 </dd>
483 </dl>
484 <dl>
485 <dt>Return Type:</dt>
486 <dd>
487 str
404 </dd> 488 </dd>
405 </dl> 489 </dl>
406 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a> 490 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
407 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4> 491 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4>
408 <b>__getSelectedFixableItems</b>(<i></i>) 492 <b>__getSelectedFixableItems</b>(<i></i>)
411 Private method to extract all selected items for fixable issues. 495 Private method to extract all selected items for fixable issues.
412 </p> 496 </p>
413 <dl> 497 <dl>
414 <dt>Returns:</dt> 498 <dt>Returns:</dt>
415 <dd> 499 <dd>
416 selected items for fixable issues (list of QTreeWidgetItem) 500 selected items for fixable issues
501 </dd>
502 </dl>
503 <dl>
504 <dt>Return Type:</dt>
505 <dd>
506 list of QTreeWidgetItem
417 </dd> 507 </dd>
418 </dl> 508 </dl>
419 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a> 509 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a>
420 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4> 510 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4>
421 <b>__getSelectedFutureImports</b>(<i></i>) 511 <b>__getSelectedFutureImports</b>(<i></i>)
448 <dd> 538 <dd>
449 dictionary containing the builtins 539 dictionary containing the builtins
450 assignments to be ignored 540 assignments to be ignored
451 </dd> 541 </dd>
452 </dl> 542 </dl>
543 <a NAME="CodeStyleCheckerDialog.__initCategoriesList" ID="CodeStyleCheckerDialog.__initCategoriesList"></a>
544 <h4>CodeStyleCheckerDialog.__initCategoriesList</h4>
545 <b>__initCategoriesList</b>(<i>enabledCategories</i>)
546
547 <p>
548 Private method to set the enabled status of the checker categories.
549 </p>
550 <dl>
551
552 <dt><i>enabledCategories</i> (str)</dt>
553 <dd>
554 comma separated list of enabled checker
555 categories
556 </dd>
557 </dl>
453 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a> 558 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
454 <h4>CodeStyleCheckerDialog.__initFuturesList</h4> 559 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
455 <b>__initFuturesList</b>(<i>selectedFutures</i>) 560 <b>__initFuturesList</b>(<i>selectedFutures</i>)
456 561
457 <p> 562 <p>
471 <p> 576 <p>
472 Private method to check, if an item has a fixable issue. 577 Private method to check, if an item has a fixable issue.
473 </p> 578 </p>
474 <dl> 579 <dl>
475 580
476 <dt><i>itm</i></dt> 581 <dt><i>itm</i> (QTreeWidgetItem)</dt>
477 <dd> 582 <dd>
478 item to be checked (QTreeWidgetItem) 583 item to be checked
479 </dd> 584 </dd>
480 </dl> 585 </dl>
481 <dl> 586 <dl>
482 <dt>Returns:</dt> 587 <dt>Returns:</dt>
483 <dd> 588 <dd>
484 flag indicating a fixable issue (boolean) 589 flag indicating a fixable issue
590 </dd>
591 </dl>
592 <dl>
593 <dt>Return Type:</dt>
594 <dd>
595 bool
485 </dd> 596 </dd>
486 </dl> 597 </dl>
487 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a> 598 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
488 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4> 599 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
489 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>) 600 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>)
492 Private method to modify a result list entry to show its 603 Private method to modify a result list entry to show its
493 positive fixed state. 604 positive fixed state.
494 </p> 605 </p>
495 <dl> 606 <dl>
496 607
497 <dt><i>itm</i></dt> 608 <dt><i>itm</i> (QTreeWidgetItem)</dt>
498 <dd> 609 <dd>
499 reference to the item to modify (QTreeWidgetItem) 610 reference to the item to modify
500 </dd> 611 </dd>
501 <dt><i>text</i></dt> 612 <dt><i>text</i> (str)</dt>
502 <dd> 613 <dd>
503 text to be appended (string) 614 text to be appended
504 </dd> 615 </dd>
505 <dt><i>fixed</i></dt> 616 <dt><i>fixed</i> (bool)</dt>
506 <dd> 617 <dd>
507 flag indicating a fixed issue (boolean) 618 flag indicating a fixed issue
508 </dd> 619 </dd>
509 </dl> 620 </dl>
510 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a> 621 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
511 <h4>CodeStyleCheckerDialog.__modifyOptions</h4> 622 <h4>CodeStyleCheckerDialog.__modifyOptions</h4>
512 <b>__modifyOptions</b>(<i>source</i>) 623 <b>__modifyOptions</b>(<i>source</i>)
519 at the end of the source in order to extend the list of excluded 630 at the end of the source in order to extend the list of excluded
520 messages for one file only. 631 messages for one file only.
521 </p> 632 </p>
522 <dl> 633 <dl>
523 634
524 <dt><i>source</i></dt> 635 <dt><i>source</i> (list of str or str)</dt>
525 <dd> 636 <dd>
526 source text (list of str or str) 637 source text
527 </dd> 638 </dd>
528 </dl> 639 </dl>
529 <dl> 640 <dl>
530 <dt>Returns:</dt> 641 <dt>Returns:</dt>
531 <dd> 642 <dd>
532 list of checker options 643 list of checker options
644 </dd>
645 </dl>
646 <dl>
647 <dt>Return Type:</dt>
648 <dd>
649 list
533 </dd> 650 </dd>
534 </dl> 651 </dl>
535 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a> 652 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
536 <h4>CodeStyleCheckerDialog.__processError</h4> 653 <h4>CodeStyleCheckerDialog.__processError</h4>
537 <b>__processError</b>(<i>fn, msg</i>) 654 <b>__processError</b>(<i>fn, msg</i>)
557 <p> 674 <p>
558 Private slot called after perfoming a style check on one file. 675 Private slot called after perfoming a style check on one file.
559 </p> 676 </p>
560 <dl> 677 <dl>
561 678
562 <dt><i>fn</i></dt> 679 <dt><i>fn</i> (str)</dt>
563 <dd> 680 <dd>
564 filename of the just checked file (str) 681 filename of the just checked file
565 </dd> 682 </dd>
566 <dt><i>codeStyleCheckerStats</i></dt> 683 <dt><i>codeStyleCheckerStats</i> (dict)</dt>
567 <dd> 684 <dd>
568 stats of style and name check (dict) 685 stats of style and name check
569 </dd> 686 </dd>
570 <dt><i>fixes</i></dt> 687 <dt><i>fixes</i> (int)</dt>
571 <dd> 688 <dd>
572 number of applied fixes (int) 689 number of applied fixes
573 </dd> 690 </dd>
574 <dt><i>results</i></dt> 691 <dt><i>results</i> (tuplt of tuple of (int, int, str, bool, bool, bool))</dt>
575 <dd> 692 <dd>
576 tuple for each found violation of style (tuple of 693 tuple for each found violation of style (tuple of
577 lineno (int), position (int), text (str), ignored (bool), 694 lineno, position, text, ignored, fixed, autofixing)
578 fixed (bool), autofixing (bool))
579 </dd> 695 </dd>
580 </dl> 696 </dl>
581 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> 697 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
582 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> 698 <h4>CodeStyleCheckerDialog.__resetStatistics</h4>
583 <b>__resetStatistics</b>(<i></i>) 699 <b>__resetStatistics</b>(<i></i>)
592 <p> 708 <p>
593 Private method to resort the tree. 709 Private method to resort the tree.
594 </p> 710 </p>
595 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a> 711 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
596 <h4>CodeStyleCheckerDialog.__selectCodes</h4> 712 <h4>CodeStyleCheckerDialog.__selectCodes</h4>
597 <b>__selectCodes</b>(<i>edit, showFixCodes</i>) 713 <b>__selectCodes</b>(<i>edit, categories, showFixCodes</i>)
598 714
599 <p> 715 <p>
600 Private method to select message codes via a selection dialog. 716 Private method to select message codes via a selection dialog.
601 </p> 717 </p>
602 <dl> 718 <dl>
603 719
604 <dt><i>edit</i></dt> 720 <dt><i>edit</i> (QLineEdit)</dt>
605 <dd> 721 <dd>
606 reference of the line edit to be populated (QLineEdit) 722 reference of the line edit to be populated
607 </dd> 723 </dd>
608 <dt><i>showFixCodes</i></dt> 724 <dt><i>categories</i> (list of str)</dt>
725 <dd>
726 list of message categories to omit
727 </dd>
728 <dt><i>showFixCodes</i> (bool)</dt>
609 <dd> 729 <dd>
610 flag indicating to show a list of fixable 730 flag indicating to show a list of fixable
611 issues (boolean) 731 issues
612 </dd> 732 </dd>
613 </dl> 733 </dl>
614 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a> 734 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
615 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4> 735 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4>
616 <b>__updateFixerStatistics</b>(<i>fixer</i>) 736 <b>__updateFixerStatistics</b>(<i>fixer</i>)
618 <p> 738 <p>
619 Private method to update the collected fixer related statistics. 739 Private method to update the collected fixer related statistics.
620 </p> 740 </p>
621 <dl> 741 <dl>
622 742
623 <dt><i>fixer</i></dt> 743 <dt><i>fixer</i> (CodeStyleFixer)</dt>
624 <dd> 744 <dd>
625 reference to the code style fixer (CodeStyleFixer) 745 reference to the code style fixer
626 </dd> 746 </dd>
627 </dl> 747 </dl>
628 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a> 748 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
629 <h4>CodeStyleCheckerDialog.__updateStatistics</h4> 749 <h4>CodeStyleCheckerDialog.__updateStatistics</h4>
630 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>) 750 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>)
632 <p> 752 <p>
633 Private method to update the collected statistics. 753 Private method to update the collected statistics.
634 </p> 754 </p>
635 <dl> 755 <dl>
636 756
637 <dt><i>statistics</i></dt> 757 <dt><i>statistics</i> (dict)</dt>
638 <dd> 758 <dd>
639 dictionary of statistical data with 759 dictionary of statistical data with
640 message code as key and message count as value 760 message code as key and message count as value
641 </dd> 761 </dd>
642 <dt><i>fixer</i></dt> 762 <dt><i>fixer</i> (CodeStyleFixer)</dt>
643 <dd> 763 <dd>
644 reference to the code style fixer (CodeStyleFixer) 764 reference to the code style fixer
645 </dd> 765 </dd>
646 <dt><i>ignoredErrors</i></dt> 766 <dt><i>ignoredErrors</i> (int)</dt>
647 <dd> 767 <dd>
648 number of ignored errors (integer) 768 number of ignored errors
649 </dd> 769 </dd>
650 </dl> 770 </dl>
651 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a> 771 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
652 <h4>CodeStyleCheckerDialog.check</h4> 772 <h4>CodeStyleCheckerDialog.check</h4>
653 <b>check</b>(<i>codestring=''</i>) 773 <b>check</b>(<i>codestring=''</i>)
658 <p> 778 <p>
659 The results are reported to the __processResult slot. 779 The results are reported to the __processResult slot.
660 </p> 780 </p>
661 <dl> 781 <dl>
662 782
663 <dt><i>codestring=</i></dt> 783 <dt><i>codestring</i> (str)</dt>
664 <dd> 784 <dd>
665 optional sourcestring (str) 785 optional sourcestring
666 </dd> 786 </dd>
667 </dl> 787 </dl>
668 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a> 788 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
669 <h4>CodeStyleCheckerDialog.checkBatch</h4> 789 <h4>CodeStyleCheckerDialog.checkBatch</h4>
670 <b>checkBatch</b>(<i></i>) 790 <b>checkBatch</b>(<i></i>)
696 <p> 816 <p>
697 Private slot called by a button of the button box clicked. 817 Private slot called by a button of the button box clicked.
698 </p> 818 </p>
699 <dl> 819 <dl>
700 820
701 <dt><i>button</i></dt> 821 <dt><i>button</i> (QAbstractButton)</dt>
702 <dd> 822 <dd>
703 button that was clicked (QAbstractButton) 823 button that was clicked
704 </dd> 824 </dd>
705 </dl> 825 </dl>
706 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a> 826 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
707 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4> 827 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4>
708 <b>on_deleteBuiltinButton_clicked</b>(<i></i>) 828 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
725 <p> 845 <p>
726 Private slot to fix selected issues. 846 Private slot to fix selected issues.
727 </p> 847 </p>
728 <p> 848 <p>
729 Build a dictionary of issues to fix. Update the initialized __options. 849 Build a dictionary of issues to fix. Update the initialized __options.
730 Then call check with the dict as keyparam to fix selected issues. 850 Then call check with the dict as keyparam to fix selected issues.
731 </p> 851 </p>
732 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a> 852 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
733 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4> 853 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
734 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>) 854 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
735 855
781 <p> 901 <p>
782 Private slot to handle the activation of an item. 902 Private slot to handle the activation of an item.
783 </p> 903 </p>
784 <dl> 904 <dl>
785 905
786 <dt><i>item</i></dt> 906 <dt><i>item</i> (QTreeWidgetItem)</dt>
787 <dd> 907 <dd>
788 reference to the activated item (QTreeWidgetItem) 908 reference to the activated item
789 </dd> 909 </dd>
790 <dt><i>column</i></dt> 910 <dt><i>column</i> (int)</dt>
791 <dd> 911 <dd>
792 column the item was activated in (integer) 912 column the item was activated in
793 </dd> 913 </dd>
794 </dl> 914 </dl>
795 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a> 915 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
796 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4> 916 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4>
797 <b>on_resultList_itemSelectionChanged</b>(<i></i>) 917 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
835 <p> 955 <p>
836 Public method to prepare the dialog with a list of filenames. 956 Public method to prepare the dialog with a list of filenames.
837 </p> 957 </p>
838 <dl> 958 <dl>
839 959
840 <dt><i>fileList</i></dt> 960 <dt><i>fileList</i> (list of str)</dt>
841 <dd> 961 <dd>
842 list of filenames (list of strings) 962 list of filenames
843 </dd> 963 </dd>
844 <dt><i>project</i></dt> 964 <dt><i>project</i> (Project)</dt>
845 <dd> 965 <dd>
846 reference to the project object (Project) 966 reference to the project object
847 </dd> 967 </dd>
848 </dl> 968 </dl>
849 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a> 969 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
850 <h4>CodeStyleCheckerDialog.start</h4> 970 <h4>CodeStyleCheckerDialog.start</h4>
851 <b>start</b>(<i>fn, save=False, repeat=None</i>) 971 <b>start</b>(<i>fn, save=False, repeat=None</i>)
853 <p> 973 <p>
854 Public slot to start the code style check. 974 Public slot to start the code style check.
855 </p> 975 </p>
856 <dl> 976 <dl>
857 977
858 <dt><i>fn</i></dt> 978 <dt><i>fn</i> (str or list of str)</dt>
859 <dd> 979 <dd>
860 file or list of files or directory to be checked 980 file or list of files or directory to be checked
861 (string or list of strings) 981 </dd>
862 </dd> 982 <dt><i>save</i> (bool)</dt>
863 <dt><i>save=</i></dt> 983 <dd>
864 <dd> 984 flag indicating to save the given file/file list/directory
865 flag indicating to save the given 985 </dd>
866 file/file list/directory (boolean) 986 <dt><i>repeat</i> (None or bool)</dt>
867 </dd>
868 <dt><i>repeat=</i></dt>
869 <dd> 987 <dd>
870 state of the repeat check box if it is not None 988 state of the repeat check box if it is not None
871 (None or boolean)
872 </dd> 989 </dd>
873 </dl> 990 </dl>
874 <div align="right"><a href="#top">Up</a></div> 991 <div align="right"><a href="#top">Up</a></div>
875 <hr /> 992 <hr />
876 </body></html> 993 </body></html>

Mercurial Repository: eric

eric ide

mercurial