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

Thu, 22 Oct 2015 19:48:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 22 Oct 2015 19:48:40 +0200
changeset 4503
d68dcbe1deb3
parent 4218
f542ad1f76c5
child 4511
b5e4e7efa904
permissions
-rw-r--r--

Improved the syntax checker, code style checker and indentation checker interfaces.

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 Module implementing a dialog to show the results of the code style check.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Class implementing a dialog to show the results of the code style check.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>CodeStyleCheckerDialog</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 Class implementing a dialog to show the results of the code style check.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 QDialog, Ui_CodeStyleCheckerDialog
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>positionRole</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <h3>Class Methods</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Constructor</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </tr><tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
63 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
64 <td>Private slot handling the completion of a batch job.</td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
65 </tr><tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Private method to clear all warning markers of open editors to be checked.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
69 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
70 <td>Private slot to create a new error item in the result list.</td>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
71 </tr><tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Private method to create an entry in the result list.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <td>Private method to get the applicable eol string.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <td>Private method to extract all selected items for fixable issues.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <td>Private method to check, if an item has a fixable issue.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="#CodeStyleCheckerDialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <td>Private method to modify a result list entry to show its positive fixed state.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </tr><tr>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
90 <td><a href="#CodeStyleCheckerDialog.__processError">__processError</a></td>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
91 <td>Private slot to process an error indication from the service.</td>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
92 </tr><tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <td><a href="#CodeStyleCheckerDialog.__processResult">__processResult</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <td>Private slot called after perfoming a style check on one file.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <td><a href="#CodeStyleCheckerDialog.__resetStatistics">__resetStatistics</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <td>Private slot to reset the statistics data.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <td><a href="#CodeStyleCheckerDialog.__resort">__resort</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <td>Private method to resort the tree.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <td><a href="#CodeStyleCheckerDialog.__selectCodes">__selectCodes</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <td>Private method to select message codes via a selection dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <td><a href="#CodeStyleCheckerDialog.__updateFixerStatistics">__updateFixerStatistics</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <td>Private method to update the collected fixer related statistics.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <td><a href="#CodeStyleCheckerDialog.__updateStatistics">__updateStatistics</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <td>Private method to update the collected statistics.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <td><a href="#CodeStyleCheckerDialog.check">check</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td>Public method to start a style check for one file.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </tr><tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
114 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
115 <td>Public method to start a style check batch job.</td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
116 </tr><tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 <td>Private slot called by a button of the button box clicked.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 <td>Private slot to fix selected issues.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <td><a href="#CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 <td><a href="#CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <td>Private slot to select the message codes to be included via a selection dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <td><a href="#CodeStyleCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 <td>Private slot to load the default configuration values.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <td><a href="#CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 <td><a href="#CodeStyleCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 <td>Private slot to reset the configuration values to their default values.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 <td>Private slot to handle the activation of an item.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
145 <td>Private slot to change the dialog state depending on the selection.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 <td><a href="#CodeStyleCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 <td>Private slot to handle the "Show" button press.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 <td><a href="#CodeStyleCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 <td>Private slot to start a code style check run.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 <td><a href="#CodeStyleCheckerDialog.on_statisticsButton_clicked">on_statisticsButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 <td>Private slot to show the statistics dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 <td>Private slot to store the current configuration values as default values.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 <td>Public method to prepare the dialog with a list of filenames.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161 </tr><tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 <td><a href="#CodeStyleCheckerDialog.start">start</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163 <td>Public slot to start the code style check.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 <h3>Static Methods</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
169 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
170 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 <h4>CodeStyleCheckerDialog (Constructor)</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, parent=None</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 Constructor
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 <dt><i>styleCheckService</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
177 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 reference to the service
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 (CodeStyleCheckService)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 </dd><dt><i>parent</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
182 reference to the parent widget (QWidget)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 </dd>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
184 </dl><a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
185 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
186 <b>__batchFinished</b>(<i></i>)
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
187 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
188 Private slot handling the completion of a batch job.
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
189 </p><a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
190 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 <b>__clearErrors</b>(<i>files</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
193 Private method to clear all warning markers of open editors to be
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194 checked.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 <dt><i>files</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
198 list of files to be checked (list of string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 </dd>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
200 </dl><a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
201 <h4>CodeStyleCheckerDialog.__createErrorItem</h4>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
202 <b>__createErrorItem</b>(<i>filename, message</i>)
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
203 <p>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
204 Private slot to create a new error item in the result list.
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
205 </p><dl>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
206 <dt><i>filename</i> (str)</dt>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
207 <dd>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
208 name of the file
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
209 </dd><dt><i>message</i> (str)</dt>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
210 <dd>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
211 error message
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
212 </dd>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
213 </dl><a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
214 <h4>CodeStyleCheckerDialog.__createResultItem</h4>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
215 <b>__createResultItem</b>(<i>filename, line, pos, message, fixed, autofixing, ignored</i>)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
216 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
217 Private method to create an entry in the result list.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
218 </p><dl>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
219 <dt><i>filename</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
220 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
221 file name of the file (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
222 </dd><dt><i>line</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
224 line number of issue (integer or string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
225 </dd><dt><i>pos</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
226 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 character position of issue (integer or string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
228 </dd><dt><i>message</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
229 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
230 message text (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 </dd><dt><i>fixed</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
232 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
233 flag indicating a fixed issue (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
234 </dd><dt><i>autofixing</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
235 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
236 flag indicating, that we are fixing issues
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
237 automatically (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
238 </dd><dt><i>ignored</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
240 flag indicating an ignored issue (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
241 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
242 </dl><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
243 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
244 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
245 reference to the created item (QTreeWidgetItem)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
246 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
247 </dl><a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
248 <h4>CodeStyleCheckerDialog.__finish</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
249 <b>__finish</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
250 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
251 Private slot called when the code style check finished or the user
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
252 pressed the cancel button.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
253 </p><a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
254 <h4>CodeStyleCheckerDialog.__getEol</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
255 <b>__getEol</b>(<i>fn</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
256 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
257 Private method to get the applicable eol string.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
258 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
259 <dt><i>fn</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
260 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
261 filename where to determine the line ending (str)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
262 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
263 </dl><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
264 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
265 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
266 eol string (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
267 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
268 </dl><a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
269 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
270 <b>__getSelectedFixableItems</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
271 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
272 Private method to extract all selected items for fixable issues.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
273 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
274 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
275 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
276 selected items for fixable issues (list of QTreeWidgetItem)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
277 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
278 </dl><a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
279 <h4>CodeStyleCheckerDialog.__itemFixable</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
280 <b>__itemFixable</b>(<i>itm</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
281 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
282 Private method to check, if an item has a fixable issue.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
283 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
284 <dt><i>itm</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
285 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
286 item to be checked (QTreeWidgetItem)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
288 </dl><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
289 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
290 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 flag indicating a fixable issue (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
292 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
293 </dl><a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
294 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
295 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
296 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
297 Private method to modify a result list entry to show its
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
298 positive fixed state.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
299 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
300 <dt><i>itm</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
301 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
302 reference to the item to modify (QTreeWidgetItem)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
303 </dd><dt><i>text</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
304 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
305 text to be appended (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
306 </dd><dt><i>fixed</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
308 flag indicating a fixed issue (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
309 </dd>
4503
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
310 </dl><a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
311 <h4>CodeStyleCheckerDialog.__processError</h4>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
312 <b>__processError</b>(<i>fn, msg</i>)
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
313 <p>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
314 Private slot to process an error indication from the service.
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
315 </p><dl>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
316 <dt><i>fn</i> (str)</dt>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
317 <dd>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
318 filename of the file
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
319 </dd><dt><i>msg</i> (str)</dt>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
320 <dd>
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
321 error message
d68dcbe1deb3 Improved the syntax checker, code style checker and indentation checker interfaces.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
322 </dd>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
323 </dl><a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
324 <h4>CodeStyleCheckerDialog.__processResult</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
325 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
326 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 Private slot called after perfoming a style check on one file.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
328 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
329 <dt><i>fn</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
330 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 filename of the just checked file (str)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
332 </dd><dt><i>codeStyleCheckerStats</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
333 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
334 stats of style and name check (dict)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
335 </dd><dt><i>fixes</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
336 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
337 number of applied fixes (int)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
338 </dd><dt><i>results</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
339 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
340 tuple for each found violation of style (tuple of
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
341 lineno (int), position (int), text (str), ignored (bool),
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
342 fixed (bool), autofixing (bool))
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
343 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
344 </dl><a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
345 <h4>CodeStyleCheckerDialog.__resetStatistics</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
346 <b>__resetStatistics</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
347 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 Private slot to reset the statistics data.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
349 </p><a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
350 <h4>CodeStyleCheckerDialog.__resort</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <b>__resort</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
353 Private method to resort the tree.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
354 </p><a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
355 <h4>CodeStyleCheckerDialog.__selectCodes</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
356 <b>__selectCodes</b>(<i>edit, showFixCodes</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
357 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
358 Private method to select message codes via a selection dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
359 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
360 <dt><i>edit</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
361 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
362 reference of the line edit to be populated (QLineEdit)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 </dd><dt><i>showFixCodes</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
364 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
365 flag indicating to show a list of fixable
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
366 issues (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
367 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
368 </dl><a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
369 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
370 <b>__updateFixerStatistics</b>(<i>fixer</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
371 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
372 Private method to update the collected fixer related statistics.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
373 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
374 <dt><i>fixer</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
375 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 reference to the code style fixer (CodeStyleFixer)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
377 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
378 </dl><a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 <h4>CodeStyleCheckerDialog.__updateStatistics</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
380 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
381 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
382 Private method to update the collected statistics.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
383 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
384 <dt><i>statistics</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
385 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
386 dictionary of statistical data with
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
387 message code as key and message count as value
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
388 </dd><dt><i>fixer</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
389 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
390 reference to the code style fixer (CodeStyleFixer)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
391 </dd><dt><i>ignoredErrors</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
392 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
393 number of ignored errors (integer)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
394 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
395 </dl><a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 <h4>CodeStyleCheckerDialog.check</h4>
3779
573d5f26bc47 Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
397 <b>check</b>(<i>codestring=''</i>)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
398 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
399 Public method to start a style check for one file.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
400 </p><p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
401 The results are reported to the __processResult slot.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
402 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
403 <dt><i>codestring=</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
404 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
405 optional sourcestring (str)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
406 </dd>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
407 </dl><a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
408 <h4>CodeStyleCheckerDialog.checkBatch</h4>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
409 <b>checkBatch</b>(<i></i>)
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
410 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
411 Public method to start a style check batch job.
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
412 </p><p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
413 The results are reported to the __processResult slot.
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3779
diff changeset
414 </p><a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
415 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
416 <b>on_buttonBox_clicked</b>(<i>button</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
417 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
418 Private slot called by a button of the button box clicked.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
419 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
420 <dt><i>button</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
421 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
422 button that was clicked (QAbstractButton)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
423 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
424 </dl><a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
425 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
426 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
427 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
428 Private slot to select the message codes to be excluded via a
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
429 selection dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
430 </p><a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
431 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
432 <b>on_fixButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
433 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 Private slot to fix selected issues.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
435 </p><p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
436 Build a dictionary of issues to fix. Update the initialized __options.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 Then call check with the dict as keyparam to fix selected issues.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
438 </p><a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
439 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
440 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
441 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
442 Private slot to select the issue codes to be fixed via a
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 selection dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
444 </p><a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
445 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
446 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
448 Private slot to select the message codes to be included via a
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
449 selection dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
450 </p><a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
451 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 <b>on_loadDefaultButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
453 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
454 Private slot to load the default configuration values.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
455 </p><a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
456 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
457 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
459 Private slot to select the issue codes not to be fixed via a
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
460 selection dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
461 </p><a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
462 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
463 <b>on_resetDefaultButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
464 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
465 Private slot to reset the configuration values to their default values.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
466 </p><a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
467 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
468 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
469 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
470 Private slot to handle the activation of an item.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
471 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 <dt><i>item</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
473 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
474 reference to the activated item (QTreeWidgetItem)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
475 </dd><dt><i>column</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
476 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
477 column the item was activated in (integer)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
478 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
479 </dl><a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
480 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
481 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
482 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
483 Private slot to change the dialog state depending on the selection.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
484 </p><a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
485 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
486 <b>on_showButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
487 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
488 Private slot to handle the "Show" button press.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
489 </p><a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
490 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
491 <b>on_startButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
492 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
493 Private slot to start a code style check run.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
494 </p><a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
495 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
496 <b>on_statisticsButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
497 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
498 Private slot to show the statistics dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
499 </p><a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
501 <b>on_storeDefaultButton_clicked</b>(<i></i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
502 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
503 Private slot to store the current configuration values as
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
504 default values.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
505 </p><a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
506 <h4>CodeStyleCheckerDialog.prepare</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
507 <b>prepare</b>(<i>fileList, project</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
508 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
509 Public method to prepare the dialog with a list of filenames.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
510 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
511 <dt><i>fileList</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
512 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
513 list of filenames (list of strings)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
514 </dd><dt><i>project</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
515 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
516 reference to the project object (Project)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
517 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
518 </dl><a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
519 <h4>CodeStyleCheckerDialog.start</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
520 <b>start</b>(<i>fn, save=False, repeat=None</i>)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
521 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
522 Public slot to start the code style check.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
523 </p><dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
524 <dt><i>fn</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
525 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
526 file or list of files or directory to be checked
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
527 (string or list of strings)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
528 </dd><dt><i>save=</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
529 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
530 flag indicating to save the given
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
531 file/file list/directory (boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
532 </dd><dt><i>repeat=</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
533 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
534 state of the repeat check box if it is not None
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
535 (None or boolean)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
536 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
537 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
538 <div align="right"><a href="#top">Up</a></div>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
539 <hr />
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
540 </body></html>

eric ide

mercurial