diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html Fri Sep 29 10:32:30 2017 +0200
@@ -0,0 +1,266 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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>
+</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>
+JsonServer
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</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>
+</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.__processCompletionsResult">__processCompletionsResult</a></td>
+<td>Private method to process the completions sent by the client.</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.__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.deactivate">deactivate</a></td>
+<td>Public method to deactivate the code assist server.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.getCallTips">getCallTips</a></td>
+<td>Public method to calculate calltips.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.getCompletions">getCompletions</a></td>
+<td>Public method to calculate the possible completions.</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>
+<td><a href="#CodeAssistServer.handleNewConnection">handleNewConnection</a></td>
+<td>Public slot for new incoming connections from a client.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.isSupportedLanguage">isSupportedLanguage</a></td>
+<td>Public method to check, if the given language is supported.</td>
+</tr><tr>
+<td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td>
+<td>Public slot to report some changed sources.</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>
+<dd>
+reference to the plugin object
+</dd><dt><i>parent</i> (QObject)</dt>
+<dd>
+parent
+</dd>
+</dl><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>
+<dd>
+dictionary containing the result sent by the client
+</dd>
+</dl><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>
+<dd>
+dictionary containing the result sent by the client
+</dd>
+</dl><a NAME="CodeAssistServer.__startCodeAssistClient" ID="CodeAssistServer.__startCodeAssistClient"></a>
+<h4>CodeAssistServer.__startCodeAssistClient</h4>
+<b>__startCodeAssistClient</b>(<i>interpreter, idString</i>)
+<p>
+ Private method to start the code assist client with the given
+ interpreter.
+</p><dl>
+<dt><i>interpreter</i> (str)</dt>
+<dd>
+interpreter to be used for the code assist client
+</dd><dt><i>idString</i> (str)</dt>
+<dd>
+id of the client to be started
+</dd>
+</dl><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><p>
+ Note: This method provides for some growth potential.
+ Currently it is empty.
+</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.getCallTips" ID="CodeAssistServer.getCallTips"></a>
+<h4>CodeAssistServer.getCallTips</h4>
+<b>getCallTips</b>(<i>pos, editor</i>)
+<p>
+ Public method to calculate calltips.
+</p><dl>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position in the text for the calltip
+</dd><dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor object, that called this method
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of possible calltips
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl><a NAME="CodeAssistServer.getCompletions" ID="CodeAssistServer.getCompletions"></a>
+<h4>CodeAssistServer.getCompletions</h4>
+<b>getCompletions</b>(<i>editor</i>)
+<p>
+ Public method to calculate the possible completions.
+</p><dl>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
+<dd>
+reference to the editor object, that called this method
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of proposals
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl><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>
+<dd>
+requested method name
+</dd><dt><i>params</i> (dict)</dt>
+<dd>
+dictionary with method specific parameters
+</dd>
+</dl><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>
+<dd>
+editor programming language to check
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the support status
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><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>
+<dd>
+file name of the changed source
+</dd><dt><i>oldSource</i> (str)</dt>
+<dd>
+source code before the change
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
