Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient.html

changeset 321
d51e810107ec
parent 283
d98e971d9e4c
child 347
b5048b5ff454
equal deleted inserted replaced
320:91b171fdd85f 321:d51e810107ec
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1>
24
23 <p> 25 <p>
24 Module implementing the refactoring client interface to rope. 26 Module implementing the refactoring client interface to rope.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#RefactoringClient">RefactoringClient</a></td> 38 <td><a href="#RefactoringClient">RefactoringClient</a></td>
34 <td>Class implementing the refactoring client interface to rope.</td> 39 <td>Class implementing the refactoring client interface to rope.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="RefactoringClient" ID="RefactoringClient"></a> 49 <a NAME="RefactoringClient" ID="RefactoringClient"></a>
43 <h2>RefactoringClient</h2> 50 <h2>RefactoringClient</h2>
51
44 <p> 52 <p>
45 Class implementing the refactoring client interface to rope. 53 Class implementing the refactoring client interface to rope.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 JsonClient 56 JsonClient
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#RefactoringClient.__init__">RefactoringClient</a></td> 72 <td><a href="#RefactoringClient.__init__">RefactoringClient</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#RefactoringClient.__abortAction">__abortAction</a></td> 76 <td><a href="#RefactoringClient.__abortAction">__abortAction</a></td>
64 <td>Private method to abort the current action.</td> 77 <td>Private method to abort the current action.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#RefactoringClient.__applyChanges">__applyChanges</a></td> 80 <td><a href="#RefactoringClient.__applyChanges">__applyChanges</a></td>
67 <td>Private method to apply the changes of a given change group.</td> 81 <td>Private method to apply the changes of a given change group.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#RefactoringClient.__calculateChangeOccurrencesChanges">__calculateChangeOccurrencesChanges</a></td> 84 <td><a href="#RefactoringClient.__calculateChangeOccurrencesChanges">__calculateChangeOccurrencesChanges</a></td>
70 <td>Private method to calculate the 'Change Occurrences' changes based on the parameters sent by the server.</td> 85 <td>Private method to calculate the 'Change Occurrences' changes based on the parameters sent by the server.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#RefactoringClient.__calculateEncapsulateFieldChanges">__calculateEncapsulateFieldChanges</a></td> 88 <td><a href="#RefactoringClient.__calculateEncapsulateFieldChanges">__calculateEncapsulateFieldChanges</a></td>
73 <td>Private method to calculate the 'Encapsulate Field' changes based on the parameters sent by the server.</td> 89 <td>Private method to calculate the 'Encapsulate Field' changes based on the parameters sent by the server.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#RefactoringClient.__calculateExtractChanges">__calculateExtractChanges</a></td> 92 <td><a href="#RefactoringClient.__calculateExtractChanges">__calculateExtractChanges</a></td>
76 <td>Private method to calculate the 'Extract' changes based on the parameters sent by the server.</td> 93 <td>Private method to calculate the 'Extract' changes based on the parameters sent by the server.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#RefactoringClient.__calculateImportsChanges">__calculateImportsChanges</a></td> 96 <td><a href="#RefactoringClient.__calculateImportsChanges">__calculateImportsChanges</a></td>
79 <td>Private method to calculate the 'Import' changes based on the parameters sent by the server.</td> 97 <td>Private method to calculate the 'Import' changes based on the parameters sent by the server.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#RefactoringClient.__calculateInlineArgumentDefaultChanges">__calculateInlineArgumentDefaultChanges</a></td> 100 <td><a href="#RefactoringClient.__calculateInlineArgumentDefaultChanges">__calculateInlineArgumentDefaultChanges</a></td>
82 <td>Private method to calculate the 'Inline Argument Default' changes based on the parameters sent by the server.</td> 101 <td>Private method to calculate the 'Inline Argument Default' changes based on the parameters sent by the server.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#RefactoringClient.__calculateInlineChanges">__calculateInlineChanges</a></td> 104 <td><a href="#RefactoringClient.__calculateInlineChanges">__calculateInlineChanges</a></td>
85 <td>Private method to calculate the 'Inline' changes based on the parameters sent by the server.</td> 105 <td>Private method to calculate the 'Inline' changes based on the parameters sent by the server.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#RefactoringClient.__calculateIntroduceFactoryChanges">__calculateIntroduceFactoryChanges</a></td> 108 <td><a href="#RefactoringClient.__calculateIntroduceFactoryChanges">__calculateIntroduceFactoryChanges</a></td>
88 <td>Private method to calculate the 'Introduce Factory' changes based on the parameters sent by the server.</td> 109 <td>Private method to calculate the 'Introduce Factory' changes based on the parameters sent by the server.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#RefactoringClient.__calculateIntroduceParameterChanges">__calculateIntroduceParameterChanges</a></td> 112 <td><a href="#RefactoringClient.__calculateIntroduceParameterChanges">__calculateIntroduceParameterChanges</a></td>
91 <td>Private method to calculate the 'Introduce Parameter' changes based on the parameters sent by the server.</td> 113 <td>Private method to calculate the 'Introduce Parameter' changes based on the parameters sent by the server.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#RefactoringClient.__calculateLocalToAttributeChanges">__calculateLocalToAttributeChanges</a></td> 116 <td><a href="#RefactoringClient.__calculateLocalToAttributeChanges">__calculateLocalToAttributeChanges</a></td>
94 <td>Private method to calculate the 'Local Variabe to Attribute' changes based on the parameters sent by the server.</td> 117 <td>Private method to calculate the 'Local Variabe to Attribute' changes based on the parameters sent by the server.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#RefactoringClient.__calculateMethodObjectChanges">__calculateMethodObjectChanges</a></td> 120 <td><a href="#RefactoringClient.__calculateMethodObjectChanges">__calculateMethodObjectChanges</a></td>
97 <td>Private method to calculate the 'Method to Method Object' changes based on the parameters sent by the server.</td> 121 <td>Private method to calculate the 'Method to Method Object' changes based on the parameters sent by the server.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#RefactoringClient.__calculateModuleToPackageChanges">__calculateModuleToPackageChanges</a></td> 124 <td><a href="#RefactoringClient.__calculateModuleToPackageChanges">__calculateModuleToPackageChanges</a></td>
100 <td>Private method to calculate the 'Module to Package' changes based on the parameters sent by the server.</td> 125 <td>Private method to calculate the 'Module to Package' changes based on the parameters sent by the server.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#RefactoringClient.__calculateMoveChanges">__calculateMoveChanges</a></td> 128 <td><a href="#RefactoringClient.__calculateMoveChanges">__calculateMoveChanges</a></td>
103 <td>Private method to calculate the 'Move ...' changes based on the parameters sent by the server.</td> 129 <td>Private method to calculate the 'Move ...' changes based on the parameters sent by the server.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#RefactoringClient.__calculateRenameChanges">__calculateRenameChanges</a></td> 132 <td><a href="#RefactoringClient.__calculateRenameChanges">__calculateRenameChanges</a></td>
106 <td>Private method to calculate the rename changes based on the parameters sent by the server.</td> 133 <td>Private method to calculate the rename changes based on the parameters sent by the server.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#RefactoringClient.__calculateRestructureChanges">__calculateRestructureChanges</a></td> 136 <td><a href="#RefactoringClient.__calculateRestructureChanges">__calculateRestructureChanges</a></td>
109 <td>Private method to calculate the 'Restructure' changes based on the parameters sent by the server.</td> 137 <td>Private method to calculate the 'Restructure' changes based on the parameters sent by the server.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#RefactoringClient.__calculateSignatureChanges">__calculateSignatureChanges</a></td> 140 <td><a href="#RefactoringClient.__calculateSignatureChanges">__calculateSignatureChanges</a></td>
112 <td>Private method to calculate the 'Signature' changes based on the parameters sent by the server.</td> 141 <td>Private method to calculate the 'Signature' changes based on the parameters sent by the server.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#RefactoringClient.__calculateUseFunctionChanges">__calculateUseFunctionChanges</a></td> 144 <td><a href="#RefactoringClient.__calculateUseFunctionChanges">__calculateUseFunctionChanges</a></td>
115 <td>Private method to calculate the 'Use Function' changes based on the parameters sent by the server.</td> 145 <td>Private method to calculate the 'Use Function' changes based on the parameters sent by the server.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#RefactoringClient.__clearChanges">__clearChanges</a></td> 148 <td><a href="#RefactoringClient.__clearChanges">__clearChanges</a></td>
118 <td>Private method to clear the changes cache of a given change group.</td> 149 <td>Private method to clear the changes cache of a given change group.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#RefactoringClient.__closeProject">__closeProject</a></td> 152 <td><a href="#RefactoringClient.__closeProject">__closeProject</a></td>
121 <td>Private slot to validate the project.</td> 153 <td>Private slot to validate the project.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#RefactoringClient.__configChanged">__configChanged</a></td> 156 <td><a href="#RefactoringClient.__configChanged">__configChanged</a></td>
124 <td>Private method to handle a change of the configuration file.</td> 157 <td>Private method to handle a change of the configuration file.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#RefactoringClient.__confirmUnsure">__confirmUnsure</a></td> 160 <td><a href="#RefactoringClient.__confirmUnsure">__confirmUnsure</a></td>
127 <td>Private method to confirm unsure occurrences.</td> 161 <td>Private method to confirm unsure occurrences.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#RefactoringClient.__getConfig">__getConfig</a></td> 164 <td><a href="#RefactoringClient.__getConfig">__getConfig</a></td>
130 <td>Private method to send some configuration data to the server.</td> 165 <td>Private method to send some configuration data to the server.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#RefactoringClient.__handleRopeError">__handleRopeError</a></td> 168 <td><a href="#RefactoringClient.__handleRopeError">__handleRopeError</a></td>
133 <td>Private method to process a rope error.</td> 169 <td>Private method to process a rope error.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#RefactoringClient.__performSOA">__performSOA</a></td> 172 <td><a href="#RefactoringClient.__performSOA">__performSOA</a></td>
136 <td>Private method to perform SOA on all modules.</td> 173 <td>Private method to perform SOA on all modules.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#RefactoringClient.__previewChanges">__previewChanges</a></td> 176 <td><a href="#RefactoringClient.__previewChanges">__previewChanges</a></td>
139 <td>Private method to determine the changes data for a preview.</td> 177 <td>Private method to determine the changes data for a preview.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#RefactoringClient.__processHistory">__processHistory</a></td> 180 <td><a href="#RefactoringClient.__processHistory">__processHistory</a></td>
142 <td>Private method to process the various history related requests.</td> 181 <td>Private method to process the various history related requests.</td>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#RefactoringClient.__queryDefinition">__queryDefinition</a></td> 184 <td><a href="#RefactoringClient.__queryDefinition">__queryDefinition</a></td>
145 <td>Private method to handle the Find Definition action.</td> 185 <td>Private method to handle the Find Definition action.</td>
146 </tr><tr> 186 </tr>
187 <tr>
147 <td><a href="#RefactoringClient.__queryImplementations">__queryImplementations</a></td> 188 <td><a href="#RefactoringClient.__queryImplementations">__queryImplementations</a></td>
148 <td>Private method to handle the Find Implementations action.</td> 189 <td>Private method to handle the Find Implementations action.</td>
149 </tr><tr> 190 </tr>
191 <tr>
150 <td><a href="#RefactoringClient.__queryReferences">__queryReferences</a></td> 192 <td><a href="#RefactoringClient.__queryReferences">__queryReferences</a></td>
151 <td>Private method to handle the Find References action.</td> 193 <td>Private method to handle the Find References action.</td>
152 </tr><tr> 194 </tr>
195 <tr>
153 <td><a href="#RefactoringClient.__reportChanged">__reportChanged</a></td> 196 <td><a href="#RefactoringClient.__reportChanged">__reportChanged</a></td>
154 <td>Private method to register some changed sources.</td> 197 <td>Private method to register some changed sources.</td>
155 </tr><tr> 198 </tr>
199 <tr>
156 <td><a href="#RefactoringClient.__requestFieldName">__requestFieldName</a></td> 200 <td><a href="#RefactoringClient.__requestFieldName">__requestFieldName</a></td>
157 <td>Private method to calculate the 'Field Name' based on the parameters sent by the server.</td> 201 <td>Private method to calculate the 'Field Name' based on the parameters sent by the server.</td>
158 </tr><tr> 202 </tr>
203 <tr>
159 <td><a href="#RefactoringClient.__requestInlineType">__requestInlineType</a></td> 204 <td><a href="#RefactoringClient.__requestInlineType">__requestInlineType</a></td>
160 <td>Private method to determine the 'Inline' changes type based on the parameters sent by the server.</td> 205 <td>Private method to determine the 'Inline' changes type based on the parameters sent by the server.</td>
161 </tr><tr> 206 </tr>
207 <tr>
162 <td><a href="#RefactoringClient.__requestMoveType">__requestMoveType</a></td> 208 <td><a href="#RefactoringClient.__requestMoveType">__requestMoveType</a></td>
163 <td>Private method to determine the 'Move Method' changes type based on the parameters sent by the server.</td> 209 <td>Private method to determine the 'Move Method' changes type based on the parameters sent by the server.</td>
164 </tr><tr> 210 </tr>
211 <tr>
165 <td><a href="#RefactoringClient.__requestSignature">__requestSignature</a></td> 212 <td><a href="#RefactoringClient.__requestSignature">__requestSignature</a></td>
166 <td>Private method to calculate the 'Signature' based on the parameters sent by the server.</td> 213 <td>Private method to calculate the 'Signature' based on the parameters sent by the server.</td>
167 </tr><tr> 214 </tr>
215 <tr>
168 <td><a href="#RefactoringClient.__requestUseFunction">__requestUseFunction</a></td> 216 <td><a href="#RefactoringClient.__requestUseFunction">__requestUseFunction</a></td>
169 <td>Private method to determine the 'Use Function' function name based on the parameters sent by the server.</td> 217 <td>Private method to determine the 'Use Function' function name based on the parameters sent by the server.</td>
170 </tr><tr> 218 </tr>
219 <tr>
171 <td><a href="#RefactoringClient.__validate">__validate</a></td> 220 <td><a href="#RefactoringClient.__validate">__validate</a></td>
172 <td>Private slot to validate the project.</td> 221 <td>Private slot to validate the project.</td>
173 </tr><tr> 222 </tr>
223 <tr>
174 <td><a href="#RefactoringClient.handleCall">handleCall</a></td> 224 <td><a href="#RefactoringClient.handleCall">handleCall</a></td>
175 <td>Public method to handle a method call from the server.</td> 225 <td>Public method to handle a method call from the server.</td>
176 </tr> 226 </tr>
177 </table> 227 </table>
178 <h3>Static Methods</h3> 228 <h3>Static Methods</h3>
229
179 <table> 230 <table>
180 <tr><td>None</td></tr> 231 <tr><td>None</td></tr>
181 </table> 232 </table>
233
182 <a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a> 234 <a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a>
183 <h4>RefactoringClient (Constructor)</h4> 235 <h4>RefactoringClient (Constructor)</h4>
184 <b>RefactoringClient</b>(<i>host, port, projectPath</i>) 236 <b>RefactoringClient</b>(<i>host, port, projectPath</i>)
237
185 <p> 238 <p>
186 Constructor 239 Constructor
187 </p><dl> 240 </p>
241 <dl>
242
188 <dt><i>host</i> (str)</dt> 243 <dt><i>host</i> (str)</dt>
189 <dd> 244 <dd>
190 ip address the background service is listening 245 ip address the background service is listening
191 </dd><dt><i>port</i> (int)</dt> 246 </dd>
247 <dt><i>port</i> (int)</dt>
192 <dd> 248 <dd>
193 port of the background service 249 port of the background service
194 </dd><dt><i>projectPath</i> (str)</dt> 250 </dd>
251 <dt><i>projectPath</i> (str)</dt>
195 <dd> 252 <dd>
196 path to the project 253 path to the project
197 </dd> 254 </dd>
198 </dl><a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a> 255 </dl>
256 <a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
199 <h4>RefactoringClient.__abortAction</h4> 257 <h4>RefactoringClient.__abortAction</h4>
200 <b>__abortAction</b>(<i>params</i>) 258 <b>__abortAction</b>(<i>params</i>)
259
201 <p> 260 <p>
202 Private method to abort the current action. 261 Private method to abort the current action.
203 </p><dl> 262 </p>
204 <dt><i>params</i> (dict)</dt> 263 <dl>
205 <dd> 264
206 dictionary containing the method parameters sent by 265 <dt><i>params</i> (dict)</dt>
207 the server 266 <dd>
208 </dd> 267 dictionary containing the method parameters sent by
209 </dl><a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a> 268 the server
269 </dd>
270 </dl>
271 <a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
210 <h4>RefactoringClient.__applyChanges</h4> 272 <h4>RefactoringClient.__applyChanges</h4>
211 <b>__applyChanges</b>(<i>params</i>) 273 <b>__applyChanges</b>(<i>params</i>)
274
212 <p> 275 <p>
213 Private method to apply the changes of a given change group. 276 Private method to apply the changes of a given change group.
214 </p><dl> 277 </p>
215 <dt><i>params</i> (dict)</dt> 278 <dl>
216 <dd> 279
217 dictionary containing the method parameters sent by 280 <dt><i>params</i> (dict)</dt>
218 the server 281 <dd>
219 </dd> 282 dictionary containing the method parameters sent by
220 </dl><a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a> 283 the server
284 </dd>
285 </dl>
286 <a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
221 <h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4> 287 <h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4>
222 <b>__calculateChangeOccurrencesChanges</b>(<i>params</i>) 288 <b>__calculateChangeOccurrencesChanges</b>(<i>params</i>)
289
223 <p> 290 <p>
224 Private method to calculate the 'Change Occurrences' changes based on 291 Private method to calculate the 'Change Occurrences' changes based on
225 the parameters sent by the server. 292 the parameters sent by the server.
226 </p><dl> 293 </p>
227 <dt><i>params</i> (dict)</dt> 294 <dl>
228 <dd> 295
229 dictionary containing the method parameters sent by 296 <dt><i>params</i> (dict)</dt>
230 the server 297 <dd>
231 </dd> 298 dictionary containing the method parameters sent by
232 </dl><a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a> 299 the server
300 </dd>
301 </dl>
302 <a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
233 <h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4> 303 <h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4>
234 <b>__calculateEncapsulateFieldChanges</b>(<i>params</i>) 304 <b>__calculateEncapsulateFieldChanges</b>(<i>params</i>)
305
235 <p> 306 <p>
236 Private method to calculate the 'Encapsulate Field' changes based on 307 Private method to calculate the 'Encapsulate Field' changes based on
237 the parameters sent by the server. 308 the parameters sent by the server.
238 </p><dl> 309 </p>
239 <dt><i>params</i> (dict)</dt> 310 <dl>
240 <dd> 311
241 dictionary containing the method parameters sent by 312 <dt><i>params</i> (dict)</dt>
242 the server 313 <dd>
243 </dd> 314 dictionary containing the method parameters sent by
244 </dl><a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a> 315 the server
316 </dd>
317 </dl>
318 <a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
245 <h4>RefactoringClient.__calculateExtractChanges</h4> 319 <h4>RefactoringClient.__calculateExtractChanges</h4>
246 <b>__calculateExtractChanges</b>(<i>params</i>) 320 <b>__calculateExtractChanges</b>(<i>params</i>)
321
247 <p> 322 <p>
248 Private method to calculate the 'Extract' changes based on the 323 Private method to calculate the 'Extract' changes based on the
249 parameters sent by the server. 324 parameters sent by the server.
250 </p><dl> 325 </p>
251 <dt><i>params</i> (dict)</dt> 326 <dl>
252 <dd> 327
253 dictionary containing the method parameters sent by 328 <dt><i>params</i> (dict)</dt>
254 the server 329 <dd>
255 </dd> 330 dictionary containing the method parameters sent by
256 </dl><dl> 331 the server
332 </dd>
333 </dl>
334 <dl>
335
257 <dt>Raises <b>Exception</b>:</dt> 336 <dt>Raises <b>Exception</b>:</dt>
258 <dd> 337 <dd>
259 raised to indicate an invalid extraction type 338 raised to indicate an invalid extraction type
260 </dd> 339 </dd>
261 </dl><a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a> 340 </dl>
341 <a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
262 <h4>RefactoringClient.__calculateImportsChanges</h4> 342 <h4>RefactoringClient.__calculateImportsChanges</h4>
263 <b>__calculateImportsChanges</b>(<i>params</i>) 343 <b>__calculateImportsChanges</b>(<i>params</i>)
344
264 <p> 345 <p>
265 Private method to calculate the 'Import' changes based on the 346 Private method to calculate the 'Import' changes based on the
266 parameters sent by the server. 347 parameters sent by the server.
267 </p><dl> 348 </p>
268 <dt><i>params</i> (dict)</dt> 349 <dl>
269 <dd> 350
270 dictionary containing the method parameters sent by 351 <dt><i>params</i> (dict)</dt>
271 the server 352 <dd>
272 </dd> 353 dictionary containing the method parameters sent by
273 </dl><a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a> 354 the server
355 </dd>
356 </dl>
357 <a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
274 <h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4> 358 <h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4>
275 <b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>) 359 <b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>)
360
276 <p> 361 <p>
277 Private method to calculate the 'Inline Argument Default' changes 362 Private method to calculate the 'Inline Argument Default' changes
278 based on the parameters sent by the server. 363 based on the parameters sent by the server.
279 </p><dl> 364 </p>
280 <dt><i>params</i> (dict)</dt> 365 <dl>
281 <dd> 366
282 dictionary containing the method parameters sent by 367 <dt><i>params</i> (dict)</dt>
283 the server 368 <dd>
284 </dd> 369 dictionary containing the method parameters sent by
285 </dl><a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a> 370 the server
371 </dd>
372 </dl>
373 <a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
286 <h4>RefactoringClient.__calculateInlineChanges</h4> 374 <h4>RefactoringClient.__calculateInlineChanges</h4>
287 <b>__calculateInlineChanges</b>(<i>params</i>) 375 <b>__calculateInlineChanges</b>(<i>params</i>)
376
288 <p> 377 <p>
289 Private method to calculate the 'Inline' changes based on the 378 Private method to calculate the 'Inline' changes based on the
290 parameters sent by the server. 379 parameters sent by the server.
291 </p><dl> 380 </p>
292 <dt><i>params</i> (dict)</dt> 381 <dl>
293 <dd> 382
294 dictionary containing the method parameters sent by 383 <dt><i>params</i> (dict)</dt>
295 the server 384 <dd>
296 </dd> 385 dictionary containing the method parameters sent by
297 </dl><a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a> 386 the server
387 </dd>
388 </dl>
389 <a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
298 <h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4> 390 <h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4>
299 <b>__calculateIntroduceFactoryChanges</b>(<i>params</i>) 391 <b>__calculateIntroduceFactoryChanges</b>(<i>params</i>)
392
300 <p> 393 <p>
301 Private method to calculate the 'Introduce Factory' changes based on 394 Private method to calculate the 'Introduce Factory' changes based on
302 the parameters sent by the server. 395 the parameters sent by the server.
303 </p><dl> 396 </p>
304 <dt><i>params</i> (dict)</dt> 397 <dl>
305 <dd> 398
306 dictionary containing the method parameters sent by 399 <dt><i>params</i> (dict)</dt>
307 the server 400 <dd>
308 </dd> 401 dictionary containing the method parameters sent by
309 </dl><a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a> 402 the server
403 </dd>
404 </dl>
405 <a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
310 <h4>RefactoringClient.__calculateIntroduceParameterChanges</h4> 406 <h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
311 <b>__calculateIntroduceParameterChanges</b>(<i>params</i>) 407 <b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
408
312 <p> 409 <p>
313 Private method to calculate the 'Introduce Parameter' changes based on 410 Private method to calculate the 'Introduce Parameter' changes based on
314 the parameters sent by the server. 411 the parameters sent by the server.
315 </p><dl> 412 </p>
316 <dt><i>params</i> (dict)</dt> 413 <dl>
317 <dd> 414
318 dictionary containing the method parameters sent by 415 <dt><i>params</i> (dict)</dt>
319 the server 416 <dd>
320 </dd> 417 dictionary containing the method parameters sent by
321 </dl><a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a> 418 the server
419 </dd>
420 </dl>
421 <a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
322 <h4>RefactoringClient.__calculateLocalToAttributeChanges</h4> 422 <h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
323 <b>__calculateLocalToAttributeChanges</b>(<i>params</i>) 423 <b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
424
324 <p> 425 <p>
325 Private method to calculate the 'Local Variabe to Attribute' changes 426 Private method to calculate the 'Local Variabe to Attribute' changes
326 based on the parameters sent by the server. 427 based on the parameters sent by the server.
327 </p><dl> 428 </p>
328 <dt><i>params</i> (dict)</dt> 429 <dl>
329 <dd> 430
330 dictionary containing the method parameters sent by 431 <dt><i>params</i> (dict)</dt>
331 the server 432 <dd>
332 </dd> 433 dictionary containing the method parameters sent by
333 </dl><a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a> 434 the server
435 </dd>
436 </dl>
437 <a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
334 <h4>RefactoringClient.__calculateMethodObjectChanges</h4> 438 <h4>RefactoringClient.__calculateMethodObjectChanges</h4>
335 <b>__calculateMethodObjectChanges</b>(<i>params</i>) 439 <b>__calculateMethodObjectChanges</b>(<i>params</i>)
440
336 <p> 441 <p>
337 Private method to calculate the 'Method to Method Object' changes 442 Private method to calculate the 'Method to Method Object' changes
338 based on the parameters sent by the server. 443 based on the parameters sent by the server.
339 </p><dl> 444 </p>
340 <dt><i>params</i> (dict)</dt> 445 <dl>
341 <dd> 446
342 dictionary containing the method parameters sent by 447 <dt><i>params</i> (dict)</dt>
343 the server 448 <dd>
344 </dd> 449 dictionary containing the method parameters sent by
345 </dl><a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a> 450 the server
451 </dd>
452 </dl>
453 <a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
346 <h4>RefactoringClient.__calculateModuleToPackageChanges</h4> 454 <h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
347 <b>__calculateModuleToPackageChanges</b>(<i>params</i>) 455 <b>__calculateModuleToPackageChanges</b>(<i>params</i>)
456
348 <p> 457 <p>
349 Private method to calculate the 'Module to Package' changes 458 Private method to calculate the 'Module to Package' changes
350 based on the parameters sent by the server. 459 based on the parameters sent by the server.
351 </p><dl> 460 </p>
352 <dt><i>params</i> (dict)</dt> 461 <dl>
353 <dd> 462
354 dictionary containing the method parameters sent by 463 <dt><i>params</i> (dict)</dt>
355 the server 464 <dd>
356 </dd> 465 dictionary containing the method parameters sent by
357 </dl><a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a> 466 the server
467 </dd>
468 </dl>
469 <a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
358 <h4>RefactoringClient.__calculateMoveChanges</h4> 470 <h4>RefactoringClient.__calculateMoveChanges</h4>
359 <b>__calculateMoveChanges</b>(<i>params</i>) 471 <b>__calculateMoveChanges</b>(<i>params</i>)
472
360 <p> 473 <p>
361 Private method to calculate the 'Move ...' changes based on the 474 Private method to calculate the 'Move ...' changes based on the
362 parameters sent by the server. 475 parameters sent by the server.
363 </p><dl> 476 </p>
364 <dt><i>params</i> (dict)</dt> 477 <dl>
365 <dd> 478
366 dictionary containing the method parameters sent by 479 <dt><i>params</i> (dict)</dt>
367 the server 480 <dd>
368 </dd> 481 dictionary containing the method parameters sent by
369 </dl><a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a> 482 the server
483 </dd>
484 </dl>
485 <a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
370 <h4>RefactoringClient.__calculateRenameChanges</h4> 486 <h4>RefactoringClient.__calculateRenameChanges</h4>
371 <b>__calculateRenameChanges</b>(<i>params</i>) 487 <b>__calculateRenameChanges</b>(<i>params</i>)
488
372 <p> 489 <p>
373 Private method to calculate the rename changes based on the parameters 490 Private method to calculate the rename changes based on the parameters
374 sent by the server. 491 sent by the server.
375 </p><dl> 492 </p>
376 <dt><i>params</i> (dict)</dt> 493 <dl>
377 <dd> 494
378 dictionary containing the method parameters sent by 495 <dt><i>params</i> (dict)</dt>
379 the server 496 <dd>
380 </dd> 497 dictionary containing the method parameters sent by
381 </dl><a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a> 498 the server
499 </dd>
500 </dl>
501 <a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
382 <h4>RefactoringClient.__calculateRestructureChanges</h4> 502 <h4>RefactoringClient.__calculateRestructureChanges</h4>
383 <b>__calculateRestructureChanges</b>(<i>params</i>) 503 <b>__calculateRestructureChanges</b>(<i>params</i>)
504
384 <p> 505 <p>
385 Private method to calculate the 'Restructure' changes based on the 506 Private method to calculate the 'Restructure' changes based on the
386 parameters sent by the server. 507 parameters sent by the server.
387 </p><dl> 508 </p>
388 <dt><i>params</i> (dict)</dt> 509 <dl>
389 <dd> 510
390 dictionary containing the method parameters sent by 511 <dt><i>params</i> (dict)</dt>
391 the server 512 <dd>
392 </dd> 513 dictionary containing the method parameters sent by
393 </dl><a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a> 514 the server
515 </dd>
516 </dl>
517 <a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
394 <h4>RefactoringClient.__calculateSignatureChanges</h4> 518 <h4>RefactoringClient.__calculateSignatureChanges</h4>
395 <b>__calculateSignatureChanges</b>(<i>params</i>) 519 <b>__calculateSignatureChanges</b>(<i>params</i>)
520
396 <p> 521 <p>
397 Private method to calculate the 'Signature' changes based on the 522 Private method to calculate the 'Signature' changes based on the
398 parameters sent by the server. 523 parameters sent by the server.
399 </p><dl> 524 </p>
400 <dt><i>params</i> (dict)</dt> 525 <dl>
401 <dd> 526
402 dictionary containing the method parameters sent by 527 <dt><i>params</i> (dict)</dt>
403 the server 528 <dd>
404 </dd> 529 dictionary containing the method parameters sent by
405 </dl><a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a> 530 the server
531 </dd>
532 </dl>
533 <a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
406 <h4>RefactoringClient.__calculateUseFunctionChanges</h4> 534 <h4>RefactoringClient.__calculateUseFunctionChanges</h4>
407 <b>__calculateUseFunctionChanges</b>(<i>params</i>) 535 <b>__calculateUseFunctionChanges</b>(<i>params</i>)
536
408 <p> 537 <p>
409 Private method to calculate the 'Use Function' changes based on the 538 Private method to calculate the 'Use Function' changes based on the
410 parameters sent by the server. 539 parameters sent by the server.
411 </p><dl> 540 </p>
412 <dt><i>params</i> (dict)</dt> 541 <dl>
413 <dd> 542
414 dictionary containing the method parameters sent by 543 <dt><i>params</i> (dict)</dt>
415 the server 544 <dd>
416 </dd> 545 dictionary containing the method parameters sent by
417 </dl><a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a> 546 the server
547 </dd>
548 </dl>
549 <a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
418 <h4>RefactoringClient.__clearChanges</h4> 550 <h4>RefactoringClient.__clearChanges</h4>
419 <b>__clearChanges</b>(<i>params</i>) 551 <b>__clearChanges</b>(<i>params</i>)
552
420 <p> 553 <p>
421 Private method to clear the changes cache of a given change group. 554 Private method to clear the changes cache of a given change group.
422 </p><dl> 555 </p>
423 <dt><i>params</i> (dict)</dt> 556 <dl>
424 <dd> 557
425 dictionary containing the method parameters sent by 558 <dt><i>params</i> (dict)</dt>
426 the server 559 <dd>
427 </dd> 560 dictionary containing the method parameters sent by
428 </dl><a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a> 561 the server
562 </dd>
563 </dl>
564 <a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
429 <h4>RefactoringClient.__closeProject</h4> 565 <h4>RefactoringClient.__closeProject</h4>
430 <b>__closeProject</b>(<i>params</i>) 566 <b>__closeProject</b>(<i>params</i>)
567
431 <p> 568 <p>
432 Private slot to validate the project. 569 Private slot to validate the project.
433 </p><dl> 570 </p>
434 <dt><i>params</i> (dict)</dt> 571 <dl>
435 <dd> 572
436 dictionary containing the method parameters sent by 573 <dt><i>params</i> (dict)</dt>
437 the server 574 <dd>
438 </dd> 575 dictionary containing the method parameters sent by
439 </dl><a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a> 576 the server
577 </dd>
578 </dl>
579 <a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
440 <h4>RefactoringClient.__configChanged</h4> 580 <h4>RefactoringClient.__configChanged</h4>
441 <b>__configChanged</b>(<i>params</i>) 581 <b>__configChanged</b>(<i>params</i>)
582
442 <p> 583 <p>
443 Private method to handle a change of the configuration file. 584 Private method to handle a change of the configuration file.
444 </p><dl> 585 </p>
445 <dt><i>params</i> (dict)</dt> 586 <dl>
446 <dd> 587
447 dictionary containing the method parameters sent by 588 <dt><i>params</i> (dict)</dt>
448 the server 589 <dd>
449 </dd> 590 dictionary containing the method parameters sent by
450 </dl><a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a> 591 the server
592 </dd>
593 </dl>
594 <a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
451 <h4>RefactoringClient.__confirmUnsure</h4> 595 <h4>RefactoringClient.__confirmUnsure</h4>
452 <b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>) 596 <b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>)
597
453 <p> 598 <p>
454 Private method to confirm unsure occurrences. 599 Private method to confirm unsure occurrences.
455 </p><dl> 600 </p>
601 <dl>
602
456 <dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt> 603 <dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt>
457 <dd> 604 <dd>
458 reference to the occurrence object 605 reference to the occurrence object
459 </dd><dt><i>changeGroup</i> (str)</dt> 606 </dd>
607 <dt><i>changeGroup</i> (str)</dt>
460 <dd> 608 <dd>
461 name of the change group 609 name of the change group
462 </dd> 610 </dd>
463 </dl><dl> 611 </dl>
612 <dl>
464 <dt>Returns:</dt> 613 <dt>Returns:</dt>
465 <dd> 614 <dd>
466 flag indicating an occurrence 615 flag indicating an occurrence
467 </dd> 616 </dd>
468 </dl><dl> 617 </dl>
618 <dl>
469 <dt>Return Type:</dt> 619 <dt>Return Type:</dt>
470 <dd> 620 <dd>
471 bool 621 bool
472 </dd> 622 </dd>
473 </dl><a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a> 623 </dl>
624 <a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
474 <h4>RefactoringClient.__getConfig</h4> 625 <h4>RefactoringClient.__getConfig</h4>
475 <b>__getConfig</b>(<i>params</i>) 626 <b>__getConfig</b>(<i>params</i>)
627
476 <p> 628 <p>
477 Private method to send some configuration data to the server. 629 Private method to send some configuration data to the server.
478 </p><dl> 630 </p>
479 <dt><i>params</i> (dict)</dt> 631 <dl>
480 <dd> 632
481 dictionary containing the method parameters sent by 633 <dt><i>params</i> (dict)</dt>
482 the server 634 <dd>
483 </dd> 635 dictionary containing the method parameters sent by
484 </dl><a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a> 636 the server
637 </dd>
638 </dl>
639 <a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
485 <h4>RefactoringClient.__handleRopeError</h4> 640 <h4>RefactoringClient.__handleRopeError</h4>
486 <b>__handleRopeError</b>(<i>err</i>) 641 <b>__handleRopeError</b>(<i>err</i>)
642
487 <p> 643 <p>
488 Private method to process a rope error. 644 Private method to process a rope error.
489 </p><dl> 645 </p>
646 <dl>
647
490 <dt><i>err</i> (Exception)</dt> 648 <dt><i>err</i> (Exception)</dt>
491 <dd> 649 <dd>
492 rope exception object 650 rope exception object
493 </dd> 651 </dd>
494 </dl><dl> 652 </dl>
653 <dl>
495 <dt>Returns:</dt> 654 <dt>Returns:</dt>
496 <dd> 655 <dd>
497 dictionary containing the error information 656 dictionary containing the error information
498 </dd> 657 </dd>
499 </dl><dl> 658 </dl>
659 <dl>
500 <dt>Return Type:</dt> 660 <dt>Return Type:</dt>
501 <dd> 661 <dd>
502 dict 662 dict
503 </dd> 663 </dd>
504 </dl><a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a> 664 </dl>
665 <a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
505 <h4>RefactoringClient.__performSOA</h4> 666 <h4>RefactoringClient.__performSOA</h4>
506 <b>__performSOA</b>(<i>params</i>) 667 <b>__performSOA</b>(<i>params</i>)
668
507 <p> 669 <p>
508 Private method to perform SOA on all modules. 670 Private method to perform SOA on all modules.
509 </p><dl> 671 </p>
510 <dt><i>params</i> (dict)</dt> 672 <dl>
511 <dd> 673
512 dictionary containing the method parameters sent by 674 <dt><i>params</i> (dict)</dt>
513 the server 675 <dd>
514 </dd> 676 dictionary containing the method parameters sent by
515 </dl><a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a> 677 the server
678 </dd>
679 </dl>
680 <a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
516 <h4>RefactoringClient.__previewChanges</h4> 681 <h4>RefactoringClient.__previewChanges</h4>
517 <b>__previewChanges</b>(<i>params</i>) 682 <b>__previewChanges</b>(<i>params</i>)
683
518 <p> 684 <p>
519 Private method to determine the changes data for a preview. 685 Private method to determine the changes data for a preview.
520 </p><dl> 686 </p>
521 <dt><i>params</i> (dict)</dt> 687 <dl>
522 <dd> 688
523 dictionary containing the method parameters sent by 689 <dt><i>params</i> (dict)</dt>
524 the server 690 <dd>
525 </dd> 691 dictionary containing the method parameters sent by
526 </dl><a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a> 692 the server
693 </dd>
694 </dl>
695 <a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
527 <h4>RefactoringClient.__processHistory</h4> 696 <h4>RefactoringClient.__processHistory</h4>
528 <b>__processHistory</b>(<i>params</i>) 697 <b>__processHistory</b>(<i>params</i>)
698
529 <p> 699 <p>
530 Private method to process the various history related requests. 700 Private method to process the various history related requests.
531 </p><dl> 701 </p>
532 <dt><i>params</i> (dict)</dt> 702 <dl>
533 <dd> 703
534 dictionary containing the method parameters sent by 704 <dt><i>params</i> (dict)</dt>
535 the server 705 <dd>
536 </dd> 706 dictionary containing the method parameters sent by
537 </dl><a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a> 707 the server
708 </dd>
709 </dl>
710 <a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
538 <h4>RefactoringClient.__queryDefinition</h4> 711 <h4>RefactoringClient.__queryDefinition</h4>
539 <b>__queryDefinition</b>(<i>params</i>) 712 <b>__queryDefinition</b>(<i>params</i>)
713
540 <p> 714 <p>
541 Private method to handle the Find Definition action. 715 Private method to handle the Find Definition action.
542 </p><dl> 716 </p>
543 <dt><i>params</i> (dict)</dt> 717 <dl>
544 <dd> 718
545 dictionary containing the method parameters sent by 719 <dt><i>params</i> (dict)</dt>
546 the server 720 <dd>
547 </dd> 721 dictionary containing the method parameters sent by
548 </dl><a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a> 722 the server
723 </dd>
724 </dl>
725 <a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
549 <h4>RefactoringClient.__queryImplementations</h4> 726 <h4>RefactoringClient.__queryImplementations</h4>
550 <b>__queryImplementations</b>(<i>params</i>) 727 <b>__queryImplementations</b>(<i>params</i>)
728
551 <p> 729 <p>
552 Private method to handle the Find Implementations action. 730 Private method to handle the Find Implementations action.
553 </p><dl> 731 </p>
554 <dt><i>params</i> (dict)</dt> 732 <dl>
555 <dd> 733
556 dictionary containing the method parameters sent by 734 <dt><i>params</i> (dict)</dt>
557 the server 735 <dd>
558 </dd> 736 dictionary containing the method parameters sent by
559 </dl><a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a> 737 the server
738 </dd>
739 </dl>
740 <a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
560 <h4>RefactoringClient.__queryReferences</h4> 741 <h4>RefactoringClient.__queryReferences</h4>
561 <b>__queryReferences</b>(<i>params</i>) 742 <b>__queryReferences</b>(<i>params</i>)
743
562 <p> 744 <p>
563 Private method to handle the Find References action. 745 Private method to handle the Find References action.
564 </p><dl> 746 </p>
565 <dt><i>params</i> (dict)</dt> 747 <dl>
566 <dd> 748
567 dictionary containing the method parameters sent by 749 <dt><i>params</i> (dict)</dt>
568 the server 750 <dd>
569 </dd> 751 dictionary containing the method parameters sent by
570 </dl><a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a> 752 the server
753 </dd>
754 </dl>
755 <a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
571 <h4>RefactoringClient.__reportChanged</h4> 756 <h4>RefactoringClient.__reportChanged</h4>
572 <b>__reportChanged</b>(<i>params</i>) 757 <b>__reportChanged</b>(<i>params</i>)
758
573 <p> 759 <p>
574 Private method to register some changed sources. 760 Private method to register some changed sources.
575 </p><dl> 761 </p>
576 <dt><i>params</i> (dict)</dt> 762 <dl>
577 <dd> 763
578 dictionary containing the method parameters sent by 764 <dt><i>params</i> (dict)</dt>
579 the server 765 <dd>
580 </dd> 766 dictionary containing the method parameters sent by
581 </dl><a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a> 767 the server
768 </dd>
769 </dl>
770 <a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
582 <h4>RefactoringClient.__requestFieldName</h4> 771 <h4>RefactoringClient.__requestFieldName</h4>
583 <b>__requestFieldName</b>(<i>params</i>) 772 <b>__requestFieldName</b>(<i>params</i>)
773
584 <p> 774 <p>
585 Private method to calculate the 'Field Name' based on the parameters 775 Private method to calculate the 'Field Name' based on the parameters
586 sent by the server. 776 sent by the server.
587 </p><dl> 777 </p>
588 <dt><i>params</i> (dict)</dt> 778 <dl>
589 <dd> 779
590 dictionary containing the method parameters sent by 780 <dt><i>params</i> (dict)</dt>
591 the server 781 <dd>
592 </dd> 782 dictionary containing the method parameters sent by
593 </dl><a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a> 783 the server
784 </dd>
785 </dl>
786 <a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
594 <h4>RefactoringClient.__requestInlineType</h4> 787 <h4>RefactoringClient.__requestInlineType</h4>
595 <b>__requestInlineType</b>(<i>params</i>) 788 <b>__requestInlineType</b>(<i>params</i>)
789
596 <p> 790 <p>
597 Private method to determine the 'Inline' changes type based on the 791 Private method to determine the 'Inline' changes type based on the
598 parameters sent by the server. 792 parameters sent by the server.
599 </p><dl> 793 </p>
600 <dt><i>params</i> (dict)</dt> 794 <dl>
601 <dd> 795
602 dictionary containing the method parameters sent by 796 <dt><i>params</i> (dict)</dt>
603 the server 797 <dd>
604 </dd> 798 dictionary containing the method parameters sent by
605 </dl><a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a> 799 the server
800 </dd>
801 </dl>
802 <a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
606 <h4>RefactoringClient.__requestMoveType</h4> 803 <h4>RefactoringClient.__requestMoveType</h4>
607 <b>__requestMoveType</b>(<i>params</i>) 804 <b>__requestMoveType</b>(<i>params</i>)
805
608 <p> 806 <p>
609 Private method to determine the 'Move Method' changes type based on the 807 Private method to determine the 'Move Method' changes type based on the
610 parameters sent by the server. 808 parameters sent by the server.
611 </p><dl> 809 </p>
612 <dt><i>params</i> (dict)</dt> 810 <dl>
613 <dd> 811
614 dictionary containing the method parameters sent by 812 <dt><i>params</i> (dict)</dt>
615 the server 813 <dd>
616 </dd> 814 dictionary containing the method parameters sent by
617 </dl><a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a> 815 the server
816 </dd>
817 </dl>
818 <a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
618 <h4>RefactoringClient.__requestSignature</h4> 819 <h4>RefactoringClient.__requestSignature</h4>
619 <b>__requestSignature</b>(<i>params</i>) 820 <b>__requestSignature</b>(<i>params</i>)
821
620 <p> 822 <p>
621 Private method to calculate the 'Signature' based on the parameters 823 Private method to calculate the 'Signature' based on the parameters
622 sent by the server. 824 sent by the server.
623 </p><dl> 825 </p>
624 <dt><i>params</i> (dict)</dt> 826 <dl>
625 <dd> 827
626 dictionary containing the method parameters sent by 828 <dt><i>params</i> (dict)</dt>
627 the server 829 <dd>
628 </dd> 830 dictionary containing the method parameters sent by
629 </dl><a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a> 831 the server
832 </dd>
833 </dl>
834 <a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
630 <h4>RefactoringClient.__requestUseFunction</h4> 835 <h4>RefactoringClient.__requestUseFunction</h4>
631 <b>__requestUseFunction</b>(<i>params</i>) 836 <b>__requestUseFunction</b>(<i>params</i>)
837
632 <p> 838 <p>
633 Private method to determine the 'Use Function' function name based on 839 Private method to determine the 'Use Function' function name based on
634 the parameters sent by the server. 840 the parameters sent by the server.
635 </p><dl> 841 </p>
636 <dt><i>params</i> (dict)</dt> 842 <dl>
637 <dd> 843
638 dictionary containing the method parameters sent by 844 <dt><i>params</i> (dict)</dt>
639 the server 845 <dd>
640 </dd> 846 dictionary containing the method parameters sent by
641 </dl><a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a> 847 the server
848 </dd>
849 </dl>
850 <a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
642 <h4>RefactoringClient.__validate</h4> 851 <h4>RefactoringClient.__validate</h4>
643 <b>__validate</b>(<i>params</i>) 852 <b>__validate</b>(<i>params</i>)
853
644 <p> 854 <p>
645 Private slot to validate the project. 855 Private slot to validate the project.
646 </p><dl> 856 </p>
647 <dt><i>params</i> (dict)</dt> 857 <dl>
648 <dd> 858
649 dictionary containing the method parameters sent by 859 <dt><i>params</i> (dict)</dt>
650 the server 860 <dd>
651 </dd> 861 dictionary containing the method parameters sent by
652 </dl><a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a> 862 the server
863 </dd>
864 </dl>
865 <a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
653 <h4>RefactoringClient.handleCall</h4> 866 <h4>RefactoringClient.handleCall</h4>
654 <b>handleCall</b>(<i>method, params</i>) 867 <b>handleCall</b>(<i>method, params</i>)
868
655 <p> 869 <p>
656 Public method to handle a method call from the server. 870 Public method to handle a method call from the server.
657 </p><dl> 871 </p>
872 <dl>
873
658 <dt><i>method</i> (str)</dt> 874 <dt><i>method</i> (str)</dt>
659 <dd> 875 <dd>
660 requested method name 876 requested method name
661 </dd><dt><i>params</i> (dict)</dt> 877 </dd>
878 <dt><i>params</i> (dict)</dt>
662 <dd> 879 <dd>
663 dictionary with method specific parameters 880 dictionary with method specific parameters
664 </dd> 881 </dd>
665 </dl> 882 </dl>
666 <div align="right"><a href="#top">Up</a></div> 883 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: Rope Refactoring

eric ide

mercurial