Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html
eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7900
- 72b88fb20261
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.SyntaxChecker.SyntaxCheckerDialog</h1> | 23 <h1>eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a simple Python syntax checker. | 26 Module implementing a simple Python syntax checker. |
| 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> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#SyntaxCheckerDialog">SyntaxCheckerDialog</a></td> | 38 <td><a href="#SyntaxCheckerDialog">SyntaxCheckerDialog</a></td> |
| 34 <td>Class implementing a dialog to display the results of a syntax check run.</td> | 39 <td>Class implementing a dialog to display the results of a syntax check run.</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="SyntaxCheckerDialog" ID="SyntaxCheckerDialog"></a> | 49 <a NAME="SyntaxCheckerDialog" ID="SyntaxCheckerDialog"></a> |
| 43 <h2>SyntaxCheckerDialog</h2> | 50 <h2>SyntaxCheckerDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog to display the results of a syntax check run. | 53 Class implementing a dialog to display the results of a syntax check run. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog, Ui_SyntaxCheckerDialog | 56 QDialog, Ui_SyntaxCheckerDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>errorRole</td></tr><tr><td>filenameRole</td></tr><tr><td>indexRole</td></tr><tr><td>lineRole</td></tr><tr><td>warningRole</td></tr> | 60 <tr><td>errorRole</td></tr><tr><td>filenameRole</td></tr><tr><td>indexRole</td></tr><tr><td>lineRole</td></tr><tr><td>warningRole</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> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#SyntaxCheckerDialog.__init__">SyntaxCheckerDialog</a></td> | 72 <td><a href="#SyntaxCheckerDialog.__init__">SyntaxCheckerDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#SyntaxCheckerDialog.__batchFinished">__batchFinished</a></td> | 76 <td><a href="#SyntaxCheckerDialog.__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="#SyntaxCheckerDialog.__clearErrors">__clearErrors</a></td> | 80 <td><a href="#SyntaxCheckerDialog.__clearErrors">__clearErrors</a></td> |
| 67 <td>Private method to clear all error and warning markers of open editors to be checked.</td> | 81 <td>Private method to clear all error and warning markers of open editors to be checked.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#SyntaxCheckerDialog.__createErrorItem">__createErrorItem</a></td> | 84 <td><a href="#SyntaxCheckerDialog.__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="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td> | 88 <td><a href="#SyntaxCheckerDialog.__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="#SyntaxCheckerDialog.__finish">__finish</a></td> | 92 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td> |
| 76 <td>Private slot called when the syntax check finished or the user pressed the button.</td> | 93 <td>Private slot called when the syntax check finished or the user pressed the button.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#SyntaxCheckerDialog.__processError">__processError</a></td> | 96 <td><a href="#SyntaxCheckerDialog.__processError">__processError</a></td> |
| 79 <td>Private slot to process an error indication from the service.</td> | 97 <td>Private slot to process an error indication from the service.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td> | 100 <td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td> |
| 82 <td>Private slot to display the reported messages.</td> | 101 <td>Private slot to display the reported messages.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td> | 104 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td> |
| 85 <td>Private method to resort the tree.</td> | 105 <td>Private method to resort the tree.</td> |
| 86 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 87 <td><a href="#SyntaxCheckerDialog.check">check</a></td> | 108 <td><a href="#SyntaxCheckerDialog.check">check</a></td> |
| 88 <td>Public method to start a check for one file.</td> | 109 <td>Public method to start a check for one file.</td> |
| 89 </tr><tr> | 110 </tr> |
| 111 <tr> | |
| 90 <td><a href="#SyntaxCheckerDialog.checkBatch">checkBatch</a></td> | 112 <td><a href="#SyntaxCheckerDialog.checkBatch">checkBatch</a></td> |
| 91 <td>Public method to start a style check batch job.</td> | 113 <td>Public method to start a style check batch job.</td> |
| 92 </tr><tr> | 114 </tr> |
| 115 <tr> | |
| 93 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 116 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 94 <td>Private slot called by a button of the button box clicked.</td> | 117 <td>Private slot called by a button of the button box clicked.</td> |
| 95 </tr><tr> | 118 </tr> |
| 119 <tr> | |
| 96 <td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> | 120 <td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> |
| 97 <td>Private slot to handle the activation of an item.</td> | 121 <td>Private slot to handle the activation of an item.</td> |
| 98 </tr><tr> | 122 </tr> |
| 123 <tr> | |
| 99 <td><a href="#SyntaxCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td> | 124 <td><a href="#SyntaxCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td> |
| 100 <td>Private slot to handle the "Show" button press.</td> | 125 <td>Private slot to handle the "Show" button press.</td> |
| 101 </tr><tr> | 126 </tr> |
| 127 <tr> | |
| 102 <td><a href="#SyntaxCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td> | 128 <td><a href="#SyntaxCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td> |
| 103 <td>Private slot to start a syntax check run.</td> | 129 <td>Private slot to start a syntax check run.</td> |
| 104 </tr><tr> | 130 </tr> |
| 131 <tr> | |
| 105 <td><a href="#SyntaxCheckerDialog.prepare">prepare</a></td> | 132 <td><a href="#SyntaxCheckerDialog.prepare">prepare</a></td> |
| 106 <td>Public method to prepare the dialog with a list of filenames.</td> | 133 <td>Public method to prepare the dialog with a list of filenames.</td> |
| 107 </tr><tr> | 134 </tr> |
| 135 <tr> | |
| 108 <td><a href="#SyntaxCheckerDialog.start">start</a></td> | 136 <td><a href="#SyntaxCheckerDialog.start">start</a></td> |
| 109 <td>Public slot to start the syntax check.</td> | 137 <td>Public slot to start the syntax check.</td> |
| 110 </tr> | 138 </tr> |
| 111 </table> | 139 </table> |
| 112 <h3>Static Methods</h3> | 140 <h3>Static Methods</h3> |
| 141 | |
| 113 <table> | 142 <table> |
| 114 <tr><td>None</td></tr> | 143 <tr><td>None</td></tr> |
| 115 </table> | 144 </table> |
| 145 | |
| 116 <a NAME="SyntaxCheckerDialog.__init__" ID="SyntaxCheckerDialog.__init__"></a> | 146 <a NAME="SyntaxCheckerDialog.__init__" ID="SyntaxCheckerDialog.__init__"></a> |
| 117 <h4>SyntaxCheckerDialog (Constructor)</h4> | 147 <h4>SyntaxCheckerDialog (Constructor)</h4> |
| 118 <b>SyntaxCheckerDialog</b>(<i>parent=None</i>) | 148 <b>SyntaxCheckerDialog</b>(<i>parent=None</i>) |
| 149 | |
| 119 <p> | 150 <p> |
| 120 Constructor | 151 Constructor |
| 121 </p><dl> | 152 </p> |
| 153 <dl> | |
| 154 | |
| 122 <dt><i>parent</i></dt> | 155 <dt><i>parent</i></dt> |
| 123 <dd> | 156 <dd> |
| 124 The parent widget. (QWidget) | 157 The parent widget. (QWidget) |
| 125 </dd> | 158 </dd> |
| 126 </dl><a NAME="SyntaxCheckerDialog.__batchFinished" ID="SyntaxCheckerDialog.__batchFinished"></a> | 159 </dl> |
| 160 <a NAME="SyntaxCheckerDialog.__batchFinished" ID="SyntaxCheckerDialog.__batchFinished"></a> | |
| 127 <h4>SyntaxCheckerDialog.__batchFinished</h4> | 161 <h4>SyntaxCheckerDialog.__batchFinished</h4> |
| 128 <b>__batchFinished</b>(<i></i>) | 162 <b>__batchFinished</b>(<i></i>) |
| 163 | |
| 129 <p> | 164 <p> |
| 130 Private slot handling the completion of a batch job. | 165 Private slot handling the completion of a batch job. |
| 131 </p><a NAME="SyntaxCheckerDialog.__clearErrors" ID="SyntaxCheckerDialog.__clearErrors"></a> | 166 </p> |
| 167 <a NAME="SyntaxCheckerDialog.__clearErrors" ID="SyntaxCheckerDialog.__clearErrors"></a> | |
| 132 <h4>SyntaxCheckerDialog.__clearErrors</h4> | 168 <h4>SyntaxCheckerDialog.__clearErrors</h4> |
| 133 <b>__clearErrors</b>(<i>files</i>) | 169 <b>__clearErrors</b>(<i>files</i>) |
| 170 | |
| 134 <p> | 171 <p> |
| 135 Private method to clear all error and warning markers of | 172 Private method to clear all error and warning markers of |
| 136 open editors to be checked. | 173 open editors to be checked. |
| 137 </p><dl> | 174 </p> |
| 175 <dl> | |
| 176 | |
| 138 <dt><i>files</i></dt> | 177 <dt><i>files</i></dt> |
| 139 <dd> | 178 <dd> |
| 140 list of files to be checked (list of string) | 179 list of files to be checked (list of string) |
| 141 </dd> | 180 </dd> |
| 142 </dl><a NAME="SyntaxCheckerDialog.__createErrorItem" ID="SyntaxCheckerDialog.__createErrorItem"></a> | 181 </dl> |
| 182 <a NAME="SyntaxCheckerDialog.__createErrorItem" ID="SyntaxCheckerDialog.__createErrorItem"></a> | |
| 143 <h4>SyntaxCheckerDialog.__createErrorItem</h4> | 183 <h4>SyntaxCheckerDialog.__createErrorItem</h4> |
| 144 <b>__createErrorItem</b>(<i>filename, message</i>) | 184 <b>__createErrorItem</b>(<i>filename, message</i>) |
| 185 | |
| 145 <p> | 186 <p> |
| 146 Private slot to create a new error item in the result list. | 187 Private slot to create a new error item in the result list. |
| 147 </p><dl> | 188 </p> |
| 189 <dl> | |
| 190 | |
| 148 <dt><i>filename</i> (str)</dt> | 191 <dt><i>filename</i> (str)</dt> |
| 149 <dd> | 192 <dd> |
| 150 name of the file | 193 name of the file |
| 151 </dd><dt><i>message</i> (str)</dt> | 194 </dd> |
| 195 <dt><i>message</i> (str)</dt> | |
| 152 <dd> | 196 <dd> |
| 153 error message | 197 error message |
| 154 </dd> | 198 </dd> |
| 155 </dl><a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a> | 199 </dl> |
| 200 <a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a> | |
| 156 <h4>SyntaxCheckerDialog.__createResultItem</h4> | 201 <h4>SyntaxCheckerDialog.__createResultItem</h4> |
| 157 <b>__createResultItem</b>(<i>filename, line, index, error, sourcecode, isWarning=False</i>) | 202 <b>__createResultItem</b>(<i>filename, line, index, error, sourcecode, isWarning=False</i>) |
| 203 | |
| 158 <p> | 204 <p> |
| 159 Private method to create an entry in the result list. | 205 Private method to create an entry in the result list. |
| 160 </p><dl> | 206 </p> |
| 207 <dl> | |
| 208 | |
| 161 <dt><i>filename</i></dt> | 209 <dt><i>filename</i></dt> |
| 162 <dd> | 210 <dd> |
| 163 file name of file (string) | 211 file name of file (string) |
| 164 </dd><dt><i>line</i></dt> | 212 </dd> |
| 213 <dt><i>line</i></dt> | |
| 165 <dd> | 214 <dd> |
| 166 line number of faulty source (integer or string) | 215 line number of faulty source (integer or string) |
| 167 </dd><dt><i>index</i></dt> | 216 </dd> |
| 217 <dt><i>index</i></dt> | |
| 168 <dd> | 218 <dd> |
| 169 index number of fault (integer) | 219 index number of fault (integer) |
| 170 </dd><dt><i>error</i></dt> | 220 </dd> |
| 221 <dt><i>error</i></dt> | |
| 171 <dd> | 222 <dd> |
| 172 error text (string) | 223 error text (string) |
| 173 </dd><dt><i>sourcecode</i></dt> | 224 </dd> |
| 225 <dt><i>sourcecode</i></dt> | |
| 174 <dd> | 226 <dd> |
| 175 faulty line of code (string) | 227 faulty line of code (string) |
| 176 </dd><dt><i>isWarning</i></dt> | 228 </dd> |
| 229 <dt><i>isWarning</i></dt> | |
| 177 <dd> | 230 <dd> |
| 178 flag indicating a warning message (boolean) | 231 flag indicating a warning message (boolean) |
| 179 </dd> | 232 </dd> |
| 180 </dl><a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a> | 233 </dl> |
| 234 <a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a> | |
| 181 <h4>SyntaxCheckerDialog.__finish</h4> | 235 <h4>SyntaxCheckerDialog.__finish</h4> |
| 182 <b>__finish</b>(<i></i>) | 236 <b>__finish</b>(<i></i>) |
| 237 | |
| 183 <p> | 238 <p> |
| 184 Private slot called when the syntax check finished or the user | 239 Private slot called when the syntax check finished or the user |
| 185 pressed the button. | 240 pressed the button. |
| 186 </p><a NAME="SyntaxCheckerDialog.__processError" ID="SyntaxCheckerDialog.__processError"></a> | 241 </p> |
| 242 <a NAME="SyntaxCheckerDialog.__processError" ID="SyntaxCheckerDialog.__processError"></a> | |
| 187 <h4>SyntaxCheckerDialog.__processError</h4> | 243 <h4>SyntaxCheckerDialog.__processError</h4> |
| 188 <b>__processError</b>(<i>fn, msg</i>) | 244 <b>__processError</b>(<i>fn, msg</i>) |
| 245 | |
| 189 <p> | 246 <p> |
| 190 Private slot to process an error indication from the service. | 247 Private slot to process an error indication from the service. |
| 191 </p><dl> | 248 </p> |
| 249 <dl> | |
| 250 | |
| 192 <dt><i>fn</i> (str)</dt> | 251 <dt><i>fn</i> (str)</dt> |
| 193 <dd> | 252 <dd> |
| 194 filename of the file | 253 filename of the file |
| 195 </dd><dt><i>msg</i> (str)</dt> | 254 </dd> |
| 255 <dt><i>msg</i> (str)</dt> | |
| 196 <dd> | 256 <dd> |
| 197 error message | 257 error message |
| 198 </dd> | 258 </dd> |
| 199 </dl><a NAME="SyntaxCheckerDialog.__processResult" ID="SyntaxCheckerDialog.__processResult"></a> | 259 </dl> |
| 260 <a NAME="SyntaxCheckerDialog.__processResult" ID="SyntaxCheckerDialog.__processResult"></a> | |
| 200 <h4>SyntaxCheckerDialog.__processResult</h4> | 261 <h4>SyntaxCheckerDialog.__processResult</h4> |
| 201 <b>__processResult</b>(<i>fn, problems</i>) | 262 <b>__processResult</b>(<i>fn, problems</i>) |
| 263 | |
| 202 <p> | 264 <p> |
| 203 Private slot to display the reported messages. | 265 Private slot to display the reported messages. |
| 204 </p><dl> | 266 </p> |
| 267 <dl> | |
| 268 | |
| 205 <dt><i>fn</i></dt> | 269 <dt><i>fn</i></dt> |
| 206 <dd> | 270 <dd> |
| 207 filename of the checked file (str) | 271 filename of the checked file (str) |
| 208 </dd><dt><i>problems</i></dt> | 272 </dd> |
| 273 <dt><i>problems</i></dt> | |
| 209 <dd> | 274 <dd> |
| 210 dictionary with the keys 'error' and 'warnings' which | 275 dictionary with the keys 'error' and 'warnings' which |
| 211 hold a list containing details about the error/ warnings | 276 hold a list containing details about the error/ warnings |
| 212 (file name, line number, column, codestring (only at syntax | 277 (file name, line number, column, codestring (only at syntax |
| 213 errors), the message) (dict) | 278 errors), the message) (dict) |
| 214 </dd> | 279 </dd> |
| 215 </dl><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> | 280 </dl> |
| 281 <a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> | |
| 216 <h4>SyntaxCheckerDialog.__resort</h4> | 282 <h4>SyntaxCheckerDialog.__resort</h4> |
| 217 <b>__resort</b>(<i></i>) | 283 <b>__resort</b>(<i></i>) |
| 284 | |
| 218 <p> | 285 <p> |
| 219 Private method to resort the tree. | 286 Private method to resort the tree. |
| 220 </p><a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a> | 287 </p> |
| 288 <a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a> | |
| 221 <h4>SyntaxCheckerDialog.check</h4> | 289 <h4>SyntaxCheckerDialog.check</h4> |
| 222 <b>check</b>(<i>codestring=''</i>) | 290 <b>check</b>(<i>codestring=''</i>) |
| 291 | |
| 223 <p> | 292 <p> |
| 224 Public method to start a check for one file. | 293 Public method to start a check for one file. |
| 225 </p><p> | 294 </p> |
| 295 <p> | |
| 226 The results are reported to the __processResult slot. | 296 The results are reported to the __processResult slot. |
| 227 </p><dl> | 297 </p> |
| 298 <dl> | |
| 299 | |
| 228 <dt><i>codestring=</i></dt> | 300 <dt><i>codestring=</i></dt> |
| 229 <dd> | 301 <dd> |
| 230 optional sourcestring (str) | 302 optional sourcestring (str) |
| 231 </dd> | 303 </dd> |
| 232 </dl><a NAME="SyntaxCheckerDialog.checkBatch" ID="SyntaxCheckerDialog.checkBatch"></a> | 304 </dl> |
| 305 <a NAME="SyntaxCheckerDialog.checkBatch" ID="SyntaxCheckerDialog.checkBatch"></a> | |
| 233 <h4>SyntaxCheckerDialog.checkBatch</h4> | 306 <h4>SyntaxCheckerDialog.checkBatch</h4> |
| 234 <b>checkBatch</b>(<i></i>) | 307 <b>checkBatch</b>(<i></i>) |
| 308 | |
| 235 <p> | 309 <p> |
| 236 Public method to start a style check batch job. | 310 Public method to start a style check batch job. |
| 237 </p><p> | 311 </p> |
| 312 <p> | |
| 238 The results are reported to the __processResult slot. | 313 The results are reported to the __processResult slot. |
| 239 </p><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a> | 314 </p> |
| 315 <a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a> | |
| 240 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4> | 316 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4> |
| 241 <b>on_buttonBox_clicked</b>(<i>button</i>) | 317 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 318 | |
| 242 <p> | 319 <p> |
| 243 Private slot called by a button of the button box clicked. | 320 Private slot called by a button of the button box clicked. |
| 244 </p><dl> | 321 </p> |
| 322 <dl> | |
| 323 | |
| 245 <dt><i>button</i></dt> | 324 <dt><i>button</i></dt> |
| 246 <dd> | 325 <dd> |
| 247 button that was clicked (QAbstractButton) | 326 button that was clicked (QAbstractButton) |
| 248 </dd> | 327 </dd> |
| 249 </dl><a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a> | 328 </dl> |
| 329 <a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a> | |
| 250 <h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4> | 330 <h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4> |
| 251 <b>on_resultList_itemActivated</b>(<i>itm, col</i>) | 331 <b>on_resultList_itemActivated</b>(<i>itm, col</i>) |
| 332 | |
| 252 <p> | 333 <p> |
| 253 Private slot to handle the activation of an item. | 334 Private slot to handle the activation of an item. |
| 254 </p><dl> | 335 </p> |
| 336 <dl> | |
| 337 | |
| 255 <dt><i>itm</i></dt> | 338 <dt><i>itm</i></dt> |
| 256 <dd> | 339 <dd> |
| 257 reference to the activated item (QTreeWidgetItem) | 340 reference to the activated item (QTreeWidgetItem) |
| 258 </dd><dt><i>col</i></dt> | 341 </dd> |
| 342 <dt><i>col</i></dt> | |
| 259 <dd> | 343 <dd> |
| 260 column the item was activated in (integer) | 344 column the item was activated in (integer) |
| 261 </dd> | 345 </dd> |
| 262 </dl><a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a> | 346 </dl> |
| 347 <a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a> | |
| 263 <h4>SyntaxCheckerDialog.on_showButton_clicked</h4> | 348 <h4>SyntaxCheckerDialog.on_showButton_clicked</h4> |
| 264 <b>on_showButton_clicked</b>(<i></i>) | 349 <b>on_showButton_clicked</b>(<i></i>) |
| 350 | |
| 265 <p> | 351 <p> |
| 266 Private slot to handle the "Show" button press. | 352 Private slot to handle the "Show" button press. |
| 267 </p><a NAME="SyntaxCheckerDialog.on_startButton_clicked" ID="SyntaxCheckerDialog.on_startButton_clicked"></a> | 353 </p> |
| 354 <a NAME="SyntaxCheckerDialog.on_startButton_clicked" ID="SyntaxCheckerDialog.on_startButton_clicked"></a> | |
| 268 <h4>SyntaxCheckerDialog.on_startButton_clicked</h4> | 355 <h4>SyntaxCheckerDialog.on_startButton_clicked</h4> |
| 269 <b>on_startButton_clicked</b>(<i></i>) | 356 <b>on_startButton_clicked</b>(<i></i>) |
| 357 | |
| 270 <p> | 358 <p> |
| 271 Private slot to start a syntax check run. | 359 Private slot to start a syntax check run. |
| 272 </p><a NAME="SyntaxCheckerDialog.prepare" ID="SyntaxCheckerDialog.prepare"></a> | 360 </p> |
| 361 <a NAME="SyntaxCheckerDialog.prepare" ID="SyntaxCheckerDialog.prepare"></a> | |
| 273 <h4>SyntaxCheckerDialog.prepare</h4> | 362 <h4>SyntaxCheckerDialog.prepare</h4> |
| 274 <b>prepare</b>(<i>fileList, project</i>) | 363 <b>prepare</b>(<i>fileList, project</i>) |
| 364 | |
| 275 <p> | 365 <p> |
| 276 Public method to prepare the dialog with a list of filenames. | 366 Public method to prepare the dialog with a list of filenames. |
| 277 </p><dl> | 367 </p> |
| 368 <dl> | |
| 369 | |
| 278 <dt><i>fileList</i></dt> | 370 <dt><i>fileList</i></dt> |
| 279 <dd> | 371 <dd> |
| 280 list of filenames (list of strings) | 372 list of filenames (list of strings) |
| 281 </dd><dt><i>project</i></dt> | 373 </dd> |
| 374 <dt><i>project</i></dt> | |
| 282 <dd> | 375 <dd> |
| 283 reference to the project object (Project) | 376 reference to the project object (Project) |
| 284 </dd> | 377 </dd> |
| 285 </dl><a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a> | 378 </dl> |
| 379 <a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a> | |
| 286 <h4>SyntaxCheckerDialog.start</h4> | 380 <h4>SyntaxCheckerDialog.start</h4> |
| 287 <b>start</b>(<i>fn, codestring=""</i>) | 381 <b>start</b>(<i>fn, codestring=""</i>) |
| 382 | |
| 288 <p> | 383 <p> |
| 289 Public slot to start the syntax check. | 384 Public slot to start the syntax check. |
| 290 </p><dl> | 385 </p> |
| 386 <dl> | |
| 387 | |
| 291 <dt><i>fn</i></dt> | 388 <dt><i>fn</i></dt> |
| 292 <dd> | 389 <dd> |
| 293 file or list of files or directory to be checked | 390 file or list of files or directory to be checked |
| 294 (string or list of strings) | 391 (string or list of strings) |
| 295 </dd><dt><i>codestring</i></dt> | 392 </dd> |
| 393 <dt><i>codestring</i></dt> | |
| 296 <dd> | 394 <dd> |
| 297 string containing the code to be checked (string). | 395 string containing the code to be checked (string). |
| 298 If this is given, fn must be a single file name. | 396 If this is given, fn must be a single file name. |
| 299 </dd> | 397 </dd> |
| 300 </dl> | 398 </dl> |
