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

branch
server_client_variant
changeset 204
b4bf79b956bc
child 283
d98e971d9e4c
equal deleted inserted replaced
203:c38750e1bafd 204:b4bf79b956bc
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1>
23 <p>
24 Module implementing the refactoring client interface to rope.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#RefactoringClient">RefactoringClient</a></td>
34 <td>Class implementing the refactoring client interface to rope.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="RefactoringClient" ID="RefactoringClient"></a>
43 <h2>RefactoringClient</h2>
44 <p>
45 Class implementing the refactoring client interface to rope.
46 </p>
47 <h3>Derived from</h3>
48 JsonClient
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>client</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#RefactoringClient.__init__">RefactoringClient</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#RefactoringClient.__abortAction">__abortAction</a></td>
64 <td>Private method to abort the current action.</td>
65 </tr><tr>
66 <td><a href="#RefactoringClient.__applyChanges">__applyChanges</a></td>
67 <td>Private method to apply the changes of a given change group.</td>
68 </tr><tr>
69 <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>
71 </tr><tr>
72 <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>
74 </tr><tr>
75 <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>
77 </tr><tr>
78 <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>
80 </tr><tr>
81 <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>
83 </tr><tr>
84 <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>
86 </tr><tr>
87 <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>
89 </tr><tr>
90 <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>
92 </tr><tr>
93 <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>
95 </tr><tr>
96 <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>
98 </tr><tr>
99 <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>
101 </tr><tr>
102 <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>
104 </tr><tr>
105 <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>
107 </tr><tr>
108 <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>
110 </tr><tr>
111 <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>
113 </tr><tr>
114 <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>
116 </tr><tr>
117 <td><a href="#RefactoringClient.__clearChanges">__clearChanges</a></td>
118 <td>Private method to clear the changes cache of a given change group.</td>
119 </tr><tr>
120 <td><a href="#RefactoringClient.__closeProject">__closeProject</a></td>
121 <td>Private slot to validate the project.</td>
122 </tr><tr>
123 <td><a href="#RefactoringClient.__configChanged">__configChanged</a></td>
124 <td>Private method to handle a change of the configuration file.</td>
125 </tr><tr>
126 <td><a href="#RefactoringClient.__confirmUnsure">__confirmUnsure</a></td>
127 <td>Private method to confirm unsure occurrences.</td>
128 </tr><tr>
129 <td><a href="#RefactoringClient.__getConfig">__getConfig</a></td>
130 <td>Private method to send some configuration data to the server.</td>
131 </tr><tr>
132 <td><a href="#RefactoringClient.__handleRopeError">__handleRopeError</a></td>
133 <td>Private method to process a rope error.</td>
134 </tr><tr>
135 <td><a href="#RefactoringClient.__performSOA">__performSOA</a></td>
136 <td>Private method to perform SOA on all modules.</td>
137 </tr><tr>
138 <td><a href="#RefactoringClient.__previewChanges">__previewChanges</a></td>
139 <td>Private method to determine the changes data for a preview.</td>
140 </tr><tr>
141 <td><a href="#RefactoringClient.__processHistory">__processHistory</a></td>
142 <td>Private method to process the various history related requests.</td>
143 </tr><tr>
144 <td><a href="#RefactoringClient.__queryDefinition">__queryDefinition</a></td>
145 <td>Private method to handle the Find Definition action.</td>
146 </tr><tr>
147 <td><a href="#RefactoringClient.__queryImplementations">__queryImplementations</a></td>
148 <td>Private method to handle the Find Implementations action.</td>
149 </tr><tr>
150 <td><a href="#RefactoringClient.__queryReferences">__queryReferences</a></td>
151 <td>Private method to handle the Find References action.</td>
152 </tr><tr>
153 <td><a href="#RefactoringClient.__reportChanged">__reportChanged</a></td>
154 <td>Private method to register some changed sources.</td>
155 </tr><tr>
156 <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>
158 </tr><tr>
159 <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>
161 </tr><tr>
162 <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>
164 </tr><tr>
165 <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>
167 </tr><tr>
168 <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>
170 </tr><tr>
171 <td><a href="#RefactoringClient.__validate">__validate</a></td>
172 <td>Private slot to validate the project.</td>
173 </tr><tr>
174 <td><a href="#RefactoringClient.handleCall">handleCall</a></td>
175 <td>Public method to handle a method call from the server.</td>
176 </tr>
177 </table>
178 <h3>Static Methods</h3>
179 <table>
180 <tr><td>None</td></tr>
181 </table>
182 <a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a>
183 <h4>RefactoringClient (Constructor)</h4>
184 <b>RefactoringClient</b>(<i>host, port, projectPath</i>)
185 <p>
186 Constructor
187 </p><dl>
188 <dt><i>host</i> (str)</dt>
189 <dd>
190 ip address the background service is listening
191 </dd><dt><i>port</i> (int)</dt>
192 <dd>
193 port of the background service
194 </dd><dt><i>projectPath</i> (str)</dt>
195 <dd>
196 path to the project
197 </dd>
198 </dl><a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
199 <h4>RefactoringClient.__abortAction</h4>
200 <b>__abortAction</b>(<i>params</i>)
201 <p>
202 Private method to abort the current action.
203 </p><dl>
204 <dt><i>params</i> (dict)</dt>
205 <dd>
206 dictionary containing the method parameters sent by
207 the server
208 </dd>
209 </dl><a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
210 <h4>RefactoringClient.__applyChanges</h4>
211 <b>__applyChanges</b>(<i>params</i>)
212 <p>
213 Private method to apply the changes of a given change group.
214 </p><dl>
215 <dt><i>params</i> (dict)</dt>
216 <dd>
217 dictionary containing the method parameters sent by
218 the server
219 </dd>
220 </dl><a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
221 <h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4>
222 <b>__calculateChangeOccurrencesChanges</b>(<i>params</i>)
223 <p>
224 Private method to calculate the 'Change Occurrences' changes based on
225 the parameters sent by the server.
226 </p><dl>
227 <dt><i>params</i> (dict)</dt>
228 <dd>
229 dictionary containing the method parameters sent by
230 the server
231 </dd>
232 </dl><a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
233 <h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4>
234 <b>__calculateEncapsulateFieldChanges</b>(<i>params</i>)
235 <p>
236 Private method to calculate the 'Encapsulate Field' changes based on
237 the parameters sent by the server.
238 </p><dl>
239 <dt><i>params</i> (dict)</dt>
240 <dd>
241 dictionary containing the method parameters sent by
242 the server
243 </dd>
244 </dl><a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
245 <h4>RefactoringClient.__calculateExtractChanges</h4>
246 <b>__calculateExtractChanges</b>(<i>params</i>)
247 <p>
248 Private method to calculate the 'Extract' changes based on the
249 parameters sent by the server.
250 </p><dl>
251 <dt><i>params</i> (dict)</dt>
252 <dd>
253 dictionary containing the method parameters sent by
254 the server
255 </dd>
256 </dl><dl>
257 <dt>Raises <b>Exception</b>:</dt>
258 <dd>
259 raised to indicate an invalid extraction type
260 </dd>
261 </dl><a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
262 <h4>RefactoringClient.__calculateImportsChanges</h4>
263 <b>__calculateImportsChanges</b>(<i>params</i>)
264 <p>
265 Private method to calculate the 'Import' changes based on the
266 parameters sent by the server.
267 </p><dl>
268 <dt><i>params</i> (dict)</dt>
269 <dd>
270 dictionary containing the method parameters sent by
271 the server
272 </dd>
273 </dl><a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
274 <h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4>
275 <b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>)
276 <p>
277 Private method to calculate the 'Inline Argument Default' changes
278 based on the parameters sent by the server.
279 </p><dl>
280 <dt><i>params</i> (dict)</dt>
281 <dd>
282 dictionary containing the method parameters sent by
283 the server
284 </dd>
285 </dl><a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
286 <h4>RefactoringClient.__calculateInlineChanges</h4>
287 <b>__calculateInlineChanges</b>(<i>params</i>)
288 <p>
289 Private method to calculate the 'Inline' changes based on the
290 parameters sent by the server.
291 </p><dl>
292 <dt><i>params</i> (dict)</dt>
293 <dd>
294 dictionary containing the method parameters sent by
295 the server
296 </dd>
297 </dl><a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
298 <h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4>
299 <b>__calculateIntroduceFactoryChanges</b>(<i>params</i>)
300 <p>
301 Private method to calculate the 'Introduce Factory' changes based on
302 the parameters sent by the server.
303 </p><dl>
304 <dt><i>params</i> (dict)</dt>
305 <dd>
306 dictionary containing the method parameters sent by
307 the server
308 </dd>
309 </dl><a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
310 <h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
311 <b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
312 <p>
313 Private method to calculate the 'Introduce Parameter' changes based on
314 the parameters sent by the server.
315 </p><dl>
316 <dt><i>params</i> (dict)</dt>
317 <dd>
318 dictionary containing the method parameters sent by
319 the server
320 </dd>
321 </dl><a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
322 <h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
323 <b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
324 <p>
325 Private method to calculate the 'Local Variabe to Attribute' changes
326 based on the parameters sent by the server.
327 </p><dl>
328 <dt><i>params</i> (dict)</dt>
329 <dd>
330 dictionary containing the method parameters sent by
331 the server
332 </dd>
333 </dl><a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
334 <h4>RefactoringClient.__calculateMethodObjectChanges</h4>
335 <b>__calculateMethodObjectChanges</b>(<i>params</i>)
336 <p>
337 Private method to calculate the 'Method to Method Object' changes
338 based on the parameters sent by the server.
339 </p><dl>
340 <dt><i>params</i> (dict)</dt>
341 <dd>
342 dictionary containing the method parameters sent by
343 the server
344 </dd>
345 </dl><a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
346 <h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
347 <b>__calculateModuleToPackageChanges</b>(<i>params</i>)
348 <p>
349 Private method to calculate the 'Module to Package' changes
350 based on the parameters sent by the server.
351 </p><dl>
352 <dt><i>params</i> (dict)</dt>
353 <dd>
354 dictionary containing the method parameters sent by
355 the server
356 </dd>
357 </dl><a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
358 <h4>RefactoringClient.__calculateMoveChanges</h4>
359 <b>__calculateMoveChanges</b>(<i>params</i>)
360 <p>
361 Private method to calculate the 'Move ...' changes based on the
362 parameters sent by the server.
363 </p><dl>
364 <dt><i>params</i> (dict)</dt>
365 <dd>
366 dictionary containing the method parameters sent by
367 the server
368 </dd>
369 </dl><a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
370 <h4>RefactoringClient.__calculateRenameChanges</h4>
371 <b>__calculateRenameChanges</b>(<i>params</i>)
372 <p>
373 Private method to calculate the rename changes based on the parameters
374 sent by the server.
375 </p><dl>
376 <dt><i>params</i> (dict)</dt>
377 <dd>
378 dictionary containing the method parameters sent by
379 the server
380 </dd>
381 </dl><a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
382 <h4>RefactoringClient.__calculateRestructureChanges</h4>
383 <b>__calculateRestructureChanges</b>(<i>params</i>)
384 <p>
385 Private method to calculate the 'Restructure' changes based on the
386 parameters sent by the server.
387 </p><dl>
388 <dt><i>params</i> (dict)</dt>
389 <dd>
390 dictionary containing the method parameters sent by
391 the server
392 </dd>
393 </dl><a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
394 <h4>RefactoringClient.__calculateSignatureChanges</h4>
395 <b>__calculateSignatureChanges</b>(<i>params</i>)
396 <p>
397 Private method to calculate the 'Signature' changes based on the
398 parameters sent by the server.
399 </p><dl>
400 <dt><i>params</i> (dict)</dt>
401 <dd>
402 dictionary containing the method parameters sent by
403 the server
404 </dd>
405 </dl><a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
406 <h4>RefactoringClient.__calculateUseFunctionChanges</h4>
407 <b>__calculateUseFunctionChanges</b>(<i>params</i>)
408 <p>
409 Private method to calculate the 'Use Function' changes based on the
410 parameters sent by the server.
411 </p><dl>
412 <dt><i>params</i> (dict)</dt>
413 <dd>
414 dictionary containing the method parameters sent by
415 the server
416 </dd>
417 </dl><a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
418 <h4>RefactoringClient.__clearChanges</h4>
419 <b>__clearChanges</b>(<i>params</i>)
420 <p>
421 Private method to clear the changes cache of a given change group.
422 </p><dl>
423 <dt><i>params</i> (dict)</dt>
424 <dd>
425 dictionary containing the method parameters sent by
426 the server
427 </dd>
428 </dl><a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
429 <h4>RefactoringClient.__closeProject</h4>
430 <b>__closeProject</b>(<i>params</i>)
431 <p>
432 Private slot to validate the project.
433 </p><dl>
434 <dt><i>params</i> (dict)</dt>
435 <dd>
436 dictionary containing the method parameters sent by
437 the server
438 </dd>
439 </dl><a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
440 <h4>RefactoringClient.__configChanged</h4>
441 <b>__configChanged</b>(<i>params</i>)
442 <p>
443 Private method to handle a change of the configuration file.
444 </p><dl>
445 <dt><i>params</i> (dict)</dt>
446 <dd>
447 dictionary containing the method parameters sent by
448 the server
449 </dd>
450 </dl><a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
451 <h4>RefactoringClient.__confirmUnsure</h4>
452 <b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>)
453 <p>
454 Private method to confirm unsure occurrences.
455 </p><dl>
456 <dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt>
457 <dd>
458 reference to the occurrence object
459 </dd><dt><i>changeGroup</i> (str)</dt>
460 <dd>
461 name of the change group
462 </dd>
463 </dl><dl>
464 <dt>Returns:</dt>
465 <dd>
466 flag indicating an occurrence
467 </dd>
468 </dl><dl>
469 <dt>Return Type:</dt>
470 <dd>
471 bool
472 </dd>
473 </dl><a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
474 <h4>RefactoringClient.__getConfig</h4>
475 <b>__getConfig</b>(<i>params</i>)
476 <p>
477 Private method to send some configuration data to the server.
478 </p><dl>
479 <dt><i>params</i> (dict)</dt>
480 <dd>
481 dictionary containing the method parameters sent by
482 the server
483 </dd>
484 </dl><a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
485 <h4>RefactoringClient.__handleRopeError</h4>
486 <b>__handleRopeError</b>(<i>err</i>)
487 <p>
488 Private method to process a rope error.
489 </p><dl>
490 <dt><i>err</i> (Exception)</dt>
491 <dd>
492 rope exception object
493 </dd>
494 </dl><dl>
495 <dt>Returns:</dt>
496 <dd>
497 dictionary containing the error information
498 </dd>
499 </dl><dl>
500 <dt>Return Type:</dt>
501 <dd>
502 dict
503 </dd>
504 </dl><a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
505 <h4>RefactoringClient.__performSOA</h4>
506 <b>__performSOA</b>(<i>params</i>)
507 <p>
508 Private method to perform SOA on all modules.
509 </p><dl>
510 <dt><i>params</i> (dict)</dt>
511 <dd>
512 dictionary containing the method parameters sent by
513 the server
514 </dd>
515 </dl><a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
516 <h4>RefactoringClient.__previewChanges</h4>
517 <b>__previewChanges</b>(<i>params</i>)
518 <p>
519 Private method to determine the changes data for a preview.
520 </p><dl>
521 <dt><i>params</i> (dict)</dt>
522 <dd>
523 dictionary containing the method parameters sent by
524 the server
525 </dd>
526 </dl><a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
527 <h4>RefactoringClient.__processHistory</h4>
528 <b>__processHistory</b>(<i>params</i>)
529 <p>
530 Private method to process the various history related requests.
531 </p><dl>
532 <dt><i>params</i> (dict)</dt>
533 <dd>
534 dictionary containing the method parameters sent by
535 the server
536 </dd>
537 </dl><a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
538 <h4>RefactoringClient.__queryDefinition</h4>
539 <b>__queryDefinition</b>(<i>params</i>)
540 <p>
541 Private method to handle the Find Definition action.
542 </p><dl>
543 <dt><i>params</i> (dict)</dt>
544 <dd>
545 dictionary containing the method parameters sent by
546 the server
547 </dd>
548 </dl><a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
549 <h4>RefactoringClient.__queryImplementations</h4>
550 <b>__queryImplementations</b>(<i>params</i>)
551 <p>
552 Private method to handle the Find Implementations action.
553 </p><dl>
554 <dt><i>params</i> (dict)</dt>
555 <dd>
556 dictionary containing the method parameters sent by
557 the server
558 </dd>
559 </dl><a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
560 <h4>RefactoringClient.__queryReferences</h4>
561 <b>__queryReferences</b>(<i>params</i>)
562 <p>
563 Private method to handle the Find References action.
564 </p><dl>
565 <dt><i>params</i> (dict)</dt>
566 <dd>
567 dictionary containing the method parameters sent by
568 the server
569 </dd>
570 </dl><a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
571 <h4>RefactoringClient.__reportChanged</h4>
572 <b>__reportChanged</b>(<i>params</i>)
573 <p>
574 Private method to register some changed sources.
575 </p><dl>
576 <dt><i>params</i> (dict)</dt>
577 <dd>
578 dictionary containing the method parameters sent by
579 the server
580 </dd>
581 </dl><a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
582 <h4>RefactoringClient.__requestFieldName</h4>
583 <b>__requestFieldName</b>(<i>params</i>)
584 <p>
585 Private method to calculate the 'Field Name' based on the parameters
586 sent by the server.
587 </p><dl>
588 <dt><i>params</i> (dict)</dt>
589 <dd>
590 dictionary containing the method parameters sent by
591 the server
592 </dd>
593 </dl><a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
594 <h4>RefactoringClient.__requestInlineType</h4>
595 <b>__requestInlineType</b>(<i>params</i>)
596 <p>
597 Private method to determine the 'Inline' changes type based on the
598 parameters sent by the server.
599 </p><dl>
600 <dt><i>params</i> (dict)</dt>
601 <dd>
602 dictionary containing the method parameters sent by
603 the server
604 </dd>
605 </dl><a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
606 <h4>RefactoringClient.__requestMoveType</h4>
607 <b>__requestMoveType</b>(<i>params</i>)
608 <p>
609 Private method to determine the 'Move Method' changes type based on the
610 parameters sent by the server.
611 </p><dl>
612 <dt><i>params</i> (dict)</dt>
613 <dd>
614 dictionary containing the method parameters sent by
615 the server
616 </dd>
617 </dl><a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
618 <h4>RefactoringClient.__requestSignature</h4>
619 <b>__requestSignature</b>(<i>params</i>)
620 <p>
621 Private method to calculate the 'Signature' based on the parameters
622 sent by the server.
623 </p><dl>
624 <dt><i>params</i> (dict)</dt>
625 <dd>
626 dictionary containing the method parameters sent by
627 the server
628 </dd>
629 </dl><a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
630 <h4>RefactoringClient.__requestUseFunction</h4>
631 <b>__requestUseFunction</b>(<i>params</i>)
632 <p>
633 Private method to determine the 'Use Function' function name based on
634 the parameters sent by the server.
635 </p><dl>
636 <dt><i>params</i> (dict)</dt>
637 <dd>
638 dictionary containing the method parameters sent by
639 the server
640 </dd>
641 </dl><a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
642 <h4>RefactoringClient.__validate</h4>
643 <b>__validate</b>(<i>params</i>)
644 <p>
645 Private slot to validate the project.
646 </p><dl>
647 <dt><i>params</i> (dict)</dt>
648 <dd>
649 dictionary containing the method parameters sent by
650 the server
651 </dd>
652 </dl><a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
653 <h4>RefactoringClient.handleCall</h4>
654 <b>handleCall</b>(<i>method, params</i>)
655 <p>
656 Public method to handle a method call from the server.
657 </p><dl>
658 <dt><i>method</i> (str)</dt>
659 <dd>
660 requested method name
661 </dd><dt><i>params</i> (dict)</dt>
662 <dd>
663 dictionary with method specific parameters
664 </dd>
665 </dl>
666 <div align="right"><a href="#top">Up</a></div>
667 <hr />
668 </body></html>

Mercurial Repository: Rope Refactoring

eric ide

mercurial