--- 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>