--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Fri Sep 29 10:32:30 2017 +0200
@@ -75,21 +75,12 @@
<td><a href="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td>
<td>Constructor</td>
</tr><tr>
-<td><a href="#RefactoringRopePlugin.__codeAssist">__codeAssist</a></td>
-<td>Private slot to show a list with completion proposals.</td>
-</tr><tr>
-<td><a href="#RefactoringRopePlugin.__completionListSelected">__completionListSelected</a></td>
-<td>Private slot to handle the selection from the completion list.</td>
-</tr><tr>
<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.__determineLanguage">__determineLanguage</a></td>
-<td>Private method to determine the valid language strings.</td>
-</tr><tr>
<td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td>
<td>Private method to disconnect an editor.</td>
</tr><tr>
@@ -117,18 +108,15 @@
<td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr><tr>
-<td><a href="#RefactoringRopePlugin.__projectClosed">__projectClosed</a></td>
-<td>Private slot to handle the projectClosed signal.</td>
-</tr><tr>
-<td><a href="#RefactoringRopePlugin.__projectOpened">__projectOpened</a></td>
-<td>Private slot to handle the projectOpened signal.</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>
@@ -138,9 +126,6 @@
<td><a href="#RefactoringRopePlugin.activate">activate</a></td>
<td>Public method to activate this plugin.</td>
</tr><tr>
-<td><a href="#RefactoringRopePlugin.codeAssist">codeAssist</a></td>
-<td>Public method to determine the autocompletion proposals.</td>
-</tr><tr>
<td><a href="#RefactoringRopePlugin.codeAssistCallTip">codeAssistCallTip</a></td>
<td>Public method to return a list of calltips.</td>
</tr><tr>
@@ -167,27 +152,9 @@
<p>
Constructor
</p><dl>
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UI.UserInterface)</dt>
<dd>
-reference to the user interface object (UI.UserInterface)
-</dd>
-</dl><a NAME="RefactoringRopePlugin.__codeAssist" ID="RefactoringRopePlugin.__codeAssist"></a>
-<h4>RefactoringRopePlugin.__codeAssist</h4>
-<b>__codeAssist</b>(<i></i>)
-<p>
- Private slot to show a list with completion proposals.
-</p><a NAME="RefactoringRopePlugin.__completionListSelected" ID="RefactoringRopePlugin.__completionListSelected"></a>
-<h4>RefactoringRopePlugin.__completionListSelected</h4>
-<b>__completionListSelected</b>(<i>userListId, txt</i>)
-<p>
- Private slot to handle the selection from the completion list.
-</p><dl>
-<dt><i>userListId</i></dt>
-<dd>
-the ID of the user list (should be 1) (integer)
-</dd><dt><i>txt</i></dt>
-<dd>
-the selected text (QString)
+reference to the user interface object
</dd>
</dl><a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a>
<h4>RefactoringRopePlugin.__connectEditor</h4>
@@ -195,9 +162,9 @@
<p>
Private method to connect an editor.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a>
<h4>RefactoringRopePlugin.__connectMouseClickHandler</h4>
@@ -205,19 +172,9 @@
<p>
Private method to connect the mouse click handler to an editor.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
-</dd>
-</dl><a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a>
-<h4>RefactoringRopePlugin.__determineLanguage</h4>
-<b>__determineLanguage</b>(<i></i>)
-<p>
- Private method to determine the valid language strings.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-list of valid language strings (list of string)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a>
<h4>RefactoringRopePlugin.__disconnectEditor</h4>
@@ -225,9 +182,9 @@
<p>
Private method to disconnect an editor.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a>
<h4>RefactoringRopePlugin.__disconnectMouseClickHandler</h4>
@@ -235,9 +192,9 @@
<p>
Private method to disconnect the mouse click handler from an editor.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a>
<h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4>
@@ -245,9 +202,9 @@
<p>
Private slot to get the old contents of the named file.
</p><dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file about to be saved (string)
+name of the file about to be saved
</dd>
</dl><a NAME="RefactoringRopePlugin.__editorClosed" ID="RefactoringRopePlugin.__editorClosed"></a>
<h4>RefactoringRopePlugin.__editorClosed</h4>
@@ -255,9 +212,9 @@
<p>
Private slot called, when an editor was closed.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a>
<h4>RefactoringRopePlugin.__editorLanguageChanged</h4>
@@ -265,9 +222,9 @@
<p>
Private slot to handle the language change of an editor.
</p><dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-programming language of the editor (string)
+programming language of the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__editorOpened" ID="RefactoringRopePlugin.__editorOpened"></a>
<h4>RefactoringRopePlugin.__editorOpened</h4>
@@ -275,9 +232,9 @@
<p>
Private slot called, when a new editor was opened.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the new editor (QScintilla.Editor)
+reference to the new editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a>
<h4>RefactoringRopePlugin.__editorSaved</h4>
@@ -285,9 +242,9 @@
<p>
Private slot to activate SOA.
</p><dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-name of the file that was saved (string)
+name of the file that was saved
</dd>
</dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a>
<h4>RefactoringRopePlugin.__initialize</h4>
@@ -299,25 +256,15 @@
<b>__loadTranslator</b>(<i></i>)
<p>
Private method to load the translation file.
-</p><a NAME="RefactoringRopePlugin.__projectClosed" ID="RefactoringRopePlugin.__projectClosed"></a>
-<h4>RefactoringRopePlugin.__projectClosed</h4>
-<b>__projectClosed</b>(<i></i>)
-<p>
- Private slot to handle the projectClosed signal.
-</p><a NAME="RefactoringRopePlugin.__projectOpened" ID="RefactoringRopePlugin.__projectOpened"></a>
-<h4>RefactoringRopePlugin.__projectOpened</h4>
-<b>__projectOpened</b>(<i></i>)
-<p>
- Private slot to handle the projectOpened signal.
</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></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a>
<h4>RefactoringRopePlugin.__setCalltipsHook</h4>
@@ -325,19 +272,24 @@
<p>
Private method to set the calltip hook.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
-</dl><a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a>
+</dl><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></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a>
<h4>RefactoringRopePlugin.__unsetCalltipsHook</h4>
@@ -345,9 +297,9 @@
<p>
Private method to unset the calltip hook.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
<h4>RefactoringRopePlugin.activate</h4>
@@ -357,21 +309,12 @@
</p><dl>
<dt>Returns:</dt>
<dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
</dd>
-</dl><a NAME="RefactoringRopePlugin.codeAssist" ID="RefactoringRopePlugin.codeAssist"></a>
-<h4>RefactoringRopePlugin.codeAssist</h4>
-<b>codeAssist</b>(<i>editor, context=False</i>)
-<p>
- Public method to determine the autocompletion proposals.
-</p><dl>
-<dt><i>editor</i></dt>
+</dl><dl>
+<dt>Return Type:</dt>
<dd>
-reference to the editor object, that called this method
- QScintilla.Editor)
-</dd><dt><i>context</i></dt>
-<dd>
-flag indicating to autocomplete a context (boolean)
+tuple of (None, bool)
</dd>
</dl><a NAME="RefactoringRopePlugin.codeAssistCallTip" ID="RefactoringRopePlugin.codeAssistCallTip"></a>
<h4>RefactoringRopePlugin.codeAssistCallTip</h4>
@@ -379,21 +322,25 @@
<p>
Public method to return a list of calltips.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
-</dd><dt><i>pos</i></dt>
+reference to the editor
+</dd><dt><i>pos</i> (int)</dt>
<dd>
-position in the text for the calltip (integer)
-</dd><dt><i>commas</i></dt>
+position in the text for the calltip
+</dd><dt><i>commas</i> (int)</dt>
<dd>
minimum number of commas contained in the calltip
- (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of possible calltips (list of strings)
+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>
@@ -406,18 +353,22 @@
<p>
Public method to get a list of possible completions.
</p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
<dd>
reference to the editor object, that called this method
- (QScintilla.Editor)
-</dd><dt><i>context</i></dt>
+</dd><dt><i>context</i> (bool)</dt>
<dd>
-flag indicating to autocomplete a context (boolean)
+flag indicating to autocomplete a context
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of possible completions (list of strings)
+list of possible completions
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a>
<h4>RefactoringRopePlugin.getPreferences</h4>
@@ -425,7 +376,7 @@
<p>
Public method to retrieve the various refactoring settings.
</p><dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
the key of the value to get
</dd>
@@ -440,9 +391,9 @@
<p>
Public method to store the various refactoring settings.
</p><dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-the key of the setting to be set (string)
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
the value to be set
@@ -514,6 +465,11 @@
<dd>
dictionary containing the relevant data
</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
