Mercurial Repositories > Rope Refactoring / file diff

diff: 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
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html	Mon Nov 12 19:03:47 2018 +0100
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html	Mon Nov 12 19:05:14 2018 +0100
@@ -48,7 +48,7 @@
 JsonServer
 <h3>Class Attributes</h3>
 <table>
-<tr><td>IdProject</td></tr>
+<tr><td>IdProject</td></tr><tr><td>PictureIDs</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -69,6 +69,9 @@
 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td>
 <td>Private method to get the configurations of all connected clients.</td>
 </tr><tr>
+<td><a href="#CodeAssistServer.__gotoDefinitionResult">__gotoDefinitionResult</a></td>
+<td>Private method to handle the "Goto Definition" result sent by the client.</td>
+</tr><tr>
 <td><a href="#CodeAssistServer.__idString">__idString</a></td>
 <td>Private method to determine the ID string for the back-end.</td>
 </tr><tr>
@@ -93,39 +96,21 @@
 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
 <td>Private method to get the name of the rope configuration file.</td>
 </tr><tr>
-<td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
-<td>Private method to set the auto-completion hook.</td>
-</tr><tr>
-<td><a href="#CodeAssistServer.__setCalltipsHook">__setCalltipsHook</a></td>
-<td>Private method to set the calltip hook.</td>
-</tr><tr>
 <td><a href="#CodeAssistServer.__setConfig">__setConfig</a></td>
 <td>Private method to set the rope client configuration data.</td>
 </tr><tr>
 <td><a href="#CodeAssistServer.__startCodeAssistClient">__startCodeAssistClient</a></td>
 <td>Private method to start the code assist client with the given interpreter.</td>
 </tr><tr>
-<td><a href="#CodeAssistServer.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
-<td>Private method to unset the auto-completion hook.</td>
-</tr><tr>
-<td><a href="#CodeAssistServer.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
-<td>Private method to unset the calltip hook.</td>
-</tr><tr>
 <td><a href="#CodeAssistServer.__updateEditorLanguageMapping">__updateEditorLanguageMapping</a></td>
 <td>Private method to update the editor language to connection mapping.</td>
 </tr><tr>
 <td><a href="#CodeAssistServer.activate">activate</a></td>
 <td>Public method to activate the code assist server.</td>
 </tr><tr>
-<td><a href="#CodeAssistServer.connectEditor">connectEditor</a></td>
-<td>Public method to connect an editor.</td>
-</tr><tr>
 <td><a href="#CodeAssistServer.deactivate">deactivate</a></td>
 <td>Public method to deactivate the code assist server.</td>
 </tr><tr>
-<td><a href="#CodeAssistServer.disconnectEditor">disconnectEditor</a></td>
-<td>Public method to disconnect an editor.</td>
-</tr><tr>
 <td><a href="#CodeAssistServer.editConfig">editConfig</a></td>
 <td>Public slot to open the rope configuration file in an editor.</td>
 </tr><tr>
@@ -135,6 +120,9 @@
 <td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td>
 <td>Public method to calculate the possible completions.</td>
 </tr><tr>
+<td><a href="#CodeAssistServer.gotoDefinition">gotoDefinition</a></td>
+<td>Public slot to find the definition for the word at the cursor position and go to it.</td>
+</tr><tr>
 <td><a href="#CodeAssistServer.handleCall">handleCall</a></td>
 <td>Public method to handle a method call from the client.</td>
 </tr><tr>
@@ -152,6 +140,9 @@
 </tr><tr>
 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
 <td>Public method to request a list of possible completions.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.setAsyncCompletions">setAsyncCompletions</a></td>
+<td>Public method to set the asynchronous completions flag.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -208,7 +199,18 @@
 <b>__getConfigs</b>(<i></i>)
 <p>
         Private method to get the configurations of all connected clients.
-</p><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
+</p><a NAME="CodeAssistServer.__gotoDefinitionResult" ID="CodeAssistServer.__gotoDefinitionResult"></a>
+<h4>CodeAssistServer.__gotoDefinitionResult</h4>
+<b>__gotoDefinitionResult</b>(<i>result</i>)
+<p>
+        Private method to handle the "Goto Definition" result sent by
+        the client.
+</p><dl>
+<dt><i>result</i> (dict)</dt>
+<dd>
+dictionary containing the result data
+</dd>
+</dl><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
 <h4>CodeAssistServer.__idString</h4>
 <b>__idString</b>(<i>editor</i>)
 <p>
