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

Mercurial Repository: eric

eric ide

mercurial