Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial