--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html Wed Jan 03 16:44:06 2024 +0100
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html Sun Oct 13 15:49:43 2024 +0200
@@ -7,53 +7,53 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1>
-
<p>
Module implementing the refactoring client interface to rope.
</p>
+
<h3>Global Attributes</h3>
-
<table>
+<tr><td>QCoreApplication</td></tr>
+<tr><td>app</td></tr>
+<tr><td>client</td></tr>
<tr><td>modulePath</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#RefactoringClient">RefactoringClient</a></td>
<td>Class implementing the refactoring client interface to rope.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="RefactoringClient" ID="RefactoringClient"></a>
<h2>RefactoringClient</h2>
-
<p>
Class implementing the refactoring client interface to rope.
</p>
+
<h3>Derived from</h3>
EricJsonClient
<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="#RefactoringClient.__init__">RefactoringClient</a></td>
<td>Constructor</td>
@@ -211,19 +211,20 @@
<td>Public method to handle a method call from the server.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a>
<h4>RefactoringClient (Constructor)</h4>
<b>RefactoringClient</b>(<i>host, port, projectPath</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -242,10 +243,10 @@
<a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
<h4>RefactoringClient.__abortAction</h4>
<b>__abortAction</b>(<i>params</i>)
-
<p>
Private method to abort the current action.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -257,10 +258,10 @@
<a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
<h4>RefactoringClient.__applyChanges</h4>
<b>__applyChanges</b>(<i>params</i>)
-
<p>
Private method to apply the changes of a given change group.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -272,11 +273,11 @@
<a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
<h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4>
<b>__calculateChangeOccurrencesChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Change Occurrences' changes based on
the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -288,11 +289,11 @@
<a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
<h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4>
<b>__calculateEncapsulateFieldChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Encapsulate Field' changes based on
the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -304,11 +305,11 @@
<a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
<h4>RefactoringClient.__calculateExtractChanges</h4>
<b>__calculateExtractChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Extract' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -327,11 +328,11 @@
<a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
<h4>RefactoringClient.__calculateImportsChanges</h4>
<b>__calculateImportsChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Import' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -343,11 +344,11 @@
<a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
<h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4>
<b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Inline Argument Default' changes
based on the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -359,11 +360,11 @@
<a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
<h4>RefactoringClient.__calculateInlineChanges</h4>
<b>__calculateInlineChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Inline' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -375,11 +376,11 @@
<a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
<h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4>
<b>__calculateIntroduceFactoryChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Introduce Factory' changes based on
the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -391,11 +392,11 @@
<a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
<h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
<b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Introduce Parameter' changes based on
the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -407,11 +408,11 @@
<a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
<h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
<b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Local Variabe to Attribute' changes
based on the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -423,11 +424,11 @@
<a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
<h4>RefactoringClient.__calculateMethodObjectChanges</h4>
<b>__calculateMethodObjectChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Method to Method Object' changes
based on the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -439,11 +440,11 @@
<a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
<h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
<b>__calculateModuleToPackageChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Module to Package' changes
based on the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -455,11 +456,11 @@
<a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
<h4>RefactoringClient.__calculateMoveChanges</h4>
<b>__calculateMoveChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Move ...' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -471,11 +472,11 @@
<a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
<h4>RefactoringClient.__calculateRenameChanges</h4>
<b>__calculateRenameChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the rename changes based on the parameters
sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -487,11 +488,11 @@
<a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
<h4>RefactoringClient.__calculateRestructureChanges</h4>
<b>__calculateRestructureChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Restructure' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -503,11 +504,11 @@
<a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
<h4>RefactoringClient.__calculateSignatureChanges</h4>
<b>__calculateSignatureChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Signature' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -519,11 +520,11 @@
<a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
<h4>RefactoringClient.__calculateUseFunctionChanges</h4>
<b>__calculateUseFunctionChanges</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Use Function' changes based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -535,10 +536,10 @@
<a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
<h4>RefactoringClient.__clearChanges</h4>
<b>__clearChanges</b>(<i>params</i>)
-
<p>
Private method to clear the changes cache of a given change group.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -550,10 +551,10 @@
<a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
<h4>RefactoringClient.__closeProject</h4>
<b>__closeProject</b>(<i>params</i>)
-
<p>
Private slot to validate the project.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -565,10 +566,10 @@
<a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
<h4>RefactoringClient.__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>
@@ -580,10 +581,10 @@
<a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
<h4>RefactoringClient.__confirmUnsure</h4>
<b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>)
-
<p>
Private method to confirm unsure occurrences.
</p>
+
<dl>
<dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt>
@@ -610,10 +611,10 @@
<a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
<h4>RefactoringClient.__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>
@@ -625,10 +626,10 @@
<a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
<h4>RefactoringClient.__handleRopeError</h4>
<b>__handleRopeError</b>(<i>err</i>)
-
<p>
Private method to process a rope error.
</p>
+
<dl>
<dt><i>err</i> (Exception)</dt>
@@ -651,10 +652,10 @@
<a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
<h4>RefactoringClient.__performSOA</h4>
<b>__performSOA</b>(<i>params</i>)
-
<p>
Private method to perform SOA on all modules.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -666,10 +667,10 @@
<a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
<h4>RefactoringClient.__previewChanges</h4>
<b>__previewChanges</b>(<i>params</i>)
-
<p>
Private method to determine the changes data for a preview.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -681,10 +682,10 @@
<a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
<h4>RefactoringClient.__processHistory</h4>
<b>__processHistory</b>(<i>params</i>)
-
<p>
Private method to process the various history related requests.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -696,10 +697,10 @@
<a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
<h4>RefactoringClient.__queryDefinition</h4>
<b>__queryDefinition</b>(<i>params</i>)
-
<p>
Private method to handle the Find Definition action.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -711,10 +712,10 @@
<a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
<h4>RefactoringClient.__queryImplementations</h4>
<b>__queryImplementations</b>(<i>params</i>)
-
<p>
Private method to handle the Find Implementations action.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -726,10 +727,10 @@
<a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
<h4>RefactoringClient.__queryReferences</h4>
<b>__queryReferences</b>(<i>params</i>)
-
<p>
Private method to handle the Find References action.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -741,10 +742,10 @@
<a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
<h4>RefactoringClient.__reportChanged</h4>
<b>__reportChanged</b>(<i>params</i>)
-
<p>
Private method to register some changed sources.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -756,11 +757,11 @@
<a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
<h4>RefactoringClient.__requestFieldName</h4>
<b>__requestFieldName</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Field Name' based on the parameters
sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -772,11 +773,11 @@
<a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
<h4>RefactoringClient.__requestInlineType</h4>
<b>__requestInlineType</b>(<i>params</i>)
-
<p>
Private method to determine the 'Inline' changes type based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -788,11 +789,11 @@
<a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
<h4>RefactoringClient.__requestMoveType</h4>
<b>__requestMoveType</b>(<i>params</i>)
-
<p>
Private method to determine the 'Move Method' changes type based on the
parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -804,11 +805,11 @@
<a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
<h4>RefactoringClient.__requestSignature</h4>
<b>__requestSignature</b>(<i>params</i>)
-
<p>
Private method to calculate the 'Signature' based on the parameters
sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -820,11 +821,11 @@
<a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
<h4>RefactoringClient.__requestUseFunction</h4>
<b>__requestUseFunction</b>(<i>params</i>)
-
<p>
Private method to determine the 'Use Function' function name based on
the parameters sent by the server.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -836,10 +837,10 @@
<a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
<h4>RefactoringClient.__validate</h4>
<b>__validate</b>(<i>params</i>)
-
<p>
Private slot to validate the project.
</p>
+
<dl>
<dt><i>params</i> (dict)</dt>
@@ -851,10 +852,10 @@
<a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
<h4>RefactoringClient.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)
-
<p>
Public method to handle a method call from the server.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -868,4 +869,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
