Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssist.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssist.html
- changeset 100
- 2bfe9e3fad8d
- child 104
- f6049d39f83d
equal
deleted
inserted
replaced
| 99:e21a49043f31 | 100:2bfe9e3fad8d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssist</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>Plugin_Refactoring_Rope.RefactoringRope.CodeAssist</h1> | |
| 23 <p> | |
| 24 Module implementing the autocompletion interface to rope. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#CodeAssist">CodeAssist</a></td> | |
| 34 <td>Class implementing the autocompletion interface to rope.</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="CodeAssist" ID="CodeAssist"></a> | |
| 43 <h2>CodeAssist</h2> | |
| 44 <p> | |
| 45 Class implementing the autocompletion interface to rope. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#CodeAssist.__init__">CodeAssist</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CodeAssist.getCallTips">getCallTips</a></td> | |
| 64 <td>Public method to calculate calltips.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CodeAssist.getCompletions">getCompletions</a></td> | |
| 67 <td>Public method to calculate the possible completions.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <h3>Static Methods</h3> | |
| 71 <table> | |
| 72 <tr><td>None</td></tr> | |
| 73 </table> | |
| 74 <a NAME="CodeAssist.__init__" ID="CodeAssist.__init__"></a> | |
| 75 <h4>CodeAssist (Constructor)</h4> | |
| 76 <b>CodeAssist</b>(<i>refactoring, editor, plugin, parent = None</i>) | |
| 77 <p> | |
| 78 Constructor | |
| 79 </p><dl> | |
| 80 <dt><i>refactoring</i></dt> | |
| 81 <dd> | |
| 82 reference to the rope refactoring object | |
| 83 (Refactoring) | |
| 84 </dd><dt><i>editor</i></dt> | |
| 85 <dd> | |
| 86 reference to the editor object, that called this method | |
| 87 QScintilla.Editor) | |
| 88 </dd><dt><i>plugin</i></dt> | |
| 89 <dd> | |
| 90 reference to the plugin object | |
| 91 </dd><dt><i>parent</i></dt> | |
| 92 <dd> | |
| 93 parent (QObject) | |
| 94 </dd> | |
| 95 </dl><a NAME="CodeAssist.getCallTips" ID="CodeAssist.getCallTips"></a> | |
| 96 <h4>CodeAssist.getCallTips</h4> | |
| 97 <b>getCallTips</b>(<i>pos</i>) | |
| 98 <p> | |
| 99 Public method to calculate calltips. | |
| 100 </p><dl> | |
| 101 <dt><i>pos</i></dt> | |
| 102 <dd> | |
| 103 position in the text for the calltip (integer) | |
| 104 </dd> | |
| 105 </dl><dl> | |
| 106 <dt>Returns:</dt> | |
| 107 <dd> | |
| 108 list of possible calltips (list of strings) | |
| 109 </dd> | |
| 110 </dl><a NAME="CodeAssist.getCompletions" ID="CodeAssist.getCompletions"></a> | |
| 111 <h4>CodeAssist.getCompletions</h4> | |
| 112 <b>getCompletions</b>(<i></i>) | |
| 113 <p> | |
| 114 Public method to calculate the possible completions. | |
| 115 </p><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 list of proposals (QStringList) | |
| 119 </dd> | |
| 120 </dl> | |
| 121 <div align="right"><a href="#top">Up</a></div> | |
| 122 <hr /> | |
| 123 </body></html> |
