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

changeset 295
8318a6881e63
parent 285
247d62c682dc
child 321
d51e810107ec
equal deleted inserted replaced
294:78e4a6823a98 295:8318a6881e63
46 </p> 46 </p>
47 <h3>Derived from</h3> 47 <h3>Derived from</h3>
48 JsonServer 48 JsonServer
49 <h3>Class Attributes</h3> 49 <h3>Class Attributes</h3>
50 <table> 50 <table>
51 <tr><td>IdProject</td></tr> 51 <tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr>
52 </table> 52 </table>
53 <h3>Class Methods</h3> 53 <h3>Class Methods</h3>
54 <table> 54 <table>
55 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
56 </table> 56 </table>
67 <td>Private method to ensure, that the requested client is active.</td> 67 <td>Private method to ensure, that the requested client is active.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td> 69 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td>
70 <td>Private method to get the configurations of all connected clients.</td> 70 <td>Private method to get the configurations of all connected clients.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#CodeAssistServer.__gotoDefinitionResult">__gotoDefinitionResult</a></td>
73 <td>Private method to handle the "Goto Definition" result sent by the client.</td>
74 </tr><tr>
72 <td><a href="#CodeAssistServer.__idString">__idString</a></td> 75 <td><a href="#CodeAssistServer.__idString">__idString</a></td>
73 <td>Private method to determine the ID string for the back-end.</td> 76 <td>Private method to determine the ID string for the back-end.</td>
74 </tr><tr> 77 </tr><tr>
75 <td><a href="#CodeAssistServer.__interpreterForProject">__interpreterForProject</a></td> 78 <td><a href="#CodeAssistServer.__interpreterForProject">__interpreterForProject</a></td>
76 <td>Private method to determine the interpreter for the current project and the environment to run it.</td> 79 <td>Private method to determine the interpreter for the current project and the environment to run it.</td>
91 <td>Private slot to handle the projectClosed signal.</td> 94 <td>Private slot to handle the projectClosed signal.</td>
92 </tr><tr> 95 </tr><tr>
93 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td> 96 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
94 <td>Private method to get the name of the rope configuration file.</td> 97 <td>Private method to get the name of the rope configuration file.</td>
95 </tr><tr> 98 </tr><tr>
96 <td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
97 <td>Private method to set the auto-completion hook.</td>
98 </tr><tr>
99 <td><a href="#CodeAssistServer.__setCalltipsHook">__setCalltipsHook</a></td>
100 <td>Private method to set the calltip hook.</td>
101 </tr><tr>
102 <td><a href="#CodeAssistServer.__setConfig">__setConfig</a></td> 99 <td><a href="#CodeAssistServer.__setConfig">__setConfig</a></td>
103 <td>Private method to set the rope client configuration data.</td> 100 <td>Private method to set the rope client configuration data.</td>
104 </tr><tr> 101 </tr><tr>
105 <td><a href="#CodeAssistServer.__startCodeAssistClient">__startCodeAssistClient</a></td> 102 <td><a href="#CodeAssistServer.__startCodeAssistClient">__startCodeAssistClient</a></td>
106 <td>Private method to start the code assist client with the given interpreter.</td> 103 <td>Private method to start the code assist client with the given interpreter.</td>
107 </tr><tr> 104 </tr><tr>
108 <td><a href="#CodeAssistServer.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
109 <td>Private method to unset the auto-completion hook.</td>
110 </tr><tr>
111 <td><a href="#CodeAssistServer.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
112 <td>Private method to unset the calltip hook.</td>
113 </tr><tr>
114 <td><a href="#CodeAssistServer.__updateEditorLanguageMapping">__updateEditorLanguageMapping</a></td> 105 <td><a href="#CodeAssistServer.__updateEditorLanguageMapping">__updateEditorLanguageMapping</a></td>
115 <td>Private method to update the editor language to connection mapping.</td> 106 <td>Private method to update the editor language to connection mapping.</td>
116 </tr><tr> 107 </tr><tr>
117 <td><a href="#CodeAssistServer.activate">activate</a></td> 108 <td><a href="#CodeAssistServer.activate">activate</a></td>
118 <td>Public method to activate the code assist server.</td> 109 <td>Public method to activate the code assist server.</td>
119 </tr><tr> 110 </tr><tr>
120 <td><a href="#CodeAssistServer.connectEditor">connectEditor</a></td>
121 <td>Public method to connect an editor.</td>
122 </tr><tr>
123 <td><a href="#CodeAssistServer.deactivate">deactivate</a></td> 111 <td><a href="#CodeAssistServer.deactivate">deactivate</a></td>
124 <td>Public method to deactivate the code assist server.</td> 112 <td>Public method to deactivate the code assist server.</td>
125 </tr><tr> 113 </tr><tr>
126 <td><a href="#CodeAssistServer.disconnectEditor">disconnectEditor</a></td>
127 <td>Public method to disconnect an editor.</td>
128 </tr><tr>
129 <td><a href="#CodeAssistServer.editConfig">editConfig</a></td> 114 <td><a href="#CodeAssistServer.editConfig">editConfig</a></td>
130 <td>Public slot to open the rope configuration file in an editor.</td> 115 <td>Public slot to open the rope configuration file in an editor.</td>
131 </tr><tr> 116 </tr><tr>
132 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td> 117 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td>
133 <td>Public method to calculate calltips.</td> 118 <td>Public method to calculate calltips.</td>
134 </tr><tr> 119 </tr><tr>
135 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td> 120 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td>
136 <td>Public method to calculate the possible completions.</td> 121 <td>Public method to calculate the possible completions.</td>
137 </tr><tr> 122 </tr><tr>
123 <td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td>
124 <td>Public slot to find the definition for the word at the cursor position and go to it.</td>
125 </tr><tr>
138 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td> 126 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td>
139 <td>Public method to handle a method call from the client.</td> 127 <td>Public method to handle a method call from the client.</td>
140 </tr><tr> 128 </tr><tr>
141 <td><a href="#CodeAssistServer.handleNewConnection">handleNewConnection</a></td> 129 <td><a href="#CodeAssistServer.handleNewConnection">handleNewConnection</a></td>
142 <td>Public slot for new incoming connections from a client.</td> 130 <td>Public slot for new incoming connections from a client.</td>
150 <td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td> 138 <td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td>
151 <td>Public method to request source code documentation for the given editor.</td> 139 <td>Public method to request source code documentation for the given editor.</td>
152 </tr><tr> 140 </tr><tr>
153 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> 141 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
154 <td>Public method to request a list of possible completions.</td> 142 <td>Public method to request a list of possible completions.</td>
143 </tr><tr>
144 <td><a href="#CodeAssistServer.setAsyncCompletions">setAsyncCompletions</a></td>
145 <td>Public method to set the asynchronous completions flag.</td>
155 </tr> 146 </tr>
156 </table> 147 </table>
157 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
158 <table> 149 <table>
159 <tr><td>None</td></tr> 150 <tr><td>None</td></tr>
206 </dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a> 197 </dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a>
207 <h4>CodeAssistServer.__getConfigs</h4> 198 <h4>CodeAssistServer.__getConfigs</h4>
208 <b>__getConfigs</b>(<i></i>) 199 <b>__getConfigs</b>(<i></i>)
209 <p> 200 <p>
210 Private method to get the configurations of all connected clients. 201 Private method to get the configurations of all connected clients.
211 </p><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a> 202 </p><a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a>
203 <h4>CodeAssistServer.__gotoDefinitionResult</h4>
204 <b>__gotoDefinitionResult</b>(<i>result</i>)
205 <p>
206 Private method to handle the "Goto Definition" result sent by
207 the client.
208 </p><dl>
209 <dt><i>result</i> (dict)</dt>
210 <dd>
211 dictionary containing the result data
212 </dd>
213 </dl><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
212 <h4>CodeAssistServer.__idString</h4> 214 <h4>CodeAssistServer.__idString</h4>
213 <b>__idString</b>(<i>editor</i>) 215 <b>__idString</b>(<i>editor</i>)
214 <p> 216 <p>
215 Private method to determine the ID string for the back-end. 217 Private method to determine the ID string for the back-end.
216 </p><dl> 218 </p><dl>
308 </dl><dl> 310 </dl><dl>
309 <dt>Return Type:</dt> 311 <dt>Return Type:</dt>
310 <dd> 312 <dd>
311 str 313 str
312 </dd> 314 </dd>
313 </dl><a NAME="CodeAssistServer.__setAutoCompletionHook" ID="CodeAssistServer.__setAutoCompletionHook"></a>
314 <h4>CodeAssistServer.__setAutoCompletionHook</h4>
315 <b>__setAutoCompletionHook</b>(<i>editor</i>)
316 <p>
317 Private method to set the auto-completion hook.
318 </p><dl>
319 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
320 <dd>
321 reference to the editor
322 </dd>
323 </dl><a NAME="CodeAssistServer.__setCalltipsHook" ID="CodeAssistServer.__setCalltipsHook"></a>
324 <h4>CodeAssistServer.__setCalltipsHook</h4>
325 <b>__setCalltipsHook</b>(<i>editor</i>)
326 <p>
327 Private method to set the calltip hook.
328 </p><dl>
329 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
330 <dd>
331 reference to the editor
332 </dd>
333 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a> 315 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a>
334 <h4>CodeAssistServer.__setConfig</h4> 316 <h4>CodeAssistServer.__setConfig</h4>
335 <b>__setConfig</b>(<i>params</i>) 317 <b>__setConfig</b>(<i>params</i>)
336 <p> 318 <p>
337 Private method to set the rope client configuration data. 319 Private method to set the rope client configuration data.
365 </dd> 347 </dd>
366 </dl><dl> 348 </dl><dl>
367 <dt>Return Type:</dt> 349 <dt>Return Type:</dt>
368 <dd> 350 <dd>
369 bool 351 bool
370 </dd>
371 </dl><a NAME="CodeAssistServer.__unsetAutoCompletionHook" ID="CodeAssistServer.__unsetAutoCompletionHook"></a>
372 <h4>CodeAssistServer.__unsetAutoCompletionHook</h4>
373 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
374 <p>
375 Private method to unset the auto-completion hook.
376 </p><dl>
377 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
378 <dd>
379 reference to the editor
380 </dd>
381 </dl><a NAME="CodeAssistServer.__unsetCalltipsHook" ID="CodeAssistServer.__unsetCalltipsHook"></a>
382 <h4>CodeAssistServer.__unsetCalltipsHook</h4>
383 <b>__unsetCalltipsHook</b>(<i>editor</i>)
384 <p>
385 Private method to unset the calltip hook.
386 </p><dl>
387 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
388 <dd>
389 reference to the editor
390 </dd> 352 </dd>
391 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a> 353 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
392 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4> 354 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
393 <b>__updateEditorLanguageMapping</b>(<i></i>) 355 <b>__updateEditorLanguageMapping</b>(<i></i>)
394 <p> 356 <p>
396 </p><a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a> 358 </p><a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a>
397 <h4>CodeAssistServer.activate</h4> 359 <h4>CodeAssistServer.activate</h4>
398 <b>activate</b>(<i></i>) 360 <b>activate</b>(<i></i>)
399 <p> 361 <p>
400 Public method to activate the code assist server. 362 Public method to activate the code assist server.
401 </p><a NAME="CodeAssistServer.connectEditor" ID="CodeAssistServer.connectEditor"></a> 363 </p><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
402 <h4>CodeAssistServer.connectEditor</h4>
403 <b>connectEditor</b>(<i>editor</i>)
404 <p>
405 Public method to connect an editor.
406 </p><dl>
407 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
408 <dd>
409 reference to the editor
410 </dd>
411 </dl><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
412 <h4>CodeAssistServer.deactivate</h4> 364 <h4>CodeAssistServer.deactivate</h4>
413 <b>deactivate</b>(<i></i>) 365 <b>deactivate</b>(<i></i>)
414 <p> 366 <p>
415 Public method to deactivate the code assist server. 367 Public method to deactivate the code assist server.
416 </p><a NAME="CodeAssistServer.disconnectEditor" ID="CodeAssistServer.disconnectEditor"></a> 368 </p><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
417 <h4>CodeAssistServer.disconnectEditor</h4>
418 <b>disconnectEditor</b>(<i>editor</i>)
419 <p>
420 Public method to disconnect an editor.
421 </p><dl>
422 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
423 <dd>
424 reference to the editor
425 </dd>
426 </dl><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
427 <h4>CodeAssistServer.editConfig</h4> 369 <h4>CodeAssistServer.editConfig</h4>
428 <b>editConfig</b>(<i>idString</i>) 370 <b>editConfig</b>(<i>idString</i>)
429 <p> 371 <p>
430 Public slot to open the rope configuration file in an editor. 372 Public slot to open the rope configuration file in an editor.
431 </p><dl> 373 </p><dl>
481 </dd> 423 </dd>
482 </dl><dl> 424 </dl><dl>
483 <dt>Return Type:</dt> 425 <dt>Return Type:</dt>
484 <dd> 426 <dd>
485 list of str 427 list of str
428 </dd>
429 </dl><a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a>
430 <h4>CodeAssistServer.gotoDefinition</h4>
431 <b>gotoDefinition</b>(<i>editor</i>)
432 <p>
433 Public slot to find the definition for the word at the cursor position
434 and go to it.
435 </p><p>
436 Note: This is executed upon a mouse click sequence.
437 </p><dl>
438 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
439 <dd>
440 reference to the calling editor
486 </dd> 441 </dd>
487 </dl><a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a> 442 </dl><a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a>
488 <h4>CodeAssistServer.handleCall</h4> 443 <h4>CodeAssistServer.handleCall</h4>
489 <b>handleCall</b>(<i>method, params</i>) 444 <b>handleCall</b>(<i>method, params</i>)
490 <p> 445 <p>
564 flag indicating to autocomplete a context 519 flag indicating to autocomplete a context
565 </dd><dt><i>acText</i> (str)</dt> 520 </dd><dt><i>acText</i> (str)</dt>
566 <dd> 521 <dd>
567 text to be completed 522 text to be completed
568 </dd> 523 </dd>
524 </dl><a NAME="CodeAssistServer.setAsyncCompletions" ID="CodeAssistServer.setAsyncCompletions"></a>
525 <h4>CodeAssistServer.setAsyncCompletions</h4>
526 <b>setAsyncCompletions</b>(<i>asynchronous</i>)
527 <p>
528 Public method to set the asynchronous completions flag.
529 </p><dl>
530 <dt><i>asynchronous</i> (bool)</dt>
531 <dd>
532 flag indicating asynchronous completions
533 </dd>
569 </dl> 534 </dl>
570 <div align="right"><a href="#top">Up</a></div> 535 <div align="right"><a href="#top">Up</a></div>
571 <hr /> 536 <hr />
572 </body></html> 537 </body></html>

Mercurial Repository: Rope Refactoring

eric ide

mercurial