Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html

branch
eric7
changeset 416
45159308166f
parent 414
af1d72eccf91
equal deleted inserted replaced
415:78af27bb8201 416:45159308166f
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</h1>
10
11 <p> 10 <p>
12 Module implementing the autocompletion interface to rope. 11 Module implementing the autocompletion interface to rope.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <tr><td>PictureIDs</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#CodeAssistServer">CodeAssistServer</a></td>
23 <td>Class implementing the autocompletion interface to rope.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
16 <table> 28 <table>
17 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
18 </table> 30 </table>
19 <h3>Classes</h3> 31
20
21 <table>
22
23 <tr>
24 <td><a href="#CodeAssistServer">CodeAssistServer</a></td>
25 <td>Class implementing the autocompletion interface to rope.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="CodeAssistServer" ID="CodeAssistServer"></a> 34 <a NAME="CodeAssistServer" ID="CodeAssistServer"></a>
36 <h2>CodeAssistServer</h2> 35 <h2>CodeAssistServer</h2>
37
38 <p> 36 <p>
39 Class implementing the autocompletion interface to rope. 37 Class implementing the autocompletion interface to rope.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 EricJsonServer 41 EricJsonServer
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>IdProject</td></tr> 44 <tr><td>IdProject</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td> 55 <td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
169 <tr> 166 <tr>
170 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> 167 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
171 <td>Public method to request a list of possible completions.</td> 168 <td>Public method to request a list of possible completions.</td>
172 </tr> 169 </tr>
173 </table> 170 </table>
171
174 <h3>Static Methods</h3> 172 <h3>Static Methods</h3>
175
176 <table> 173 <table>
177 <tr><td>None</td></tr> 174 <tr><td>None</td></tr>
178 </table> 175 </table>
179 176
177
180 <a NAME="CodeAssistServer.__init__" ID="CodeAssistServer.__init__"></a> 178 <a NAME="CodeAssistServer.__init__" ID="CodeAssistServer.__init__"></a>
181 <h4>CodeAssistServer (Constructor)</h4> 179 <h4>CodeAssistServer (Constructor)</h4>
182 <b>CodeAssistServer</b>(<i>plugin, parent=None</i>) 180 <b>CodeAssistServer</b>(<i>plugin, parent=None</i>)
183
184 <p> 181 <p>
185 Constructor 182 Constructor
186 </p> 183 </p>
184
187 <dl> 185 <dl>
188 186
189 <dt><i>plugin</i> (RefactoringRopePlugin)</dt> 187 <dt><i>plugin</i> (RefactoringRopePlugin)</dt>
190 <dd> 188 <dd>
191 reference to the plugin object 189 reference to the plugin object
196 </dd> 194 </dd>
197 </dl> 195 </dl>
198 <a NAME="CodeAssistServer.__configChanged" ID="CodeAssistServer.__configChanged"></a> 196 <a NAME="CodeAssistServer.__configChanged" ID="CodeAssistServer.__configChanged"></a>
199 <h4>CodeAssistServer.__configChanged</h4> 197 <h4>CodeAssistServer.__configChanged</h4>
200 <b>__configChanged</b>(<i>idString</i>) 198 <b>__configChanged</b>(<i>idString</i>)
201
202 <p> 199 <p>
203 Private slot called, when the rope config file has changed. 200 Private slot called, when the rope config file has changed.
204 </p> 201 </p>
202
205 <dl> 203 <dl>
206 204
207 <dt><i>idString</i> (str)</dt> 205 <dt><i>idString</i> (str)</dt>
208 <dd> 206 <dd>
209 id for which to get the configuration file 207 id for which to get the configuration file
210 </dd> 208 </dd>
211 </dl> 209 </dl>
212 <a NAME="CodeAssistServer.__ensureActive" ID="CodeAssistServer.__ensureActive"></a> 210 <a NAME="CodeAssistServer.__ensureActive" ID="CodeAssistServer.__ensureActive"></a>
213 <h4>CodeAssistServer.__ensureActive</h4> 211 <h4>CodeAssistServer.__ensureActive</h4>
214 <b>__ensureActive</b>(<i>idString</i>) 212 <b>__ensureActive</b>(<i>idString</i>)
215
216 <p> 213 <p>
217 Private method to ensure, that the requested client is active. 214 Private method to ensure, that the requested client is active.
218 </p> 215 </p>
219 <p> 216 <p>
220 A non-active client will be started. 217 A non-active client will be started.
221 </p> 218 </p>
219
222 <dl> 220 <dl>
223 221
224 <dt><i>idString</i> (str)</dt> 222 <dt><i>idString</i> (str)</dt>
225 <dd> 223 <dd>
226 id of the client to be checked 224 id of the client to be checked
239 </dd> 237 </dd>
240 </dl> 238 </dl>
241 <a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a> 239 <a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a>
242 <h4>CodeAssistServer.__getConfigs</h4> 240 <h4>CodeAssistServer.__getConfigs</h4>
243 <b>__getConfigs</b>(<i></i>) 241 <b>__getConfigs</b>(<i></i>)
244
245 <p> 242 <p>
246 Private method to get the configurations of all connected clients. 243 Private method to get the configurations of all connected clients.
247 </p> 244 </p>
245
248 <a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a> 246 <a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a>
249 <h4>CodeAssistServer.__gotoDefinitionResult</h4> 247 <h4>CodeAssistServer.__gotoDefinitionResult</h4>
250 <b>__gotoDefinitionResult</b>(<i>result</i>) 248 <b>__gotoDefinitionResult</b>(<i>result</i>)
251
252 <p> 249 <p>
253 Private method to handle the "Goto Definition" result sent by 250 Private method to handle the "Goto Definition" result sent by
254 the client. 251 the client.
255 </p> 252 </p>
253
256 <dl> 254 <dl>
257 255
258 <dt><i>result</i> (dict)</dt> 256 <dt><i>result</i> (dict)</dt>
259 <dd> 257 <dd>
260 dictionary containing the result data 258 dictionary containing the result data
261 </dd> 259 </dd>
262 </dl> 260 </dl>
263 <a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a> 261 <a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
264 <h4>CodeAssistServer.__idString</h4> 262 <h4>CodeAssistServer.__idString</h4>
265 <b>__idString</b>(<i>editor</i>) 263 <b>__idString</b>(<i>editor</i>)
266
267 <p> 264 <p>
268 Private method to determine the ID string for the back-end. 265 Private method to determine the ID string for the back-end.
269 </p> 266 </p>
267
270 <dl> 268 <dl>
271 269
272 <dt><i>editor</i> (Editor)</dt> 270 <dt><i>editor</i> (Editor)</dt>
273 <dd> 271 <dd>
274 reference to the editor to determine the ID string for 272 reference to the editor to determine the ID string for
287 </dd> 285 </dd>
288 </dl> 286 </dl>
289 <a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a> 287 <a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a>
290 <h4>CodeAssistServer.__interpreterForProject</h4> 288 <h4>CodeAssistServer.__interpreterForProject</h4>
291 <b>__interpreterForProject</b>(<i></i>) 289 <b>__interpreterForProject</b>(<i></i>)
292
293 <p> 290 <p>
294 Private method to determine the interpreter for the current project and 291 Private method to determine the interpreter for the current project and
295 the environment to run it. 292 the environment to run it.
296 </p> 293 </p>
294
297 <dl> 295 <dl>
298 <dt>Return:</dt> 296 <dt>Return:</dt>
299 <dd> 297 <dd>
300 tuple containing the interpreter of the current project and the 298 tuple containing the interpreter of the current project and the
301 environment variables 299 environment variables
308 </dd> 306 </dd>
309 </dl> 307 </dl>
310 <a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a> 308 <a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
311 <h4>CodeAssistServer.__processCallTipsResult</h4> 309 <h4>CodeAssistServer.__processCallTipsResult</h4>
312 <b>__processCallTipsResult</b>(<i>result</i>) 310 <b>__processCallTipsResult</b>(<i>result</i>)
313
314 <p> 311 <p>
315 Private method to process the calltips sent by the client. 312 Private method to process the calltips sent by the client.
316 </p> 313 </p>
314
317 <dl> 315 <dl>
318 316
319 <dt><i>result</i> (dict)</dt> 317 <dt><i>result</i> (dict)</dt>
320 <dd> 318 <dd>
321 dictionary containing the result sent by the client 319 dictionary containing the result sent by the client
322 </dd> 320 </dd>
323 </dl> 321 </dl>
324 <a NAME="CodeAssistServer.__processClientException" ID="CodeAssistServer.__processClientException"></a> 322 <a NAME="CodeAssistServer.__processClientException" ID="CodeAssistServer.__processClientException"></a>
325 <h4>CodeAssistServer.__processClientException</h4> 323 <h4>CodeAssistServer.__processClientException</h4>
326 <b>__processClientException</b>(<i>params</i>) 324 <b>__processClientException</b>(<i>params</i>)
327
328 <p> 325 <p>
329 Private method to handle exceptions of the refactoring client. 326 Private method to handle exceptions of the refactoring client.
330 </p> 327 </p>
328
331 <dl> 329 <dl>
332 330
333 <dt><i>params</i> (dict)</dt> 331 <dt><i>params</i> (dict)</dt>
334 <dd> 332 <dd>
335 dictionary containing the exception data 333 dictionary containing the exception data
336 </dd> 334 </dd>
337 </dl> 335 </dl>
338 <a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a> 336 <a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a>
339 <h4>CodeAssistServer.__processCompletionsResult</h4> 337 <h4>CodeAssistServer.__processCompletionsResult</h4>
340 <b>__processCompletionsResult</b>(<i>result</i>) 338 <b>__processCompletionsResult</b>(<i>result</i>)
341
342 <p> 339 <p>
343 Private method to process the completions sent by the client. 340 Private method to process the completions sent by the client.
344 </p> 341 </p>
342
345 <dl> 343 <dl>
346 344
347 <dt><i>result</i> (dict)</dt> 345 <dt><i>result</i> (dict)</dt>
348 <dd> 346 <dd>
349 dictionary containing the result sent by the client 347 dictionary containing the result sent by the client
350 </dd> 348 </dd>
351 </dl> 349 </dl>
352 <a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a> 350 <a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a>
353 <h4>CodeAssistServer.__processDocumentationResult</h4> 351 <h4>CodeAssistServer.__processDocumentationResult</h4>
354 <b>__processDocumentationResult</b>(<i>result</i>) 352 <b>__processDocumentationResult</b>(<i>result</i>)
355
356 <p> 353 <p>
357 Private method to process the documentation sent by the client. 354 Private method to process the documentation sent by the client.
358 </p> 355 </p>
356
359 <dl> 357 <dl>
360 358
361 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt> 359 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt>
362 <dd> 360 <dd>
363 dictionary containing the result sent by the client 361 dictionary containing the result sent by the client
364 </dd> 362 </dd>
365 </dl> 363 </dl>
366 <a NAME="CodeAssistServer.__processGotoReferencesResult" ID="CodeAssistServer.__processGotoReferencesResult"></a> 364 <a NAME="CodeAssistServer.__processGotoReferencesResult" ID="CodeAssistServer.__processGotoReferencesResult"></a>
367 <h4>CodeAssistServer.__processGotoReferencesResult</h4> 365 <h4>CodeAssistServer.__processGotoReferencesResult</h4>
368 <b>__processGotoReferencesResult</b>(<i>result</i>) 366 <b>__processGotoReferencesResult</b>(<i>result</i>)
369
370 <p> 367 <p>
371 Private method callback for the goto references result. 368 Private method callback for the goto references result.
372 </p> 369 </p>
370
373 <dl> 371 <dl>
374 372
375 <dt><i>result</i> (dict)</dt> 373 <dt><i>result</i> (dict)</dt>
376 <dd> 374 <dd>
377 dictionary containing the result data 375 dictionary containing the result data
378 </dd> 376 </dd>
379 </dl> 377 </dl>
380 <a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a> 378 <a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a>
381 <h4>CodeAssistServer.__projectClosed</h4> 379 <h4>CodeAssistServer.__projectClosed</h4>
382 <b>__projectClosed</b>(<i></i>) 380 <b>__projectClosed</b>(<i></i>)
383
384 <p> 381 <p>
385 Private slot to handle the projectClosed signal. 382 Private slot to handle the projectClosed signal.
386 </p> 383 </p>
384
387 <a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a> 385 <a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
388 <h4>CodeAssistServer.__ropeConfigFile</h4> 386 <h4>CodeAssistServer.__ropeConfigFile</h4>
389 <b>__ropeConfigFile</b>(<i>idString</i>) 387 <b>__ropeConfigFile</b>(<i>idString</i>)
390
391 <p> 388 <p>
392 Private method to get the name of the rope configuration file. 389 Private method to get the name of the rope configuration file.
393 </p> 390 </p>
391
394 <dl> 392 <dl>
395 393
396 <dt><i>idString</i> (str)</dt> 394 <dt><i>idString</i> (str)</dt>
397 <dd> 395 <dd>
398 id for which to get the configuration file 396 id for which to get the configuration file
411 </dd> 409 </dd>
412 </dl> 410 </dl>
413 <a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a> 411 <a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a>
414 <h4>CodeAssistServer.__setConfig</h4> 412 <h4>CodeAssistServer.__setConfig</h4>
415 <b>__setConfig</b>(<i>params</i>) 413 <b>__setConfig</b>(<i>params</i>)
416
417 <p> 414 <p>
418 Private method to set the rope client configuration data. 415 Private method to set the rope client configuration data.
419 </p> 416 </p>
417
420 <dl> 418 <dl>
421 419
422 <dt><i>params</i> (dict)</dt> 420 <dt><i>params</i> (dict)</dt>
423 <dd> 421 <dd>
424 dictionary containing the configuration data 422 dictionary containing the configuration data
425 </dd> 423 </dd>
426 </dl> 424 </dl>
427 <a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a> 425 <a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a>
428 <h4>CodeAssistServer.__startCodeAssistClient</h4> 426 <h4>CodeAssistServer.__startCodeAssistClient</h4>
429 <b>__startCodeAssistClient</b>(<i>interpreter, idString, clientEnv</i>) 427 <b>__startCodeAssistClient</b>(<i>interpreter, idString, clientEnv</i>)
430
431 <p> 428 <p>
432 Private method to start the code assist client with the given 429 Private method to start the code assist client with the given
433 interpreter. 430 interpreter.
434 </p> 431 </p>
432
435 <dl> 433 <dl>
436 434
437 <dt><i>interpreter</i> (str)</dt> 435 <dt><i>interpreter</i> (str)</dt>
438 <dd> 436 <dd>
439 interpreter to be used for the code assist client 437 interpreter to be used for the code assist client
461 </dd> 459 </dd>
462 </dl> 460 </dl>
463 <a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a> 461 <a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
464 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4> 462 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
465 <b>__updateEditorLanguageMapping</b>(<i></i>) 463 <b>__updateEditorLanguageMapping</b>(<i></i>)
466
467 <p> 464 <p>
468 Private method to update the editor language to connection mapping. 465 Private method to update the editor language to connection mapping.
469 </p> 466 </p>
467
470 <a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a> 468 <a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a>
471 <h4>CodeAssistServer.activate</h4> 469 <h4>CodeAssistServer.activate</h4>
472 <b>activate</b>(<i></i>) 470 <b>activate</b>(<i></i>)
473
474 <p> 471 <p>
475 Public method to activate the code assist server. 472 Public method to activate the code assist server.
476 </p> 473 </p>
474
477 <a NAME="CodeAssistServer.createConfig" ID="CodeAssistServer.createConfig"></a> 475 <a NAME="CodeAssistServer.createConfig" ID="CodeAssistServer.createConfig"></a>
478 <h4>CodeAssistServer.createConfig</h4> 476 <h4>CodeAssistServer.createConfig</h4>
479 <b>createConfig</b>(<i>idString</i>) 477 <b>createConfig</b>(<i>idString</i>)
480
481 <p> 478 <p>
482 Public slot to create a new default rope configuration file. 479 Public slot to create a new default rope configuration file.
483 </p> 480 </p>
481
484 <dl> 482 <dl>
485 483
486 <dt><i>idString</i> (str)</dt> 484 <dt><i>idString</i> (str)</dt>
487 <dd> 485 <dd>
488 id for which to create the configuration file 486 id for which to create the configuration file
489 </dd> 487 </dd>
490 </dl> 488 </dl>
491 <a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a> 489 <a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
492 <h4>CodeAssistServer.deactivate</h4> 490 <h4>CodeAssistServer.deactivate</h4>
493 <b>deactivate</b>(<i></i>) 491 <b>deactivate</b>(<i></i>)
494
495 <p> 492 <p>
496 Public method to deactivate the code assist server. 493 Public method to deactivate the code assist server.
497 </p> 494 </p>
495
498 <a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a> 496 <a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
499 <h4>CodeAssistServer.editConfig</h4> 497 <h4>CodeAssistServer.editConfig</h4>
500 <b>editConfig</b>(<i>idString</i>) 498 <b>editConfig</b>(<i>idString</i>)
501
502 <p> 499 <p>
503 Public slot to open the rope configuration file in an editor. 500 Public slot to open the rope configuration file in an editor.
504 </p> 501 </p>
502
505 <dl> 503 <dl>
506 504
507 <dt><i>idString</i> (str)</dt> 505 <dt><i>idString</i> (str)</dt>
508 <dd> 506 <dd>
509 id for which to get the configuration file 507 id for which to get the configuration file
510 </dd> 508 </dd>
511 </dl> 509 </dl>
512 <a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a> 510 <a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a>
513 <h4>CodeAssistServer.getCallTips</h4> 511 <h4>CodeAssistServer.getCallTips</h4>
514 <b>getCallTips</b>(<i>editor, pos, commas</i>) 512 <b>getCallTips</b>(<i>editor, pos, commas</i>)
515
516 <p> 513 <p>
517 Public method to calculate calltips. 514 Public method to calculate calltips.
518 </p> 515 </p>
516
519 <dl> 517 <dl>
520 518
521 <dt><i>editor</i> (Editor)</dt> 519 <dt><i>editor</i> (Editor)</dt>
522 <dd> 520 <dd>
523 reference to the editor object, that called this method 521 reference to the editor object, that called this method
544 </dd> 542 </dd>
545 </dl> 543 </dl>
546 <a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a> 544 <a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a>
547 <h4>CodeAssistServer.gotoDefinition</h4> 545 <h4>CodeAssistServer.gotoDefinition</h4>
548 <b>gotoDefinition</b>(<i>editor</i>) 546 <b>gotoDefinition</b>(<i>editor</i>)
549
550 <p> 547 <p>
551 Public slot to find the definition for the word at the cursor position 548 Public slot to find the definition for the word at the cursor position
552 and go to it. 549 and go to it.
553 </p> 550 </p>
554 <p> 551 <p>
555 Note: This is executed upon a mouse click sequence. 552 Note: This is executed upon a mouse click sequence.
556 </p> 553 </p>
554
557 <dl> 555 <dl>
558 556
559 <dt><i>editor</i> (Editor)</dt> 557 <dt><i>editor</i> (Editor)</dt>
560 <dd> 558 <dd>
561 reference to the calling editor 559 reference to the calling editor
562 </dd> 560 </dd>
563 </dl> 561 </dl>
564 <a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a> 562 <a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a>
565 <h4>CodeAssistServer.handleCall</h4> 563 <h4>CodeAssistServer.handleCall</h4>
566 <b>handleCall</b>(<i>method, params</i>) 564 <b>handleCall</b>(<i>method, params</i>)
567
568 <p> 565 <p>
569 Public method to handle a method call from the client. 566 Public method to handle a method call from the client.
570 </p> 567 </p>
568
571 <dl> 569 <dl>
572 570
573 <dt><i>method</i> (str)</dt> 571 <dt><i>method</i> (str)</dt>
574 <dd> 572 <dd>
575 requested method name 573 requested method name
580 </dd> 578 </dd>
581 </dl> 579 </dl>
582 <a NAME="CodeAssistServer.handleNewConnection" ID="CodeAssistServer.handleNewConnection"></a> 580 <a NAME="CodeAssistServer.handleNewConnection" ID="CodeAssistServer.handleNewConnection"></a>
583 <h4>CodeAssistServer.handleNewConnection</h4> 581 <h4>CodeAssistServer.handleNewConnection</h4>
584 <b>handleNewConnection</b>(<i></i>) 582 <b>handleNewConnection</b>(<i></i>)
585
586 <p> 583 <p>
587 Public slot for new incoming connections from a client. 584 Public slot for new incoming connections from a client.
588 </p> 585 </p>
586
589 <a NAME="CodeAssistServer.isSupportedLanguage" ID="CodeAssistServer.isSupportedLanguage"></a> 587 <a NAME="CodeAssistServer.isSupportedLanguage" ID="CodeAssistServer.isSupportedLanguage"></a>
590 <h4>CodeAssistServer.isSupportedLanguage</h4> 588 <h4>CodeAssistServer.isSupportedLanguage</h4>
591 <b>isSupportedLanguage</b>(<i>language</i>) 589 <b>isSupportedLanguage</b>(<i>language</i>)
592
593 <p> 590 <p>
594 Public method to check, if the given language is supported. 591 Public method to check, if the given language is supported.
595 </p> 592 </p>
593
596 <dl> 594 <dl>
597 595
598 <dt><i>language</i> (str)</dt> 596 <dt><i>language</i> (str)</dt>
599 <dd> 597 <dd>
600 editor programming language to check 598 editor programming language to check
613 </dd> 611 </dd>
614 </dl> 612 </dl>
615 <a NAME="CodeAssistServer.reportChanged" ID="CodeAssistServer.reportChanged"></a> 613 <a NAME="CodeAssistServer.reportChanged" ID="CodeAssistServer.reportChanged"></a>
616 <h4>CodeAssistServer.reportChanged</h4> 614 <h4>CodeAssistServer.reportChanged</h4>
617 <b>reportChanged</b>(<i>filename, oldSource</i>) 615 <b>reportChanged</b>(<i>filename, oldSource</i>)
618
619 <p> 616 <p>
620 Public slot to report some changed sources. 617 Public slot to report some changed sources.
621 </p> 618 </p>
619
622 <dl> 620 <dl>
623 621
624 <dt><i>filename</i> (str)</dt> 622 <dt><i>filename</i> (str)</dt>
625 <dd> 623 <dd>
626 file name of the changed source 624 file name of the changed source
631 </dd> 629 </dd>
632 </dl> 630 </dl>
633 <a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a> 631 <a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a>
634 <h4>CodeAssistServer.requestCodeDocumentation</h4> 632 <h4>CodeAssistServer.requestCodeDocumentation</h4>
635 <b>requestCodeDocumentation</b>(<i>editor</i>) 633 <b>requestCodeDocumentation</b>(<i>editor</i>)
636
637 <p> 634 <p>
638 Public method to request source code documentation for the given 635 Public method to request source code documentation for the given
639 editor. 636 editor.
640 </p> 637 </p>
638
641 <dl> 639 <dl>
642 640
643 <dt><i>editor</i> (Editor)</dt> 641 <dt><i>editor</i> (Editor)</dt>
644 <dd> 642 <dd>
645 reference to the editor to get source code documentation 643 reference to the editor to get source code documentation
647 </dd> 645 </dd>
648 </dl> 646 </dl>
649 <a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a> 647 <a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a>
650 <h4>CodeAssistServer.requestCompletions</h4> 648 <h4>CodeAssistServer.requestCompletions</h4>
651 <b>requestCompletions</b>(<i>editor, context, acText</i>) 649 <b>requestCompletions</b>(<i>editor, context, acText</i>)
652
653 <p> 650 <p>
654 Public method to request a list of possible completions. 651 Public method to request a list of possible completions.
655 </p> 652 </p>
653
656 <dl> 654 <dl>
657 655
658 <dt><i>editor</i> (Editor)</dt> 656 <dt><i>editor</i> (Editor)</dt>
659 <dd> 657 <dd>
660 reference to the editor object, that called this method 658 reference to the editor object, that called this method

Mercurial Repository: Rope Refactoring

eric ide

mercurial