--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html Wed Jan 03 16:44:06 2024 +0100
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html Sun Oct 13 15:49:43 2024 +0200
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</h1>
-
<p>
Module implementing the autocompletion interface to rope.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>None</td></tr>
+<tr><td>PictureIDs</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodeAssistServer">CodeAssistServer</a></td>
<td>Class implementing the autocompletion interface to rope.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="CodeAssistServer" ID="CodeAssistServer"></a>
<h2>CodeAssistServer</h2>
-
<p>
Class implementing the autocompletion interface to rope.
</p>
+
<h3>Derived from</h3>
EricJsonServer
<h3>Class Attributes</h3>
-
<table>
<tr><td>IdProject</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CodeAssistServer.__init__">CodeAssistServer</a></td>
<td>Constructor</td>
@@ -171,19 +168,20 @@
<td>Public method to request a list of possible completions.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodeAssistServer.__init__" ID="CodeAssistServer.__init__"></a>
<h4>CodeAssistServer (Constructor)</h4>
<b>CodeAssistServer</b>(<i>plugin, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>plugin</i> (RefactoringRopePlugin)</dt>
@@ -198,10 +196,10 @@
<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>
@@ -212,13 +210,13 @@
<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><i>idString</i> (str)</dt>
@@ -241,18 +239,18 @@
<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.__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>
@@ -263,10 +261,10 @@
<a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
<h4>CodeAssistServer.__idString</h4>
<b>__idString</b>(<i>editor</i>)
-
<p>
Private method to determine the ID string for the back-end.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -289,11 +287,11 @@
<a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a>
<h4>CodeAssistServer.__interpreterForProject</h4>
<b>__interpreterForProject</b>(<i></i>)
-
<p>
Private method to determine the interpreter for the current project and
the environment to run it.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -310,10 +308,10 @@
<a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
<h4>CodeAssistServer.__processCallTipsResult</h4>
<b>__processCallTipsResult</b>(<i>result</i>)
-
<p>
Private method to process the calltips sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -324,10 +322,10 @@
<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>
@@ -338,10 +336,10 @@
<a NAME="CodeAssistServer.__processCompletionsResult" ID="CodeAssistServer.__processCompletionsResult"></a>
<h4>CodeAssistServer.__processCompletionsResult</h4>
<b>__processCompletionsResult</b>(<i>result</i>)
-
<p>
Private method to process the completions sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -352,10 +350,10 @@
<a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a>
<h4>CodeAssistServer.__processDocumentationResult</h4>
<b>__processDocumentationResult</b>(<i>result</i>)
-
<p>
Private method to process the documentation sent by the client.
</p>
+
<dl>
<dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt>
@@ -366,10 +364,10 @@
<a NAME="CodeAssistServer.__processGotoReferencesResult" ID="CodeAssistServer.__processGotoReferencesResult"></a>
<h4>CodeAssistServer.__processGotoReferencesResult</h4>
<b>__processGotoReferencesResult</b>(<i>result</i>)
-
<p>
Private method callback for the goto references result.
</p>
+
<dl>
<dt><i>result</i> (dict)</dt>
@@ -380,17 +378,17 @@
<a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a>
<h4>CodeAssistServer.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to handle the projectClosed signal.
</p>
+
<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>
@@ -413,10 +411,10 @@
<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>
@@ -427,11 +425,11 @@
<a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a>
<h4>CodeAssistServer.__startCodeAssistClient</h4>
<b>__startCodeAssistClient</b>(<i>interpreter, idString, clientEnv</i>)
-
<p>
Private method to start the code assist client with the given
interpreter.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -463,24 +461,24 @@
<a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
<h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
<b>__updateEditorLanguageMapping</b>(<i></i>)
-
<p>
Private method to update the editor language to connection mapping.
</p>
+
<a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a>
<h4>CodeAssistServer.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate the code assist server.
</p>
+
<a NAME="CodeAssistServer.createConfig" ID="CodeAssistServer.createConfig"></a>
<h4>CodeAssistServer.createConfig</h4>
<b>createConfig</b>(<i>idString</i>)
-
<p>
Public slot to create a new default rope configuration file.
</p>
+
<dl>
<dt><i>idString</i> (str)</dt>
@@ -491,17 +489,17 @@
<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.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>
@@ -512,10 +510,10 @@
<a NAME="CodeAssistServer.getCallTips" ID="CodeAssistServer.getCallTips"></a>
<h4>CodeAssistServer.getCallTips</h4>
<b>getCallTips</b>(<i>editor, pos, commas</i>)
-
<p>
Public method to calculate calltips.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -546,7 +544,6 @@
<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.
@@ -554,6 +551,7 @@
<p>
Note: This is executed upon a mouse click sequence.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -564,10 +562,10 @@
<a NAME="CodeAssistServer.handleCall" ID="CodeAssistServer.handleCall"></a>
<h4>CodeAssistServer.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)
-
<p>
Public method to handle a method call from the client.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -582,17 +580,17 @@
<a NAME="CodeAssistServer.handleNewConnection" ID="CodeAssistServer.handleNewConnection"></a>
<h4>CodeAssistServer.handleNewConnection</h4>
<b>handleNewConnection</b>(<i></i>)
-
<p>
Public slot for new incoming connections from a client.
</p>
+
<a NAME="CodeAssistServer.isSupportedLanguage" ID="CodeAssistServer.isSupportedLanguage"></a>
<h4>CodeAssistServer.isSupportedLanguage</h4>
<b>isSupportedLanguage</b>(<i>language</i>)
-
<p>
Public method to check, if the given language is supported.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -615,10 +613,10 @@
<a NAME="CodeAssistServer.reportChanged" ID="CodeAssistServer.reportChanged"></a>
<h4>CodeAssistServer.reportChanged</h4>
<b>reportChanged</b>(<i>filename, oldSource</i>)
-
<p>
Public slot to report some changed sources.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -633,11 +631,11 @@
<a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a>
<h4>CodeAssistServer.requestCodeDocumentation</h4>
<b>requestCodeDocumentation</b>(<i>editor</i>)
-
<p>
Public method to request source code documentation for the given
editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -649,10 +647,10 @@
<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>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -670,4 +668,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
