Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html

eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog.html

changeset 7662
d5e4bed968b4
parent 7661
6bf02583bf9e
child 7663
b4d5234f92e7
equal deleted inserted replaced
7661:6bf02583bf9e 7662:d5e4bed968b4
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.Plugins.CheckerPlugins.Tabnanny.TabnannyDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of the tabnanny command
27 process.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#TabnannyDialog">TabnannyDialog</a></td>
40 <td>Class implementing a dialog to show the results of the tabnanny check run.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="TabnannyDialog" ID="TabnannyDialog"></a>
51 <h2>TabnannyDialog</h2>
52
53 <p>
54 Class implementing a dialog to show the results of the tabnanny check run.
55 </p>
56 <h3>Derived from</h3>
57 QDialog, Ui_TabnannyDialog
58 <h3>Class Attributes</h3>
59
60 <table>
61 <tr><td>filenameRole</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69
70 <table>
71
72 <tr>
73 <td><a href="#TabnannyDialog.__init__">TabnannyDialog</a></td>
74 <td>Constructor</td>
75 </tr>
76 <tr>
77 <td><a href="#TabnannyDialog.__batchFinished">__batchFinished</a></td>
78 <td>Private slot handling the completion of a batch job.</td>
79 </tr>
80 <tr>
81 <td><a href="#TabnannyDialog.__createErrorItem">__createErrorItem</a></td>
82 <td>Private slot to create a new error item in the result list.</td>
83 </tr>
84 <tr>
85 <td><a href="#TabnannyDialog.__createResultItem">__createResultItem</a></td>
86 <td>Private method to create an entry in the result list.</td>
87 </tr>
88 <tr>
89 <td><a href="#TabnannyDialog.__finish">__finish</a></td>
90 <td>Private slot called when the action or the user pressed the button.</td>
91 </tr>
92 <tr>
93 <td><a href="#TabnannyDialog.__processError">__processError</a></td>
94 <td>Private slot to process an error indication from the service.</td>
95 </tr>
96 <tr>
97 <td><a href="#TabnannyDialog.__processResult">__processResult</a></td>
98 <td>Private slot called after perfoming a style check on one file.</td>
99 </tr>
100 <tr>
101 <td><a href="#TabnannyDialog.__resort">__resort</a></td>
102 <td>Private method to resort the tree.</td>
103 </tr>
104 <tr>
105 <td><a href="#TabnannyDialog.check">check</a></td>
106 <td>Public method to start an indentation check for one file.</td>
107 </tr>
108 <tr>
109 <td><a href="#TabnannyDialog.checkBatch">checkBatch</a></td>
110 <td>Public method to start an indentation check batch job.</td>
111 </tr>
112 <tr>
113 <td><a href="#TabnannyDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
114 <td>Private slot called by a button of the button box clicked.</td>
115 </tr>
116 <tr>
117 <td><a href="#TabnannyDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
118 <td>Private slot to handle the activation of an item.</td>
119 </tr>
120 <tr>
121 <td><a href="#TabnannyDialog.on_startButton_clicked">on_startButton_clicked</a></td>
122 <td>Private slot to start a code metrics run.</td>
123 </tr>
124 <tr>
125 <td><a href="#TabnannyDialog.prepare">prepare</a></td>
126 <td>Public method to prepare the dialog with a list of filenames.</td>
127 </tr>
128 <tr>
129 <td><a href="#TabnannyDialog.start">start</a></td>
130 <td>Public slot to start the tabnanny check.</td>
131 </tr>
132 </table>
133 <h3>Static Methods</h3>
134
135 <table>
136 <tr><td>None</td></tr>
137 </table>
138
139 <a NAME="TabnannyDialog.__init__" ID="TabnannyDialog.__init__"></a>
140 <h4>TabnannyDialog (Constructor)</h4>
141 <b>TabnannyDialog</b>(<i>indentCheckService, parent=None</i>)
142
143 <p>
144 Constructor
145 </p>
146 <dl>
147
148 <dt><i>indentCheckService</i></dt>
149 <dd>
150 reference to the service (IndentCheckService)
151 </dd>
152 <dt><i>parent</i></dt>
153 <dd>
154 The parent widget (QWidget).
155 </dd>
156 </dl>
157 <a NAME="TabnannyDialog.__batchFinished" ID="TabnannyDialog.__batchFinished"></a>
158 <h4>TabnannyDialog.__batchFinished</h4>
159 <b>__batchFinished</b>(<i></i>)
160
161 <p>
162 Private slot handling the completion of a batch job.
163 </p>
164 <a NAME="TabnannyDialog.__createErrorItem" ID="TabnannyDialog.__createErrorItem"></a>
165 <h4>TabnannyDialog.__createErrorItem</h4>
166 <b>__createErrorItem</b>(<i>filename, message</i>)
167
168 <p>
169 Private slot to create a new error item in the result list.
170 </p>
171 <dl>
172
173 <dt><i>filename</i> (str)</dt>
174 <dd>
175 name of the file
176 </dd>
177 <dt><i>message</i> (str)</dt>
178 <dd>
179 error message
180 </dd>
181 </dl>
182 <a NAME="TabnannyDialog.__createResultItem" ID="TabnannyDialog.__createResultItem"></a>
183 <h4>TabnannyDialog.__createResultItem</h4>
184 <b>__createResultItem</b>(<i>filename, line, sourcecode</i>)
185
186 <p>
187 Private method to create an entry in the result list.
188 </p>
189 <dl>
190
191 <dt><i>filename</i></dt>
192 <dd>
193 filename of file (string)
194 </dd>
195 <dt><i>line</i></dt>
196 <dd>
197 linenumber of faulty source (integer or string)
198 </dd>
199 <dt><i>sourcecode</i></dt>
200 <dd>
201 faulty line of code (string)
202 </dd>
203 </dl>
204 <a NAME="TabnannyDialog.__finish" ID="TabnannyDialog.__finish"></a>
205 <h4>TabnannyDialog.__finish</h4>
206 <b>__finish</b>(<i></i>)
207
208 <p>
209 Private slot called when the action or the user pressed the button.
210 </p>
211 <a NAME="TabnannyDialog.__processError" ID="TabnannyDialog.__processError"></a>
212 <h4>TabnannyDialog.__processError</h4>
213 <b>__processError</b>(<i>fn, msg</i>)
214
215 <p>
216 Private slot to process an error indication from the service.
217 </p>
218 <dl>
219
220 <dt><i>fn</i> (str)</dt>
221 <dd>
222 filename of the file
223 </dd>
224 <dt><i>msg</i> (str)</dt>
225 <dd>
226 error message
227 </dd>
228 </dl>
229 <a NAME="TabnannyDialog.__processResult" ID="TabnannyDialog.__processResult"></a>
230 <h4>TabnannyDialog.__processResult</h4>
231 <b>__processResult</b>(<i>fn, nok, line, error</i>)
232
233 <p>
234 Private slot called after perfoming a style check on one file.
235 </p>
236 <dl>
237
238 <dt><i>fn</i></dt>
239 <dd>
240 filename of the just checked file (str)
241 </dd>
242 <dt><i>nok</i></dt>
243 <dd>
244 flag if a problem was found (bool)
245 </dd>
246 <dt><i>line</i></dt>
247 <dd>
248 line number (str)
249 </dd>
250 <dt><i>error</i></dt>
251 <dd>
252 text of the problem (str)
253 </dd>
254 </dl>
255 <a NAME="TabnannyDialog.__resort" ID="TabnannyDialog.__resort"></a>
256 <h4>TabnannyDialog.__resort</h4>
257 <b>__resort</b>(<i></i>)
258
259 <p>
260 Private method to resort the tree.
261 </p>
262 <a NAME="TabnannyDialog.check" ID="TabnannyDialog.check"></a>
263 <h4>TabnannyDialog.check</h4>
264 <b>check</b>(<i>codestring=''</i>)
265
266 <p>
267 Public method to start an indentation check for one file.
268 </p>
269 <p>
270 The results are reported to the __processResult slot.
271 </p>
272 <dl>
273
274 <dt><i>codestring=</i></dt>
275 <dd>
276 optional sourcestring (str)
277 </dd>
278 </dl>
279 <a NAME="TabnannyDialog.checkBatch" ID="TabnannyDialog.checkBatch"></a>
280 <h4>TabnannyDialog.checkBatch</h4>
281 <b>checkBatch</b>(<i></i>)
282
283 <p>
284 Public method to start an indentation check batch job.
285 </p>
286 <p>
287 The results are reported to the __processResult slot.
288 </p>
289 <a NAME="TabnannyDialog.on_buttonBox_clicked" ID="TabnannyDialog.on_buttonBox_clicked"></a>
290 <h4>TabnannyDialog.on_buttonBox_clicked</h4>
291 <b>on_buttonBox_clicked</b>(<i>button</i>)
292
293 <p>
294 Private slot called by a button of the button box clicked.
295 </p>
296 <dl>
297
298 <dt><i>button</i></dt>
299 <dd>
300 button that was clicked (QAbstractButton)
301 </dd>
302 </dl>
303 <a NAME="TabnannyDialog.on_resultList_itemActivated" ID="TabnannyDialog.on_resultList_itemActivated"></a>
304 <h4>TabnannyDialog.on_resultList_itemActivated</h4>
305 <b>on_resultList_itemActivated</b>(<i>itm, col</i>)
306
307 <p>
308 Private slot to handle the activation of an item.
309 </p>
310 <dl>
311
312 <dt><i>itm</i></dt>
313 <dd>
314 reference to the activated item (QTreeWidgetItem)
315 </dd>
316 <dt><i>col</i></dt>
317 <dd>
318 column the item was activated in (integer)
319 </dd>
320 </dl>
321 <a NAME="TabnannyDialog.on_startButton_clicked" ID="TabnannyDialog.on_startButton_clicked"></a>
322 <h4>TabnannyDialog.on_startButton_clicked</h4>
323 <b>on_startButton_clicked</b>(<i></i>)
324
325 <p>
326 Private slot to start a code metrics run.
327 </p>
328 <a NAME="TabnannyDialog.prepare" ID="TabnannyDialog.prepare"></a>
329 <h4>TabnannyDialog.prepare</h4>
330 <b>prepare</b>(<i>fileList, project</i>)
331
332 <p>
333 Public method to prepare the dialog with a list of filenames.
334 </p>
335 <dl>
336
337 <dt><i>fileList</i></dt>
338 <dd>
339 list of filenames (list of strings)
340 </dd>
341 <dt><i>project</i></dt>
342 <dd>
343 reference to the project object (Project)
344 </dd>
345 </dl>
346 <a NAME="TabnannyDialog.start" ID="TabnannyDialog.start"></a>
347 <h4>TabnannyDialog.start</h4>
348 <b>start</b>(<i>fn</i>)
349
350 <p>
351 Public slot to start the tabnanny check.
352 </p>
353 <dl>
354
355 <dt><i>fn</i></dt>
356 <dd>
357 File or list of files or directory to be checked
358 (string or list of strings)
359 </dd>
360 </dl>
361 <div align="right"><a href="#top">Up</a></div>
362 <hr />
363 </body></html>

Mercurial Repository: eric

eric ide

mercurial