--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Wed Jan 03 16:44:06 2024 +0100
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Sun Oct 13 15:49:43 2024 +0200
@@ -7,28 +7,37 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.PluginRefactoringRope</h1>
-
<p>
Module implementing the Rope refactoring plugin.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>doNotCompile</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>refactoringRopePluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
+<tr><td>author</td></tr>
+<tr><td>autoactivate</td></tr>
+<tr><td>className</td></tr>
+<tr><td>deactivateable</td></tr>
+<tr><td>doNotCompile</td></tr>
+<tr><td>error</td></tr>
+<tr><td>longDescription</td></tr>
+<tr><td>name</td></tr>
+<tr><td>packageName</td></tr>
+<tr><td>pyqtApi</td></tr>
+<tr><td>refactoringRopePluginObject</td></tr>
+<tr><td>shortDescription</td></tr>
+<tr><td>version</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td>
<td>Class implementing the Rope refactoring plugin.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td>
<td>Module function to create the autocompletion configuration page.</td>
@@ -54,30 +63,29 @@
<td>Module function to prepare for an uninstallation.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a>
<h2>RefactoringRopePlugin</h2>
-
<p>
Class implementing the Rope refactoring plugin.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>PreferencesKey</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td>
<td>Constructor</td>
@@ -171,19 +179,20 @@
<td>Public method to store the various refactoring settings.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RefactoringRopePlugin.__init__" ID="RefactoringRopePlugin.__init__"></a>
<h4>RefactoringRopePlugin (Constructor)</h4>
<b>RefactoringRopePlugin</b>(<i>ui</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>ui</i> (UserInterface)</dt>
@@ -194,10 +203,10 @@
<a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a>
<h4>RefactoringRopePlugin.__connectEditor</h4>
<b>__connectEditor</b>(<i>editor</i>)
-
<p>
Private method to connect an editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -208,10 +217,10 @@
<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> (Editor)</dt>
@@ -222,10 +231,10 @@
<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>Return:</dt>
<dd>
@@ -241,10 +250,10 @@
<a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a>
<h4>RefactoringRopePlugin.__disconnectEditor</h4>
<b>__disconnectEditor</b>(<i>editor</i>)
-
<p>
Private method to disconnect an editor.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -255,10 +264,10 @@
<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> (Editor)</dt>
@@ -269,10 +278,10 @@
<a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a>
<h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4>
<b>__editorAboutToBeSaved</b>(<i>filename</i>)
-
<p>
Private slot to get the old contents of the named file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -283,10 +292,10 @@
<a NAME="RefactoringRopePlugin.__editorClosed" ID="RefactoringRopePlugin.__editorClosed"></a>
<h4>RefactoringRopePlugin.__editorClosed</h4>
<b>__editorClosed</b>(<i>editor</i>)
-
<p>
Private slot called, when an editor was closed.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -297,10 +306,10 @@
<a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a>
<h4>RefactoringRopePlugin.__editorLanguageChanged</h4>
<b>__editorLanguageChanged</b>(<i>language</i>)
-
<p>
Private slot to handle the language change of an editor.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -311,10 +320,10 @@
<a NAME="RefactoringRopePlugin.__editorOpened" ID="RefactoringRopePlugin.__editorOpened"></a>
<h4>RefactoringRopePlugin.__editorOpened</h4>
<b>__editorOpened</b>(<i>editor</i>)
-
<p>
Private slot called, when a new editor was opened.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -325,10 +334,10 @@
<a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a>
<h4>RefactoringRopePlugin.__editorSaved</h4>
<b>__editorSaved</b>(<i>filename</i>)
-
<p>
Private slot to activate SOA.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -339,24 +348,24 @@
<a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a>
<h4>RefactoringRopePlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private slot to (re)initialize the plugin.
</p>
+
<a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a>
<h4>RefactoringRopePlugin.__loadTranslator</h4>
<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> (Editor)</dt>
@@ -367,10 +376,10 @@
<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> (Editor)</dt>
@@ -381,17 +390,17 @@
<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> (Editor)</dt>
@@ -402,10 +411,10 @@
<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> (Editor)</dt>
@@ -416,10 +425,10 @@
<a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
<h4>RefactoringRopePlugin.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate this plugin.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -435,17 +444,17 @@
<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.getCodeAssistServer" ID="RefactoringRopePlugin.getCodeAssistServer"></a>
<h4>RefactoringRopePlugin.getCodeAssistServer</h4>
<b>getCodeAssistServer</b>(<i></i>)
-
<p>
Public method to get a reference to the code assist server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -461,10 +470,10 @@
<a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a>
<h4>RefactoringRopePlugin.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
-
<p>
Public method to retrieve the various refactoring settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -487,10 +496,10 @@
<a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a>
<h4>RefactoringRopePlugin.setPreferences</h4>
<b>setPreferences</b>(<i>key, value</i>)
-
<p>
Public method to store the various refactoring settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -508,10 +517,10 @@
<a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a>
<h2>createAutoCompletionPage</h2>
<b>createAutoCompletionPage</b>(<i>configDlg</i>)
-
<p>
Module function to create the autocompletion configuration page.
</p>
+
<dl>
<dt><i>configDlg</i> (ConfigurationWidget)</dt>
@@ -537,10 +546,10 @@
<a NAME="createCallTipsPage" ID="createCallTipsPage"></a>
<h2>createCallTipsPage</h2>
<b>createCallTipsPage</b>(<i>configDlg</i>)
-
<p>
Module function to create the calltips configuration page.
</p>
+
<dl>
<dt><i>configDlg</i> (ConfigurationWidget)</dt>
@@ -566,10 +575,10 @@
<a NAME="createMouseClickHandlerPage" ID="createMouseClickHandlerPage"></a>
<h2>createMouseClickHandlerPage</h2>
<b>createMouseClickHandlerPage</b>(<i>configDlg</i>)
-
<p>
Module function to create the mouse click handler configuration page.
</p>
+
<dl>
<dt><i>configDlg</i> (ConfigurationWidget)</dt>
@@ -595,10 +604,10 @@
<a NAME="getConfigData" ID="getConfigData"></a>
<h2>getConfigData</h2>
<b>getConfigData</b>(<i></i>)
-
<p>
Module function returning data as required by the configuration dialog.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -617,10 +626,10 @@
<a NAME="installDependencies" ID="installDependencies"></a>
<h2>installDependencies</h2>
<b>installDependencies</b>(<i>pipInstall</i>)
-
<p>
Function to install dependencies of this plug-in.
</p>
+
<dl>
<dt><i>pipInstall</i> (function)</dt>
@@ -634,10 +643,10 @@
<a NAME="prepareUninstall" ID="prepareUninstall"></a>
<h2>prepareUninstall</h2>
<b>prepareUninstall</b>(<i></i>)
-
<p>
Module function to prepare for an uninstallation.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
