Sun, 08 Oct 2017 17:57:18 +0200
Updated source docu.
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Sun Oct 08 17:56:43 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Sun Oct 08 17:57:18 2017 +0200 @@ -78,15 +78,9 @@ <td><a href="#RefactoringRopePlugin.__connectEditor">__connectEditor</a></td> <td>Private method to connect an editor.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.__connectMouseClickHandler">__connectMouseClickHandler</a></td> -<td>Private method to connect the mouse click handler to an editor.</td> -</tr><tr> <td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td> <td>Private method to disconnect an editor.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td> -<td>Private method to disconnect the mouse click handler from an editor.</td> -</tr><tr> <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td> <td>Private slot to get the old contents of the named file.</td> </tr><tr> @@ -108,32 +102,17 @@ <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td> <td>Private method to load the translation file.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.__setAutoCompletionHook">__setAutoCompletionHook</a></td> -<td>Private method to set the autocompletion hook.</td> -</tr><tr> -<td><a href="#RefactoringRopePlugin.__setCalltipsHook">__setCalltipsHook</a></td> -<td>Private method to set the calltip hook.</td> -</tr><tr> <td><a href="#RefactoringRopePlugin.__shutdown">__shutdown</a></td> <td>Private slot handling the shutdown signal of the plug-in manager.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td> -<td>Private method to unset the autocompletion hook.</td> -</tr><tr> -<td><a href="#RefactoringRopePlugin.__unsetCalltipsHook">__unsetCalltipsHook</a></td> -<td>Private method to unset the calltip hook.</td> -</tr><tr> <td><a href="#RefactoringRopePlugin.activate">activate</a></td> <td>Public method to activate this plugin.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.codeAssistCallTip">codeAssistCallTip</a></td> -<td>Public method to return a list of calltips.</td> -</tr><tr> <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> </tr><tr> -<td><a href="#RefactoringRopePlugin.getCompletionsList">getCompletionsList</a></td> -<td>Public method to get a list of possible completions.</td> +<td><a href="#RefactoringRopePlugin.getCodeAssistServer">getCodeAssistServer</a></td> +<td>Public method to get a reference to the code assist server.</td> </tr><tr> <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td> <td>Public method to retrieve the various refactoring settings.</td> @@ -166,16 +145,6 @@ <dd> reference to the editor </dd> -</dl><a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a> -<h4>RefactoringRopePlugin.__connectMouseClickHandler</h4> -<b>__connectMouseClickHandler</b>(<i>editor</i>) -<p> - Private method to connect the mouse click handler to an editor. -</p><dl> -<dt><i>editor</i> (QScintilla.Editor)</dt> -<dd> -reference to the editor -</dd> </dl><a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a> <h4>RefactoringRopePlugin.__disconnectEditor</h4> <b>__disconnectEditor</b>(<i>editor</i>) @@ -186,16 +155,6 @@ <dd> reference to the editor </dd> -</dl><a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a> -<h4>RefactoringRopePlugin.__disconnectMouseClickHandler</h4> -<b>__disconnectMouseClickHandler</b>(<i>editor</i>) -<p> - Private method to disconnect the mouse click handler from an editor. -</p><dl> -<dt><i>editor</i> (QScintilla.Editor)</dt> -<dd> -reference to the editor -</dd> </dl><a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a> <h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4> <b>__editorAboutToBeSaved</b>(<i>filename</i>) @@ -256,52 +215,12 @@ <b>__loadTranslator</b>(<i></i>) <p> Private method to load the translation file. -</p><a NAME="RefactoringRopePlugin.__setAutoCompletionHook" ID="RefactoringRopePlugin.__setAutoCompletionHook"></a> -<h4>RefactoringRopePlugin.__setAutoCompletionHook</h4> -<b>__setAutoCompletionHook</b>(<i>editor</i>) -<p> - Private method to set the autocompletion hook. -</p><dl> -<dt><i>editor</i> (QScintilla.Editor)</dt> -<dd> -reference to the editor -</dd> -</dl><a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a> -<h4>RefactoringRopePlugin.__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="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a> +</p><a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a> <h4>RefactoringRopePlugin.__shutdown</h4> <b>__shutdown</b>(<i></i>) <p> Private slot handling the shutdown signal of the plug-in manager. -</p><a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a> -<h4>RefactoringRopePlugin.__unsetAutoCompletionHook</h4> -<b>__unsetAutoCompletionHook</b>(<i>editor</i>) -<p> - Private method to unset the autocompletion hook. -</p><dl> -<dt><i>editor</i> (QScintilla.Editor)</dt> -<dd> -reference to the editor -</dd> -</dl><a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a> -<h4>RefactoringRopePlugin.__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="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> +</p><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> <h4>RefactoringRopePlugin.activate</h4> <b>activate</b>(<i></i>) <p> @@ -316,59 +235,25 @@ <dd> tuple of (None, bool) </dd> -</dl><a NAME="RefactoringRopePlugin.codeAssistCallTip" ID="RefactoringRopePlugin.codeAssistCallTip"></a> -<h4>RefactoringRopePlugin.codeAssistCallTip</h4> -<b>codeAssistCallTip</b>(<i>editor, pos, commas</i>) -<p> - Public method to return a list of calltips. -</p><dl> -<dt><i>editor</i> (QScintilla.Editor)</dt> -<dd> -reference to the editor -</dd><dt><i>pos</i> (int)</dt> -<dd> -position in the text for the calltip -</dd><dt><i>commas</i> (int)</dt> -<dd> -minimum number of commas contained in the calltip -</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="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a> <h4>RefactoringRopePlugin.deactivate</h4> <b>deactivate</b>(<i></i>) <p> Public method to deactivate this plugin. -</p><a NAME="RefactoringRopePlugin.getCompletionsList" ID="RefactoringRopePlugin.getCompletionsList"></a> -<h4>RefactoringRopePlugin.getCompletionsList</h4> -<b>getCompletionsList</b>(<i>editor, context</i>) +</p><a NAME="RefactoringRopePlugin.getCodeAssistServer" ID="RefactoringRopePlugin.getCodeAssistServer"></a> +<h4>RefactoringRopePlugin.getCodeAssistServer</h4> +<b>getCodeAssistServer</b>(<i></i>) <p> - Public method to get a list of possible completions. + Public method to get a reference to the code assist server. </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 possible completions +reference to the code assist server </dd> </dl><dl> <dt>Return Type:</dt> <dd> -list of str +CodeAssistServer </dd> </dl><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a> <h4>RefactoringRopePlugin.getPreferences</h4>
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Sun Oct 08 17:56:43 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html Sun Oct 08 17:57:18 2017 +0200 @@ -60,12 +60,21 @@ <td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td> <td>Constructor</td> </tr><tr> +<td><a href="#CodeAssistClient.__closeProject">__closeProject</a></td> +<td>Private slot to validate the project.</td> +</tr><tr> +<td><a href="#CodeAssistClient.__configChanged">__configChanged</a></td> +<td>Private method to handle a change of the configuration file.</td> +</tr><tr> <td><a href="#CodeAssistClient.__getCallTips">__getCallTips</a></td> <td>Private method to calculate possible calltips.</td> </tr><tr> <td><a href="#CodeAssistClient.__getCompletions">__getCompletions</a></td> <td>Private method to calculate possible completions.</td> </tr><tr> +<td><a href="#CodeAssistClient.__getConfig">__getConfig</a></td> +<td>Private method to send some configuration data to the server.</td> +</tr><tr> <td><a href="#CodeAssistClient.__handleRopeError">__handleRopeError</a></td> <td>Private method to process a rope error.</td> </tr><tr> @@ -100,6 +109,28 @@ <dd> path to the project </dd> +</dl><a NAME="CodeAssistClient.__closeProject" ID="CodeAssistClient.__closeProject"></a> +<h4>CodeAssistClient.__closeProject</h4> +<b>__closeProject</b>(<i>params</i>) +<p> + Private slot to validate the project. +</p><dl> +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the method parameters sent by + the server +</dd> +</dl><a NAME="CodeAssistClient.__configChanged" ID="CodeAssistClient.__configChanged"></a> +<h4>CodeAssistClient.__configChanged</h4> +<b>__configChanged</b>(<i>params</i>) +<p> + Private method to handle a change of the configuration file. +</p><dl> +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the method parameters sent by + the server +</dd> </dl><a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a> <h4>CodeAssistClient.__getCallTips</h4> <b>__getCallTips</b>(<i>params</i>) @@ -120,6 +151,17 @@ <dd> dictionary containing the method parameters </dd> +</dl><a NAME="CodeAssistClient.__getConfig" ID="CodeAssistClient.__getConfig"></a> +<h4>CodeAssistClient.__getConfig</h4> +<b>__getConfig</b>(<i>params</i>) +<p> + Private method to send some configuration data to the server. +</p><dl> +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the method parameters sent by + the server +</dd> </dl><a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> <h4>CodeAssistClient.__handleRopeError</h4> <b>__handleRopeError</b>(<i>err</i>)
--- 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 />
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ConfigurationPage.AutoCompletionRopePage.html Sun Oct 08 17:56:43 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ConfigurationPage.AutoCompletionRopePage.html Sun Oct 08 17:57:18 2017 +0200 @@ -60,6 +60,15 @@ <td><a href="#AutoCompletionRopePage.__init__">AutoCompletionRopePage</a></td> <td>Constructor</td> </tr><tr> +<td><a href="#AutoCompletionRopePage.on_python2Button_clicked">on_python2Button_clicked</a></td> +<td>Private slot to edit the rope configuration for Python 2.</td> +</tr><tr> +<td><a href="#AutoCompletionRopePage.on_python3Button_clicked">on_python3Button_clicked</a></td> +<td>Private slot to edit the rope configuration for Python 3.</td> +</tr><tr> +<td><a href="#AutoCompletionRopePage.polishPage">polishPage</a></td> +<td>Public slot to perform some polishing actions.</td> +</tr><tr> <td><a href="#AutoCompletionRopePage.save">save</a></td> <td>Public slot to save the Rope Autocompletion configuration.</td> </tr> @@ -78,7 +87,22 @@ <dd> reference to the plugin object </dd> -</dl><a NAME="AutoCompletionRopePage.save" ID="AutoCompletionRopePage.save"></a> +</dl><a NAME="AutoCompletionRopePage.on_python2Button_clicked" ID="AutoCompletionRopePage.on_python2Button_clicked"></a> +<h4>AutoCompletionRopePage.on_python2Button_clicked</h4> +<b>on_python2Button_clicked</b>(<i></i>) +<p> + Private slot to edit the rope configuration for Python 2. +</p><a NAME="AutoCompletionRopePage.on_python3Button_clicked" ID="AutoCompletionRopePage.on_python3Button_clicked"></a> +<h4>AutoCompletionRopePage.on_python3Button_clicked</h4> +<b>on_python3Button_clicked</b>(<i></i>) +<p> + Private slot to edit the rope configuration for Python 3. +</p><a NAME="AutoCompletionRopePage.polishPage" ID="AutoCompletionRopePage.polishPage"></a> +<h4>AutoCompletionRopePage.polishPage</h4> +<b>polishPage</b>(<i></i>) +<p> + Public slot to perform some polishing actions. +</p><a NAME="AutoCompletionRopePage.save" ID="AutoCompletionRopePage.save"></a> <h4>AutoCompletionRopePage.save</h4> <b>save</b>(<i></i>) <p>
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer.html Sun Oct 08 17:56:43 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer.html Sun Oct 08 17:57:18 2017 +0200 @@ -72,12 +72,18 @@ <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td> <td>Private slot called, when the rope config file has changed.</td> </tr><tr> +<td><a href="#RefactoringServer.__connectMouseClickHandler">__connectMouseClickHandler</a></td> +<td>Private method to connect the mouse click handler to an editor.</td> +</tr><tr> <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td> <td>Private slot to convert a local variable to an attribute.</td> </tr><tr> <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td> <td>Private slot to return the contents of rope's default configuration.</td> </tr><tr> +<td><a href="#RefactoringServer.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td> +<td>Private method to disconnect the mouse click handler from an editor.</td> +</tr><tr> <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td> <td>Private method to perform the extract refactoring.</td> </tr><tr> @@ -237,9 +243,15 @@ <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td> <td>Public method to check, if an editor has unsaved changes.</td> </tr><tr> +<td><a href="#RefactoringServer.connectEditor">connectEditor</a></td> +<td>Public method to connect an editor.</td> +</tr><tr> <td><a href="#RefactoringServer.deactivate">deactivate</a></td> <td>Public method to deactivate the refactoring server.</td> </tr><tr> +<td><a href="#RefactoringServer.disconnectEditor">disconnectEditor</a></td> +<td>Public method to disconnect an editor.</td> +</tr><tr> <td><a href="#RefactoringServer.getActions">getActions</a></td> <td>Public method to get a list of all actions.</td> </tr><tr> @@ -308,7 +320,17 @@ <b>__configChanged</b>(<i></i>) <p> Private slot called, when the rope config file has changed. -</p><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a> +</p><a NAME="RefactoringServer.__connectMouseClickHandler" ID="RefactoringServer.__connectMouseClickHandler"></a> +<h4>RefactoringServer.__connectMouseClickHandler</h4> +<b>__connectMouseClickHandler</b>(<i>editor</i>) +<p> + Private method to connect the mouse click handler to an editor. +</p><dl> +<dt><i>editor</i> (QScintilla.Editor)</dt> +<dd> +reference to the editor +</dd> +</dl><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a> <h4>RefactoringServer.__convertLocalToAttribute</h4> <b>__convertLocalToAttribute</b>(<i></i>) <p> @@ -329,6 +351,16 @@ <dd> str </dd> +</dl><a NAME="RefactoringServer.__disconnectMouseClickHandler" ID="RefactoringServer.__disconnectMouseClickHandler"></a> +<h4>RefactoringServer.__disconnectMouseClickHandler</h4> +<b>__disconnectMouseClickHandler</b>(<i>editor</i>) +<p> + Private method to disconnect the mouse click handler from an editor. +</p><dl> +<dt><i>editor</i> (QScintilla.Editor)</dt> +<dd> +reference to the editor +</dd> </dl><a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a> <h4>RefactoringServer.__doExtract</h4> <b>__doExtract</b>(<i>title, kind</i>) @@ -772,12 +804,32 @@ <dd> bool </dd> +</dl><a NAME="RefactoringServer.connectEditor" ID="RefactoringServer.connectEditor"></a> +<h4>RefactoringServer.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="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a> <h4>RefactoringServer.deactivate</h4> <b>deactivate</b>(<i></i>) <p> Public method to deactivate the refactoring server. -</p><a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a> +</p><a NAME="RefactoringServer.disconnectEditor" ID="RefactoringServer.disconnectEditor"></a> +<h4>RefactoringServer.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="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a> <h4>RefactoringServer.getActions</h4> <b>getActions</b>(<i></i>) <p>