|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.JediInterface.AssistantJedi</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.JediInterface.AssistantJedi</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the Jedi assistant plug-in. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#AssistantJedi">AssistantJedi</a></td> |
|
25 <td>Class implementing the Jedi assistant interface.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="AssistantJedi" ID="AssistantJedi"></a> |
|
36 <h2>AssistantJedi</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing the Jedi assistant interface. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QObject |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#AssistantJedi.__init__">AssistantJedi</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#AssistantJedi.__connectEditor">__connectEditor</a></td> |
|
63 <td>Private method to connect an editor.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#AssistantJedi.__connectMouseClickHandler">__connectMouseClickHandler</a></td> |
|
67 <td>Private method to connect the mouse click handler to an editor.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#AssistantJedi.__determineLanguage">__determineLanguage</a></td> |
|
71 <td>Private method to determine the valid language strings.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#AssistantJedi.__disconnectEditor">__disconnectEditor</a></td> |
|
75 <td>Private method to disconnect an editor.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#AssistantJedi.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td> |
|
79 <td>Private method to disconnect the mouse click handler from an editor.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#AssistantJedi.__editorClosed">__editorClosed</a></td> |
|
83 <td>Private slot called, when an editor was closed.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#AssistantJedi.__editorLanguageChanged">__editorLanguageChanged</a></td> |
|
87 <td>Private slot to handle the language change of an editor.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#AssistantJedi.__editorOpened">__editorOpened</a></td> |
|
91 <td>Private slot called, when a new editor was opened.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#AssistantJedi.__editorShowMenu">__editorShowMenu</a></td> |
|
95 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#AssistantJedi.__initRefactoringMenu">__initRefactoringMenu</a></td> |
|
99 <td>Private method to initialize the Refactoring menu.</td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td><a href="#AssistantJedi.__preferencesChanged">__preferencesChanged</a></td> |
|
103 <td>Private slot handling changes of the Disassembly viewer settings.</td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td><a href="#AssistantJedi.__setAutoCompletionHook">__setAutoCompletionHook</a></td> |
|
107 <td>Private method to set the autocompletion hook.</td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td><a href="#AssistantJedi.__setCalltipsHook">__setCalltipsHook</a></td> |
|
111 <td>Private method to set the calltip hook.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#AssistantJedi.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td> |
|
115 <td>Private method to unset the autocompletion hook.</td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td><a href="#AssistantJedi.__unsetCalltipsHook">__unsetCalltipsHook</a></td> |
|
119 <td>Private method to unset the calltip hook.</td> |
|
120 </tr> |
|
121 </table> |
|
122 <h3>Static Methods</h3> |
|
123 |
|
124 <table> |
|
125 <tr><td>None</td></tr> |
|
126 </table> |
|
127 |
|
128 <a NAME="AssistantJedi.__init__" ID="AssistantJedi.__init__"></a> |
|
129 <h4>AssistantJedi (Constructor)</h4> |
|
130 <b>AssistantJedi</b>(<i>ui, viewManager, project</i>) |
|
131 |
|
132 <p> |
|
133 Constructor |
|
134 </p> |
|
135 <dl> |
|
136 |
|
137 <dt><i>ui</i> (UserInterface)</dt> |
|
138 <dd> |
|
139 reference to the user interface object |
|
140 </dd> |
|
141 <dt><i>viewManager</i> (ViewManager)</dt> |
|
142 <dd> |
|
143 reference to the viewmanager object |
|
144 </dd> |
|
145 <dt><i>project</i> (Project)</dt> |
|
146 <dd> |
|
147 reference to the project object |
|
148 </dd> |
|
149 </dl> |
|
150 <a NAME="AssistantJedi.__connectEditor" ID="AssistantJedi.__connectEditor"></a> |
|
151 <h4>AssistantJedi.__connectEditor</h4> |
|
152 <b>__connectEditor</b>(<i>editor</i>) |
|
153 |
|
154 <p> |
|
155 Private method to connect an editor. |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>editor</i> (Editor)</dt> |
|
160 <dd> |
|
161 reference to the editor |
|
162 </dd> |
|
163 </dl> |
|
164 <a NAME="AssistantJedi.__connectMouseClickHandler" ID="AssistantJedi.__connectMouseClickHandler"></a> |
|
165 <h4>AssistantJedi.__connectMouseClickHandler</h4> |
|
166 <b>__connectMouseClickHandler</b>(<i>editor</i>) |
|
167 |
|
168 <p> |
|
169 Private method to connect the mouse click handler to an editor. |
|
170 </p> |
|
171 <dl> |
|
172 |
|
173 <dt><i>editor</i> (Editor)</dt> |
|
174 <dd> |
|
175 reference to the editor |
|
176 </dd> |
|
177 </dl> |
|
178 <a NAME="AssistantJedi.__determineLanguage" ID="AssistantJedi.__determineLanguage"></a> |
|
179 <h4>AssistantJedi.__determineLanguage</h4> |
|
180 <b>__determineLanguage</b>(<i></i>) |
|
181 |
|
182 <p> |
|
183 Private method to determine the valid language strings. |
|
184 </p> |
|
185 <dl> |
|
186 <dt>Return:</dt> |
|
187 <dd> |
|
188 list of valid language strings |
|
189 </dd> |
|
190 </dl> |
|
191 <dl> |
|
192 <dt>Return Type:</dt> |
|
193 <dd> |
|
194 list of str |
|
195 </dd> |
|
196 </dl> |
|
197 <a NAME="AssistantJedi.__disconnectEditor" ID="AssistantJedi.__disconnectEditor"></a> |
|
198 <h4>AssistantJedi.__disconnectEditor</h4> |
|
199 <b>__disconnectEditor</b>(<i>editor</i>) |
|
200 |
|
201 <p> |
|
202 Private method to disconnect an editor. |
|
203 </p> |
|
204 <dl> |
|
205 |
|
206 <dt><i>editor</i> (Editor)</dt> |
|
207 <dd> |
|
208 reference to the editor |
|
209 </dd> |
|
210 </dl> |
|
211 <a NAME="AssistantJedi.__disconnectMouseClickHandler" ID="AssistantJedi.__disconnectMouseClickHandler"></a> |
|
212 <h4>AssistantJedi.__disconnectMouseClickHandler</h4> |
|
213 <b>__disconnectMouseClickHandler</b>(<i>editor</i>) |
|
214 |
|
215 <p> |
|
216 Private method to disconnect the mouse click handler from an editor. |
|
217 </p> |
|
218 <dl> |
|
219 |
|
220 <dt><i>editor</i> (Editor)</dt> |
|
221 <dd> |
|
222 reference to the editor |
|
223 </dd> |
|
224 </dl> |
|
225 <a NAME="AssistantJedi.__editorClosed" ID="AssistantJedi.__editorClosed"></a> |
|
226 <h4>AssistantJedi.__editorClosed</h4> |
|
227 <b>__editorClosed</b>(<i>editor</i>) |
|
228 |
|
229 <p> |
|
230 Private slot called, when an editor was closed. |
|
231 </p> |
|
232 <dl> |
|
233 |
|
234 <dt><i>editor</i> (Editor)</dt> |
|
235 <dd> |
|
236 reference to the editor |
|
237 </dd> |
|
238 </dl> |
|
239 <a NAME="AssistantJedi.__editorLanguageChanged" ID="AssistantJedi.__editorLanguageChanged"></a> |
|
240 <h4>AssistantJedi.__editorLanguageChanged</h4> |
|
241 <b>__editorLanguageChanged</b>(<i>language</i>) |
|
242 |
|
243 <p> |
|
244 Private slot to handle the language change of an editor. |
|
245 </p> |
|
246 <dl> |
|
247 |
|
248 <dt><i>language</i> (str)</dt> |
|
249 <dd> |
|
250 programming language of the editor |
|
251 </dd> |
|
252 </dl> |
|
253 <a NAME="AssistantJedi.__editorOpened" ID="AssistantJedi.__editorOpened"></a> |
|
254 <h4>AssistantJedi.__editorOpened</h4> |
|
255 <b>__editorOpened</b>(<i>editor</i>) |
|
256 |
|
257 <p> |
|
258 Private slot called, when a new editor was opened. |
|
259 </p> |
|
260 <dl> |
|
261 |
|
262 <dt><i>editor</i> (Editor)</dt> |
|
263 <dd> |
|
264 reference to the new editor |
|
265 </dd> |
|
266 </dl> |
|
267 <a NAME="AssistantJedi.__editorShowMenu" ID="AssistantJedi.__editorShowMenu"></a> |
|
268 <h4>AssistantJedi.__editorShowMenu</h4> |
|
269 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) |
|
270 |
|
271 <p> |
|
272 Private slot called, when the the editor context menu or a submenu is |
|
273 about to be shown. |
|
274 </p> |
|
275 <dl> |
|
276 |
|
277 <dt><i>menuName</i> (str)</dt> |
|
278 <dd> |
|
279 name of the menu to be shown |
|
280 </dd> |
|
281 <dt><i>menu</i> (QMenu)</dt> |
|
282 <dd> |
|
283 reference to the menu |
|
284 </dd> |
|
285 <dt><i>editor</i> (Editor)</dt> |
|
286 <dd> |
|
287 reference to the editor |
|
288 </dd> |
|
289 </dl> |
|
290 <a NAME="AssistantJedi.__initRefactoringMenu" ID="AssistantJedi.__initRefactoringMenu"></a> |
|
291 <h4>AssistantJedi.__initRefactoringMenu</h4> |
|
292 <b>__initRefactoringMenu</b>(<i></i>) |
|
293 |
|
294 <p> |
|
295 Private method to initialize the Refactoring menu. |
|
296 </p> |
|
297 <a NAME="AssistantJedi.__preferencesChanged" ID="AssistantJedi.__preferencesChanged"></a> |
|
298 <h4>AssistantJedi.__preferencesChanged</h4> |
|
299 <b>__preferencesChanged</b>(<i></i>) |
|
300 |
|
301 <p> |
|
302 Private slot handling changes of the Disassembly viewer settings. |
|
303 </p> |
|
304 <a NAME="AssistantJedi.__setAutoCompletionHook" ID="AssistantJedi.__setAutoCompletionHook"></a> |
|
305 <h4>AssistantJedi.__setAutoCompletionHook</h4> |
|
306 <b>__setAutoCompletionHook</b>(<i>editor</i>) |
|
307 |
|
308 <p> |
|
309 Private method to set the autocompletion hook. |
|
310 </p> |
|
311 <dl> |
|
312 |
|
313 <dt><i>editor</i> (Editor)</dt> |
|
314 <dd> |
|
315 reference to the editor |
|
316 </dd> |
|
317 </dl> |
|
318 <a NAME="AssistantJedi.__setCalltipsHook" ID="AssistantJedi.__setCalltipsHook"></a> |
|
319 <h4>AssistantJedi.__setCalltipsHook</h4> |
|
320 <b>__setCalltipsHook</b>(<i>editor</i>) |
|
321 |
|
322 <p> |
|
323 Private method to set the calltip hook. |
|
324 </p> |
|
325 <dl> |
|
326 |
|
327 <dt><i>editor</i> (Editor)</dt> |
|
328 <dd> |
|
329 reference to the editor |
|
330 </dd> |
|
331 </dl> |
|
332 <a NAME="AssistantJedi.__unsetAutoCompletionHook" ID="AssistantJedi.__unsetAutoCompletionHook"></a> |
|
333 <h4>AssistantJedi.__unsetAutoCompletionHook</h4> |
|
334 <b>__unsetAutoCompletionHook</b>(<i>editor</i>) |
|
335 |
|
336 <p> |
|
337 Private method to unset the autocompletion hook. |
|
338 </p> |
|
339 <dl> |
|
340 |
|
341 <dt><i>editor</i> (Editor)</dt> |
|
342 <dd> |
|
343 reference to the editor |
|
344 </dd> |
|
345 </dl> |
|
346 <a NAME="AssistantJedi.__unsetCalltipsHook" ID="AssistantJedi.__unsetCalltipsHook"></a> |
|
347 <h4>AssistantJedi.__unsetCalltipsHook</h4> |
|
348 <b>__unsetCalltipsHook</b>(<i>editor</i>) |
|
349 |
|
350 <p> |
|
351 Private method to unset the calltip hook. |
|
352 </p> |
|
353 <dl> |
|
354 |
|
355 <dt><i>editor</i> (Editor)</dt> |
|
356 <dd> |
|
357 reference to the editor |
|
358 </dd> |
|
359 </dl> |
|
360 <div align="right"><a href="#top">Up</a></div> |
|
361 <hr /> |
|
362 </body></html> |