Mercurial Repositories > Eric Assistant / file comparison

comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html

AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html

changeset 163
842fce9b31ce
parent 140
a0ea7418d433
child 177
25cb41783971
equal deleted inserted replaced
162:db992524e3f5 163:842fce9b31ce
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>Plugin_Assistant_Eric.AssistantEric.Assistant</h1> 23 <h1>Plugin_Assistant_Eric.AssistantEric.Assistant</h1>
24
23 <p> 25 <p>
24 Module implementing the eric assistant, an alternative autocompletion and 26 Module implementing the eric assistant, an alternative autocompletion and
25 calltips system. 27 calltips system.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>AcsAPIs</td></tr><tr><td>AcsDocument</td></tr><tr><td>AcsProject</td></tr> 32 <tr><td>AcsAPIs</td></tr><tr><td>AcsDocument</td></tr><tr><td>AcsProject</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
35
32 <table> 36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#Assistant">Assistant</a></td> 39 <td><a href="#Assistant">Assistant</a></td>
35 <td>Class implementing the autocompletion and calltips system.</td> 40 <td>Class implementing the autocompletion and calltips system.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
44
39 <table> 45 <table>
40 <tr><td>None</td></tr> 46 <tr><td>None</td></tr>
41 </table> 47 </table>
42 <hr /><hr /> 48 <hr />
49 <hr />
43 <a NAME="Assistant" ID="Assistant"></a> 50 <a NAME="Assistant" ID="Assistant"></a>
44 <h2>Assistant</h2> 51 <h2>Assistant</h2>
52
45 <p> 53 <p>
46 Class implementing the autocompletion and calltips system. 54 Class implementing the autocompletion and calltips system.
47 </p> 55 </p>
48 <h3>Derived from</h3> 56 <h3>Derived from</h3>
49 QObject 57 QObject
50 <h3>Class Attributes</h3> 58 <h3>Class Attributes</h3>
59
51 <table> 60 <table>
52 <tr><td>None</td></tr> 61 <tr><td>None</td></tr>
53 </table> 62 </table>
54 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
64
55 <table> 65 <table>
56 <tr><td>None</td></tr> 66 <tr><td>None</td></tr>
57 </table> 67 </table>
58 <h3>Methods</h3> 68 <h3>Methods</h3>
69
59 <table> 70 <table>
71
60 <tr> 72 <tr>
61 <td><a href="#Assistant.__init__">Assistant</a></td> 73 <td><a href="#Assistant.__init__">Assistant</a></td>
62 <td>Constructor</td> 74 <td>Constructor</td>
63 </tr><tr> 75 </tr>
76 <tr>
64 <td><a href="#Assistant.__editorClosed">__editorClosed</a></td> 77 <td><a href="#Assistant.__editorClosed">__editorClosed</a></td>
65 <td>Private slot called, when an editor was closed.</td> 78 <td>Private slot called, when an editor was closed.</td>
66 </tr><tr> 79 </tr>
80 <tr>
67 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td> 81 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td>
68 <td>Private slot called, when a new editor was opened.</td> 82 <td>Private slot called, when a new editor was opened.</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#Assistant.__getApiCalltips">__getApiCalltips</a></td> 85 <td><a href="#Assistant.__getApiCalltips">__getApiCalltips</a></td>
71 <td>Private method to determine calltips from APIs.</td> 86 <td>Private method to determine calltips from APIs.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td> 89 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td>
74 <td>Private method to determine a list of completions from an API object.</td> 90 <td>Private method to determine a list of completions from an API object.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#Assistant.__getCompletions">__getCompletions</a></td> 93 <td><a href="#Assistant.__getCompletions">__getCompletions</a></td>
77 <td>Private method to get the list of possible completions.</td> 94 <td>Private method to get the list of possible completions.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#Assistant.__getDocumentCalltips">__getDocumentCalltips</a></td> 97 <td><a href="#Assistant.__getDocumentCalltips">__getDocumentCalltips</a></td>
80 <td>Private method to determine calltips from the document.</td> 98 <td>Private method to determine calltips from the document.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#Assistant.__getDocumentCompletions">__getDocumentCompletions</a></td> 101 <td><a href="#Assistant.__getDocumentCompletions">__getDocumentCompletions</a></td>
83 <td>Private method to determine autocompletion proposals from the document.</td> 102 <td>Private method to determine autocompletion proposals from the document.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#Assistant.__getProjectType">__getProjectType</a></td> 105 <td><a href="#Assistant.__getProjectType">__getProjectType</a></td>
86 <td>Private method to determine the project type to be used.</td> 106 <td>Private method to determine the project type to be used.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td> 109 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td>
89 <td>Private method to handle a change of the global configuration.</td> 110 <td>Private method to handle a change of the global configuration.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#Assistant.__recordSelectedContext">__recordSelectedContext</a></td> 113 <td><a href="#Assistant.__recordSelectedContext">__recordSelectedContext</a></td>
92 <td>Private slot to handle the selection from the completion list to record the selected completion context.</td> 114 <td>Private slot to handle the selection from the completion list to record the selected completion context.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#Assistant.__setAutoCompletionHook">__setAutoCompletionHook</a></td> 117 <td><a href="#Assistant.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
95 <td>Private method to set the autocompletion hook.</td> 118 <td>Private method to set the autocompletion hook.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#Assistant.__setCalltipsHook">__setCalltipsHook</a></td> 121 <td><a href="#Assistant.__setCalltipsHook">__setCalltipsHook</a></td>
98 <td>Private method to set the calltip hook.</td> 122 <td>Private method to set the calltip hook.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#Assistant.__shutdown">__shutdown</a></td> 125 <td><a href="#Assistant.__shutdown">__shutdown</a></td>
101 <td>Private slot to handle the shutdown signal.</td> 126 <td>Private slot to handle the shutdown signal.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#Assistant.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td> 129 <td><a href="#Assistant.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
104 <td>Private method to unset the autocompletion hook.</td> 130 <td>Private method to unset the autocompletion hook.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#Assistant.__unsetCalltipsHook">__unsetCalltipsHook</a></td> 133 <td><a href="#Assistant.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
107 <td>Private method to unset the calltip hook.</td> 134 <td>Private method to unset the calltip hook.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#Assistant.activate">activate</a></td> 137 <td><a href="#Assistant.activate">activate</a></td>
110 <td>Public method to perform actions upon activation.</td> 138 <td>Public method to perform actions upon activation.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#Assistant.calltips">calltips</a></td> 141 <td><a href="#Assistant.calltips">calltips</a></td>
113 <td>Public method to return a list of calltips.</td> 142 <td>Public method to return a list of calltips.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#Assistant.deactivate">deactivate</a></td> 145 <td><a href="#Assistant.deactivate">deactivate</a></td>
116 <td>Public method to perform actions upon deactivation.</td> 146 <td>Public method to perform actions upon deactivation.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#Assistant.getCompletionsList">getCompletionsList</a></td> 149 <td><a href="#Assistant.getCompletionsList">getCompletionsList</a></td>
119 <td>Public method to get a list of possible completions.</td> 150 <td>Public method to get a list of possible completions.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#Assistant.setEnabled">setEnabled</a></td> 153 <td><a href="#Assistant.setEnabled">setEnabled</a></td>
122 <td>Public method to enable or disable a feature.</td> 154 <td>Public method to enable or disable a feature.</td>
123 </tr> 155 </tr>
124 </table> 156 </table>
125 <h3>Static Methods</h3> 157 <h3>Static Methods</h3>
158
126 <table> 159 <table>
127 <tr><td>None</td></tr> 160 <tr><td>None</td></tr>
128 </table> 161 </table>
162
129 <a NAME="Assistant.__init__" ID="Assistant.__init__"></a> 163 <a NAME="Assistant.__init__" ID="Assistant.__init__"></a>
130 <h4>Assistant (Constructor)</h4> 164 <h4>Assistant (Constructor)</h4>
131 <b>Assistant</b>(<i>plugin, parent=None</i>) 165 <b>Assistant</b>(<i>plugin, parent=None</i>)
166
132 <p> 167 <p>
133 Constructor 168 Constructor
134 </p><dl> 169 </p>
170 <dl>
171
135 <dt><i>plugin</i></dt> 172 <dt><i>plugin</i></dt>
136 <dd> 173 <dd>
137 reference to the plugin object 174 reference to the plugin object
138 </dd><dt><i>parent</i></dt> 175 </dd>
176 <dt><i>parent</i></dt>
139 <dd> 177 <dd>
140 parent (QObject) 178 parent (QObject)
141 </dd> 179 </dd>
142 </dl><a NAME="Assistant.__editorClosed" ID="Assistant.__editorClosed"></a> 180 </dl>
181 <a NAME="Assistant.__editorClosed" ID="Assistant.__editorClosed"></a>
143 <h4>Assistant.__editorClosed</h4> 182 <h4>Assistant.__editorClosed</h4>
144 <b>__editorClosed</b>(<i>editor</i>) 183 <b>__editorClosed</b>(<i>editor</i>)
184
145 <p> 185 <p>
146 Private slot called, when an editor was closed. 186 Private slot called, when an editor was closed.
147 </p><dl> 187 </p>
188 <dl>
189
148 <dt><i>editor</i></dt> 190 <dt><i>editor</i></dt>
149 <dd> 191 <dd>
150 reference to the editor (QScintilla.Editor) 192 reference to the editor (QScintilla.Editor)
151 </dd> 193 </dd>
152 </dl><a NAME="Assistant.__editorOpened" ID="Assistant.__editorOpened"></a> 194 </dl>
195 <a NAME="Assistant.__editorOpened" ID="Assistant.__editorOpened"></a>
153 <h4>Assistant.__editorOpened</h4> 196 <h4>Assistant.__editorOpened</h4>
154 <b>__editorOpened</b>(<i>editor</i>) 197 <b>__editorOpened</b>(<i>editor</i>)
198
155 <p> 199 <p>
156 Private slot called, when a new editor was opened. 200 Private slot called, when a new editor was opened.
157 </p><dl> 201 </p>
202 <dl>
203
158 <dt><i>editor</i></dt> 204 <dt><i>editor</i></dt>
159 <dd> 205 <dd>
160 reference to the new editor (QScintilla.Editor) 206 reference to the new editor (QScintilla.Editor)
161 </dd> 207 </dd>
162 </dl><a NAME="Assistant.__getApiCalltips" ID="Assistant.__getApiCalltips"></a> 208 </dl>
209 <a NAME="Assistant.__getApiCalltips" ID="Assistant.__getApiCalltips"></a>
163 <h4>Assistant.__getApiCalltips</h4> 210 <h4>Assistant.__getApiCalltips</h4>
164 <b>__getApiCalltips</b>(<i>api, word, commas, prefix, module, editor</i>) 211 <b>__getApiCalltips</b>(<i>api, word, commas, prefix, module, editor</i>)
212
165 <p> 213 <p>
166 Private method to determine calltips from APIs. 214 Private method to determine calltips from APIs.
167 </p><dl> 215 </p>
216 <dl>
217
168 <dt><i>api</i></dt> 218 <dt><i>api</i></dt>
169 <dd> 219 <dd>
170 reference to the API object to be used (APIsManager.DbAPIs) 220 reference to the API object to be used (APIsManager.DbAPIs)
171 </dd><dt><i>word</i></dt> 221 </dd>
222 <dt><i>word</i></dt>
172 <dd> 223 <dd>
173 function to get calltips for (string) 224 function to get calltips for (string)
174 </dd><dt><i>commas</i></dt> 225 </dd>
226 <dt><i>commas</i></dt>
175 <dd> 227 <dd>
176 minimum number of commas contained in the calltip 228 minimum number of commas contained in the calltip
177 (integer) 229 (integer)
178 </dd><dt><i>prefix</i></dt> 230 </dd>
231 <dt><i>prefix</i></dt>
179 <dd> 232 <dd>
180 prefix of the word to be completed (string) 233 prefix of the word to be completed (string)
181 </dd><dt><i>module</i></dt> 234 </dd>
235 <dt><i>module</i></dt>
182 <dd> 236 <dd>
183 reference to the scanned module info (Module) 237 reference to the scanned module info (Module)
184 </dd><dt><i>editor</i></dt> 238 </dd>
239 <dt><i>editor</i></dt>
185 <dd> 240 <dd>
186 reference to the editor object (QScintilla.Editor) 241 reference to the editor object (QScintilla.Editor)
187 </dd> 242 </dd>
188 </dl><dl> 243 </dl>
244 <dl>
189 <dt>Returns:</dt> 245 <dt>Returns:</dt>
190 <dd> 246 <dd>
191 list of calltips (list of string) 247 list of calltips (list of string)
192 </dd> 248 </dd>
193 </dl><a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a> 249 </dl>
250 <a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a>
194 <h4>Assistant.__getApiCompletions</h4> 251 <h4>Assistant.__getApiCompletions</h4>
195 <b>__getApiCompletions</b>(<i>api, word, context, prefix, module, editor</i>) 252 <b>__getApiCompletions</b>(<i>api, word, context, prefix, module, editor</i>)
253
196 <p> 254 <p>
197 Private method to determine a list of completions from an API object. 255 Private method to determine a list of completions from an API object.
198 </p><dl> 256 </p>
257 <dl>
258
199 <dt><i>api</i></dt> 259 <dt><i>api</i></dt>
200 <dd> 260 <dd>
201 reference to the API object to be used (APIsManager.DbAPIs) 261 reference to the API object to be used (APIsManager.DbAPIs)
202 </dd><dt><i>word</i></dt> 262 </dd>
263 <dt><i>word</i></dt>
203 <dd> 264 <dd>
204 word (or wordpart) to complete (string) 265 word (or wordpart) to complete (string)
205 </dd><dt><i>context</i></dt> 266 </dd>
267 <dt><i>context</i></dt>
206 <dd> 268 <dd>
207 flag indicating to autocomplete a context (boolean) 269 flag indicating to autocomplete a context (boolean)
208 </dd><dt><i>prefix</i></dt> 270 </dd>
271 <dt><i>prefix</i></dt>
209 <dd> 272 <dd>
210 prefix of the word to be completed (string) 273 prefix of the word to be completed (string)
211 </dd><dt><i>module</i></dt> 274 </dd>
275 <dt><i>module</i></dt>
212 <dd> 276 <dd>
213 reference to the scanned module info (Module) 277 reference to the scanned module info (Module)
214 </dd><dt><i>editor</i></dt> 278 </dd>
279 <dt><i>editor</i></dt>
215 <dd> 280 <dd>
216 reference to the editor object (QScintilla.Editor.Editor) 281 reference to the editor object (QScintilla.Editor.Editor)
217 </dd> 282 </dd>
218 </dl><dl> 283 </dl>
284 <dl>
219 <dt>Returns:</dt> 285 <dt>Returns:</dt>
220 <dd> 286 <dd>
221 list of possible completions (list of strings) 287 list of possible completions (list of strings)
222 </dd> 288 </dd>
223 </dl><a NAME="Assistant.__getCompletions" ID="Assistant.__getCompletions"></a> 289 </dl>
290 <a NAME="Assistant.__getCompletions" ID="Assistant.__getCompletions"></a>
224 <h4>Assistant.__getCompletions</h4> 291 <h4>Assistant.__getCompletions</h4>
225 <b>__getCompletions</b>(<i>word, context, prefix, language, projectType, module, editor, importCompletion, documentOnly, sep</i>) 292 <b>__getCompletions</b>(<i>word, context, prefix, language, projectType, module, editor, importCompletion, documentOnly, sep</i>)
293
226 <p> 294 <p>
227 Private method to get the list of possible completions. 295 Private method to get the list of possible completions.
228 </p><dl> 296 </p>
297 <dl>
298
229 <dt><i>word</i></dt> 299 <dt><i>word</i></dt>
230 <dd> 300 <dd>
231 word (or wordpart) to complete (string) 301 word (or wordpart) to complete (string)
232 </dd><dt><i>context</i></dt> 302 </dd>
303 <dt><i>context</i></dt>
233 <dd> 304 <dd>
234 flag indicating to autocomplete a context (boolean) 305 flag indicating to autocomplete a context (boolean)
235 </dd><dt><i>prefix</i></dt> 306 </dd>
307 <dt><i>prefix</i></dt>
236 <dd> 308 <dd>
237 prefix of the word to be completed (string) 309 prefix of the word to be completed (string)
238 </dd><dt><i>language</i></dt> 310 </dd>
311 <dt><i>language</i></dt>
239 <dd> 312 <dd>
240 programming language of the source (string) 313 programming language of the source (string)
241 </dd><dt><i>projectType</i></dt> 314 </dd>
315 <dt><i>projectType</i></dt>
242 <dd> 316 <dd>
243 type of the project (string) 317 type of the project (string)
244 </dd><dt><i>module</i></dt> 318 </dd>
319 <dt><i>module</i></dt>
245 <dd> 320 <dd>
246 reference to the scanned module info (Module) 321 reference to the scanned module info (Module)
247 </dd><dt><i>editor</i></dt> 322 </dd>
323 <dt><i>editor</i></dt>
248 <dd> 324 <dd>
249 reference to the editor object (QScintilla.Editor.Editor) 325 reference to the editor object (QScintilla.Editor.Editor)
250 </dd><dt><i>importCompletion</i></dt> 326 </dd>
327 <dt><i>importCompletion</i></dt>
251 <dd> 328 <dd>
252 flag indicating an import completion (boolean) 329 flag indicating an import completion (boolean)
253 </dd><dt><i>documentOnly</i></dt> 330 </dd>
331 <dt><i>documentOnly</i></dt>
254 <dd> 332 <dd>
255 flag indicating to complete from the document only 333 flag indicating to complete from the document only
256 (boolean) 334 (boolean)
257 </dd><dt><i>sep</i></dt> 335 </dd>
336 <dt><i>sep</i></dt>
258 <dd> 337 <dd>
259 separator string (string) 338 separator string (string)
260 </dd> 339 </dd>
261 </dl><dl> 340 </dl>
341 <dl>
262 <dt>Returns:</dt> 342 <dt>Returns:</dt>
263 <dd> 343 <dd>
264 list of possible completions (list of strings) 344 list of possible completions (list of strings)
265 </dd> 345 </dd>
266 </dl><a NAME="Assistant.__getDocumentCalltips" ID="Assistant.__getDocumentCalltips"></a> 346 </dl>
347 <a NAME="Assistant.__getDocumentCalltips" ID="Assistant.__getDocumentCalltips"></a>
267 <h4>Assistant.__getDocumentCalltips</h4> 348 <h4>Assistant.__getDocumentCalltips</h4>
268 <b>__getDocumentCalltips</b>(<i>word, prefix, module, editor, doHierarchy=False</i>) 349 <b>__getDocumentCalltips</b>(<i>word, prefix, module, editor, doHierarchy=False</i>)
350
269 <p> 351 <p>
270 Private method to determine calltips from the document. 352 Private method to determine calltips from the document.
271 </p><dl> 353 </p>
354 <dl>
355
272 <dt><i>word</i></dt> 356 <dt><i>word</i></dt>
273 <dd> 357 <dd>
274 function to get calltips for (string) 358 function to get calltips for (string)
275 </dd><dt><i>prefix</i></dt> 359 </dd>
360 <dt><i>prefix</i></dt>
276 <dd> 361 <dd>
277 prefix of the word to be completed (string) 362 prefix of the word to be completed (string)
278 </dd><dt><i>module</i></dt> 363 </dd>
364 <dt><i>module</i></dt>
279 <dd> 365 <dd>
280 reference to the scanned module info (Module) 366 reference to the scanned module info (Module)
281 </dd><dt><i>editor</i></dt> 367 </dd>
368 <dt><i>editor</i></dt>
282 <dd> 369 <dd>
283 reference to the editor object (QScintilla.Editor) 370 reference to the editor object (QScintilla.Editor)
284 </dd><dt><i>doHierarchy=</i></dt> 371 </dd>
372 <dt><i>doHierarchy=</i></dt>
285 <dd> 373 <dd>
286 flag indicating a hierarchical search (boolean) 374 flag indicating a hierarchical search (boolean)
287 </dd> 375 </dd>
288 </dl><dl> 376 </dl>
377 <dl>
289 <dt>Returns:</dt> 378 <dt>Returns:</dt>
290 <dd> 379 <dd>
291 list of calltips (list of string) 380 list of calltips (list of string)
292 </dd> 381 </dd>
293 </dl><a NAME="Assistant.__getDocumentCompletions" ID="Assistant.__getDocumentCompletions"></a> 382 </dl>
383 <a NAME="Assistant.__getDocumentCompletions" ID="Assistant.__getDocumentCompletions"></a>
294 <h4>Assistant.__getDocumentCompletions</h4> 384 <h4>Assistant.__getDocumentCompletions</h4>
295 <b>__getDocumentCompletions</b>(<i>editor, word, context, sep, prefix, module, doHierarchy=False</i>) 385 <b>__getDocumentCompletions</b>(<i>editor, word, context, sep, prefix, module, doHierarchy=False</i>)
386
296 <p> 387 <p>
297 Private method to determine autocompletion proposals from the document. 388 Private method to determine autocompletion proposals from the document.
298 </p><dl> 389 </p>
390 <dl>
391
299 <dt><i>editor</i></dt> 392 <dt><i>editor</i></dt>
300 <dd> 393 <dd>
301 reference to the editor object (QScintilla.Editor.Editor) 394 reference to the editor object (QScintilla.Editor.Editor)
302 </dd><dt><i>word</i></dt> 395 </dd>
396 <dt><i>word</i></dt>
303 <dd> 397 <dd>
304 string to be completed (string) 398 string to be completed (string)
305 </dd><dt><i>context</i></dt> 399 </dd>
400 <dt><i>context</i></dt>
306 <dd> 401 <dd>
307 flag indicating to autocomplete a context (boolean) 402 flag indicating to autocomplete a context (boolean)
308 </dd><dt><i>sep</i></dt> 403 </dd>
404 <dt><i>sep</i></dt>
309 <dd> 405 <dd>
310 separator string (string) 406 separator string (string)
311 </dd><dt><i>prefix</i></dt> 407 </dd>
408 <dt><i>prefix</i></dt>
312 <dd> 409 <dd>
313 prefix of the word to be completed (string) 410 prefix of the word to be completed (string)
314 </dd><dt><i>module</i></dt> 411 </dd>
412 <dt><i>module</i></dt>
315 <dd> 413 <dd>
316 reference to the scanned module info (Module) 414 reference to the scanned module info (Module)
317 </dd><dt><i>doHierarchy=</i></dt> 415 </dd>
416 <dt><i>doHierarchy=</i></dt>
318 <dd> 417 <dd>
319 flag indicating a hierarchical search (boolean) 418 flag indicating a hierarchical search (boolean)
320 </dd> 419 </dd>
321 </dl><dl> 420 </dl>
421 <dl>
322 <dt>Returns:</dt> 422 <dt>Returns:</dt>
323 <dd> 423 <dd>
324 list of possible completions (list of strings) 424 list of possible completions (list of strings)
325 </dd> 425 </dd>
326 </dl><a NAME="Assistant.__getProjectType" ID="Assistant.__getProjectType"></a> 426 </dl>
427 <a NAME="Assistant.__getProjectType" ID="Assistant.__getProjectType"></a>
327 <h4>Assistant.__getProjectType</h4> 428 <h4>Assistant.__getProjectType</h4>
328 <b>__getProjectType</b>(<i>editor</i>) 429 <b>__getProjectType</b>(<i>editor</i>)
430
329 <p> 431 <p>
330 Private method to determine the project type to be used. 432 Private method to determine the project type to be used.
331 </p><dl> 433 </p>
434 <dl>
435
332 <dt><i>editor</i> (Editor)</dt> 436 <dt><i>editor</i> (Editor)</dt>
333 <dd> 437 <dd>
334 reference to the editor to check 438 reference to the editor to check
335 </dd> 439 </dd>
336 </dl><dl> 440 </dl>
441 <dl>
337 <dt>Returns:</dt> 442 <dt>Returns:</dt>
338 <dd> 443 <dd>
339 project type 444 project type
340 </dd> 445 </dd>
341 </dl><dl> 446 </dl>
447 <dl>
342 <dt>Return Type:</dt> 448 <dt>Return Type:</dt>
343 <dd> 449 <dd>
344 str 450 str
345 </dd> 451 </dd>
346 </dl><a NAME="Assistant.__preferencesChanged" ID="Assistant.__preferencesChanged"></a> 452 </dl>
453 <a NAME="Assistant.__preferencesChanged" ID="Assistant.__preferencesChanged"></a>
347 <h4>Assistant.__preferencesChanged</h4> 454 <h4>Assistant.__preferencesChanged</h4>
348 <b>__preferencesChanged</b>(<i></i>) 455 <b>__preferencesChanged</b>(<i></i>)
456
349 <p> 457 <p>
350 Private method to handle a change of the global configuration. 458 Private method to handle a change of the global configuration.
351 </p><a NAME="Assistant.__recordSelectedContext" ID="Assistant.__recordSelectedContext"></a> 459 </p>
460 <a NAME="Assistant.__recordSelectedContext" ID="Assistant.__recordSelectedContext"></a>
352 <h4>Assistant.__recordSelectedContext</h4> 461 <h4>Assistant.__recordSelectedContext</h4>
353 <b>__recordSelectedContext</b>(<i>userListId, txt</i>) 462 <b>__recordSelectedContext</b>(<i>userListId, txt</i>)
463
354 <p> 464 <p>
355 Private slot to handle the selection from the completion list to 465 Private slot to handle the selection from the completion list to
356 record the selected completion context. 466 record the selected completion context.
357 </p><dl> 467 </p>
468 <dl>
469
358 <dt><i>userListId</i></dt> 470 <dt><i>userListId</i></dt>
359 <dd> 471 <dd>
360 the ID of the user list (should be 1) (integer) 472 the ID of the user list (should be 1) (integer)
361 </dd><dt><i>txt</i></dt> 473 </dd>
474 <dt><i>txt</i></dt>
362 <dd> 475 <dd>
363 the selected text (string) 476 the selected text (string)
364 </dd> 477 </dd>
365 </dl><a NAME="Assistant.__setAutoCompletionHook" ID="Assistant.__setAutoCompletionHook"></a> 478 </dl>
479 <a NAME="Assistant.__setAutoCompletionHook" ID="Assistant.__setAutoCompletionHook"></a>
366 <h4>Assistant.__setAutoCompletionHook</h4> 480 <h4>Assistant.__setAutoCompletionHook</h4>
367 <b>__setAutoCompletionHook</b>(<i>editor</i>) 481 <b>__setAutoCompletionHook</b>(<i>editor</i>)
482
368 <p> 483 <p>
369 Private method to set the autocompletion hook. 484 Private method to set the autocompletion hook.
370 </p><dl> 485 </p>
486 <dl>
487
371 <dt><i>editor</i></dt> 488 <dt><i>editor</i></dt>
372 <dd> 489 <dd>
373 reference to the editor (QScintilla.Editor) 490 reference to the editor (QScintilla.Editor)
374 </dd> 491 </dd>
375 </dl><a NAME="Assistant.__setCalltipsHook" ID="Assistant.__setCalltipsHook"></a> 492 </dl>
493 <a NAME="Assistant.__setCalltipsHook" ID="Assistant.__setCalltipsHook"></a>
376 <h4>Assistant.__setCalltipsHook</h4> 494 <h4>Assistant.__setCalltipsHook</h4>
377 <b>__setCalltipsHook</b>(<i>editor</i>) 495 <b>__setCalltipsHook</b>(<i>editor</i>)
496
378 <p> 497 <p>
379 Private method to set the calltip hook. 498 Private method to set the calltip hook.
380 </p><dl> 499 </p>
500 <dl>
501
381 <dt><i>editor</i></dt> 502 <dt><i>editor</i></dt>
382 <dd> 503 <dd>
383 reference to the editor (QScintilla.Editor) 504 reference to the editor (QScintilla.Editor)
384 </dd> 505 </dd>
385 </dl><a NAME="Assistant.__shutdown" ID="Assistant.__shutdown"></a> 506 </dl>
507 <a NAME="Assistant.__shutdown" ID="Assistant.__shutdown"></a>
386 <h4>Assistant.__shutdown</h4> 508 <h4>Assistant.__shutdown</h4>
387 <b>__shutdown</b>(<i></i>) 509 <b>__shutdown</b>(<i></i>)
510
388 <p> 511 <p>
389 Private slot to handle the shutdown signal. 512 Private slot to handle the shutdown signal.
390 </p><a NAME="Assistant.__unsetAutoCompletionHook" ID="Assistant.__unsetAutoCompletionHook"></a> 513 </p>
514 <a NAME="Assistant.__unsetAutoCompletionHook" ID="Assistant.__unsetAutoCompletionHook"></a>
391 <h4>Assistant.__unsetAutoCompletionHook</h4> 515 <h4>Assistant.__unsetAutoCompletionHook</h4>
392 <b>__unsetAutoCompletionHook</b>(<i>editor</i>) 516 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
517
393 <p> 518 <p>
394 Private method to unset the autocompletion hook. 519 Private method to unset the autocompletion hook.
395 </p><dl> 520 </p>
521 <dl>
522
396 <dt><i>editor</i></dt> 523 <dt><i>editor</i></dt>
397 <dd> 524 <dd>
398 reference to the editor (QScintilla.Editor) 525 reference to the editor (QScintilla.Editor)
399 </dd> 526 </dd>
400 </dl><a NAME="Assistant.__unsetCalltipsHook" ID="Assistant.__unsetCalltipsHook"></a> 527 </dl>
528 <a NAME="Assistant.__unsetCalltipsHook" ID="Assistant.__unsetCalltipsHook"></a>
401 <h4>Assistant.__unsetCalltipsHook</h4> 529 <h4>Assistant.__unsetCalltipsHook</h4>
402 <b>__unsetCalltipsHook</b>(<i>editor</i>) 530 <b>__unsetCalltipsHook</b>(<i>editor</i>)
531
403 <p> 532 <p>
404 Private method to unset the calltip hook. 533 Private method to unset the calltip hook.
405 </p><dl> 534 </p>
535 <dl>
536
406 <dt><i>editor</i></dt> 537 <dt><i>editor</i></dt>
407 <dd> 538 <dd>
408 reference to the editor (QScintilla.Editor) 539 reference to the editor (QScintilla.Editor)
409 </dd> 540 </dd>
410 </dl><a NAME="Assistant.activate" ID="Assistant.activate"></a> 541 </dl>
542 <a NAME="Assistant.activate" ID="Assistant.activate"></a>
411 <h4>Assistant.activate</h4> 543 <h4>Assistant.activate</h4>
412 <b>activate</b>(<i></i>) 544 <b>activate</b>(<i></i>)
545
413 <p> 546 <p>
414 Public method to perform actions upon activation. 547 Public method to perform actions upon activation.
415 </p><a NAME="Assistant.calltips" ID="Assistant.calltips"></a> 548 </p>
549 <a NAME="Assistant.calltips" ID="Assistant.calltips"></a>
416 <h4>Assistant.calltips</h4> 550 <h4>Assistant.calltips</h4>
417 <b>calltips</b>(<i>editor, pos, commas</i>) 551 <b>calltips</b>(<i>editor, pos, commas</i>)
552
418 <p> 553 <p>
419 Public method to return a list of calltips. 554 Public method to return a list of calltips.
420 </p><dl> 555 </p>
556 <dl>
557
421 <dt><i>editor</i></dt> 558 <dt><i>editor</i></dt>
422 <dd> 559 <dd>
423 reference to the editor (QScintilla.Editor) 560 reference to the editor (QScintilla.Editor)
424 </dd><dt><i>pos</i></dt> 561 </dd>
562 <dt><i>pos</i></dt>
425 <dd> 563 <dd>
426 position in the text for the calltip (integer) 564 position in the text for the calltip (integer)
427 </dd><dt><i>commas</i></dt> 565 </dd>
566 <dt><i>commas</i></dt>
428 <dd> 567 <dd>
429 minimum number of commas contained in the calltip 568 minimum number of commas contained in the calltip
430 (integer) 569 (integer)
431 </dd> 570 </dd>
432 </dl><dl> 571 </dl>
572 <dl>
433 <dt>Returns:</dt> 573 <dt>Returns:</dt>
434 <dd> 574 <dd>
435 list of possible calltips (list of strings) 575 list of possible calltips (list of strings)
436 </dd> 576 </dd>
437 </dl><a NAME="Assistant.deactivate" ID="Assistant.deactivate"></a> 577 </dl>
578 <a NAME="Assistant.deactivate" ID="Assistant.deactivate"></a>
438 <h4>Assistant.deactivate</h4> 579 <h4>Assistant.deactivate</h4>
439 <b>deactivate</b>(<i></i>) 580 <b>deactivate</b>(<i></i>)
581
440 <p> 582 <p>
441 Public method to perform actions upon deactivation. 583 Public method to perform actions upon deactivation.
442 </p><a NAME="Assistant.getCompletionsList" ID="Assistant.getCompletionsList"></a> 584 </p>
585 <a NAME="Assistant.getCompletionsList" ID="Assistant.getCompletionsList"></a>
443 <h4>Assistant.getCompletionsList</h4> 586 <h4>Assistant.getCompletionsList</h4>
444 <b>getCompletionsList</b>(<i>editor, context</i>) 587 <b>getCompletionsList</b>(<i>editor, context</i>)
588
445 <p> 589 <p>
446 Public method to get a list of possible completions. 590 Public method to get a list of possible completions.
447 </p><dl> 591 </p>
592 <dl>
593
448 <dt><i>editor</i></dt> 594 <dt><i>editor</i></dt>
449 <dd> 595 <dd>
450 reference to the editor object, that called this method 596 reference to the editor object, that called this method
451 (QScintilla.Editor) 597 (QScintilla.Editor)
452 </dd><dt><i>context</i></dt> 598 </dd>
599 <dt><i>context</i></dt>
453 <dd> 600 <dd>
454 flag indicating to autocomplete a context (boolean) 601 flag indicating to autocomplete a context (boolean)
455 </dd> 602 </dd>
456 </dl><dl> 603 </dl>
604 <dl>
457 <dt>Returns:</dt> 605 <dt>Returns:</dt>
458 <dd> 606 <dd>
459 list of possible completions (list of strings) 607 list of possible completions (list of strings)
460 </dd> 608 </dd>
461 </dl><a NAME="Assistant.setEnabled" ID="Assistant.setEnabled"></a> 609 </dl>
610 <a NAME="Assistant.setEnabled" ID="Assistant.setEnabled"></a>
462 <h4>Assistant.setEnabled</h4> 611 <h4>Assistant.setEnabled</h4>
463 <b>setEnabled</b>(<i>key, enabled</i>) 612 <b>setEnabled</b>(<i>key, enabled</i>)
613
464 <p> 614 <p>
465 Public method to enable or disable a feature. 615 Public method to enable or disable a feature.
466 </p><dl> 616 </p>
617 <dl>
618
467 <dt><i>key</i></dt> 619 <dt><i>key</i></dt>
468 <dd> 620 <dd>
469 feature to set (string) 621 feature to set (string)
470 </dd><dt><i>enabled</i></dt> 622 </dd>
623 <dt><i>enabled</i></dt>
471 <dd> 624 <dd>
472 flag indicating the status (boolean) 625 flag indicating the status (boolean)
473 </dd> 626 </dd>
474 </dl> 627 </dl>
475 <div align="right"><a href="#top">Up</a></div> 628 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: Eric Assistant

eric ide

mercurial