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

branch
server_client_variant
changeset 214
ccc3918ac38c
parent 204
b4bf79b956bc
child 217
874115c79ca7
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html	Sun Oct 08 17:56:43 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html	Sun Oct 08 17:57:18 2017 +0200
@@ -60,24 +60,63 @@
 <td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td>
 <td>Constructor</td>
 </tr><tr>
+<td><a href="#CodeAssistServer.__configChanged">__configChanged</a></td>
+<td>Private slot called, when the rope config file has changed.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.__ensureActive">__ensureActive</a></td>
+<td>Private method to ensure, that the requested client is active.</td>
+</tr><tr>
+<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.__processCallTipsResult">__processCallTipsResult</a></td>
 <td>Private method to process the calltips sent by the client.</td>
 </tr><tr>
+<td><a href="#CodeAssistServer.__processClientException">__processClientException</a></td>
+<td>Private method to handle exceptions of the refactoring client.</td>
+</tr><tr>
 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td>
 <td>Private method to process the completions sent by the client.</td>
 </tr><tr>
+<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>
 <td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td>
 <td>Public method to calculate calltips.</td>
 </tr><tr>
@@ -95,6 +134,9 @@
 </tr><tr>
 <td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td>
 <td>Public slot to report some changed sources.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
+<td>Public method to request a list of possible completions.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -114,7 +156,39 @@
 <dd>
 parent
 </dd>
-</dl><a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
+</dl><a NAME="CodeAssistServer.__configChanged" ID="CodeAssistServer.__configChanged"></a>
+<h4>CodeAssistServer.__configChanged</h4>
+<b>__configChanged</b>(<i>idString</i>)
+<p>
+        Private slot called, when the rope config file has changed.
+</p><dl>
+<dt><i>idString</i> (str)</dt>
+<dd>
+id for which to get the configuration file
+</dd>
+</dl><a NAME="CodeAssistServer.__ensureActive" ID="CodeAssistServer.__ensureActive"></a>
+<h4>CodeAssistServer.__ensureActive</h4>
+<b>__ensureActive</b>(<i>idString</i>)
+<p>
+        Private method to ensure, that the requested client is active.
+</p><p>
+        A non-active client will be started.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating an active client
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a>
+<h4>CodeAssistServer.__getConfigs</h4>
+<b>__getConfigs</b>(<i></i>)
+<p>
+        Private method to get the configurations of all connected clients.
+</p><a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
 <h4>CodeAssistServer.__processCallTipsResult</h4>
 <b>__processCallTipsResult</b>(<i>result</i>)
 <p>
@@ -124,6 +198,16 @@
 <dd>
 dictionary containing the result sent by the client
 </dd>
+</dl><a NAME="CodeAssistServer.__processClientException" ID="CodeAssistServer.__processClientException"></a>
+<h4>CodeAssistServer.__processClientException</h4>
+<b>__processClientException</b>(<i>params</i>)
+<p>
+        Private method to handle exceptions of the refactoring client.
+</p><dl>
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the exception data
+</dd>
 </dl><a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a>
 <h4>CodeAssistServer.__processCompletionsResult</h4>
 <b>__processCompletionsResult</b>(<i>result</i>)
@@ -134,6 +218,56 @@
 <dd>
 dictionary containing the result sent by the client
 </dd>
+</dl><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
+<h4>CodeAssistServer.__ropeConfigFile</h4>
+<b>__ropeConfigFile</b>(<i>idString</i>)
+<p>
+        Private method to get the name of the rope configuration file.
+</p><dl>
+<dt><i>idString</i> (str)</dt>
+<dd>
+id for which to get the configuration file
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+name of the rope configuration file
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<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)</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)</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>)
+<p>
+        Private method to set the rope client configuration data.
+</p><dl>
+<dt><i>params</i> (dict)</dt>
+<dd>
+dictionary containing the configuration data
+</dd>
 </dl><a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a>
 <h4>CodeAssistServer.__startCodeAssistClient</h4>
 <b>__startCodeAssistClient</b>(<i>interpreter, idString</i>)
@@ -148,6 +282,36 @@
 <dd>
 id of the client to be started
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a successful start of the client
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<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)</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)</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>)
@@ -161,23 +325,56 @@
 </p><p>
         Note: This method provides for some growth potential.
             Currently it is empty.
-</p><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
+</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)</dt>
+<dd>
+reference to the editor
+</dd>
+</dl><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.getCallTips" ID="CodeAssistServer.getCallTips"></a>
+</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)</dt>
+<dd>
+reference to the editor
+</dd>
+</dl><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
+<h4>CodeAssistServer.editConfig</h4>
+<b>editConfig</b>(<i>idString</i>)
+<p>
+        Public slot to open the rope configuration file in an editor.
+</p><dl>
+<dt><i>idString</i> (str)</dt>
+<dd>
+id for which to get the configuration file
+</dd>
+</dl><a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a>
 <h4>CodeAssistServer.getCallTips</h4>
-<b>getCallTips</b>(<i>pos, editor</i>)
+<b>getCallTips</b>(<i>editor, pos, commas</i>)
 <p>
         Public method to calculate calltips.
 </p><dl>
-<dt><i>pos</i> (int)</dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor object, that called this method
+</dd><dt><i>pos</i> (int)</dt>
 <dd>
 position in the text for the calltip
-</dd><dt><i>editor</i> (QScintilla.Editor)</dt>
+</dd><dt><i>commas</i> (int)</dt>
 <dd>
-reference to the editor object, that called this method
+minimum number of commas contained in the calltip
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -191,18 +388,23 @@
 </dd>
 </dl><a NAME="CodeAssistServer.getCompletions" ID="CodeAssistServer.getCompletions"></a>
 <h4>CodeAssistServer.getCompletions</h4>
-<b>getCompletions</b>(<i>editor</i>)
+<b>getCompletions</b>(<i>editor, context</i>)
 <p>
         Public method to calculate the possible completions.
+</p><p>
+        Note: This is the synchronous variant for eric6 before 17.11.
 </p><dl>
 <dt><i>editor</i> (QScintilla.Editor)</dt>
 <dd>
 reference to the editor object, that called this method
+</dd><dt><i>context</i> (bool)</dt>
+<dd>
+flag indicating to autocomplete a context
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of proposals
+list of possible completions
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
@@ -260,6 +462,25 @@
 <dd>
 source code before the change
 </dd>
+</dl><a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a>
+<h4>CodeAssistServer.requestCompletions</h4>
+<b>requestCompletions</b>(<i>editor, context, acText</i>)
+<p>
+        Public method to request a list of possible completions.
+</p><p>
+        Note: This is part of the asynchronous variant for eric6 17.11 and
+              later.
+</p><dl>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor object, that called this method
+</dd><dt><i>context</i> (bool)</dt>
+<dd>
+flag indicating to autocomplete a context
+</dd><dt><i>acText</i> (str)</dt>
+<dd>
+text to be completed
+</dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

Mercurial Repository: Rope Refactoring

eric ide

mercurial