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 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7602
44998fccbf6f
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1> 23 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show the results of the code style check. 26 Module implementing a dialog to show the results of the code style check.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td> 38 <td><a href="#CodeStyleCheckerDialog">CodeStyleCheckerDialog</a></td>
34 <td>Class implementing a dialog to show the results of the code style check.</td> 39 <td>Class implementing a dialog to show the results of the code style check.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a> 49 <a NAME="CodeStyleCheckerDialog" ID="CodeStyleCheckerDialog"></a>
43 <h2>CodeStyleCheckerDialog</h2> 50 <h2>CodeStyleCheckerDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show the results of the code style check. 53 Class implementing a dialog to show the results of the code style check.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_CodeStyleCheckerDialog 56 QDialog, Ui_CodeStyleCheckerDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <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>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>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td> 72 <td><a href="#CodeStyleCheckerDialog.__init__">CodeStyleCheckerDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td> 76 <td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
64 <td>Private slot handling the completion of a batch job.</td> 77 <td>Private slot handling the completion of a batch job.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td> 80 <td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
67 <td>Private method to clear all warning markers of open editors to be checked.</td> 81 <td>Private method to clear all warning markers of open editors to be checked.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td> 84 <td><a href="#CodeStyleCheckerDialog.__createErrorItem">__createErrorItem</a></td>
70 <td>Private slot to create a new error item in the result list.</td> 85 <td>Private slot to create a new error item in the result list.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td> 88 <td><a href="#CodeStyleCheckerDialog.__createResultItem">__createResultItem</a></td>
73 <td>Private method to create an entry in the result list.</td> 89 <td>Private method to create an entry in the result list.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td> 92 <td><a href="#CodeStyleCheckerDialog.__finish">__finish</a></td>
76 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td> 93 <td>Private slot called when the code style check finished or the user pressed the cancel button.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td> 96 <td><a href="#CodeStyleCheckerDialog.__getBuiltinsIgnoreList">__getBuiltinsIgnoreList</a></td>
79 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td> 97 <td>Private method to get a dictionary containing the builtins assignments to be ignored.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td> 100 <td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
82 <td>Private method to get the applicable eol string.</td> 101 <td>Private method to get the applicable eol string.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td> 104 <td><a href="#CodeStyleCheckerDialog.__getSelectedFixableItems">__getSelectedFixableItems</a></td>
85 <td>Private method to extract all selected items for fixable issues.</td> 105 <td>Private method to extract all selected items for fixable issues.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#CodeStyleCheckerDialog.__getSelectedFutureImports">__getSelectedFutureImports</a></td> 108 <td><a href="#CodeStyleCheckerDialog.__getSelectedFutureImports">__getSelectedFutureImports</a></td>
88 <td>Private method to get the expected future imports.</td> 109 <td>Private method to get the expected future imports.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td> 112 <td><a href="#CodeStyleCheckerDialog.__initBuiltinsIgnoreList">__initBuiltinsIgnoreList</a></td>
91 <td>Private method to populate the list of shadowed builtins to be ignored.</td> 113 <td>Private method to populate the list of shadowed builtins to be ignored.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td> 116 <td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
94 <td>Private method to set the selected status of the future imports.</td> 117 <td>Private method to set the selected status of the future imports.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td> 120 <td><a href="#CodeStyleCheckerDialog.__itemFixable">__itemFixable</a></td>
97 <td>Private method to check, if an item has a fixable issue.</td> 121 <td>Private method to check, if an item has a fixable issue.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#CodeStyleCheckerDialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td> 124 <td><a href="#CodeStyleCheckerDialog.__modifyFixedResultItem">__modifyFixedResultItem</a></td>
100 <td>Private method to modify a result list entry to show its positive fixed state.</td> 125 <td>Private method to modify a result list entry to show its positive fixed state.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#CodeStyleCheckerDialog.__modifyOptions">__modifyOptions</a></td> 128 <td><a href="#CodeStyleCheckerDialog.__modifyOptions">__modifyOptions</a></td>
103 <td>Private method to modify the options based on eflag: entries.</td> 129 <td>Private method to modify the options based on eflag: entries.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#CodeStyleCheckerDialog.__processError">__processError</a></td> 132 <td><a href="#CodeStyleCheckerDialog.__processError">__processError</a></td>
106 <td>Private slot to process an error indication from the service.</td> 133 <td>Private slot to process an error indication from the service.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#CodeStyleCheckerDialog.__processResult">__processResult</a></td> 136 <td><a href="#CodeStyleCheckerDialog.__processResult">__processResult</a></td>
109 <td>Private slot called after perfoming a style check on one file.</td> 137 <td>Private slot called after perfoming a style check on one file.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#CodeStyleCheckerDialog.__resetStatistics">__resetStatistics</a></td> 140 <td><a href="#CodeStyleCheckerDialog.__resetStatistics">__resetStatistics</a></td>
112 <td>Private slot to reset the statistics data.</td> 141 <td>Private slot to reset the statistics data.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#CodeStyleCheckerDialog.__resort">__resort</a></td> 144 <td><a href="#CodeStyleCheckerDialog.__resort">__resort</a></td>
115 <td>Private method to resort the tree.</td> 145 <td>Private method to resort the tree.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#CodeStyleCheckerDialog.__selectCodes">__selectCodes</a></td> 148 <td><a href="#CodeStyleCheckerDialog.__selectCodes">__selectCodes</a></td>
118 <td>Private method to select message codes via a selection dialog.</td> 149 <td>Private method to select message codes via a selection dialog.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#CodeStyleCheckerDialog.__updateFixerStatistics">__updateFixerStatistics</a></td> 152 <td><a href="#CodeStyleCheckerDialog.__updateFixerStatistics">__updateFixerStatistics</a></td>
121 <td>Private method to update the collected fixer related statistics.</td> 153 <td>Private method to update the collected fixer related statistics.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#CodeStyleCheckerDialog.__updateStatistics">__updateStatistics</a></td> 156 <td><a href="#CodeStyleCheckerDialog.__updateStatistics">__updateStatistics</a></td>
124 <td>Private method to update the collected statistics.</td> 157 <td>Private method to update the collected statistics.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#CodeStyleCheckerDialog.check">check</a></td> 160 <td><a href="#CodeStyleCheckerDialog.check">check</a></td>
127 <td>Public method to start a style check for one file.</td> 161 <td>Public method to start a style check for one file.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td> 164 <td><a href="#CodeStyleCheckerDialog.checkBatch">checkBatch</a></td>
130 <td>Public method to start a style check batch job.</td> 165 <td>Public method to start a style check batch job.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td> 168 <td><a href="#CodeStyleCheckerDialog.on_addBuiltinButton_clicked">on_addBuiltinButton_clicked</a></td>
133 <td>Private slot to add a built-in assignment to be ignored.</td> 169 <td>Private slot to add a built-in assignment to be ignored.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td> 172 <td><a href="#CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged">on_builtinsAssignmentList_itemSelectionChanged</a></td>
136 <td>Private slot to react upon changes of the selected builtin assignments.</td> 173 <td>Private slot to react upon changes of the selected builtin assignments.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 176 <td><a href="#CodeStyleCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
139 <td>Private slot called by a button of the button box clicked.</td> 177 <td>Private slot called by a button of the button box clicked.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td> 180 <td><a href="#CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked">on_deleteBuiltinButton_clicked</a></td>
142 <td>Private slot to delete the selected items from the list.</td> 181 <td>Private slot to delete the selected items from the list.</td>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td> 184 <td><a href="#CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked">on_excludeMessagesSelectButton_clicked</a></td>
145 <td>Private slot to select the message codes to be excluded via a selection dialog.</td> 185 <td>Private slot to select the message codes to be excluded via a selection dialog.</td>
146 </tr><tr> 186 </tr>
187 <tr>
147 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td> 188 <td><a href="#CodeStyleCheckerDialog.on_fixButton_clicked">on_fixButton_clicked</a></td>
148 <td>Private slot to fix selected issues.</td> 189 <td>Private slot to fix selected issues.</td>
149 </tr><tr> 190 </tr>
191 <tr>
150 <td><a href="#CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td> 192 <td><a href="#CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked">on_fixIssuesSelectButton_clicked</a></td>
151 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td> 193 <td>Private slot to select the issue codes to be fixed via a selection dialog.</td>
152 </tr><tr> 194 </tr>
195 <tr>
153 <td><a href="#CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td> 196 <td><a href="#CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked">on_includeMessagesSelectButton_clicked</a></td>
154 <td>Private slot to select the message codes to be included via a selection dialog.</td> 197 <td>Private slot to select the message codes to be included via a selection dialog.</td>
155 </tr><tr> 198 </tr>
199 <tr>
156 <td><a href="#CodeStyleCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td> 200 <td><a href="#CodeStyleCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
157 <td>Private slot to load the default configuration values.</td> 201 <td>Private slot to load the default configuration values.</td>
158 </tr><tr> 202 </tr>
203 <tr>
159 <td><a href="#CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td> 204 <td><a href="#CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked">on_noFixIssuesSelectButton_clicked</a></td>
160 <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td> 205 <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td>
161 </tr><tr> 206 </tr>
207 <tr>
162 <td><a href="#CodeStyleCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td> 208 <td><a href="#CodeStyleCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td>
163 <td>Private slot to reset the configuration values to their default values.</td> 209 <td>Private slot to reset the configuration values to their default values.</td>
164 </tr><tr> 210 </tr>
211 <tr>
165 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> 212 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
166 <td>Private slot to handle the activation of an item.</td> 213 <td>Private slot to handle the activation of an item.</td>
167 </tr><tr> 214 </tr>
215 <tr>
168 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td> 216 <td><a href="#CodeStyleCheckerDialog.on_resultList_itemSelectionChanged">on_resultList_itemSelectionChanged</a></td>
169 <td>Private slot to change the dialog state depending on the selection.</td> 217 <td>Private slot to change the dialog state depending on the selection.</td>
170 </tr><tr> 218 </tr>
219 <tr>
171 <td><a href="#CodeStyleCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td> 220 <td><a href="#CodeStyleCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td>
172 <td>Private slot to handle the "Show" button press.</td> 221 <td>Private slot to handle the "Show" button press.</td>
173 </tr><tr> 222 </tr>
223 <tr>
174 <td><a href="#CodeStyleCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td> 224 <td><a href="#CodeStyleCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td>
175 <td>Private slot to start a code style check run.</td> 225 <td>Private slot to start a code style check run.</td>
176 </tr><tr> 226 </tr>
227 <tr>
177 <td><a href="#CodeStyleCheckerDialog.on_statisticsButton_clicked">on_statisticsButton_clicked</a></td> 228 <td><a href="#CodeStyleCheckerDialog.on_statisticsButton_clicked">on_statisticsButton_clicked</a></td>
178 <td>Private slot to show the statistics dialog.</td> 229 <td>Private slot to show the statistics dialog.</td>
179 </tr><tr> 230 </tr>
231 <tr>
180 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td> 232 <td><a href="#CodeStyleCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
181 <td>Private slot to store the current configuration values as default values.</td> 233 <td>Private slot to store the current configuration values as default values.</td>
182 </tr><tr> 234 </tr>
235 <tr>
183 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td> 236 <td><a href="#CodeStyleCheckerDialog.prepare">prepare</a></td>
184 <td>Public method to prepare the dialog with a list of filenames.</td> 237 <td>Public method to prepare the dialog with a list of filenames.</td>
185 </tr><tr> 238 </tr>
239 <tr>
186 <td><a href="#CodeStyleCheckerDialog.start">start</a></td> 240 <td><a href="#CodeStyleCheckerDialog.start">start</a></td>
187 <td>Public slot to start the code style check.</td> 241 <td>Public slot to start the code style check.</td>
188 </tr> 242 </tr>
189 </table> 243 </table>
190 <h3>Static Methods</h3> 244 <h3>Static Methods</h3>
245
191 <table> 246 <table>
192 <tr><td>None</td></tr> 247 <tr><td>None</td></tr>
193 </table> 248 </table>
249
194 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a> 250 <a NAME="CodeStyleCheckerDialog.__init__" ID="CodeStyleCheckerDialog.__init__"></a>
195 <h4>CodeStyleCheckerDialog (Constructor)</h4> 251 <h4>CodeStyleCheckerDialog (Constructor)</h4>
196 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, parent=None</i>) 252 <b>CodeStyleCheckerDialog</b>(<i>styleCheckService, parent=None</i>)
253
197 <p> 254 <p>
198 Constructor 255 Constructor
199 </p><dl> 256 </p>
257 <dl>
258
200 <dt><i>styleCheckService</i></dt> 259 <dt><i>styleCheckService</i></dt>
201 <dd> 260 <dd>
202 reference to the service 261 reference to the service
203 (CodeStyleCheckService) 262 (CodeStyleCheckService)
204 </dd><dt><i>parent</i></dt> 263 </dd>
264 <dt><i>parent</i></dt>
205 <dd> 265 <dd>
206 reference to the parent widget (QWidget) 266 reference to the parent widget (QWidget)
207 </dd> 267 </dd>
208 </dl><a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a> 268 </dl>
269 <a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
209 <h4>CodeStyleCheckerDialog.__batchFinished</h4> 270 <h4>CodeStyleCheckerDialog.__batchFinished</h4>
210 <b>__batchFinished</b>(<i></i>) 271 <b>__batchFinished</b>(<i></i>)
272
211 <p> 273 <p>
212 Private slot handling the completion of a batch job. 274 Private slot handling the completion of a batch job.
213 </p><a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a> 275 </p>
276 <a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
214 <h4>CodeStyleCheckerDialog.__clearErrors</h4> 277 <h4>CodeStyleCheckerDialog.__clearErrors</h4>
215 <b>__clearErrors</b>(<i>files</i>) 278 <b>__clearErrors</b>(<i>files</i>)
279
216 <p> 280 <p>
217 Private method to clear all warning markers of open editors to be 281 Private method to clear all warning markers of open editors to be
218 checked. 282 checked.
219 </p><dl> 283 </p>
284 <dl>
285
220 <dt><i>files</i></dt> 286 <dt><i>files</i></dt>
221 <dd> 287 <dd>
222 list of files to be checked (list of string) 288 list of files to be checked (list of string)
223 </dd> 289 </dd>
224 </dl><a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a> 290 </dl>
291 <a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
225 <h4>CodeStyleCheckerDialog.__createErrorItem</h4> 292 <h4>CodeStyleCheckerDialog.__createErrorItem</h4>
226 <b>__createErrorItem</b>(<i>filename, message</i>) 293 <b>__createErrorItem</b>(<i>filename, message</i>)
294
227 <p> 295 <p>
228 Private slot to create a new error item in the result list. 296 Private slot to create a new error item in the result list.
229 </p><dl> 297 </p>
298 <dl>
299
230 <dt><i>filename</i> (str)</dt> 300 <dt><i>filename</i> (str)</dt>
231 <dd> 301 <dd>
232 name of the file 302 name of the file
233 </dd><dt><i>message</i> (str)</dt> 303 </dd>
304 <dt><i>message</i> (str)</dt>
234 <dd> 305 <dd>
235 error message 306 error message
236 </dd> 307 </dd>
237 </dl><a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a> 308 </dl>
309 <a NAME="CodeStyleCheckerDialog.__createResultItem" ID="CodeStyleCheckerDialog.__createResultItem"></a>
238 <h4>CodeStyleCheckerDialog.__createResultItem</h4> 310 <h4>CodeStyleCheckerDialog.__createResultItem</h4>
239 <b>__createResultItem</b>(<i>filename, line, pos, message, fixed, autofixing, ignored</i>) 311 <b>__createResultItem</b>(<i>filename, line, pos, message, fixed, autofixing, ignored</i>)
312
240 <p> 313 <p>
241 Private method to create an entry in the result list. 314 Private method to create an entry in the result list.
242 </p><dl> 315 </p>
316 <dl>
317
243 <dt><i>filename</i></dt> 318 <dt><i>filename</i></dt>
244 <dd> 319 <dd>
245 file name of the file (string) 320 file name of the file (string)
246 </dd><dt><i>line</i></dt> 321 </dd>
322 <dt><i>line</i></dt>
247 <dd> 323 <dd>
248 line number of issue (integer or string) 324 line number of issue (integer or string)
249 </dd><dt><i>pos</i></dt> 325 </dd>
326 <dt><i>pos</i></dt>
250 <dd> 327 <dd>
251 character position of issue (integer or string) 328 character position of issue (integer or string)
252 </dd><dt><i>message</i></dt> 329 </dd>
330 <dt><i>message</i></dt>
253 <dd> 331 <dd>
254 message text (string) 332 message text (string)
255 </dd><dt><i>fixed</i></dt> 333 </dd>
334 <dt><i>fixed</i></dt>
256 <dd> 335 <dd>
257 flag indicating a fixed issue (boolean) 336 flag indicating a fixed issue (boolean)
258 </dd><dt><i>autofixing</i></dt> 337 </dd>
338 <dt><i>autofixing</i></dt>
259 <dd> 339 <dd>
260 flag indicating, that we are fixing issues 340 flag indicating, that we are fixing issues
261 automatically (boolean) 341 automatically (boolean)
262 </dd><dt><i>ignored</i></dt> 342 </dd>
343 <dt><i>ignored</i></dt>
263 <dd> 344 <dd>
264 flag indicating an ignored issue (boolean) 345 flag indicating an ignored issue (boolean)
265 </dd> 346 </dd>
266 </dl><dl> 347 </dl>
348 <dl>
267 <dt>Returns:</dt> 349 <dt>Returns:</dt>
268 <dd> 350 <dd>
269 reference to the created item (QTreeWidgetItem) 351 reference to the created item (QTreeWidgetItem)
270 </dd> 352 </dd>
271 </dl><a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a> 353 </dl>
354 <a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
272 <h4>CodeStyleCheckerDialog.__finish</h4> 355 <h4>CodeStyleCheckerDialog.__finish</h4>
273 <b>__finish</b>(<i></i>) 356 <b>__finish</b>(<i></i>)
357
274 <p> 358 <p>
275 Private slot called when the code style check finished or the user 359 Private slot called when the code style check finished or the user
276 pressed the cancel button. 360 pressed the cancel button.
277 </p><a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a> 361 </p>
362 <a NAME="CodeStyleCheckerDialog.__getBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__getBuiltinsIgnoreList"></a>
278 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4> 363 <h4>CodeStyleCheckerDialog.__getBuiltinsIgnoreList</h4>
279 <b>__getBuiltinsIgnoreList</b>(<i></i>) 364 <b>__getBuiltinsIgnoreList</b>(<i></i>)
365
280 <p> 366 <p>
281 Private method to get a dictionary containing the builtins assignments 367 Private method to get a dictionary containing the builtins assignments
282 to be ignored. 368 to be ignored.
283 </p><dl> 369 </p>
370 <dl>
284 <dt>Returns:</dt> 371 <dt>Returns:</dt>
285 <dd> 372 <dd>
286 dictionary containing the builtins assignments to be ignored 373 dictionary containing the builtins assignments to be ignored
287 </dd> 374 </dd>
288 </dl><dl> 375 </dl>
376 <dl>
289 <dt>Return Type:</dt> 377 <dt>Return Type:</dt>
290 <dd> 378 <dd>
291 dict of list of str 379 dict of list of str
292 </dd> 380 </dd>
293 </dl><a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a> 381 </dl>
382 <a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
294 <h4>CodeStyleCheckerDialog.__getEol</h4> 383 <h4>CodeStyleCheckerDialog.__getEol</h4>
295 <b>__getEol</b>(<i>fn</i>) 384 <b>__getEol</b>(<i>fn</i>)
385
296 <p> 386 <p>
297 Private method to get the applicable eol string. 387 Private method to get the applicable eol string.
298 </p><dl> 388 </p>
389 <dl>
390
299 <dt><i>fn</i></dt> 391 <dt><i>fn</i></dt>
300 <dd> 392 <dd>
301 filename where to determine the line ending (str) 393 filename where to determine the line ending (str)
302 </dd> 394 </dd>
303 </dl><dl> 395 </dl>
396 <dl>
304 <dt>Returns:</dt> 397 <dt>Returns:</dt>
305 <dd> 398 <dd>
306 eol string (string) 399 eol string (string)
307 </dd> 400 </dd>
308 </dl><a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a> 401 </dl>
402 <a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
309 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4> 403 <h4>CodeStyleCheckerDialog.__getSelectedFixableItems</h4>
310 <b>__getSelectedFixableItems</b>(<i></i>) 404 <b>__getSelectedFixableItems</b>(<i></i>)
405
311 <p> 406 <p>
312 Private method to extract all selected items for fixable issues. 407 Private method to extract all selected items for fixable issues.
313 </p><dl> 408 </p>
409 <dl>
314 <dt>Returns:</dt> 410 <dt>Returns:</dt>
315 <dd> 411 <dd>
316 selected items for fixable issues (list of QTreeWidgetItem) 412 selected items for fixable issues (list of QTreeWidgetItem)
317 </dd> 413 </dd>
318 </dl><a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a> 414 </dl>
415 <a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a>
319 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4> 416 <h4>CodeStyleCheckerDialog.__getSelectedFutureImports</h4>
320 <b>__getSelectedFutureImports</b>(<i></i>) 417 <b>__getSelectedFutureImports</b>(<i></i>)
418
321 <p> 419 <p>
322 Private method to get the expected future imports. 420 Private method to get the expected future imports.
323 </p><dl> 421 </p>
422 <dl>
324 <dt>Returns:</dt> 423 <dt>Returns:</dt>
325 <dd> 424 <dd>
326 expected future imports as a comma separated string 425 expected future imports as a comma separated string
327 </dd> 426 </dd>
328 </dl><dl> 427 </dl>
428 <dl>
329 <dt>Return Type:</dt> 429 <dt>Return Type:</dt>
330 <dd> 430 <dd>
331 str 431 str
332 </dd> 432 </dd>
333 </dl><a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a> 433 </dl>
434 <a NAME="CodeStyleCheckerDialog.__initBuiltinsIgnoreList" ID="CodeStyleCheckerDialog.__initBuiltinsIgnoreList"></a>
334 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4> 435 <h4>CodeStyleCheckerDialog.__initBuiltinsIgnoreList</h4>
335 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>) 436 <b>__initBuiltinsIgnoreList</b>(<i>builtinsIgnoreDict</i>)
437
336 <p> 438 <p>
337 Private method to populate the list of shadowed builtins to be ignored. 439 Private method to populate the list of shadowed builtins to be ignored.
338 </p><dl> 440 </p>
441 <dl>
442
339 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt> 443 <dt><i>builtinsIgnoreDict</i> (dict of list of str)</dt>
340 <dd> 444 <dd>
341 dictionary containing the builtins 445 dictionary containing the builtins
342 assignments to be ignored 446 assignments to be ignored
343 </dd> 447 </dd>
344 </dl><a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a> 448 </dl>
449 <a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
345 <h4>CodeStyleCheckerDialog.__initFuturesList</h4> 450 <h4>CodeStyleCheckerDialog.__initFuturesList</h4>
346 <b>__initFuturesList</b>(<i>selectedFutures</i>) 451 <b>__initFuturesList</b>(<i>selectedFutures</i>)
452
347 <p> 453 <p>
348 Private method to set the selected status of the future imports. 454 Private method to set the selected status of the future imports.
349 </p><dl> 455 </p>
456 <dl>
457
350 <dt><i>selectedFutures</i> (str)</dt> 458 <dt><i>selectedFutures</i> (str)</dt>
351 <dd> 459 <dd>
352 comma separated list of expected future imports 460 comma separated list of expected future imports
353 </dd> 461 </dd>
354 </dl><a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a> 462 </dl>
463 <a NAME="CodeStyleCheckerDialog.__itemFixable" ID="CodeStyleCheckerDialog.__itemFixable"></a>
355 <h4>CodeStyleCheckerDialog.__itemFixable</h4> 464 <h4>CodeStyleCheckerDialog.__itemFixable</h4>
356 <b>__itemFixable</b>(<i>itm</i>) 465 <b>__itemFixable</b>(<i>itm</i>)
466
357 <p> 467 <p>
358 Private method to check, if an item has a fixable issue. 468 Private method to check, if an item has a fixable issue.
359 </p><dl> 469 </p>
470 <dl>
471
360 <dt><i>itm</i></dt> 472 <dt><i>itm</i></dt>
361 <dd> 473 <dd>
362 item to be checked (QTreeWidgetItem) 474 item to be checked (QTreeWidgetItem)
363 </dd> 475 </dd>
364 </dl><dl> 476 </dl>
477 <dl>
365 <dt>Returns:</dt> 478 <dt>Returns:</dt>
366 <dd> 479 <dd>
367 flag indicating a fixable issue (boolean) 480 flag indicating a fixable issue (boolean)
368 </dd> 481 </dd>
369 </dl><a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a> 482 </dl>
483 <a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
370 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4> 484 <h4>CodeStyleCheckerDialog.__modifyFixedResultItem</h4>
371 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>) 485 <b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>)
486
372 <p> 487 <p>
373 Private method to modify a result list entry to show its 488 Private method to modify a result list entry to show its
374 positive fixed state. 489 positive fixed state.
375 </p><dl> 490 </p>
491 <dl>
492
376 <dt><i>itm</i></dt> 493 <dt><i>itm</i></dt>
377 <dd> 494 <dd>
378 reference to the item to modify (QTreeWidgetItem) 495 reference to the item to modify (QTreeWidgetItem)
379 </dd><dt><i>text</i></dt> 496 </dd>
497 <dt><i>text</i></dt>
380 <dd> 498 <dd>
381 text to be appended (string) 499 text to be appended (string)
382 </dd><dt><i>fixed</i></dt> 500 </dd>
501 <dt><i>fixed</i></dt>
383 <dd> 502 <dd>
384 flag indicating a fixed issue (boolean) 503 flag indicating a fixed issue (boolean)
385 </dd> 504 </dd>
386 </dl><a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a> 505 </dl>
506 <a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
387 <h4>CodeStyleCheckerDialog.__modifyOptions</h4> 507 <h4>CodeStyleCheckerDialog.__modifyOptions</h4>
388 <b>__modifyOptions</b>(<i>source</i>) 508 <b>__modifyOptions</b>(<i>source</i>)
509
389 <p> 510 <p>
390 Private method to modify the options based on eflag: entries. 511 Private method to modify the options based on eflag: entries.
391 </p><p> 512 </p>
513 <p>
392 This method looks for comment lines like '# eflag: noqa = M601' 514 This method looks for comment lines like '# eflag: noqa = M601'
393 at the end of the source in order to extend the list of excluded 515 at the end of the source in order to extend the list of excluded
394 messages for one file only. 516 messages for one file only.
395 </p><dl> 517 </p>
518 <dl>
519
396 <dt><i>source</i></dt> 520 <dt><i>source</i></dt>
397 <dd> 521 <dd>
398 source text (list of str or str) 522 source text (list of str or str)
399 </dd> 523 </dd>
400 </dl><dl> 524 </dl>
525 <dl>
401 <dt>Returns:</dt> 526 <dt>Returns:</dt>
402 <dd> 527 <dd>
403 list of checker options 528 list of checker options
404 </dd> 529 </dd>
405 </dl><a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a> 530 </dl>
531 <a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
406 <h4>CodeStyleCheckerDialog.__processError</h4> 532 <h4>CodeStyleCheckerDialog.__processError</h4>
407 <b>__processError</b>(<i>fn, msg</i>) 533 <b>__processError</b>(<i>fn, msg</i>)
534
408 <p> 535 <p>
409 Private slot to process an error indication from the service. 536 Private slot to process an error indication from the service.
410 </p><dl> 537 </p>
538 <dl>
539
411 <dt><i>fn</i> (str)</dt> 540 <dt><i>fn</i> (str)</dt>
412 <dd> 541 <dd>
413 filename of the file 542 filename of the file
414 </dd><dt><i>msg</i> (str)</dt> 543 </dd>
544 <dt><i>msg</i> (str)</dt>
415 <dd> 545 <dd>
416 error message 546 error message
417 </dd> 547 </dd>
418 </dl><a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a> 548 </dl>
549 <a NAME="CodeStyleCheckerDialog.__processResult" ID="CodeStyleCheckerDialog.__processResult"></a>
419 <h4>CodeStyleCheckerDialog.__processResult</h4> 550 <h4>CodeStyleCheckerDialog.__processResult</h4>
420 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>) 551 <b>__processResult</b>(<i>fn, codeStyleCheckerStats, fixes, results</i>)
552
421 <p> 553 <p>
422 Private slot called after perfoming a style check on one file. 554 Private slot called after perfoming a style check on one file.
423 </p><dl> 555 </p>
556 <dl>
557
424 <dt><i>fn</i></dt> 558 <dt><i>fn</i></dt>
425 <dd> 559 <dd>
426 filename of the just checked file (str) 560 filename of the just checked file (str)
427 </dd><dt><i>codeStyleCheckerStats</i></dt> 561 </dd>
562 <dt><i>codeStyleCheckerStats</i></dt>
428 <dd> 563 <dd>
429 stats of style and name check (dict) 564 stats of style and name check (dict)
430 </dd><dt><i>fixes</i></dt> 565 </dd>
566 <dt><i>fixes</i></dt>
431 <dd> 567 <dd>
432 number of applied fixes (int) 568 number of applied fixes (int)
433 </dd><dt><i>results</i></dt> 569 </dd>
570 <dt><i>results</i></dt>
434 <dd> 571 <dd>
435 tuple for each found violation of style (tuple of 572 tuple for each found violation of style (tuple of
436 lineno (int), position (int), text (str), ignored (bool), 573 lineno (int), position (int), text (str), ignored (bool),
437 fixed (bool), autofixing (bool)) 574 fixed (bool), autofixing (bool))
438 </dd> 575 </dd>
439 </dl><a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a> 576 </dl>
577 <a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
440 <h4>CodeStyleCheckerDialog.__resetStatistics</h4> 578 <h4>CodeStyleCheckerDialog.__resetStatistics</h4>
441 <b>__resetStatistics</b>(<i></i>) 579 <b>__resetStatistics</b>(<i></i>)
580
442 <p> 581 <p>
443 Private slot to reset the statistics data. 582 Private slot to reset the statistics data.
444 </p><a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a> 583 </p>
584 <a NAME="CodeStyleCheckerDialog.__resort" ID="CodeStyleCheckerDialog.__resort"></a>
445 <h4>CodeStyleCheckerDialog.__resort</h4> 585 <h4>CodeStyleCheckerDialog.__resort</h4>
446 <b>__resort</b>(<i></i>) 586 <b>__resort</b>(<i></i>)
587
447 <p> 588 <p>
448 Private method to resort the tree. 589 Private method to resort the tree.
449 </p><a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a> 590 </p>
591 <a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
450 <h4>CodeStyleCheckerDialog.__selectCodes</h4> 592 <h4>CodeStyleCheckerDialog.__selectCodes</h4>
451 <b>__selectCodes</b>(<i>edit, showFixCodes</i>) 593 <b>__selectCodes</b>(<i>edit, showFixCodes</i>)
594
452 <p> 595 <p>
453 Private method to select message codes via a selection dialog. 596 Private method to select message codes via a selection dialog.
454 </p><dl> 597 </p>
598 <dl>
599
455 <dt><i>edit</i></dt> 600 <dt><i>edit</i></dt>
456 <dd> 601 <dd>
457 reference of the line edit to be populated (QLineEdit) 602 reference of the line edit to be populated (QLineEdit)
458 </dd><dt><i>showFixCodes</i></dt> 603 </dd>
604 <dt><i>showFixCodes</i></dt>
459 <dd> 605 <dd>
460 flag indicating to show a list of fixable 606 flag indicating to show a list of fixable
461 issues (boolean) 607 issues (boolean)
462 </dd> 608 </dd>
463 </dl><a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a> 609 </dl>
610 <a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
464 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4> 611 <h4>CodeStyleCheckerDialog.__updateFixerStatistics</h4>
465 <b>__updateFixerStatistics</b>(<i>fixer</i>) 612 <b>__updateFixerStatistics</b>(<i>fixer</i>)
613
466 <p> 614 <p>
467 Private method to update the collected fixer related statistics. 615 Private method to update the collected fixer related statistics.
468 </p><dl> 616 </p>
617 <dl>
618
469 <dt><i>fixer</i></dt> 619 <dt><i>fixer</i></dt>
470 <dd> 620 <dd>
471 reference to the code style fixer (CodeStyleFixer) 621 reference to the code style fixer (CodeStyleFixer)
472 </dd> 622 </dd>
473 </dl><a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a> 623 </dl>
624 <a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
474 <h4>CodeStyleCheckerDialog.__updateStatistics</h4> 625 <h4>CodeStyleCheckerDialog.__updateStatistics</h4>
475 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>) 626 <b>__updateStatistics</b>(<i>statistics, fixer, ignoredErrors</i>)
627
476 <p> 628 <p>
477 Private method to update the collected statistics. 629 Private method to update the collected statistics.
478 </p><dl> 630 </p>
631 <dl>
632
479 <dt><i>statistics</i></dt> 633 <dt><i>statistics</i></dt>
480 <dd> 634 <dd>
481 dictionary of statistical data with 635 dictionary of statistical data with
482 message code as key and message count as value 636 message code as key and message count as value
483 </dd><dt><i>fixer</i></dt> 637 </dd>
638 <dt><i>fixer</i></dt>
484 <dd> 639 <dd>
485 reference to the code style fixer (CodeStyleFixer) 640 reference to the code style fixer (CodeStyleFixer)
486 </dd><dt><i>ignoredErrors</i></dt> 641 </dd>
642 <dt><i>ignoredErrors</i></dt>
487 <dd> 643 <dd>
488 number of ignored errors (integer) 644 number of ignored errors (integer)
489 </dd> 645 </dd>
490 </dl><a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a> 646 </dl>
647 <a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
491 <h4>CodeStyleCheckerDialog.check</h4> 648 <h4>CodeStyleCheckerDialog.check</h4>
492 <b>check</b>(<i>codestring=''</i>) 649 <b>check</b>(<i>codestring=''</i>)
650
493 <p> 651 <p>
494 Public method to start a style check for one file. 652 Public method to start a style check for one file.
495 </p><p> 653 </p>
654 <p>
496 The results are reported to the __processResult slot. 655 The results are reported to the __processResult slot.
497 </p><dl> 656 </p>
657 <dl>
658
498 <dt><i>codestring=</i></dt> 659 <dt><i>codestring=</i></dt>
499 <dd> 660 <dd>
500 optional sourcestring (str) 661 optional sourcestring (str)
501 </dd> 662 </dd>
502 </dl><a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a> 663 </dl>
664 <a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
503 <h4>CodeStyleCheckerDialog.checkBatch</h4> 665 <h4>CodeStyleCheckerDialog.checkBatch</h4>
504 <b>checkBatch</b>(<i></i>) 666 <b>checkBatch</b>(<i></i>)
667
505 <p> 668 <p>
506 Public method to start a style check batch job. 669 Public method to start a style check batch job.
507 </p><p> 670 </p>
671 <p>
508 The results are reported to the __processResult slot. 672 The results are reported to the __processResult slot.
509 </p><a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a> 673 </p>
674 <a NAME="CodeStyleCheckerDialog.on_addBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_addBuiltinButton_clicked"></a>
510 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4> 675 <h4>CodeStyleCheckerDialog.on_addBuiltinButton_clicked</h4>
511 <b>on_addBuiltinButton_clicked</b>(<i></i>) 676 <b>on_addBuiltinButton_clicked</b>(<i></i>)
677
512 <p> 678 <p>
513 Private slot to add a built-in assignment to be ignored. 679 Private slot to add a built-in assignment to be ignored.
514 </p><a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a> 680 </p>
681 <a NAME="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged"></a>
515 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4> 682 <h4>CodeStyleCheckerDialog.on_builtinsAssignmentList_itemSelectionChanged</h4>
516 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>) 683 <b>on_builtinsAssignmentList_itemSelectionChanged</b>(<i></i>)
684
517 <p> 685 <p>
518 Private slot to react upon changes of the selected builtin assignments. 686 Private slot to react upon changes of the selected builtin assignments.
519 </p><a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a> 687 </p>
688 <a NAME="CodeStyleCheckerDialog.on_buttonBox_clicked" ID="CodeStyleCheckerDialog.on_buttonBox_clicked"></a>
520 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4> 689 <h4>CodeStyleCheckerDialog.on_buttonBox_clicked</h4>
521 <b>on_buttonBox_clicked</b>(<i>button</i>) 690 <b>on_buttonBox_clicked</b>(<i>button</i>)
691
522 <p> 692 <p>
523 Private slot called by a button of the button box clicked. 693 Private slot called by a button of the button box clicked.
524 </p><dl> 694 </p>
695 <dl>
696
525 <dt><i>button</i></dt> 697 <dt><i>button</i></dt>
526 <dd> 698 <dd>
527 button that was clicked (QAbstractButton) 699 button that was clicked (QAbstractButton)
528 </dd> 700 </dd>
529 </dl><a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a> 701 </dl>
702 <a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
530 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4> 703 <h4>CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked</h4>
531 <b>on_deleteBuiltinButton_clicked</b>(<i></i>) 704 <b>on_deleteBuiltinButton_clicked</b>(<i></i>)
705
532 <p> 706 <p>
533 Private slot to delete the selected items from the list. 707 Private slot to delete the selected items from the list.
534 </p><a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a> 708 </p>
709 <a NAME="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked"></a>
535 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4> 710 <h4>CodeStyleCheckerDialog.on_excludeMessagesSelectButton_clicked</h4>
536 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>) 711 <b>on_excludeMessagesSelectButton_clicked</b>(<i></i>)
712
537 <p> 713 <p>
538 Private slot to select the message codes to be excluded via a 714 Private slot to select the message codes to be excluded via a
539 selection dialog. 715 selection dialog.
540 </p><a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a> 716 </p>
717 <a NAME="CodeStyleCheckerDialog.on_fixButton_clicked" ID="CodeStyleCheckerDialog.on_fixButton_clicked"></a>
541 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4> 718 <h4>CodeStyleCheckerDialog.on_fixButton_clicked</h4>
542 <b>on_fixButton_clicked</b>(<i></i>) 719 <b>on_fixButton_clicked</b>(<i></i>)
720
543 <p> 721 <p>
544 Private slot to fix selected issues. 722 Private slot to fix selected issues.
545 </p><p> 723 </p>
724 <p>
546 Build a dictionary of issues to fix. Update the initialized __options. 725 Build a dictionary of issues to fix. Update the initialized __options.
547 Then call check with the dict as keyparam to fix selected issues. 726 Then call check with the dict as keyparam to fix selected issues.
548 </p><a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a> 727 </p>
728 <a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
549 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4> 729 <h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
550 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>) 730 <b>on_fixIssuesSelectButton_clicked</b>(<i></i>)
731
551 <p> 732 <p>
552 Private slot to select the issue codes to be fixed via a 733 Private slot to select the issue codes to be fixed via a
553 selection dialog. 734 selection dialog.
554 </p><a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a> 735 </p>
736 <a NAME="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked"></a>
555 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4> 737 <h4>CodeStyleCheckerDialog.on_includeMessagesSelectButton_clicked</h4>
556 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>) 738 <b>on_includeMessagesSelectButton_clicked</b>(<i></i>)
739
557 <p> 740 <p>
558 Private slot to select the message codes to be included via a 741 Private slot to select the message codes to be included via a
559 selection dialog. 742 selection dialog.
560 </p><a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a> 743 </p>
744 <a NAME="CodeStyleCheckerDialog.on_loadDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_loadDefaultButton_clicked"></a>
561 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4> 745 <h4>CodeStyleCheckerDialog.on_loadDefaultButton_clicked</h4>
562 <b>on_loadDefaultButton_clicked</b>(<i></i>) 746 <b>on_loadDefaultButton_clicked</b>(<i></i>)
747
563 <p> 748 <p>
564 Private slot to load the default configuration values. 749 Private slot to load the default configuration values.
565 </p><a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a> 750 </p>
751 <a NAME="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked"></a>
566 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4> 752 <h4>CodeStyleCheckerDialog.on_noFixIssuesSelectButton_clicked</h4>
567 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>) 753 <b>on_noFixIssuesSelectButton_clicked</b>(<i></i>)
754
568 <p> 755 <p>
569 Private slot to select the issue codes not to be fixed via a 756 Private slot to select the issue codes not to be fixed via a
570 selection dialog. 757 selection dialog.
571 </p><a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a> 758 </p>
759 <a NAME="CodeStyleCheckerDialog.on_resetDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_resetDefaultButton_clicked"></a>
572 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4> 760 <h4>CodeStyleCheckerDialog.on_resetDefaultButton_clicked</h4>
573 <b>on_resetDefaultButton_clicked</b>(<i></i>) 761 <b>on_resetDefaultButton_clicked</b>(<i></i>)
762
574 <p> 763 <p>
575 Private slot to reset the configuration values to their default values. 764 Private slot to reset the configuration values to their default values.
576 </p><a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a> 765 </p>
766 <a NAME="CodeStyleCheckerDialog.on_resultList_itemActivated" ID="CodeStyleCheckerDialog.on_resultList_itemActivated"></a>
577 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4> 767 <h4>CodeStyleCheckerDialog.on_resultList_itemActivated</h4>
578 <b>on_resultList_itemActivated</b>(<i>item, column</i>) 768 <b>on_resultList_itemActivated</b>(<i>item, column</i>)
769
579 <p> 770 <p>
580 Private slot to handle the activation of an item. 771 Private slot to handle the activation of an item.
581 </p><dl> 772 </p>
773 <dl>
774
582 <dt><i>item</i></dt> 775 <dt><i>item</i></dt>
583 <dd> 776 <dd>
584 reference to the activated item (QTreeWidgetItem) 777 reference to the activated item (QTreeWidgetItem)
585 </dd><dt><i>column</i></dt> 778 </dd>
779 <dt><i>column</i></dt>
586 <dd> 780 <dd>
587 column the item was activated in (integer) 781 column the item was activated in (integer)
588 </dd> 782 </dd>
589 </dl><a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a> 783 </dl>
784 <a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
590 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4> 785 <h4>CodeStyleCheckerDialog.on_resultList_itemSelectionChanged</h4>
591 <b>on_resultList_itemSelectionChanged</b>(<i></i>) 786 <b>on_resultList_itemSelectionChanged</b>(<i></i>)
787
592 <p> 788 <p>
593 Private slot to change the dialog state depending on the selection. 789 Private slot to change the dialog state depending on the selection.
594 </p><a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a> 790 </p>
791 <a NAME="CodeStyleCheckerDialog.on_showButton_clicked" ID="CodeStyleCheckerDialog.on_showButton_clicked"></a>
595 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4> 792 <h4>CodeStyleCheckerDialog.on_showButton_clicked</h4>
596 <b>on_showButton_clicked</b>(<i></i>) 793 <b>on_showButton_clicked</b>(<i></i>)
794
597 <p> 795 <p>
598 Private slot to handle the "Show" button press. 796 Private slot to handle the "Show" button press.
599 </p><a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a> 797 </p>
798 <a NAME="CodeStyleCheckerDialog.on_startButton_clicked" ID="CodeStyleCheckerDialog.on_startButton_clicked"></a>
600 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4> 799 <h4>CodeStyleCheckerDialog.on_startButton_clicked</h4>
601 <b>on_startButton_clicked</b>(<i></i>) 800 <b>on_startButton_clicked</b>(<i></i>)
801
602 <p> 802 <p>
603 Private slot to start a code style check run. 803 Private slot to start a code style check run.
604 </p><a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a> 804 </p>
805 <a NAME="CodeStyleCheckerDialog.on_statisticsButton_clicked" ID="CodeStyleCheckerDialog.on_statisticsButton_clicked"></a>
605 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4> 806 <h4>CodeStyleCheckerDialog.on_statisticsButton_clicked</h4>
606 <b>on_statisticsButton_clicked</b>(<i></i>) 807 <b>on_statisticsButton_clicked</b>(<i></i>)
808
607 <p> 809 <p>
608 Private slot to show the statistics dialog. 810 Private slot to show the statistics dialog.
609 </p><a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a> 811 </p>
812 <a NAME="CodeStyleCheckerDialog.on_storeDefaultButton_clicked" ID="CodeStyleCheckerDialog.on_storeDefaultButton_clicked"></a>
610 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4> 813 <h4>CodeStyleCheckerDialog.on_storeDefaultButton_clicked</h4>
611 <b>on_storeDefaultButton_clicked</b>(<i></i>) 814 <b>on_storeDefaultButton_clicked</b>(<i></i>)
815
612 <p> 816 <p>
613 Private slot to store the current configuration values as 817 Private slot to store the current configuration values as
614 default values. 818 default values.
615 </p><a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a> 819 </p>
820 <a NAME="CodeStyleCheckerDialog.prepare" ID="CodeStyleCheckerDialog.prepare"></a>
616 <h4>CodeStyleCheckerDialog.prepare</h4> 821 <h4>CodeStyleCheckerDialog.prepare</h4>
617 <b>prepare</b>(<i>fileList, project</i>) 822 <b>prepare</b>(<i>fileList, project</i>)
823
618 <p> 824 <p>
619 Public method to prepare the dialog with a list of filenames. 825 Public method to prepare the dialog with a list of filenames.
620 </p><dl> 826 </p>
827 <dl>
828
621 <dt><i>fileList</i></dt> 829 <dt><i>fileList</i></dt>
622 <dd> 830 <dd>
623 list of filenames (list of strings) 831 list of filenames (list of strings)
624 </dd><dt><i>project</i></dt> 832 </dd>
833 <dt><i>project</i></dt>
625 <dd> 834 <dd>
626 reference to the project object (Project) 835 reference to the project object (Project)
627 </dd> 836 </dd>
628 </dl><a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a> 837 </dl>
838 <a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
629 <h4>CodeStyleCheckerDialog.start</h4> 839 <h4>CodeStyleCheckerDialog.start</h4>
630 <b>start</b>(<i>fn, save=False, repeat=None</i>) 840 <b>start</b>(<i>fn, save=False, repeat=None</i>)
841
631 <p> 842 <p>
632 Public slot to start the code style check. 843 Public slot to start the code style check.
633 </p><dl> 844 </p>
845 <dl>
846
634 <dt><i>fn</i></dt> 847 <dt><i>fn</i></dt>
635 <dd> 848 <dd>
636 file or list of files or directory to be checked 849 file or list of files or directory to be checked
637 (string or list of strings) 850 (string or list of strings)
638 </dd><dt><i>save=</i></dt> 851 </dd>
852 <dt><i>save=</i></dt>
639 <dd> 853 <dd>
640 flag indicating to save the given 854 flag indicating to save the given
641 file/file list/directory (boolean) 855 file/file list/directory (boolean)
642 </dd><dt><i>repeat=</i></dt> 856 </dd>
857 <dt><i>repeat=</i></dt>
643 <dd> 858 <dd>
644 state of the repeat check box if it is not None 859 state of the repeat check box if it is not None
645 (None or boolean) 860 (None or boolean)
646 </dd> 861 </dd>
647 </dl> 862 </dl>

Mercurial Repository: eric

eric ide

mercurial