@@ -310,26 +312,6 @@
 <dd>
 str
 </dd>
-</dl><a NAME="CodeAssistServer.__setAutoCompletionHook" ID="CodeAssistServer.__setAutoCompletionHook"></a>
-<h4>CodeAssistServer.__setAutoCompletionHook</h4>
-<b>__setAutoCompletionHook</b>(<i>editor</i>)
-<p>
-        Private method to set the auto-completion hook.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
-</dl><a NAME="CodeAssistServer.__setCalltipsHook" ID="CodeAssistServer.__setCalltipsHook"></a>
-<h4>CodeAssistServer.__setCalltipsHook</h4>
-<b>__setCalltipsHook</b>(<i>editor</i>)
-<p>
-        Private method to set the calltip hook.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a>
 <h4>CodeAssistServer.__setConfig</h4>
 <b>__setConfig</b>(<i>params</i>)
@@ -368,26 +350,6 @@
 <dd>
 bool
 </dd>
-</dl><a NAME="CodeAssistServer.__unsetAutoCompletionHook" ID="CodeAssistServer.__unsetAutoCompletionHook"></a>
-<h4>CodeAssistServer.__unsetAutoCompletionHook</h4>
-<b>__unsetAutoCompletionHook</b>(<i>editor</i>)
-<p>
-        Private method to unset the auto-completion hook.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
-</dl><a NAME="CodeAssistServer.__unsetCalltipsHook" ID="CodeAssistServer.__unsetCalltipsHook"></a>
-<h4>CodeAssistServer.__unsetCalltipsHook</h4>
-<b>__unsetCalltipsHook</b>(<i>editor</i>)
-<p>
-        Private method to unset the calltip hook.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
 <b>__updateEditorLanguageMapping</b>(<i></i>)
@@ -398,32 +360,12 @@
 <b>activate</b>(<i></i>)
 <p>
         Public method to activate the code assist server.
-</p><a NAME="CodeAssistServer.connectEditor" ID="CodeAssistServer.connectEditor"></a>
-<h4>CodeAssistServer.connectEditor</h4>
-<b>connectEditor</b>(<i>editor</i>)
-<p>
-        Public method to connect an editor.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
-</dl><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
+</p><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
 <h4>CodeAssistServer.deactivate</h4>
 <b>deactivate</b>(<i></i>)
 <p>
         Public method to deactivate the code assist server.
-</p><a NAME="CodeAssistServer.disconnectEditor" ID="CodeAssistServer.disconnectEditor"></a>
-<h4>CodeAssistServer.disconnectEditor</h4>
-<b>disconnectEditor</b>(<i>editor</i>)
-<p>
-        Public method to disconnect an editor.
-</p><dl>
-<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
-<dd>
-reference to the editor
-</dd>
-</dl><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
+</p><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
 <h4>CodeAssistServer.editConfig</h4>
 <b>editConfig</b>(<i>idString</i>)
 <p>
@@ -484,6 +426,19 @@
 <dd>
 list of str
 </dd>
+</dl><a NAME="CodeAssistServer.gotoDefinition" ID="CodeAssistServer.gotoDefinition"></a>
+<h4>CodeAssistServer.gotoDefinition</h4>
+<b>gotoDefinition</b>(<i>editor</i>)
+<p>
+        Public slot to find the definition for the word at the cursor position
+        and go to it.
+</p><p>
+        Note: This is executed upon a mouse click sequence.
+</p><dl>
+<dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
+<dd>
+reference to the calling editor
+</dd>
 </dl><a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a>
 <h4>CodeAssistServer.handleCall</h4>
 <b>handleCall</b>(<i>method, params</i>)
@@ -566,6 +521,16 @@
 <dd>
 text to be completed
 </dd>
+</dl><a NAME="CodeAssistServer.setAsyncCompletions" ID="CodeAssistServer.setAsyncCompletions"></a>
+<h4>CodeAssistServer.setAsyncCompletions</h4>
+<b>setAsyncCompletions</b>(<i>asynchronous</i>)
+<p>
+        Public method to set the asynchronous completions flag.
+</p><dl>
+<dt><i>asynchronous</i> (bool)</dt>
+<dd>
+flag indicating asynchronous completions
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

Mercurial Repository: Rope Refactoring

eric ide

mercurial