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 365
- f740b50380df
- parent 360
- 2b35968f3d02
- child 370
- 9d246420f284
equal
deleted
inserted
replaced
| 364:a92b3272f4c1 | 365:f740b50380df |
|---|---|
| 51 | 51 |
| 52 <p> | 52 <p> |
| 53 Class implementing the autocompletion interface to rope. | 53 Class implementing the autocompletion interface to rope. |
| 54 </p> | 54 </p> |
| 55 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 56 E5JsonServer | 56 EricJsonServer |
| 57 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | 58 |
| 59 <table> | 59 <table> |
| 60 <tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr> | 60 <tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr> |
| 61 </table> | 61 </table> |
| 147 <tr> | 147 <tr> |
| 148 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td> | 148 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td> |
| 149 <td>Public method to calculate calltips.</td> | 149 <td>Public method to calculate calltips.</td> |
| 150 </tr> | 150 </tr> |
| 151 <tr> | 151 <tr> |
| 152 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td> | |
| 153 <td>Public method to calculate the possible completions.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td> | 152 <td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td> |
| 157 <td>Public slot to find the definition for the word at the cursor position and go to it.</td> | 153 <td>Public slot to find the definition for the word at the cursor position and go to it.</td> |
| 158 </tr> | 154 </tr> |
| 159 <tr> | 155 <tr> |
| 160 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td> | 156 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td> |
| 177 <td>Public method to request source code documentation for the given editor.</td> | 173 <td>Public method to request source code documentation for the given editor.</td> |
| 178 </tr> | 174 </tr> |
| 179 <tr> | 175 <tr> |
| 180 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> | 176 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> |
| 181 <td>Public method to request a list of possible completions.</td> | 177 <td>Public method to request a list of possible completions.</td> |
| 182 </tr> | |
| 183 <tr> | |
| 184 <td><a href="#CodeAssistServer.setAsyncCompletions">setAsyncCompletions</a></td> | |
| 185 <td>Public method to set the asynchronous completions flag.</td> | |
| 186 </tr> | 178 </tr> |
| 187 </table> | 179 </table> |
| 188 <h3>Static Methods</h3> | 180 <h3>Static Methods</h3> |
| 189 | 181 |
| 190 <table> | 182 <table> |
| 281 <p> | 273 <p> |
| 282 Private method to determine the ID string for the back-end. | 274 Private method to determine the ID string for the back-end. |
| 283 </p> | 275 </p> |
| 284 <dl> | 276 <dl> |
| 285 | 277 |
| 286 <dt><i>editor</i> (QScintilla.Editor)</dt> | 278 <dt><i>editor</i> (Editor)</dt> |
| 287 <dd> | 279 <dd> |
| 288 reference to the editor to determine the ID string for | 280 reference to the editor to determine the ID string for |
| 289 </dd> | 281 </dd> |
| 290 </dl> | 282 </dl> |
| 291 <dl> | 283 <dl> |
| 502 <p> | 494 <p> |
| 503 Public method to calculate calltips. | 495 Public method to calculate calltips. |
| 504 </p> | 496 </p> |
| 505 <dl> | 497 <dl> |
| 506 | 498 |
| 507 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> | 499 <dt><i>editor</i> (Editor)</dt> |
| 508 <dd> | 500 <dd> |
| 509 reference to the editor object, that called this method | 501 reference to the editor object, that called this method |
| 510 </dd> | 502 </dd> |
| 511 <dt><i>pos</i> (int)</dt> | 503 <dt><i>pos</i> (int)</dt> |
| 512 <dd> | 504 <dd> |
| 519 </dl> | 511 </dl> |
| 520 <dl> | 512 <dl> |
| 521 <dt>Return:</dt> | 513 <dt>Return:</dt> |
| 522 <dd> | 514 <dd> |
| 523 list of possible calltips | 515 list of possible calltips |
| 524 </dd> | |
| 525 </dl> | |
| 526 <dl> | |
| 527 <dt>Return Type:</dt> | |
| 528 <dd> | |
| 529 list of str | |
| 530 </dd> | |
| 531 </dl> | |
| 532 <a NAME="CodeAssistServer.getCompletions" ID="CodeAssistServer.getCompletions"></a> | |
| 533 <h4>CodeAssistServer.getCompletions</h4> | |
| 534 <b>getCompletions</b>(<i>editor, context</i>) | |
| 535 | |
| 536 <p> | |
| 537 Public method to calculate the possible completions. | |
| 538 </p> | |
| 539 <p> | |
| 540 Note: This is the synchronous variant for eric6 before 17.11. | |
| 541 </p> | |
| 542 <dl> | |
| 543 | |
| 544 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> | |
| 545 <dd> | |
| 546 reference to the editor object, that called this method | |
| 547 </dd> | |
| 548 <dt><i>context</i> (bool)</dt> | |
| 549 <dd> | |
| 550 flag indicating to autocomplete a context | |
| 551 </dd> | |
| 552 </dl> | |
| 553 <dl> | |
| 554 <dt>Return:</dt> | |
| 555 <dd> | |
| 556 list of possible completions | |
| 557 </dd> | 516 </dd> |
| 558 </dl> | 517 </dl> |
| 559 <dl> | 518 <dl> |
| 560 <dt>Return Type:</dt> | 519 <dt>Return Type:</dt> |
| 561 <dd> | 520 <dd> |
| 573 <p> | 532 <p> |
| 574 Note: This is executed upon a mouse click sequence. | 533 Note: This is executed upon a mouse click sequence. |
| 575 </p> | 534 </p> |
| 576 <dl> | 535 <dl> |
| 577 | 536 |
| 578 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> | 537 <dt><i>editor</i> (Editor)</dt> |
| 579 <dd> | 538 <dd> |
| 580 reference to the calling editor | 539 reference to the calling editor |
| 581 </dd> | 540 </dd> |
| 582 </dl> | 541 </dl> |
| 583 <a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a> | 542 <a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a> |
| 657 Public method to request source code documentation for the given | 616 Public method to request source code documentation for the given |
| 658 editor. | 617 editor. |
| 659 </p> | 618 </p> |
| 660 <dl> | 619 <dl> |
| 661 | 620 |
| 662 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> | 621 <dt><i>editor</i> (Editor)</dt> |
| 663 <dd> | 622 <dd> |
| 664 reference to the editor to get source code documentation | 623 reference to the editor to get source code documentation |
| 665 for | 624 for |
| 666 </dd> | 625 </dd> |
| 667 </dl> | 626 </dl> |
| 670 <b>requestCompletions</b>(<i>editor, context, acText</i>) | 629 <b>requestCompletions</b>(<i>editor, context, acText</i>) |
| 671 | 630 |
| 672 <p> | 631 <p> |
| 673 Public method to request a list of possible completions. | 632 Public method to request a list of possible completions. |
| 674 </p> | 633 </p> |
| 675 <p> | 634 <dl> |
| 676 Note: This is part of the asynchronous variant for eric6 17.11 and | 635 |
| 677 later. | 636 <dt><i>editor</i> (Editor)</dt> |
| 678 </p> | |
| 679 <dl> | |
| 680 | |
| 681 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> | |
| 682 <dd> | 637 <dd> |
| 683 reference to the editor object, that called this method | 638 reference to the editor object, that called this method |
| 684 </dd> | 639 </dd> |
| 685 <dt><i>context</i> (bool)</dt> | 640 <dt><i>context</i> (bool)</dt> |
| 686 <dd> | 641 <dd> |
| 687 flag indicating to autocomplete a context | 642 flag indicating to autocomplete a context |
| 688 </dd> | 643 </dd> |
| 689 <dt><i>acText</i> (str)</dt> | 644 <dt><i>acText</i> (str)</dt> |
| 690 <dd> | 645 <dd> |
| 691 text to be completed | 646 text to be completed |
| 692 </dd> | |
| 693 </dl> | |
| 694 <a NAME="CodeAssistServer.setAsyncCompletions" ID="CodeAssistServer.setAsyncCompletions"></a> | |
| 695 <h4>CodeAssistServer.setAsyncCompletions</h4> | |
| 696 <b>setAsyncCompletions</b>(<i>asynchronous</i>) | |
| 697 | |
| 698 <p> | |
| 699 Public method to set the asynchronous completions flag. | |
| 700 </p> | |
| 701 <dl> | |
| 702 | |
| 703 <dt><i>asynchronous</i> (bool)</dt> | |
| 704 <dd> | |
| 705 flag indicating asynchronous completions | |
| 706 </dd> | 647 </dd> |
| 707 </dl> | 648 </dl> |
| 708 <div align="right"><a href="#top">Up</a></div> | 649 <div align="right"><a href="#top">Up</a></div> |
| 709 <hr /> | 650 <hr /> |
| 710 </body></html> | 651 </body></html> |
