Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7204
cbf6d88004ce
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.PluginTabnanny</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.PluginTabnanny</h1>
23 <p>
24 Module implementing the Tabnanny plugin.
25 </p>
26 <h3>Global Attributes</h3>
27 <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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#TabnannyPlugin">TabnannyPlugin</a></td>
34 <td>Class implementing the Tabnanny plugin.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="TabnannyPlugin" ID="TabnannyPlugin"></a>
43 <h2>TabnannyPlugin</h2>
44 <p>
45 Class implementing the Tabnanny plugin.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>batchFinished()</dt>
49 <dd>
50 emitted when a style check batch is done
51 </dd><dt>error(str, str)</dt>
52 <dd>
53 emitted in case of an error
54 </dd><dt>indentChecked(str, bool, str, str)</dt>
55 <dd>
56 emitted when the indent
57 check was done.
58 </dd>
59 </dl>
60 <h3>Derived from</h3>
61 QObject
62 <h3>Class Attributes</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Methods</h3>
71 <table>
72 <tr>
73 <td><a href="#TabnannyPlugin.__init__">TabnannyPlugin</a></td>
74 <td>Constructor</td>
75 </tr><tr>
76 <td><a href="#TabnannyPlugin.__editorClosed">__editorClosed</a></td>
77 <td>Private slot called, when an editor was closed.</td>
78 </tr><tr>
79 <td><a href="#TabnannyPlugin.__editorOpened">__editorOpened</a></td>
80 <td>Private slot called, when a new editor was opened.</td>
81 </tr><tr>
82 <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>
84 </tr><tr>
85 <td><a href="#TabnannyPlugin.__editorTabnanny">__editorTabnanny</a></td>
86 <td>Private slot to handle the tabnanny context menu action of the editors.</td>
87 </tr><tr>
88 <td><a href="#TabnannyPlugin.__initialize">__initialize</a></td>
89 <td>Private slot to (re)initialize the plugin.</td>
90 </tr><tr>
91 <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>
93 </tr><tr>
94 <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>
96 </tr><tr>
97 <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>
99 </tr><tr>
100 <td><a href="#TabnannyPlugin.__projectTabnanny">__projectTabnanny</a></td>
101 <td>Private slot used to check the project files for bad indentations.</td>
102 </tr><tr>
103 <td><a href="#TabnannyPlugin.__serviceError">__serviceError</a></td>
104 <td>Private slot handling service errors.</td>
105 </tr><tr>
106 <td><a href="#TabnannyPlugin.activate">activate</a></td>
107 <td>Public method to activate this plugin.</td>
108 </tr><tr>
109 <td><a href="#TabnannyPlugin.batchJobDone">batchJobDone</a></td>
110 <td>Public slot handling the completion of a batch job.</td>
111 </tr><tr>
112 <td><a href="#TabnannyPlugin.cancelIndentBatchCheck">cancelIndentBatchCheck</a></td>
113 <td>Public method to cancel all batch jobs.</td>
114 </tr><tr>
115 <td><a href="#TabnannyPlugin.deactivate">deactivate</a></td>
116 <td>Public method to deactivate this plugin.</td>
117 </tr><tr>
118 <td><a href="#TabnannyPlugin.indentBatchCheck">indentBatchCheck</a></td>
119 <td>Public method to prepare an indentation check on multiple Python source files.</td>
120 </tr><tr>
121 <td><a href="#TabnannyPlugin.indentCheck">indentCheck</a></td>
122 <td>Public method to prepare an indentation check on one Python source file.</td>
123 </tr><tr>
124 <td><a href="#TabnannyPlugin.serviceErrorPy2">serviceErrorPy2</a></td>
125 <td>Public slot handling service errors for Python 2.</td>
126 </tr><tr>
127 <td><a href="#TabnannyPlugin.serviceErrorPy3">serviceErrorPy3</a></td>
128 <td>Public slot handling service errors for Python 2.</td>
129 </tr>
130 </table>
131 <h3>Static Methods</h3>
132 <table>
133 <tr><td>None</td></tr>
134 </table>
135 <a NAME="TabnannyPlugin.__init__" ID="TabnannyPlugin.__init__"></a>
136 <h4>TabnannyPlugin (Constructor)</h4>
137 <b>TabnannyPlugin</b>(<i>ui</i>)
138 <p>
139 Constructor
140 </p><dl>
141 <dt><i>ui</i></dt>
142 <dd>
143 reference to the user interface object (UI.UserInterface)
144 </dd>
145 </dl><a NAME="TabnannyPlugin.__editorClosed" ID="TabnannyPlugin.__editorClosed"></a>
146 <h4>TabnannyPlugin.__editorClosed</h4>
147 <b>__editorClosed</b>(<i>editor</i>)
148 <p>
149 Private slot called, when an editor was closed.
150 </p><dl>
151 <dt><i>editor</i></dt>
152 <dd>
153 reference to the editor (QScintilla.Editor)
154 </dd>
155 </dl><a NAME="TabnannyPlugin.__editorOpened" ID="TabnannyPlugin.__editorOpened"></a>
156 <h4>TabnannyPlugin.__editorOpened</h4>
157 <b>__editorOpened</b>(<i>editor</i>)
158 <p>
159 Private slot called, when a new editor was opened.
160 </p><dl>
161 <dt><i>editor</i></dt>
162 <dd>
163 reference to the new editor (QScintilla.Editor)
164 </dd>
165 </dl><a NAME="TabnannyPlugin.__editorShowMenu" ID="TabnannyPlugin.__editorShowMenu"></a>
166 <h4>TabnannyPlugin.__editorShowMenu</h4>
167 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
168 <p>
169 Private slot called, when the the editor context menu or a submenu is
170 about to be shown.
171 </p><dl>
172 <dt><i>menuName</i></dt>
173 <dd>
174 name of the menu to be shown (string)
175 </dd><dt><i>menu</i></dt>
176 <dd>
177 reference to the menu (QMenu)
178 </dd><dt><i>editor</i></dt>
179 <dd>
180 reference to the editor
181 </dd>
182 </dl><a NAME="TabnannyPlugin.__editorTabnanny" ID="TabnannyPlugin.__editorTabnanny"></a>
183 <h4>TabnannyPlugin.__editorTabnanny</h4>
184 <b>__editorTabnanny</b>(<i></i>)
185 <p>
186 Private slot to handle the tabnanny context menu action of the editors.
187 </p><a NAME="TabnannyPlugin.__initialize" ID="TabnannyPlugin.__initialize"></a>
188 <h4>TabnannyPlugin.__initialize</h4>
189 <b>__initialize</b>(<i></i>)
190 <p>
191 Private slot to (re)initialize the plugin.
192 </p><a NAME="TabnannyPlugin.__projectBrowserShowMenu" ID="TabnannyPlugin.__projectBrowserShowMenu"></a>
193 <h4>TabnannyPlugin.__projectBrowserShowMenu</h4>
194 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
195 <p>
196 Private slot called, when the the project browser context menu or a
197 submenu is about to be shown.
198 </p><dl>
199 <dt><i>menuName</i></dt>
200 <dd>
201 name of the menu to be shown (string)
202 </dd><dt><i>menu</i></dt>
203 <dd>
204 reference to the menu (QMenu)
205 </dd>
206 </dl><a NAME="TabnannyPlugin.__projectBrowserTabnanny" ID="TabnannyPlugin.__projectBrowserTabnanny"></a>
207 <h4>TabnannyPlugin.__projectBrowserTabnanny</h4>
208 <b>__projectBrowserTabnanny</b>(<i></i>)
209 <p>
210 Private method to handle the tabnanny context menu action of the
211 project sources browser.
212 </p><a NAME="TabnannyPlugin.__projectShowMenu" ID="TabnannyPlugin.__projectShowMenu"></a>
213 <h4>TabnannyPlugin.__projectShowMenu</h4>
214 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
215 <p>
216 Private slot called, when the the project menu or a submenu is
217 about to be shown.
218 </p><dl>
219 <dt><i>menuName</i></dt>
220 <dd>
221 name of the menu to be shown (string)
222 </dd><dt><i>menu</i></dt>
223 <dd>
224 reference to the menu (QMenu)
225 </dd>
226 </dl><a NAME="TabnannyPlugin.__projectTabnanny" ID="TabnannyPlugin.__projectTabnanny"></a>
227 <h4>TabnannyPlugin.__projectTabnanny</h4>
228 <b>__projectTabnanny</b>(<i></i>)
229 <p>
230 Private slot used to check the project files for bad indentations.
231 </p><a NAME="TabnannyPlugin.__serviceError" ID="TabnannyPlugin.__serviceError"></a>
232 <h4>TabnannyPlugin.__serviceError</h4>
233 <b>__serviceError</b>(<i>fn, msg</i>)
234 <p>
235 Private slot handling service errors.
236 </p><dl>
237 <dt><i>fn</i></dt>
238 <dd>
239 file name (string)
240 </dd><dt><i>msg</i></dt>
241 <dd>
242 message text (string)
243 </dd>
244 </dl><a NAME="TabnannyPlugin.activate" ID="TabnannyPlugin.activate"></a>
245 <h4>TabnannyPlugin.activate</h4>
246 <b>activate</b>(<i></i>)
247 <p>
248 Public method to activate this plugin.
249 </p><dl>
250 <dt>Returns:</dt>
251 <dd>
252 tuple of None and activation status (boolean)
253 </dd>
254 </dl><a NAME="TabnannyPlugin.batchJobDone" ID="TabnannyPlugin.batchJobDone"></a>
255 <h4>TabnannyPlugin.batchJobDone</h4>
256 <b>batchJobDone</b>(<i>fx, lang</i>)
257 <p>
258 Public slot handling the completion of a batch job.
259 </p><dl>
260 <dt><i>fx</i></dt>
261 <dd>
262 service name (string)
263 </dd><dt><i>lang</i></dt>
264 <dd>
265 language (string)
266 </dd>
267 </dl><a NAME="TabnannyPlugin.cancelIndentBatchCheck" ID="TabnannyPlugin.cancelIndentBatchCheck"></a>
268 <h4>TabnannyPlugin.cancelIndentBatchCheck</h4>
269 <b>cancelIndentBatchCheck</b>(<i></i>)
270 <p>
271 Public method to cancel all batch jobs.
272 </p><a NAME="TabnannyPlugin.deactivate" ID="TabnannyPlugin.deactivate"></a>
273 <h4>TabnannyPlugin.deactivate</h4>
274 <b>deactivate</b>(<i></i>)
275 <p>
276 Public method to deactivate this plugin.
277 </p><a NAME="TabnannyPlugin.indentBatchCheck" ID="TabnannyPlugin.indentBatchCheck"></a>
278 <h4>TabnannyPlugin.indentBatchCheck</h4>
279 <b>indentBatchCheck</b>(<i>argumentsList</i>)
280 <p>
281 Public method to prepare an indentation check on multiple Python
282 source files.
283 </p><dl>
284 <dt><i>argumentsList</i></dt>
285 <dd>
286 list of arguments tuples with each tuple
287 containing filename and source (string, string)
288 </dd>
289 </dl><a NAME="TabnannyPlugin.indentCheck" ID="TabnannyPlugin.indentCheck"></a>
290 <h4>TabnannyPlugin.indentCheck</h4>
291 <b>indentCheck</b>(<i>lang, filename, source</i>)
292 <p>
293 Public method to prepare an indentation check on one Python source
294 file.
295 </p><dl>
296 <dt><i>lang</i></dt>
297 <dd>
298 language of the file or None to determine by internal
299 algorithm (str or None)
300 </dd><dt><i>filename</i></dt>
301 <dd>
302 source filename (string)
303 </dd><dt><i>source</i></dt>
304 <dd>
305 string containing the code to check (string)
306 </dd>
307 </dl><a NAME="TabnannyPlugin.serviceErrorPy2" ID="TabnannyPlugin.serviceErrorPy2"></a>
308 <h4>TabnannyPlugin.serviceErrorPy2</h4>
309 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>)
310 <p>
311 Public slot handling service errors for Python 2.
312 </p><dl>
313 <dt><i>fx</i></dt>
314 <dd>
315 service name (string)
316 </dd><dt><i>lang</i></dt>
317 <dd>
318 language (string)
319 </dd><dt><i>fn</i></dt>
320 <dd>
321 file name (string)
322 </dd><dt><i>msg</i></dt>
323 <dd>
324 message text (string)
325 </dd>
326 </dl><a NAME="TabnannyPlugin.serviceErrorPy3" ID="TabnannyPlugin.serviceErrorPy3"></a>
327 <h4>TabnannyPlugin.serviceErrorPy3</h4>
328 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
329 <p>
330 Public slot handling service errors for Python 2.
331 </p><dl>
332 <dt><i>fx</i></dt>
333 <dd>
334 service name (string)
335 </dd><dt><i>lang</i></dt>
336 <dd>
337 language (string)
338 </dd><dt><i>fn</i></dt>
339 <dd>
340 file name (string)
341 </dd><dt><i>msg</i></dt>
342 <dd>
343 message text (string)
344 </dd>
345 </dl>
346 <div align="right"><a href="#top">Up</a></div>
347 <hr />
348 </body></html>

Mercurial Repository: eric

eric ide

mercurial