src/eric7/Documentation/Source/eric7.Plugins.PluginCodeStyleChecker.html

branch
eric7
changeset 10437
2f70ca07f0af
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10436:f6881d10e995 10437:2f70ca07f0af
161 <p> 161 <p>
162 Constructor 162 Constructor
163 </p> 163 </p>
164 <dl> 164 <dl>
165 165
166 <dt><i>ui</i></dt> 166 <dt><i>ui</i> (UserInterface)</dt>
167 <dd> 167 <dd>
168 reference to the user interface object (UI.UserInterface) 168 reference to the user interface object
169 </dd> 169 </dd>
170 </dl> 170 </dl>
171 <a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a> 171 <a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a>
172 <h4>CodeStyleCheckerPlugin.__editorClosed</h4> 172 <h4>CodeStyleCheckerPlugin.__editorClosed</h4>
173 <b>__editorClosed</b>(<i>editor</i>) 173 <b>__editorClosed</b>(<i>editor</i>)
175 <p> 175 <p>
176 Private slot called, when an editor was closed. 176 Private slot called, when an editor was closed.
177 </p> 177 </p>
178 <dl> 178 <dl>
179 179
180 <dt><i>editor</i></dt> 180 <dt><i>editor</i> (Editor)</dt>
181 <dd> 181 <dd>
182 reference to the editor (QScintilla.Editor) 182 reference to the editor
183 </dd> 183 </dd>
184 </dl> 184 </dl>
185 <a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a> 185 <a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a>
186 <h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4> 186 <h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4>
187 <b>__editorCodeStyleCheck</b>(<i></i>) 187 <b>__editorCodeStyleCheck</b>(<i></i>)
197 <p> 197 <p>
198 Private slot called, when a new editor was opened. 198 Private slot called, when a new editor was opened.
199 </p> 199 </p>
200 <dl> 200 <dl>
201 201
202 <dt><i>editor</i></dt> 202 <dt><i>editor</i> (Editor)</dt>
203 <dd> 203 <dd>
204 reference to the new editor (QScintilla.Editor) 204 reference to the new editor
205 </dd> 205 </dd>
206 </dl> 206 </dl>
207 <a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a> 207 <a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a>
208 <h4>CodeStyleCheckerPlugin.__editorShowMenu</h4> 208 <h4>CodeStyleCheckerPlugin.__editorShowMenu</h4>
209 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 209 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
212 Private slot called, when the the editor context menu or a submenu is 212 Private slot called, when the the editor context menu or a submenu is
213 about to be shown. 213 about to be shown.
214 </p> 214 </p>
215 <dl> 215 <dl>
216 216
217 <dt><i>menuName</i></dt> 217 <dt><i>menuName</i> (str)</dt>
218 <dd> 218 <dd>
219 name of the menu to be shown (string) 219 name of the menu to be shown
220 </dd> 220 </dd>
221 <dt><i>menu</i></dt> 221 <dt><i>menu</i> (QMenu)</dt>
222 <dd> 222 <dd>
223 reference to the menu (QMenu) 223 reference to the menu
224 </dd> 224 </dd>
225 <dt><i>editor</i></dt> 225 <dt><i>editor</i> (Editor)</dt>
226 <dd> 226 <dd>
227 reference to the editor 227 reference to the editor
228 </dd> 228 </dd>
229 </dl> 229 </dl>
230 <a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a> 230 <a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a>
250 Private slot called, when the the project browser menu or a submenu is 250 Private slot called, when the the project browser menu or a submenu is
251 about to be shown. 251 about to be shown.
252 </p> 252 </p>
253 <dl> 253 <dl>
254 254
255 <dt><i>menuName</i></dt> 255 <dt><i>menuName</i> (str)</dt>
256 <dd> 256 <dd>
257 name of the menu to be shown (string) 257 name of the menu to be shown
258 </dd> 258 </dd>
259 <dt><i>menu</i></dt> 259 <dt><i>menu</i> (QMenu)</dt>
260 <dd> 260 <dd>
261 reference to the menu (QMenu) 261 reference to the menu
262 </dd> 262 </dd>
263 </dl> 263 </dl>
264 <a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a> 264 <a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a>
265 <h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4> 265 <h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4>
266 <b>__projectCodeStyleCheck</b>(<i></i>) 266 <b>__projectCodeStyleCheck</b>(<i></i>)
276 Private slot called, when the the project menu or a submenu is 276 Private slot called, when the the project menu or a submenu is
277 about to be shown. 277 about to be shown.
278 </p> 278 </p>
279 <dl> 279 <dl>
280 280
281 <dt><i>menuName</i></dt> 281 <dt><i>menuName</i> (str)</dt>
282 <dd> 282 <dd>
283 name of the menu to be shown (string) 283 name of the menu to be shown
284 </dd> 284 </dd>
285 <dt><i>menu</i></dt> 285 <dt><i>menu</i> (QMenu)</dt>
286 <dd> 286 <dd>
287 reference to the menu (QMenu) 287 reference to the menu
288 </dd> 288 </dd>
289 </dl> 289 </dl>
290 <a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a> 290 <a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a>
291 <h4>CodeStyleCheckerPlugin.__serviceError</h4> 291 <h4>CodeStyleCheckerPlugin.__serviceError</h4>
292 <b>__serviceError</b>(<i>fn, msg</i>) 292 <b>__serviceError</b>(<i>fn, msg</i>)
294 <p> 294 <p>
295 Private slot handling service errors. 295 Private slot handling service errors.
296 </p> 296 </p>
297 <dl> 297 <dl>
298 298
299 <dt><i>fn</i></dt> 299 <dt><i>fn</i> (str)</dt>
300 <dd> 300 <dd>
301 file name (string) 301 file name
302 </dd> 302 </dd>
303 <dt><i>msg</i></dt> 303 <dt><i>msg</i> (str)</dt>
304 <dd> 304 <dd>
305 message text (string) 305 message text
306 </dd> 306 </dd>
307 </dl> 307 </dl>
308 <a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a> 308 <a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a>
309 <h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4> 309 <h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4>
310 <b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>) 310 <b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>)
336 Public method to activate this plugin. 336 Public method to activate this plugin.
337 </p> 337 </p>
338 <dl> 338 <dl>
339 <dt>Return:</dt> 339 <dt>Return:</dt>
340 <dd> 340 <dd>
341 tuple of None and activation status (boolean) 341 tuple of None and activation status
342 </dd>
343 </dl>
344 <dl>
345 <dt>Return Type:</dt>
346 <dd>
347 bool
342 </dd> 348 </dd>
343 </dl> 349 </dl>
344 <a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a> 350 <a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a>
345 <h4>CodeStyleCheckerPlugin.batchJobDone</h4> 351 <h4>CodeStyleCheckerPlugin.batchJobDone</h4>
346 <b>batchJobDone</b>(<i>fx, lang</i>) 352 <b>batchJobDone</b>(<i>fx, lang</i>)
348 <p> 354 <p>
349 Public slot handling the completion of a batch job. 355 Public slot handling the completion of a batch job.
350 </p> 356 </p>
351 <dl> 357 <dl>
352 358
353 <dt><i>fx</i></dt> 359 <dt><i>fx</i> (str)</dt>
354 <dd> 360 <dd>
355 service name (string) 361 service name
356 </dd> 362 </dd>
357 <dt><i>lang</i></dt> 363 <dt><i>lang</i> (str)</dt>
358 <dd> 364 <dd>
359 language (string) 365 language
360 </dd> 366 </dd>
361 </dl> 367 </dl>
362 <a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a> 368 <a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a>
363 <h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4> 369 <h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4>
364 <b>cancelStyleBatchCheck</b>(<i></i>) 370 <b>cancelStyleBatchCheck</b>(<i></i>)
380 <p> 386 <p>
381 Public slot handling service errors for Python 3. 387 Public slot handling service errors for Python 3.
382 </p> 388 </p>
383 <dl> 389 <dl>
384 390
385 <dt><i>fx</i></dt> 391 <dt><i>fx</i> (str)</dt>
386 <dd> 392 <dd>
387 service name (string) 393 service name
388 </dd> 394 </dd>
389 <dt><i>lang</i></dt> 395 <dt><i>lang</i> (str)</dt>
390 <dd> 396 <dd>
391 language (string) 397 language
392 </dd> 398 </dd>
393 <dt><i>fn</i></dt> 399 <dt><i>fn</i> (str)</dt>
394 <dd> 400 <dd>
395 file name (string) 401 file name
396 </dd> 402 </dd>
397 <dt><i>msg</i></dt> 403 <dt><i>msg</i> (str)</dt>
398 <dd> 404 <dd>
399 message text (string) 405 message text
400 </dd> 406 </dd>
401 </dl> 407 </dl>
402 <a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a> 408 <a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a>
403 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4> 409 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4>
404 <b>styleBatchCheck</b>(<i>argumentsList</i>) 410 <b>styleBatchCheck</b>(<i>argumentsList</i>)

eric ide

mercurial