Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html

branch
eric7
changeset 9508
5a02bdb1dcba
parent 9236
db53a9efe7ef
child 9925
a267ac36dd69
equal deleted inserted replaced
9507:1f39839655ea 9508:5a02bdb1dcba
120 </tr> 120 </tr>
121 <tr> 121 <tr>
122 <td><a href="#SyntaxCheckerDialog.start">start</a></td> 122 <td><a href="#SyntaxCheckerDialog.start">start</a></td>
123 <td>Public slot to start the syntax check.</td> 123 <td>Public slot to start the syntax check.</td>
124 </tr> 124 </tr>
125 <tr>
126 <td><a href="#SyntaxCheckerDialog.startForBrowser">startForBrowser</a></td>
127 <td>Public slot to start the syntax check for the project sources browser.</td>
128 </tr>
125 </table> 129 </table>
126 <h3>Static Methods</h3> 130 <h3>Static Methods</h3>
127 131
128 <table> 132 <table>
129 <tr><td>None</td></tr> 133 <tr><td>None</td></tr>
136 <p> 140 <p>
137 Constructor 141 Constructor
138 </p> 142 </p>
139 <dl> 143 <dl>
140 144
141 <dt><i>parent</i></dt> 145 <dt><i>parent</i> (QWidget)</dt>
142 <dd> 146 <dd>
143 The parent widget. (QWidget) 147 reference to the parent widget
144 </dd> 148 </dd>
145 </dl> 149 </dl>
146 <a NAME="SyntaxCheckerDialog.__batchFinished" ID="SyntaxCheckerDialog.__batchFinished"></a> 150 <a NAME="SyntaxCheckerDialog.__batchFinished" ID="SyntaxCheckerDialog.__batchFinished"></a>
147 <h4>SyntaxCheckerDialog.__batchFinished</h4> 151 <h4>SyntaxCheckerDialog.__batchFinished</h4>
148 <b>__batchFinished</b>(<i></i>) 152 <b>__batchFinished</b>(<i></i>)
158 Private method to clear all error and warning markers of 162 Private method to clear all error and warning markers of
159 open editors to be checked. 163 open editors to be checked.
160 </p> 164 </p>
161 <dl> 165 <dl>
162 166
163 <dt><i>files</i></dt> 167 <dt><i>files</i> (list of str)</dt>
164 <dd> 168 <dd>
165 list of files to be checked (list of string) 169 list of files to be checked
166 </dd> 170 </dd>
167 </dl> 171 </dl>
168 <a NAME="SyntaxCheckerDialog.__createErrorItem" ID="SyntaxCheckerDialog.__createErrorItem"></a> 172 <a NAME="SyntaxCheckerDialog.__createErrorItem" ID="SyntaxCheckerDialog.__createErrorItem"></a>
169 <h4>SyntaxCheckerDialog.__createErrorItem</h4> 173 <h4>SyntaxCheckerDialog.__createErrorItem</h4>
170 <b>__createErrorItem</b>(<i>filename, message</i>) 174 <b>__createErrorItem</b>(<i>filename, message</i>)
190 <p> 194 <p>
191 Private method to create an entry in the result list. 195 Private method to create an entry in the result list.
192 </p> 196 </p>
193 <dl> 197 <dl>
194 198
195 <dt><i>filename</i></dt> 199 <dt><i>filename</i> (str)</dt>
196 <dd> 200 <dd>
197 file name of file (string) 201 file name of file
198 </dd> 202 </dd>
199 <dt><i>line</i></dt> 203 <dt><i>line</i> (int or str)</dt>
200 <dd> 204 <dd>
201 line number of faulty source (integer or string) 205 line number of faulty source
202 </dd> 206 </dd>
203 <dt><i>index</i></dt> 207 <dt><i>index</i> (int)</dt>
204 <dd> 208 <dd>
205 index number of fault (integer) 209 index number of fault
206 </dd> 210 </dd>
207 <dt><i>error</i></dt> 211 <dt><i>error</i> (str)</dt>
208 <dd> 212 <dd>
209 error text (string) 213 error text
210 </dd> 214 </dd>
211 <dt><i>sourcecode</i></dt> 215 <dt><i>sourcecode</i> (str)</dt>
212 <dd> 216 <dd>
213 faulty line of code (string) 217 faulty line of code
214 </dd> 218 </dd>
215 <dt><i>isWarning</i></dt> 219 <dt><i>isWarning</i> (bool)</dt>
216 <dd> 220 <dd>
217 flag indicating a warning message (boolean) 221 flag indicating a warning message
218 </dd> 222 </dd>
219 </dl> 223 </dl>
220 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a> 224 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a>
221 <h4>SyntaxCheckerDialog.__finish</h4> 225 <h4>SyntaxCheckerDialog.__finish</h4>
222 <b>__finish</b>(<i></i>) 226 <b>__finish</b>(<i></i>)
250 <p> 254 <p>
251 Private slot to display the reported messages. 255 Private slot to display the reported messages.
252 </p> 256 </p>
253 <dl> 257 <dl>
254 258
255 <dt><i>fn</i></dt> 259 <dt><i>fn</i> (str)</dt>
256 <dd> 260 <dd>
257 filename of the checked file (str) 261 filename of the checked file
258 </dd> 262 </dd>
259 <dt><i>problems</i></dt> 263 <dt><i>problems</i> (dict)</dt>
260 <dd> 264 <dd>
261 dictionary with the keys 'error' and 'warnings' which 265 dictionary with the keys 'error' and 'warnings' which
262 hold a list containing details about the error/ warnings 266 hold a list containing details about the error/ warnings
263 (file name, line number, column, codestring (only at syntax 267 (file name, line number, column, codestring (only at syntax
264 errors), the message) (dict) 268 errors), the message)
265 </dd> 269 </dd>
266 </dl> 270 </dl>
267 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> 271 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
268 <h4>SyntaxCheckerDialog.__resort</h4> 272 <h4>SyntaxCheckerDialog.__resort</h4>
269 <b>__resort</b>(<i></i>) 273 <b>__resort</b>(<i></i>)
281 <p> 285 <p>
282 The results are reported to the __processResult slot. 286 The results are reported to the __processResult slot.
283 </p> 287 </p>
284 <dl> 288 <dl>
285 289
286 <dt><i>codestring</i></dt> 290 <dt><i>codestring</i> (str)</dt>
287 <dd> 291 <dd>
288 optional sourcestring (str) 292 optional sourcestring
289 </dd> 293 </dd>
290 </dl> 294 </dl>
291 <a NAME="SyntaxCheckerDialog.checkBatch" ID="SyntaxCheckerDialog.checkBatch"></a> 295 <a NAME="SyntaxCheckerDialog.checkBatch" ID="SyntaxCheckerDialog.checkBatch"></a>
292 <h4>SyntaxCheckerDialog.checkBatch</h4> 296 <h4>SyntaxCheckerDialog.checkBatch</h4>
293 <b>checkBatch</b>(<i></i>) 297 <b>checkBatch</b>(<i></i>)
305 <p> 309 <p>
306 Private slot called by a button of the button box clicked. 310 Private slot called by a button of the button box clicked.
307 </p> 311 </p>
308 <dl> 312 <dl>
309 313
310 <dt><i>button</i></dt> 314 <dt><i>button</i> (QAbstractButton)</dt>
311 <dd> 315 <dd>
312 button that was clicked (QAbstractButton) 316 button that was clicked
313 </dd> 317 </dd>
314 </dl> 318 </dl>
315 <a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a> 319 <a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a>
316 <h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4> 320 <h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4>
317 <b>on_resultList_itemActivated</b>(<i>itm, col</i>) 321 <b>on_resultList_itemActivated</b>(<i>itm, col</i>)
319 <p> 323 <p>
320 Private slot to handle the activation of an item. 324 Private slot to handle the activation of an item.
321 </p> 325 </p>
322 <dl> 326 <dl>
323 327
324 <dt><i>itm</i></dt> 328 <dt><i>itm</i> (QTreeWidgetItem)</dt>
325 <dd> 329 <dd>
326 reference to the activated item (QTreeWidgetItem) 330 reference to the activated item
327 </dd> 331 </dd>
328 <dt><i>col</i></dt> 332 <dt><i>col</i> (int)</dt>
329 <dd> 333 <dd>
330 column the item was activated in (integer) 334 column the item was activated in
331 </dd> 335 </dd>
332 </dl> 336 </dl>
333 <a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a> 337 <a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a>
334 <h4>SyntaxCheckerDialog.on_showButton_clicked</h4> 338 <h4>SyntaxCheckerDialog.on_showButton_clicked</h4>
335 <b>on_showButton_clicked</b>(<i></i>) 339 <b>on_showButton_clicked</b>(<i></i>)
351 <p> 355 <p>
352 Public method to prepare the dialog with a list of filenames. 356 Public method to prepare the dialog with a list of filenames.
353 </p> 357 </p>
354 <dl> 358 <dl>
355 359
356 <dt><i>fileList</i></dt> 360 <dt><i>fileList</i> (list of str)</dt>
357 <dd> 361 <dd>
358 list of filenames (list of strings) 362 list of filenames
359 </dd> 363 </dd>
360 <dt><i>project</i></dt> 364 <dt><i>project</i> (Project)</dt>
361 <dd> 365 <dd>
362 reference to the project object (Project) 366 reference to the project object
363 </dd> 367 </dd>
364 </dl> 368 </dl>
365 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a> 369 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a>
366 <h4>SyntaxCheckerDialog.start</h4> 370 <h4>SyntaxCheckerDialog.start</h4>
367 <b>start</b>(<i>fn, codestring=""</i>) 371 <b>start</b>(<i>fn, codestring=""</i>)
369 <p> 373 <p>
370 Public slot to start the syntax check. 374 Public slot to start the syntax check.
371 </p> 375 </p>
372 <dl> 376 <dl>
373 377
374 <dt><i>fn</i></dt> 378 <dt><i>fn</i> (str or list of str)</dt>
375 <dd> 379 <dd>
376 file or list of files or directory to be checked 380 file or list of files or directory to be checked
377 (string or list of strings) 381 </dd>
378 </dd> 382 <dt><i>codestring</i> (str)</dt>
379 <dt><i>codestring</i></dt> 383 <dd>
380 <dd> 384 string containing the code to be checked. If this is given,
381 string containing the code to be checked (string). 385 fn must be a single file name.
382 If this is given, fn must be a single file name. 386 </dd>
387 </dl>
388 <a NAME="SyntaxCheckerDialog.startForBrowser" ID="SyntaxCheckerDialog.startForBrowser"></a>
389 <h4>SyntaxCheckerDialog.startForBrowser</h4>
390 <b>startForBrowser</b>(<i>fn</i>)
391
392 <p>
393 Public slot to start the syntax check for the project sources browser.
394 </p>
395 <dl>
396
397 <dt><i>fn</i> (str or list of str)</dt>
398 <dd>
399 file or list of files or directory to be checked
383 </dd> 400 </dd>
384 </dl> 401 </dl>
385 <div align="right"><a href="#top">Up</a></div> 402 <div align="right"><a href="#top">Up</a></div>
386 <hr /> 403 <hr />
387 </body></html> 404 </body></html>

Mercurial Repository: eric

eric ide

mercurial