Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html

branch
BgService
changeset 3209
c5432abceb25
parent 2387
2d119e79ab54
child 3456
96232974dcdb
equal deleted inserted replaced
3177:5af61402d74d 3209:c5432abceb25
67 <td>Private method to create an entry in the result list.</td> 67 <td>Private method to create an entry in the result list.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td> 69 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td>
70 <td>Private slot called when the syntax check finished or the user pressed the button.</td> 70 <td>Private slot called when the syntax check finished or the user pressed the button.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#SyntaxCheckerDialog.__processResult">__processResult</a></td>
73 <td>Slot to display the reported messages.</td>
74 </tr><tr>
72 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td> 75 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td>
73 <td>Private method to resort the tree.</td> 76 <td>Private method to resort the tree.</td>
77 </tr><tr>
78 <td><a href="#SyntaxCheckerDialog.check">check</a></td>
79 <td>Start a check for one file.</td>
74 </tr><tr> 80 </tr><tr>
75 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 81 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
76 <td>Private slot called by a button of the button box clicked.</td> 82 <td>Private slot called by a button of the button box clicked.</td>
77 </tr><tr> 83 </tr><tr>
78 <td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> 84 <td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
139 <h4>SyntaxCheckerDialog.__finish</h4> 145 <h4>SyntaxCheckerDialog.__finish</h4>
140 <b>__finish</b>(<i></i>) 146 <b>__finish</b>(<i></i>)
141 <p> 147 <p>
142 Private slot called when the syntax check finished or the user 148 Private slot called when the syntax check finished or the user
143 pressed the button. 149 pressed the button.
144 </p><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> 150 </p><a NAME="SyntaxCheckerDialog.__processResult" ID="SyntaxCheckerDialog.__processResult"></a>
151 <h4>SyntaxCheckerDialog.__processResult</h4>
152 <b>__processResult</b>(<i>fn, nok, fname, line, index, code, error, warnings</i>)
153 <p>
154 Slot to display the reported messages.
155 </p><p>
156 If checkFlakes is True, warnings contains a list of strings containing
157 the warnings (marker, file name, line number, message)
158 The values are only valid, if nok is False.
159 </p><dl>
160 <dt><i>fn</i></dt>
161 <dd>
162 filename of the checked file (str)
163 </dd><dt><i>nok</i></dt>
164 <dd>
165 flag if an error in the source was found (boolean)
166 </dd><dt><i>fname</i></dt>
167 <dd>
168 filename of the checked file (str) # TODO: remove dubl.
169 </dd><dt><i>line</i></dt>
170 <dd>
171 number where the error occured (int)
172 </dd><dt><i>index</i></dt>
173 <dd>
174 the column where the error occured (int)
175 </dd><dt><i>code</i></dt>
176 <dd>
177 the part of the code where the error occured (str)
178 </dd><dt><i>error</i></dt>
179 <dd>
180 the name of the error (str)
181 </dd><dt><i>warnings</i></dt>
182 <dd>
183 a list of strings containing the warnings
184 (marker, file name, line number, col, message)
185 </dd>
186 </dl><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a>
145 <h4>SyntaxCheckerDialog.__resort</h4> 187 <h4>SyntaxCheckerDialog.__resort</h4>
146 <b>__resort</b>(<i></i>) 188 <b>__resort</b>(<i></i>)
147 <p> 189 <p>
148 Private method to resort the tree. 190 Private method to resort the tree.
149 </p><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a> 191 </p><a NAME="SyntaxCheckerDialog.check" ID="SyntaxCheckerDialog.check"></a>
192 <h4>SyntaxCheckerDialog.check</h4>
193 <b>check</b>(<i>codestring=''</i>)
194 <p>
195 Start a check for one file.
196 </p><p>
197 The results are reported to the __processResult slot.
198 </p><dl>
199 <dt><i>codestring=</i></dt>
200 <dd>
201 optional sourcestring (str)
202 </dd>
203 </dl><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a>
150 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4> 204 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4>
151 <b>on_buttonBox_clicked</b>(<i>button</i>) 205 <b>on_buttonBox_clicked</b>(<i>button</i>)
152 <p> 206 <p>
153 Private slot called by a button of the button box clicked. 207 Private slot called by a button of the button box clicked.
154 </p><dl> 208 </p><dl>
203 file or list of files or directory to be checked 257 file or list of files or directory to be checked
204 (string or list of strings) 258 (string or list of strings)
205 </dd><dt><i>codestring</i></dt> 259 </dd><dt><i>codestring</i></dt>
206 <dd> 260 <dd>
207 string containing the code to be checked (string). 261 string containing the code to be checked (string).
208 If this is given, file must be a single file name. 262 If this is given, fn must be a single file name.
209 </dd> 263 </dd>
210 </dl> 264 </dl>
211 <div align="right"><a href="#top">Up</a></div> 265 <div align="right"><a href="#top">Up</a></div>
212 <hr /> 266 <hr />
213 </body></html> 267 </body></html>

eric ide

mercurial