43 <h2>TabnannyPlugin</h2> |
43 <h2>TabnannyPlugin</h2> |
44 <p> |
44 <p> |
45 Class implementing the Tabnanny plugin. |
45 Class implementing the Tabnanny plugin. |
46 </p><h3>Signals</h3> |
46 </p><h3>Signals</h3> |
47 <dl> |
47 <dl> |
48 <dt>indentChecked(str, bool, str, str)</dt> |
48 <dt>batchFinished()</dt> |
49 <dd> |
49 <dd> |
50 emited when the indent |
50 emitted when a style check batch is done |
|
51 </dd><dt>indentChecked(str, bool, str, str)</dt> |
|
52 <dd> |
|
53 emitted when the indent |
51 check was done. |
54 check was done. |
52 </dd> |
55 </dd> |
53 </dl> |
56 </dl> |
54 <h3>Derived from</h3> |
57 <h3>Derived from</h3> |
55 QObject |
58 QObject |
98 <td>Private slot handling service errors.</td> |
101 <td>Private slot handling service errors.</td> |
99 </tr><tr> |
102 </tr><tr> |
100 <td><a href="#TabnannyPlugin.activate">activate</a></td> |
103 <td><a href="#TabnannyPlugin.activate">activate</a></td> |
101 <td>Public method to activate this plugin.</td> |
104 <td>Public method to activate this plugin.</td> |
102 </tr><tr> |
105 </tr><tr> |
|
106 <td><a href="#TabnannyPlugin.batchJobDone">batchJobDone</a></td> |
|
107 <td>Public slot handling the completion of a batch job.</td> |
|
108 </tr><tr> |
|
109 <td><a href="#TabnannyPlugin.cancelIndentBatchCheck">cancelIndentBatchCheck</a></td> |
|
110 <td>Public method to cancel all batch jobs.</td> |
|
111 </tr><tr> |
103 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td> |
112 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td> |
104 <td>Public method to deactivate this plugin.</td> |
113 <td>Public method to deactivate this plugin.</td> |
105 </tr><tr> |
114 </tr><tr> |
|
115 <td><a href="#TabnannyPlugin.indentBatchCheck">indentBatchCheck</a></td> |
|
116 <td>Public method to prepare an indentation check on multiple Python source files.</td> |
|
117 </tr><tr> |
106 <td><a href="#TabnannyPlugin.indentCheck">indentCheck</a></td> |
118 <td><a href="#TabnannyPlugin.indentCheck">indentCheck</a></td> |
107 <td>Public method to prepare a style check on one Python source file.</td> |
119 <td>Public method to prepare an indentation check on one Python source file.</td> |
108 </tr><tr> |
120 </tr><tr> |
109 <td><a href="#TabnannyPlugin.serviceErrorPy2">serviceErrorPy2</a></td> |
121 <td><a href="#TabnannyPlugin.serviceErrorPy2">serviceErrorPy2</a></td> |
110 <td>Public method handling service errors for Python 2.</td> |
122 <td>Public slot handling service errors for Python 2.</td> |
111 </tr><tr> |
123 </tr><tr> |
112 <td><a href="#TabnannyPlugin.serviceErrorPy3">serviceErrorPy3</a></td> |
124 <td><a href="#TabnannyPlugin.serviceErrorPy3">serviceErrorPy3</a></td> |
113 <td>Public method handling service errors for Python 2.</td> |
125 <td>Public slot handling service errors for Python 2.</td> |
114 </tr> |
126 </tr> |
115 </table> |
127 </table> |
116 <h3>Static Methods</h3> |
128 <h3>Static Methods</h3> |
117 <table> |
129 <table> |
118 <tr><td>None</td></tr> |
130 <tr><td>None</td></tr> |
234 </p><dl> |
246 </p><dl> |
235 <dt>Returns:</dt> |
247 <dt>Returns:</dt> |
236 <dd> |
248 <dd> |
237 tuple of None and activation status (boolean) |
249 tuple of None and activation status (boolean) |
238 </dd> |
250 </dd> |
239 </dl><a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a> |
251 </dl><a NAME="TabnannyPlugin.batchJobDone" ID="TabnannyPlugin.batchJobDone"></a> |
|
252 <h4>TabnannyPlugin.batchJobDone</h4> |
|
253 <b>batchJobDone</b>(<i>fx, lang</i>) |
|
254 <p> |
|
255 Public slot handling the completion of a batch job. |
|
256 </p><dl> |
|
257 <dt><i>fx</i></dt> |
|
258 <dd> |
|
259 service name (string) |
|
260 </dd><dt><i>lang</i></dt> |
|
261 <dd> |
|
262 language (string) |
|
263 </dd> |
|
264 </dl><a NAME="TabnannyPlugin.cancelIndentBatchCheck" ID="TabnannyPlugin.cancelIndentBatchCheck"></a> |
|
265 <h4>TabnannyPlugin.cancelIndentBatchCheck</h4> |
|
266 <b>cancelIndentBatchCheck</b>(<i></i>) |
|
267 <p> |
|
268 Public method to cancel all batch jobs. |
|
269 </p><a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a> |
240 <h4>TabnannyPlugin.deactivate</h4> |
270 <h4>TabnannyPlugin.deactivate</h4> |
241 <b>deactivate</b>(<i></i>) |
271 <b>deactivate</b>(<i></i>) |
242 <p> |
272 <p> |
243 Public method to deactivate this plugin. |
273 Public method to deactivate this plugin. |
244 </p><a NAME="TabnannyPlugin.indentCheck" ID="TabnannyPlugin.indentCheck"></a> |
274 </p><a NAME="TabnannyPlugin.indentBatchCheck" ID="TabnannyPlugin.indentBatchCheck"></a> |
|
275 <h4>TabnannyPlugin.indentBatchCheck</h4> |
|
276 <b>indentBatchCheck</b>(<i>argumentsList</i>) |
|
277 <p> |
|
278 Public method to prepare an indentation check on multiple Python |
|
279 source files. |
|
280 </p><dl> |
|
281 <dt><i>argumentsList</i></dt> |
|
282 <dd> |
|
283 list of arguments tuples with each tuple |
|
284 containing filename and source (string, string) |
|
285 </dd> |
|
286 </dl><a NAME="TabnannyPlugin.indentCheck" ID="TabnannyPlugin.indentCheck"></a> |
245 <h4>TabnannyPlugin.indentCheck</h4> |
287 <h4>TabnannyPlugin.indentCheck</h4> |
246 <b>indentCheck</b>(<i>lang, filename, source</i>) |
288 <b>indentCheck</b>(<i>lang, filename, source</i>) |
247 <p> |
289 <p> |
248 Public method to prepare a style check on one Python source file. |
290 Public method to prepare an indentation check on one Python source |
|
291 file. |
249 </p><dl> |
292 </p><dl> |
250 <dt><i>lang</i></dt> |
293 <dt><i>lang</i></dt> |
251 <dd> |
294 <dd> |
252 language of the file or None to determine by internal |
295 language of the file or None to determine by internal |
253 algorithm (str or None) |
296 algorithm (str or None) |
260 </dd> |
303 </dd> |
261 </dl><a NAME="TabnannyPlugin.serviceErrorPy2" ID="TabnannyPlugin.serviceErrorPy2"></a> |
304 </dl><a NAME="TabnannyPlugin.serviceErrorPy2" ID="TabnannyPlugin.serviceErrorPy2"></a> |
262 <h4>TabnannyPlugin.serviceErrorPy2</h4> |
305 <h4>TabnannyPlugin.serviceErrorPy2</h4> |
263 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) |
306 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) |
264 <p> |
307 <p> |
265 Public method handling service errors for Python 2. |
308 Public slot handling service errors for Python 2. |
266 </p><dl> |
309 </p><dl> |
267 <dt><i>fx</i></dt> |
310 <dt><i>fx</i></dt> |
268 <dd> |
311 <dd> |
269 service name (string) |
312 service name (string) |
270 </dd><dt><i>lang</i></dt> |
313 </dd><dt><i>lang</i></dt> |
279 </dd> |
322 </dd> |
280 </dl><a NAME="TabnannyPlugin.serviceErrorPy3" ID="TabnannyPlugin.serviceErrorPy3"></a> |
323 </dl><a NAME="TabnannyPlugin.serviceErrorPy3" ID="TabnannyPlugin.serviceErrorPy3"></a> |
281 <h4>TabnannyPlugin.serviceErrorPy3</h4> |
324 <h4>TabnannyPlugin.serviceErrorPy3</h4> |
282 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) |
325 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) |
283 <p> |
326 <p> |
284 Public method handling service errors for Python 2. |
327 Public slot handling service errors for Python 2. |
285 </p><dl> |
328 </p><dl> |
286 <dt><i>fx</i></dt> |
329 <dt><i>fx</i></dt> |
287 <dd> |
330 <dd> |
288 service name (string) |
331 service name (string) |
289 </dd><dt><i>lang</i></dt> |
332 </dd><dt><i>lang</i></dt> |