eric6/Documentation/Source/eric6.Plugins.PluginTabnanny.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7635
0cdead130a81
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.PluginTabnanny</h1> 23 <h1>eric6.Plugins.PluginTabnanny</h1>
24
23 <p> 25 <p>
24 Module implementing the Tabnanny plugin. 26 Module implementing the Tabnanny plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</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="#TabnannyPlugin">TabnannyPlugin</a></td> 38 <td><a href="#TabnannyPlugin">TabnannyPlugin</a></td>
34 <td>Class implementing the Tabnanny plugin.</td> 39 <td>Class implementing the Tabnanny plugin.</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="TabnannyPlugin" ID="TabnannyPlugin"></a> 49 <a NAME="TabnannyPlugin" ID="TabnannyPlugin"></a>
43 <h2>TabnannyPlugin</h2> 50 <h2>TabnannyPlugin</h2>
51
44 <p> 52 <p>
45 Class implementing the Tabnanny plugin. 53 Class implementing the Tabnanny plugin.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>batchFinished()</dt> 58 <dt>batchFinished()</dt>
49 <dd> 59 <dd>
50 emitted when a style check batch is done 60 emitted when a style check batch is done
51 </dd><dt>error(str, str)</dt> 61 </dd>
62 <dt>error(str, str)</dt>
52 <dd> 63 <dd>
53 emitted in case of an error 64 emitted in case of an error
54 </dd><dt>indentChecked(str, bool, str, str)</dt> 65 </dd>
66 <dt>indentChecked(str, bool, str, str)</dt>
55 <dd> 67 <dd>
56 emitted when the indent 68 emitted when the indent
57 check was done. 69 check was done.
58 </dd> 70 </dd>
59 </dl> 71 </dl>
60 <h3>Derived from</h3> 72 <h3>Derived from</h3>
61 QObject 73 QObject
62 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
80
67 <table> 81 <table>
68 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
69 </table> 83 </table>
70 <h3>Methods</h3> 84 <h3>Methods</h3>
71 <table> 85
86 <table>
87
72 <tr> 88 <tr>
73 <td><a href="#TabnannyPlugin.__init__">TabnannyPlugin</a></td> 89 <td><a href="#TabnannyPlugin.__init__">TabnannyPlugin</a></td>
74 <td>Constructor</td> 90 <td>Constructor</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#TabnannyPlugin.__editorClosed">__editorClosed</a></td> 93 <td><a href="#TabnannyPlugin.__editorClosed">__editorClosed</a></td>
77 <td>Private slot called, when an editor was closed.</td> 94 <td>Private slot called, when an editor was closed.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#TabnannyPlugin.__editorOpened">__editorOpened</a></td> 97 <td><a href="#TabnannyPlugin.__editorOpened">__editorOpened</a></td>
80 <td>Private slot called, when a new editor was opened.</td> 98 <td>Private slot called, when a new editor was opened.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#TabnannyPlugin.__editorShowMenu">__editorShowMenu</a></td> 101 <td><a href="#TabnannyPlugin.__editorShowMenu">__editorShowMenu</a></td>
83 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 102 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#TabnannyPlugin.__editorTabnanny">__editorTabnanny</a></td> 105 <td><a href="#TabnannyPlugin.__editorTabnanny">__editorTabnanny</a></td>
86 <td>Private slot to handle the tabnanny context menu action of the editors.</td> 106 <td>Private slot to handle the tabnanny context menu action of the editors.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#TabnannyPlugin.__initialize">__initialize</a></td> 109 <td><a href="#TabnannyPlugin.__initialize">__initialize</a></td>
89 <td>Private slot to (re)initialize the plugin.</td> 110 <td>Private slot to (re)initialize the plugin.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#TabnannyPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> 113 <td><a href="#TabnannyPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
92 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td> 114 <td>Private slot called, when the the project browser context menu or a submenu is about to be shown.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#TabnannyPlugin.__projectBrowserTabnanny">__projectBrowserTabnanny</a></td> 117 <td><a href="#TabnannyPlugin.__projectBrowserTabnanny">__projectBrowserTabnanny</a></td>
95 <td>Private method to handle the tabnanny context menu action of the project sources browser.</td> 118 <td>Private method to handle the tabnanny context menu action of the project sources browser.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#TabnannyPlugin.__projectShowMenu">__projectShowMenu</a></td> 121 <td><a href="#TabnannyPlugin.__projectShowMenu">__projectShowMenu</a></td>
98 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> 122 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#TabnannyPlugin.__projectTabnanny">__projectTabnanny</a></td> 125 <td><a href="#TabnannyPlugin.__projectTabnanny">__projectTabnanny</a></td>
101 <td>Private slot used to check the project files for bad indentations.</td> 126 <td>Private slot used to check the project files for bad indentations.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#TabnannyPlugin.__serviceError">__serviceError</a></td> 129 <td><a href="#TabnannyPlugin.__serviceError">__serviceError</a></td>
104 <td>Private slot handling service errors.</td> 130 <td>Private slot handling service errors.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#TabnannyPlugin.activate">activate</a></td> 133 <td><a href="#TabnannyPlugin.activate">activate</a></td>
107 <td>Public method to activate this plugin.</td> 134 <td>Public method to activate this plugin.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#TabnannyPlugin.batchJobDone">batchJobDone</a></td> 137 <td><a href="#TabnannyPlugin.batchJobDone">batchJobDone</a></td>
110 <td>Public slot handling the completion of a batch job.</td> 138 <td>Public slot handling the completion of a batch job.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#TabnannyPlugin.cancelIndentBatchCheck">cancelIndentBatchCheck</a></td> 141 <td><a href="#TabnannyPlugin.cancelIndentBatchCheck">cancelIndentBatchCheck</a></td>
113 <td>Public method to cancel all batch jobs.</td> 142 <td>Public method to cancel all batch jobs.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td> 145 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td>
116 <td>Public method to deactivate this plugin.</td> 146 <td>Public method to deactivate this plugin.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#TabnannyPlugin.indentBatchCheck">indentBatchCheck</a></td> 149 <td><a href="#TabnannyPlugin.indentBatchCheck">indentBatchCheck</a></td>
119 <td>Public method to prepare an indentation check on multiple Python source files.</td> 150 <td>Public method to prepare an indentation check on multiple Python source files.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#TabnannyPlugin.indentCheck">indentCheck</a></td> 153 <td><a href="#TabnannyPlugin.indentCheck">indentCheck</a></td>
122 <td>Public method to prepare an indentation check on one Python source file.</td> 154 <td>Public method to prepare an indentation check on one Python source file.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#TabnannyPlugin.serviceErrorPy2">serviceErrorPy2</a></td> 157 <td><a href="#TabnannyPlugin.serviceErrorPy2">serviceErrorPy2</a></td>
125 <td>Public slot handling service errors for Python 2.</td> 158 <td>Public slot handling service errors for Python 2.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#TabnannyPlugin.serviceErrorPy3">serviceErrorPy3</a></td> 161 <td><a href="#TabnannyPlugin.serviceErrorPy3">serviceErrorPy3</a></td>
128 <td>Public slot handling service errors for Python 2.</td> 162 <td>Public slot handling service errors for Python 2.</td>
129 </tr> 163 </tr>
130 </table> 164 </table>
131 <h3>Static Methods</h3> 165 <h3>Static Methods</h3>
166
132 <table> 167 <table>
133 <tr><td>None</td></tr> 168 <tr><td>None</td></tr>
134 </table> 169 </table>
170
135 <a NAME="TabnannyPlugin.__init__" ID="TabnannyPlugin.__init__"></a> 171 <a NAME="TabnannyPlugin.__init__" ID="TabnannyPlugin.__init__"></a>
136 <h4>TabnannyPlugin (Constructor)</h4> 172 <h4>TabnannyPlugin (Constructor)</h4>
137 <b>TabnannyPlugin</b>(<i>ui</i>) 173 <b>TabnannyPlugin</b>(<i>ui</i>)
174
138 <p> 175 <p>
139 Constructor 176 Constructor
140 </p><dl> 177 </p>
178 <dl>
179
141 <dt><i>ui</i></dt> 180 <dt><i>ui</i></dt>
142 <dd> 181 <dd>
143 reference to the user interface object (UI.UserInterface) 182 reference to the user interface object (UI.UserInterface)
144 </dd> 183 </dd>
145 </dl><a NAME="TabnannyPlugin.__editorClosed" ID="TabnannyPlugin.__editorClosed"></a> 184 </dl>
185 <a NAME="TabnannyPlugin.__editorClosed" ID="TabnannyPlugin.__editorClosed"></a>
146 <h4>TabnannyPlugin.__editorClosed</h4> 186 <h4>TabnannyPlugin.__editorClosed</h4>
147 <b>__editorClosed</b>(<i>editor</i>) 187 <b>__editorClosed</b>(<i>editor</i>)
188
148 <p> 189 <p>
149 Private slot called, when an editor was closed. 190 Private slot called, when an editor was closed.
150 </p><dl> 191 </p>
192 <dl>
193
151 <dt><i>editor</i></dt> 194 <dt><i>editor</i></dt>
152 <dd> 195 <dd>
153 reference to the editor (QScintilla.Editor) 196 reference to the editor (QScintilla.Editor)
154 </dd> 197 </dd>
155 </dl><a NAME="TabnannyPlugin.__editorOpened" ID="TabnannyPlugin.__editorOpened"></a> 198 </dl>
199 <a NAME="TabnannyPlugin.__editorOpened" ID="TabnannyPlugin.__editorOpened"></a>
156 <h4>TabnannyPlugin.__editorOpened</h4> 200 <h4>TabnannyPlugin.__editorOpened</h4>
157 <b>__editorOpened</b>(<i>editor</i>) 201 <b>__editorOpened</b>(<i>editor</i>)
202
158 <p> 203 <p>
159 Private slot called, when a new editor was opened. 204 Private slot called, when a new editor was opened.
160 </p><dl> 205 </p>
206 <dl>
207
161 <dt><i>editor</i></dt> 208 <dt><i>editor</i></dt>
162 <dd> 209 <dd>
163 reference to the new editor (QScintilla.Editor) 210 reference to the new editor (QScintilla.Editor)
164 </dd> 211 </dd>
165 </dl><a NAME="TabnannyPlugin.__editorShowMenu" ID="TabnannyPlugin.__editorShowMenu"></a> 212 </dl>
213 <a NAME="TabnannyPlugin.__editorShowMenu" ID="TabnannyPlugin.__editorShowMenu"></a>
166 <h4>TabnannyPlugin.__editorShowMenu</h4> 214 <h4>TabnannyPlugin.__editorShowMenu</h4>
167 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 215 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
216
168 <p> 217 <p>
169 Private slot called, when the the editor context menu or a submenu is 218 Private slot called, when the the editor context menu or a submenu is
170 about to be shown. 219 about to be shown.
171 </p><dl> 220 </p>
221 <dl>
222
172 <dt><i>menuName</i></dt> 223 <dt><i>menuName</i></dt>
173 <dd> 224 <dd>
174 name of the menu to be shown (string) 225 name of the menu to be shown (string)
175 </dd><dt><i>menu</i></dt> 226 </dd>
227 <dt><i>menu</i></dt>
176 <dd> 228 <dd>
177 reference to the menu (QMenu) 229 reference to the menu (QMenu)
178 </dd><dt><i>editor</i></dt> 230 </dd>
231 <dt><i>editor</i></dt>
179 <dd> 232 <dd>
180 reference to the editor 233 reference to the editor
181 </dd> 234 </dd>
182 </dl><a NAME="TabnannyPlugin.__editorTabnanny" ID="TabnannyPlugin.__editorTabnanny"></a> 235 </dl>
236 <a NAME="TabnannyPlugin.__editorTabnanny" ID="TabnannyPlugin.__editorTabnanny"></a>
183 <h4>TabnannyPlugin.__editorTabnanny</h4> 237 <h4>TabnannyPlugin.__editorTabnanny</h4>
184 <b>__editorTabnanny</b>(<i></i>) 238 <b>__editorTabnanny</b>(<i></i>)
239
185 <p> 240 <p>
186 Private slot to handle the tabnanny context menu action of the editors. 241 Private slot to handle the tabnanny context menu action of the editors.
187 </p><a NAME="TabnannyPlugin.__initialize" ID="TabnannyPlugin.__initialize"></a> 242 </p>
243 <a NAME="TabnannyPlugin.__initialize" ID="TabnannyPlugin.__initialize"></a>
188 <h4>TabnannyPlugin.__initialize</h4> 244 <h4>TabnannyPlugin.__initialize</h4>
189 <b>__initialize</b>(<i></i>) 245 <b>__initialize</b>(<i></i>)
246
190 <p> 247 <p>
191 Private slot to (re)initialize the plugin. 248 Private slot to (re)initialize the plugin.
192 </p><a NAME="TabnannyPlugin.__projectBrowserShowMenu" ID="TabnannyPlugin.__projectBrowserShowMenu"></a> 249 </p>
250 <a NAME="TabnannyPlugin.__projectBrowserShowMenu" ID="TabnannyPlugin.__projectBrowserShowMenu"></a>
193 <h4>TabnannyPlugin.__projectBrowserShowMenu</h4> 251 <h4>TabnannyPlugin.__projectBrowserShowMenu</h4>
194 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) 252 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
253
195 <p> 254 <p>
196 Private slot called, when the the project browser context menu or a 255 Private slot called, when the the project browser context menu or a
197 submenu is about to be shown. 256 submenu is about to be shown.
198 </p><dl> 257 </p>
258 <dl>
259
199 <dt><i>menuName</i></dt> 260 <dt><i>menuName</i></dt>
200 <dd> 261 <dd>
201 name of the menu to be shown (string) 262 name of the menu to be shown (string)
202 </dd><dt><i>menu</i></dt> 263 </dd>
264 <dt><i>menu</i></dt>
203 <dd> 265 <dd>
204 reference to the menu (QMenu) 266 reference to the menu (QMenu)
205 </dd> 267 </dd>
206 </dl><a NAME="TabnannyPlugin.__projectBrowserTabnanny" ID="TabnannyPlugin.__projectBrowserTabnanny"></a> 268 </dl>
269 <a NAME="TabnannyPlugin.__projectBrowserTabnanny" ID="TabnannyPlugin.__projectBrowserTabnanny"></a>
207 <h4>TabnannyPlugin.__projectBrowserTabnanny</h4> 270 <h4>TabnannyPlugin.__projectBrowserTabnanny</h4>
208 <b>__projectBrowserTabnanny</b>(<i></i>) 271 <b>__projectBrowserTabnanny</b>(<i></i>)
272
209 <p> 273 <p>
210 Private method to handle the tabnanny context menu action of the 274 Private method to handle the tabnanny context menu action of the
211 project sources browser. 275 project sources browser.
212 </p><a NAME="TabnannyPlugin.__projectShowMenu" ID="TabnannyPlugin.__projectShowMenu"></a> 276 </p>
277 <a NAME="TabnannyPlugin.__projectShowMenu" ID="TabnannyPlugin.__projectShowMenu"></a>
213 <h4>TabnannyPlugin.__projectShowMenu</h4> 278 <h4>TabnannyPlugin.__projectShowMenu</h4>
214 <b>__projectShowMenu</b>(<i>menuName, menu</i>) 279 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
280
215 <p> 281 <p>
216 Private slot called, when the the project menu or a submenu is 282 Private slot called, when the the project menu or a submenu is
217 about to be shown. 283 about to be shown.
218 </p><dl> 284 </p>
285 <dl>
286
219 <dt><i>menuName</i></dt> 287 <dt><i>menuName</i></dt>
220 <dd> 288 <dd>
221 name of the menu to be shown (string) 289 name of the menu to be shown (string)
222 </dd><dt><i>menu</i></dt> 290 </dd>
291 <dt><i>menu</i></dt>
223 <dd> 292 <dd>
224 reference to the menu (QMenu) 293 reference to the menu (QMenu)
225 </dd> 294 </dd>
226 </dl><a NAME="TabnannyPlugin.__projectTabnanny" ID="TabnannyPlugin.__projectTabnanny"></a> 295 </dl>
296 <a NAME="TabnannyPlugin.__projectTabnanny" ID="TabnannyPlugin.__projectTabnanny"></a>
227 <h4>TabnannyPlugin.__projectTabnanny</h4> 297 <h4>TabnannyPlugin.__projectTabnanny</h4>
228 <b>__projectTabnanny</b>(<i></i>) 298 <b>__projectTabnanny</b>(<i></i>)
299
229 <p> 300 <p>
230 Private slot used to check the project files for bad indentations. 301 Private slot used to check the project files for bad indentations.
231 </p><a NAME="TabnannyPlugin.__serviceError" ID="TabnannyPlugin.__serviceError"></a> 302 </p>
303 <a NAME="TabnannyPlugin.__serviceError" ID="TabnannyPlugin.__serviceError"></a>
232 <h4>TabnannyPlugin.__serviceError</h4> 304 <h4>TabnannyPlugin.__serviceError</h4>
233 <b>__serviceError</b>(<i>fn, msg</i>) 305 <b>__serviceError</b>(<i>fn, msg</i>)
306
234 <p> 307 <p>
235 Private slot handling service errors. 308 Private slot handling service errors.
236 </p><dl> 309 </p>
310 <dl>
311
237 <dt><i>fn</i></dt> 312 <dt><i>fn</i></dt>
238 <dd> 313 <dd>
239 file name (string) 314 file name (string)
240 </dd><dt><i>msg</i></dt> 315 </dd>
316 <dt><i>msg</i></dt>
241 <dd> 317 <dd>
242 message text (string) 318 message text (string)
243 </dd> 319 </dd>
244 </dl><a NAME="TabnannyPlugin.activate" ID="TabnannyPlugin.activate"></a> 320 </dl>
321 <a NAME="TabnannyPlugin.activate" ID="TabnannyPlugin.activate"></a>
245 <h4>TabnannyPlugin.activate</h4> 322 <h4>TabnannyPlugin.activate</h4>
246 <b>activate</b>(<i></i>) 323 <b>activate</b>(<i></i>)
324
247 <p> 325 <p>
248 Public method to activate this plugin. 326 Public method to activate this plugin.
249 </p><dl> 327 </p>
328 <dl>
250 <dt>Returns:</dt> 329 <dt>Returns:</dt>
251 <dd> 330 <dd>
252 tuple of None and activation status (boolean) 331 tuple of None and activation status (boolean)
253 </dd> 332 </dd>
254 </dl><a NAME="TabnannyPlugin.batchJobDone" ID="TabnannyPlugin.batchJobDone"></a> 333 </dl>
334 <a NAME="TabnannyPlugin.batchJobDone" ID="TabnannyPlugin.batchJobDone"></a>
255 <h4>TabnannyPlugin.batchJobDone</h4> 335 <h4>TabnannyPlugin.batchJobDone</h4>
256 <b>batchJobDone</b>(<i>fx, lang</i>) 336 <b>batchJobDone</b>(<i>fx, lang</i>)
337
257 <p> 338 <p>
258 Public slot handling the completion of a batch job. 339 Public slot handling the completion of a batch job.
259 </p><dl> 340 </p>
341 <dl>
342
260 <dt><i>fx</i></dt> 343 <dt><i>fx</i></dt>
261 <dd> 344 <dd>
262 service name (string) 345 service name (string)
263 </dd><dt><i>lang</i></dt> 346 </dd>
347 <dt><i>lang</i></dt>
264 <dd> 348 <dd>
265 language (string) 349 language (string)
266 </dd> 350 </dd>
267 </dl><a NAME="TabnannyPlugin.cancelIndentBatchCheck" ID="TabnannyPlugin.cancelIndentBatchCheck"></a> 351 </dl>
352 <a NAME="TabnannyPlugin.cancelIndentBatchCheck" ID="TabnannyPlugin.cancelIndentBatchCheck"></a>
268 <h4>TabnannyPlugin.cancelIndentBatchCheck</h4> 353 <h4>TabnannyPlugin.cancelIndentBatchCheck</h4>
269 <b>cancelIndentBatchCheck</b>(<i></i>) 354 <b>cancelIndentBatchCheck</b>(<i></i>)
355
270 <p> 356 <p>
271 Public method to cancel all batch jobs. 357 Public method to cancel all batch jobs.
272 </p><a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a> 358 </p>
359 <a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a>
273 <h4>TabnannyPlugin.deactivate</h4> 360 <h4>TabnannyPlugin.deactivate</h4>
274 <b>deactivate</b>(<i></i>) 361 <b>deactivate</b>(<i></i>)
362
275 <p> 363 <p>
276 Public method to deactivate this plugin. 364 Public method to deactivate this plugin.
277 </p><a NAME="TabnannyPlugin.indentBatchCheck" ID="TabnannyPlugin.indentBatchCheck"></a> 365 </p>
366 <a NAME="TabnannyPlugin.indentBatchCheck" ID="TabnannyPlugin.indentBatchCheck"></a>
278 <h4>TabnannyPlugin.indentBatchCheck</h4> 367 <h4>TabnannyPlugin.indentBatchCheck</h4>
279 <b>indentBatchCheck</b>(<i>argumentsList</i>) 368 <b>indentBatchCheck</b>(<i>argumentsList</i>)
369
280 <p> 370 <p>
281 Public method to prepare an indentation check on multiple Python 371 Public method to prepare an indentation check on multiple Python
282 source files. 372 source files.
283 </p><dl> 373 </p>
374 <dl>
375
284 <dt><i>argumentsList</i></dt> 376 <dt><i>argumentsList</i></dt>
285 <dd> 377 <dd>
286 list of arguments tuples with each tuple 378 list of arguments tuples with each tuple
287 containing filename and source (string, string) 379 containing filename and source (string, string)
288 </dd> 380 </dd>
289 </dl><a NAME="TabnannyPlugin.indentCheck" ID="TabnannyPlugin.indentCheck"></a> 381 </dl>
382 <a NAME="TabnannyPlugin.indentCheck" ID="TabnannyPlugin.indentCheck"></a>
290 <h4>TabnannyPlugin.indentCheck</h4> 383 <h4>TabnannyPlugin.indentCheck</h4>
291 <b>indentCheck</b>(<i>lang, filename, source</i>) 384 <b>indentCheck</b>(<i>lang, filename, source</i>)
385
292 <p> 386 <p>
293 Public method to prepare an indentation check on one Python source 387 Public method to prepare an indentation check on one Python source
294 file. 388 file.
295 </p><dl> 389 </p>
390 <dl>
391
296 <dt><i>lang</i></dt> 392 <dt><i>lang</i></dt>
297 <dd> 393 <dd>
298 language of the file or None to determine by internal 394 language of the file or None to determine by internal
299 algorithm (str or None) 395 algorithm (str or None)
300 </dd><dt><i>filename</i></dt> 396 </dd>
397 <dt><i>filename</i></dt>
301 <dd> 398 <dd>
302 source filename (string) 399 source filename (string)
303 </dd><dt><i>source</i></dt> 400 </dd>
401 <dt><i>source</i></dt>
304 <dd> 402 <dd>
305 string containing the code to check (string) 403 string containing the code to check (string)
306 </dd> 404 </dd>
307 </dl><a NAME="TabnannyPlugin.serviceErrorPy2" ID="TabnannyPlugin.serviceErrorPy2"></a> 405 </dl>
406 <a NAME="TabnannyPlugin.serviceErrorPy2" ID="TabnannyPlugin.serviceErrorPy2"></a>
308 <h4>TabnannyPlugin.serviceErrorPy2</h4> 407 <h4>TabnannyPlugin.serviceErrorPy2</h4>
309 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) 408 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>)
409
310 <p> 410 <p>
311 Public slot handling service errors for Python 2. 411 Public slot handling service errors for Python 2.
312 </p><dl> 412 </p>
413 <dl>
414
313 <dt><i>fx</i></dt> 415 <dt><i>fx</i></dt>
314 <dd> 416 <dd>
315 service name (string) 417 service name (string)
316 </dd><dt><i>lang</i></dt> 418 </dd>
419 <dt><i>lang</i></dt>
317 <dd> 420 <dd>
318 language (string) 421 language (string)
319 </dd><dt><i>fn</i></dt> 422 </dd>
423 <dt><i>fn</i></dt>
320 <dd> 424 <dd>
321 file name (string) 425 file name (string)
322 </dd><dt><i>msg</i></dt> 426 </dd>
427 <dt><i>msg</i></dt>
323 <dd> 428 <dd>
324 message text (string) 429 message text (string)
325 </dd> 430 </dd>
326 </dl><a NAME="TabnannyPlugin.serviceErrorPy3" ID="TabnannyPlugin.serviceErrorPy3"></a> 431 </dl>
432 <a NAME="TabnannyPlugin.serviceErrorPy3" ID="TabnannyPlugin.serviceErrorPy3"></a>
327 <h4>TabnannyPlugin.serviceErrorPy3</h4> 433 <h4>TabnannyPlugin.serviceErrorPy3</h4>
328 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) 434 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
435
329 <p> 436 <p>
330 Public slot handling service errors for Python 2. 437 Public slot handling service errors for Python 2.
331 </p><dl> 438 </p>
439 <dl>
440
332 <dt><i>fx</i></dt> 441 <dt><i>fx</i></dt>
333 <dd> 442 <dd>
334 service name (string) 443 service name (string)
335 </dd><dt><i>lang</i></dt> 444 </dd>
445 <dt><i>lang</i></dt>
336 <dd> 446 <dd>
337 language (string) 447 language (string)
338 </dd><dt><i>fn</i></dt> 448 </dd>
449 <dt><i>fn</i></dt>
339 <dd> 450 <dd>
340 file name (string) 451 file name (string)
341 </dd><dt><i>msg</i></dt> 452 </dd>
453 <dt><i>msg</i></dt>
342 <dd> 454 <dd>
343 message text (string) 455 message text (string)
344 </dd> 456 </dd>
345 </dl> 457 </dl>
346 <div align="right"><a href="#top">Up</a></div> 458 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial