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
eric7
changeset 416
45159308166f
parent 375
c61a2f18ed78
equal deleted inserted replaced
415:78af27bb8201 416:45159308166f
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringClient</h1>
10
11 <p> 10 <p>
12 Module implementing the refactoring client interface to rope. 11 Module implementing the refactoring client interface to rope.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
16 <tr><td>QCoreApplication</td></tr>
17 <tr><td>app</td></tr>
18 <tr><td>client</td></tr>
17 <tr><td>modulePath</td></tr> 19 <tr><td>modulePath</td></tr>
18 </table> 20 </table>
21
19 <h3>Classes</h3> 22 <h3>Classes</h3>
20
21 <table> 23 <table>
22
23 <tr> 24 <tr>
24 <td><a href="#RefactoringClient">RefactoringClient</a></td> 25 <td><a href="#RefactoringClient">RefactoringClient</a></td>
25 <td>Class implementing the refactoring client interface to rope.</td> 26 <td>Class implementing the refactoring client interface to rope.</td>
26 </tr> 27 </tr>
27 </table> 28 </table>
29
28 <h3>Functions</h3> 30 <h3>Functions</h3>
29
30 <table> 31 <table>
31 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
32 </table> 33 </table>
34
33 <hr /> 35 <hr />
34 <hr /> 36 <hr />
35 <a NAME="RefactoringClient" ID="RefactoringClient"></a> 37 <a NAME="RefactoringClient" ID="RefactoringClient"></a>
36 <h2>RefactoringClient</h2> 38 <h2>RefactoringClient</h2>
37
38 <p> 39 <p>
39 Class implementing the refactoring client interface to rope. 40 Class implementing the refactoring client interface to rope.
40 </p> 41 </p>
42
41 <h3>Derived from</h3> 43 <h3>Derived from</h3>
42 EricJsonClient 44 EricJsonClient
43 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
44
45 <table> 46 <table>
46 <tr><td>None</td></tr> 47 <tr><td>None</td></tr>
47 </table> 48 </table>
49
48 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
49
50 <table> 51 <table>
51 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
52 </table> 53 </table>
54
53 <h3>Methods</h3> 55 <h3>Methods</h3>
54
55 <table> 56 <table>
56
57 <tr> 57 <tr>
58 <td><a href="#RefactoringClient.__init__">RefactoringClient</a></td> 58 <td><a href="#RefactoringClient.__init__">RefactoringClient</a></td>
59 <td>Constructor</td> 59 <td>Constructor</td>
60 </tr> 60 </tr>
61 <tr> 61 <tr>
209 <tr> 209 <tr>
210 <td><a href="#RefactoringClient.handleCall">handleCall</a></td> 210 <td><a href="#RefactoringClient.handleCall">handleCall</a></td>
211 <td>Public method to handle a method call from the server.</td> 211 <td>Public method to handle a method call from the server.</td>
212 </tr> 212 </tr>
213 </table> 213 </table>
214
214 <h3>Static Methods</h3> 215 <h3>Static Methods</h3>
215
216 <table> 216 <table>
217 <tr><td>None</td></tr> 217 <tr><td>None</td></tr>
218 </table> 218 </table>
219 219
220
220 <a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a> 221 <a NAME="RefactoringClient.__init__" ID="RefactoringClient.__init__"></a>
221 <h4>RefactoringClient (Constructor)</h4> 222 <h4>RefactoringClient (Constructor)</h4>
222 <b>RefactoringClient</b>(<i>host, port, projectPath</i>) 223 <b>RefactoringClient</b>(<i>host, port, projectPath</i>)
223
224 <p> 224 <p>
225 Constructor 225 Constructor
226 </p> 226 </p>
227
227 <dl> 228 <dl>
228 229
229 <dt><i>host</i> (str)</dt> 230 <dt><i>host</i> (str)</dt>
230 <dd> 231 <dd>
231 ip address the background service is listening 232 ip address the background service is listening
240 </dd> 241 </dd>
241 </dl> 242 </dl>
242 <a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a> 243 <a NAME="RefactoringClient.__abortAction" ID="RefactoringClient.__abortAction"></a>
243 <h4>RefactoringClient.__abortAction</h4> 244 <h4>RefactoringClient.__abortAction</h4>
244 <b>__abortAction</b>(<i>params</i>) 245 <b>__abortAction</b>(<i>params</i>)
245
246 <p> 246 <p>
247 Private method to abort the current action. 247 Private method to abort the current action.
248 </p> 248 </p>
249
249 <dl> 250 <dl>
250 251
251 <dt><i>params</i> (dict)</dt> 252 <dt><i>params</i> (dict)</dt>
252 <dd> 253 <dd>
253 dictionary containing the method parameters sent by 254 dictionary containing the method parameters sent by
255 </dd> 256 </dd>
256 </dl> 257 </dl>
257 <a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a> 258 <a NAME="RefactoringClient.__applyChanges" ID="RefactoringClient.__applyChanges"></a>
258 <h4>RefactoringClient.__applyChanges</h4> 259 <h4>RefactoringClient.__applyChanges</h4>
259 <b>__applyChanges</b>(<i>params</i>) 260 <b>__applyChanges</b>(<i>params</i>)
260
261 <p> 261 <p>
262 Private method to apply the changes of a given change group. 262 Private method to apply the changes of a given change group.
263 </p> 263 </p>
264
264 <dl> 265 <dl>
265 266
266 <dt><i>params</i> (dict)</dt> 267 <dt><i>params</i> (dict)</dt>
267 <dd> 268 <dd>
268 dictionary containing the method parameters sent by 269 dictionary containing the method parameters sent by
270 </dd> 271 </dd>
271 </dl> 272 </dl>
272 <a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a> 273 <a NAME="RefactoringClient.__calculateChangeOccurrencesChanges" ID="RefactoringClient.__calculateChangeOccurrencesChanges"></a>
273 <h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4> 274 <h4>RefactoringClient.__calculateChangeOccurrencesChanges</h4>
274 <b>__calculateChangeOccurrencesChanges</b>(<i>params</i>) 275 <b>__calculateChangeOccurrencesChanges</b>(<i>params</i>)
275
276 <p> 276 <p>
277 Private method to calculate the 'Change Occurrences' changes based on 277 Private method to calculate the 'Change Occurrences' changes based on
278 the parameters sent by the server. 278 the parameters sent by the server.
279 </p> 279 </p>
280
280 <dl> 281 <dl>
281 282
282 <dt><i>params</i> (dict)</dt> 283 <dt><i>params</i> (dict)</dt>
283 <dd> 284 <dd>
284 dictionary containing the method parameters sent by 285 dictionary containing the method parameters sent by
286 </dd> 287 </dd>
287 </dl> 288 </dl>
288 <a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a> 289 <a NAME="RefactoringClient.__calculateEncapsulateFieldChanges" ID="RefactoringClient.__calculateEncapsulateFieldChanges"></a>
289 <h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4> 290 <h4>RefactoringClient.__calculateEncapsulateFieldChanges</h4>
290 <b>__calculateEncapsulateFieldChanges</b>(<i>params</i>) 291 <b>__calculateEncapsulateFieldChanges</b>(<i>params</i>)
291
292 <p> 292 <p>
293 Private method to calculate the 'Encapsulate Field' changes based on 293 Private method to calculate the 'Encapsulate Field' changes based on
294 the parameters sent by the server. 294 the parameters sent by the server.
295 </p> 295 </p>
296
296 <dl> 297 <dl>
297 298
298 <dt><i>params</i> (dict)</dt> 299 <dt><i>params</i> (dict)</dt>
299 <dd> 300 <dd>
300 dictionary containing the method parameters sent by 301 dictionary containing the method parameters sent by
302 </dd> 303 </dd>
303 </dl> 304 </dl>
304 <a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a> 305 <a NAME="RefactoringClient.__calculateExtractChanges" ID="RefactoringClient.__calculateExtractChanges"></a>
305 <h4>RefactoringClient.__calculateExtractChanges</h4> 306 <h4>RefactoringClient.__calculateExtractChanges</h4>
306 <b>__calculateExtractChanges</b>(<i>params</i>) 307 <b>__calculateExtractChanges</b>(<i>params</i>)
307
308 <p> 308 <p>
309 Private method to calculate the 'Extract' changes based on the 309 Private method to calculate the 'Extract' changes based on the
310 parameters sent by the server. 310 parameters sent by the server.
311 </p> 311 </p>
312
312 <dl> 313 <dl>
313 314
314 <dt><i>params</i> (dict)</dt> 315 <dt><i>params</i> (dict)</dt>
315 <dd> 316 <dd>
316 dictionary containing the method parameters sent by 317 dictionary containing the method parameters sent by
325 </dd> 326 </dd>
326 </dl> 327 </dl>
327 <a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a> 328 <a NAME="RefactoringClient.__calculateImportsChanges" ID="RefactoringClient.__calculateImportsChanges"></a>
328 <h4>RefactoringClient.__calculateImportsChanges</h4> 329 <h4>RefactoringClient.__calculateImportsChanges</h4>
329 <b>__calculateImportsChanges</b>(<i>params</i>) 330 <b>__calculateImportsChanges</b>(<i>params</i>)
330
331 <p> 331 <p>
332 Private method to calculate the 'Import' changes based on the 332 Private method to calculate the 'Import' changes based on the
333 parameters sent by the server. 333 parameters sent by the server.
334 </p> 334 </p>
335
335 <dl> 336 <dl>
336 337
337 <dt><i>params</i> (dict)</dt> 338 <dt><i>params</i> (dict)</dt>
338 <dd> 339 <dd>
339 dictionary containing the method parameters sent by 340 dictionary containing the method parameters sent by
341 </dd> 342 </dd>
342 </dl> 343 </dl>
343 <a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a> 344 <a NAME="RefactoringClient.__calculateInlineArgumentDefaultChanges" ID="RefactoringClient.__calculateInlineArgumentDefaultChanges"></a>
344 <h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4> 345 <h4>RefactoringClient.__calculateInlineArgumentDefaultChanges</h4>
345 <b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>) 346 <b>__calculateInlineArgumentDefaultChanges</b>(<i>params</i>)
346
347 <p> 347 <p>
348 Private method to calculate the 'Inline Argument Default' changes 348 Private method to calculate the 'Inline Argument Default' changes
349 based on the parameters sent by the server. 349 based on the parameters sent by the server.
350 </p> 350 </p>
351
351 <dl> 352 <dl>
352 353
353 <dt><i>params</i> (dict)</dt> 354 <dt><i>params</i> (dict)</dt>
354 <dd> 355 <dd>
355 dictionary containing the method parameters sent by 356 dictionary containing the method parameters sent by
357 </dd> 358 </dd>
358 </dl> 359 </dl>
359 <a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a> 360 <a NAME="RefactoringClient.__calculateInlineChanges" ID="RefactoringClient.__calculateInlineChanges"></a>
360 <h4>RefactoringClient.__calculateInlineChanges</h4> 361 <h4>RefactoringClient.__calculateInlineChanges</h4>
361 <b>__calculateInlineChanges</b>(<i>params</i>) 362 <b>__calculateInlineChanges</b>(<i>params</i>)
362
363 <p> 363 <p>
364 Private method to calculate the 'Inline' changes based on the 364 Private method to calculate the 'Inline' changes based on the
365 parameters sent by the server. 365 parameters sent by the server.
366 </p> 366 </p>
367
367 <dl> 368 <dl>
368 369
369 <dt><i>params</i> (dict)</dt> 370 <dt><i>params</i> (dict)</dt>
370 <dd> 371 <dd>
371 dictionary containing the method parameters sent by 372 dictionary containing the method parameters sent by
373 </dd> 374 </dd>
374 </dl> 375 </dl>
375 <a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a> 376 <a NAME="RefactoringClient.__calculateIntroduceFactoryChanges" ID="RefactoringClient.__calculateIntroduceFactoryChanges"></a>
376 <h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4> 377 <h4>RefactoringClient.__calculateIntroduceFactoryChanges</h4>
377 <b>__calculateIntroduceFactoryChanges</b>(<i>params</i>) 378 <b>__calculateIntroduceFactoryChanges</b>(<i>params</i>)
378
379 <p> 379 <p>
380 Private method to calculate the 'Introduce Factory' changes based on 380 Private method to calculate the 'Introduce Factory' changes based on
381 the parameters sent by the server. 381 the parameters sent by the server.
382 </p> 382 </p>
383
383 <dl> 384 <dl>
384 385
385 <dt><i>params</i> (dict)</dt> 386 <dt><i>params</i> (dict)</dt>
386 <dd> 387 <dd>
387 dictionary containing the method parameters sent by 388 dictionary containing the method parameters sent by
389 </dd> 390 </dd>
390 </dl> 391 </dl>
391 <a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a> 392 <a NAME="RefactoringClient.__calculateIntroduceParameterChanges" ID="RefactoringClient.__calculateIntroduceParameterChanges"></a>
392 <h4>RefactoringClient.__calculateIntroduceParameterChanges</h4> 393 <h4>RefactoringClient.__calculateIntroduceParameterChanges</h4>
393 <b>__calculateIntroduceParameterChanges</b>(<i>params</i>) 394 <b>__calculateIntroduceParameterChanges</b>(<i>params</i>)
394
395 <p> 395 <p>
396 Private method to calculate the 'Introduce Parameter' changes based on 396 Private method to calculate the 'Introduce Parameter' changes based on
397 the parameters sent by the server. 397 the parameters sent by the server.
398 </p> 398 </p>
399
399 <dl> 400 <dl>
400 401
401 <dt><i>params</i> (dict)</dt> 402 <dt><i>params</i> (dict)</dt>
402 <dd> 403 <dd>
403 dictionary containing the method parameters sent by 404 dictionary containing the method parameters sent by
405 </dd> 406 </dd>
406 </dl> 407 </dl>
407 <a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a> 408 <a NAME="RefactoringClient.__calculateLocalToAttributeChanges" ID="RefactoringClient.__calculateLocalToAttributeChanges"></a>
408 <h4>RefactoringClient.__calculateLocalToAttributeChanges</h4> 409 <h4>RefactoringClient.__calculateLocalToAttributeChanges</h4>
409 <b>__calculateLocalToAttributeChanges</b>(<i>params</i>) 410 <b>__calculateLocalToAttributeChanges</b>(<i>params</i>)
410
411 <p> 411 <p>
412 Private method to calculate the 'Local Variabe to Attribute' changes 412 Private method to calculate the 'Local Variabe to Attribute' changes
413 based on the parameters sent by the server. 413 based on the parameters sent by the server.
414 </p> 414 </p>
415
415 <dl> 416 <dl>
416 417
417 <dt><i>params</i> (dict)</dt> 418 <dt><i>params</i> (dict)</dt>
418 <dd> 419 <dd>
419 dictionary containing the method parameters sent by 420 dictionary containing the method parameters sent by
421 </dd> 422 </dd>
422 </dl> 423 </dl>
423 <a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a> 424 <a NAME="RefactoringClient.__calculateMethodObjectChanges" ID="RefactoringClient.__calculateMethodObjectChanges"></a>
424 <h4>RefactoringClient.__calculateMethodObjectChanges</h4> 425 <h4>RefactoringClient.__calculateMethodObjectChanges</h4>
425 <b>__calculateMethodObjectChanges</b>(<i>params</i>) 426 <b>__calculateMethodObjectChanges</b>(<i>params</i>)
426
427 <p> 427 <p>
428 Private method to calculate the 'Method to Method Object' changes 428 Private method to calculate the 'Method to Method Object' changes
429 based on the parameters sent by the server. 429 based on the parameters sent by the server.
430 </p> 430 </p>
431
431 <dl> 432 <dl>
432 433
433 <dt><i>params</i> (dict)</dt> 434 <dt><i>params</i> (dict)</dt>
434 <dd> 435 <dd>
435 dictionary containing the method parameters sent by 436 dictionary containing the method parameters sent by
437 </dd> 438 </dd>
438 </dl> 439 </dl>
439 <a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a> 440 <a NAME="RefactoringClient.__calculateModuleToPackageChanges" ID="RefactoringClient.__calculateModuleToPackageChanges"></a>
440 <h4>RefactoringClient.__calculateModuleToPackageChanges</h4> 441 <h4>RefactoringClient.__calculateModuleToPackageChanges</h4>
441 <b>__calculateModuleToPackageChanges</b>(<i>params</i>) 442 <b>__calculateModuleToPackageChanges</b>(<i>params</i>)
442
443 <p> 443 <p>
444 Private method to calculate the 'Module to Package' changes 444 Private method to calculate the 'Module to Package' changes
445 based on the parameters sent by the server. 445 based on the parameters sent by the server.
446 </p> 446 </p>
447
447 <dl> 448 <dl>
448 449
449 <dt><i>params</i> (dict)</dt> 450 <dt><i>params</i> (dict)</dt>
450 <dd> 451 <dd>
451 dictionary containing the method parameters sent by 452 dictionary containing the method parameters sent by
453 </dd> 454 </dd>
454 </dl> 455 </dl>
455 <a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a> 456 <a NAME="RefactoringClient.__calculateMoveChanges" ID="RefactoringClient.__calculateMoveChanges"></a>
456 <h4>RefactoringClient.__calculateMoveChanges</h4> 457 <h4>RefactoringClient.__calculateMoveChanges</h4>
457 <b>__calculateMoveChanges</b>(<i>params</i>) 458 <b>__calculateMoveChanges</b>(<i>params</i>)
458
459 <p> 459 <p>
460 Private method to calculate the 'Move ...' changes based on the 460 Private method to calculate the 'Move ...' changes based on the
461 parameters sent by the server. 461 parameters sent by the server.
462 </p> 462 </p>
463
463 <dl> 464 <dl>
464 465
465 <dt><i>params</i> (dict)</dt> 466 <dt><i>params</i> (dict)</dt>
466 <dd> 467 <dd>
467 dictionary containing the method parameters sent by 468 dictionary containing the method parameters sent by
469 </dd> 470 </dd>
470 </dl> 471 </dl>
471 <a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a> 472 <a NAME="RefactoringClient.__calculateRenameChanges" ID="RefactoringClient.__calculateRenameChanges"></a>
472 <h4>RefactoringClient.__calculateRenameChanges</h4> 473 <h4>RefactoringClient.__calculateRenameChanges</h4>
473 <b>__calculateRenameChanges</b>(<i>params</i>) 474 <b>__calculateRenameChanges</b>(<i>params</i>)
474
475 <p> 475 <p>
476 Private method to calculate the rename changes based on the parameters 476 Private method to calculate the rename changes based on the parameters
477 sent by the server. 477 sent by the server.
478 </p> 478 </p>
479
479 <dl> 480 <dl>
480 481
481 <dt><i>params</i> (dict)</dt> 482 <dt><i>params</i> (dict)</dt>
482 <dd> 483 <dd>
483 dictionary containing the method parameters sent by 484 dictionary containing the method parameters sent by
485 </dd> 486 </dd>
486 </dl> 487 </dl>
487 <a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a> 488 <a NAME="RefactoringClient.__calculateRestructureChanges" ID="RefactoringClient.__calculateRestructureChanges"></a>
488 <h4>RefactoringClient.__calculateRestructureChanges</h4> 489 <h4>RefactoringClient.__calculateRestructureChanges</h4>
489 <b>__calculateRestructureChanges</b>(<i>params</i>) 490 <b>__calculateRestructureChanges</b>(<i>params</i>)
490
491 <p> 491 <p>
492 Private method to calculate the 'Restructure' changes based on the 492 Private method to calculate the 'Restructure' changes based on the
493 parameters sent by the server. 493 parameters sent by the server.
494 </p> 494 </p>
495
495 <dl> 496 <dl>
496 497
497 <dt><i>params</i> (dict)</dt> 498 <dt><i>params</i> (dict)</dt>
498 <dd> 499 <dd>
499 dictionary containing the method parameters sent by 500 dictionary containing the method parameters sent by
501 </dd> 502 </dd>
502 </dl> 503 </dl>
503 <a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a> 504 <a NAME="RefactoringClient.__calculateSignatureChanges" ID="RefactoringClient.__calculateSignatureChanges"></a>
504 <h4>RefactoringClient.__calculateSignatureChanges</h4> 505 <h4>RefactoringClient.__calculateSignatureChanges</h4>
505 <b>__calculateSignatureChanges</b>(<i>params</i>) 506 <b>__calculateSignatureChanges</b>(<i>params</i>)
506
507 <p> 507 <p>
508 Private method to calculate the 'Signature' changes based on the 508 Private method to calculate the 'Signature' changes based on the
509 parameters sent by the server. 509 parameters sent by the server.
510 </p> 510 </p>
511
511 <dl> 512 <dl>
512 513
513 <dt><i>params</i> (dict)</dt> 514 <dt><i>params</i> (dict)</dt>
514 <dd> 515 <dd>
515 dictionary containing the method parameters sent by 516 dictionary containing the method parameters sent by
517 </dd> 518 </dd>
518 </dl> 519 </dl>
519 <a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a> 520 <a NAME="RefactoringClient.__calculateUseFunctionChanges" ID="RefactoringClient.__calculateUseFunctionChanges"></a>
520 <h4>RefactoringClient.__calculateUseFunctionChanges</h4> 521 <h4>RefactoringClient.__calculateUseFunctionChanges</h4>
521 <b>__calculateUseFunctionChanges</b>(<i>params</i>) 522 <b>__calculateUseFunctionChanges</b>(<i>params</i>)
522
523 <p> 523 <p>
524 Private method to calculate the 'Use Function' changes based on the 524 Private method to calculate the 'Use Function' changes based on the
525 parameters sent by the server. 525 parameters sent by the server.
526 </p> 526 </p>
527
527 <dl> 528 <dl>
528 529
529 <dt><i>params</i> (dict)</dt> 530 <dt><i>params</i> (dict)</dt>
530 <dd> 531 <dd>
531 dictionary containing the method parameters sent by 532 dictionary containing the method parameters sent by
533 </dd> 534 </dd>
534 </dl> 535 </dl>
535 <a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a> 536 <a NAME="RefactoringClient.__clearChanges" ID="RefactoringClient.__clearChanges"></a>
536 <h4>RefactoringClient.__clearChanges</h4> 537 <h4>RefactoringClient.__clearChanges</h4>
537 <b>__clearChanges</b>(<i>params</i>) 538 <b>__clearChanges</b>(<i>params</i>)
538
539 <p> 539 <p>
540 Private method to clear the changes cache of a given change group. 540 Private method to clear the changes cache of a given change group.
541 </p> 541 </p>
542
542 <dl> 543 <dl>
543 544
544 <dt><i>params</i> (dict)</dt> 545 <dt><i>params</i> (dict)</dt>
545 <dd> 546 <dd>
546 dictionary containing the method parameters sent by 547 dictionary containing the method parameters sent by
548 </dd> 549 </dd>
549 </dl> 550 </dl>
550 <a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a> 551 <a NAME="RefactoringClient.__closeProject" ID="RefactoringClient.__closeProject"></a>
551 <h4>RefactoringClient.__closeProject</h4> 552 <h4>RefactoringClient.__closeProject</h4>
552 <b>__closeProject</b>(<i>params</i>) 553 <b>__closeProject</b>(<i>params</i>)
553
554 <p> 554 <p>
555 Private slot to validate the project. 555 Private slot to validate the project.
556 </p> 556 </p>
557
557 <dl> 558 <dl>
558 559
559 <dt><i>params</i> (dict)</dt> 560 <dt><i>params</i> (dict)</dt>
560 <dd> 561 <dd>
561 dictionary containing the method parameters sent by 562 dictionary containing the method parameters sent by
563 </dd> 564 </dd>
564 </dl> 565 </dl>
565 <a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a> 566 <a NAME="RefactoringClient.__configChanged" ID="RefactoringClient.__configChanged"></a>
566 <h4>RefactoringClient.__configChanged</h4> 567 <h4>RefactoringClient.__configChanged</h4>
567 <b>__configChanged</b>(<i>params</i>) 568 <b>__configChanged</b>(<i>params</i>)
568
569 <p> 569 <p>
570 Private method to handle a change of the configuration file. 570 Private method to handle a change of the configuration file.
571 </p> 571 </p>
572
572 <dl> 573 <dl>
573 574
574 <dt><i>params</i> (dict)</dt> 575 <dt><i>params</i> (dict)</dt>
575 <dd> 576 <dd>
576 dictionary containing the method parameters sent by 577 dictionary containing the method parameters sent by
578 </dd> 579 </dd>
579 </dl> 580 </dl>
580 <a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a> 581 <a NAME="RefactoringClient.__confirmUnsure" ID="RefactoringClient.__confirmUnsure"></a>
581 <h4>RefactoringClient.__confirmUnsure</h4> 582 <h4>RefactoringClient.__confirmUnsure</h4>
582 <b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>) 583 <b>__confirmUnsure</b>(<i>occurrence, changeGroup</i>)
583
584 <p> 584 <p>
585 Private method to confirm unsure occurrences. 585 Private method to confirm unsure occurrences.
586 </p> 586 </p>
587
587 <dl> 588 <dl>
588 589
589 <dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt> 590 <dt><i>occurrence</i> (rope.refactor.occurrences.Occurrence)</dt>
590 <dd> 591 <dd>
591 reference to the occurrence object 592 reference to the occurrence object
608 </dd> 609 </dd>
609 </dl> 610 </dl>
610 <a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a> 611 <a NAME="RefactoringClient.__getConfig" ID="RefactoringClient.__getConfig"></a>
611 <h4>RefactoringClient.__getConfig</h4> 612 <h4>RefactoringClient.__getConfig</h4>
612 <b>__getConfig</b>(<i>params</i>) 613 <b>__getConfig</b>(<i>params</i>)
613
614 <p> 614 <p>
615 Private method to send some configuration data to the server. 615 Private method to send some configuration data to the server.
616 </p> 616 </p>
617
617 <dl> 618 <dl>
618 619
619 <dt><i>params</i> (dict)</dt> 620 <dt><i>params</i> (dict)</dt>
620 <dd> 621 <dd>
621 dictionary containing the method parameters sent by 622 dictionary containing the method parameters sent by
623 </dd> 624 </dd>
624 </dl> 625 </dl>
625 <a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a> 626 <a NAME="RefactoringClient.__handleRopeError" ID="RefactoringClient.__handleRopeError"></a>
626 <h4>RefactoringClient.__handleRopeError</h4> 627 <h4>RefactoringClient.__handleRopeError</h4>
627 <b>__handleRopeError</b>(<i>err</i>) 628 <b>__handleRopeError</b>(<i>err</i>)
628
629 <p> 629 <p>
630 Private method to process a rope error. 630 Private method to process a rope error.
631 </p> 631 </p>
632
632 <dl> 633 <dl>
633 634
634 <dt><i>err</i> (Exception)</dt> 635 <dt><i>err</i> (Exception)</dt>
635 <dd> 636 <dd>
636 rope exception object 637 rope exception object
649 </dd> 650 </dd>
650 </dl> 651 </dl>
651 <a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a> 652 <a NAME="RefactoringClient.__performSOA" ID="RefactoringClient.__performSOA"></a>
652 <h4>RefactoringClient.__performSOA</h4> 653 <h4>RefactoringClient.__performSOA</h4>
653 <b>__performSOA</b>(<i>params</i>) 654 <b>__performSOA</b>(<i>params</i>)
654
655 <p> 655 <p>
656 Private method to perform SOA on all modules. 656 Private method to perform SOA on all modules.
657 </p> 657 </p>
658
658 <dl> 659 <dl>
659 660
660 <dt><i>params</i> (dict)</dt> 661 <dt><i>params</i> (dict)</dt>
661 <dd> 662 <dd>
662 dictionary containing the method parameters sent by 663 dictionary containing the method parameters sent by
664 </dd> 665 </dd>
665 </dl> 666 </dl>
666 <a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a> 667 <a NAME="RefactoringClient.__previewChanges" ID="RefactoringClient.__previewChanges"></a>
667 <h4>RefactoringClient.__previewChanges</h4> 668 <h4>RefactoringClient.__previewChanges</h4>
668 <b>__previewChanges</b>(<i>params</i>) 669 <b>__previewChanges</b>(<i>params</i>)
669
670 <p> 670 <p>
671 Private method to determine the changes data for a preview. 671 Private method to determine the changes data for a preview.
672 </p> 672 </p>
673
673 <dl> 674 <dl>
674 675
675 <dt><i>params</i> (dict)</dt> 676 <dt><i>params</i> (dict)</dt>
676 <dd> 677 <dd>
677 dictionary containing the method parameters sent by 678 dictionary containing the method parameters sent by
679 </dd> 680 </dd>
680 </dl> 681 </dl>
681 <a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a> 682 <a NAME="RefactoringClient.__processHistory" ID="RefactoringClient.__processHistory"></a>
682 <h4>RefactoringClient.__processHistory</h4> 683 <h4>RefactoringClient.__processHistory</h4>
683 <b>__processHistory</b>(<i>params</i>) 684 <b>__processHistory</b>(<i>params</i>)
684
685 <p> 685 <p>
686 Private method to process the various history related requests. 686 Private method to process the various history related requests.
687 </p> 687 </p>
688
688 <dl> 689 <dl>
689 690
690 <dt><i>params</i> (dict)</dt> 691 <dt><i>params</i> (dict)</dt>
691 <dd> 692 <dd>
692 dictionary containing the method parameters sent by 693 dictionary containing the method parameters sent by
694 </dd> 695 </dd>
695 </dl> 696 </dl>
696 <a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a> 697 <a NAME="RefactoringClient.__queryDefinition" ID="RefactoringClient.__queryDefinition"></a>
697 <h4>RefactoringClient.__queryDefinition</h4> 698 <h4>RefactoringClient.__queryDefinition</h4>
698 <b>__queryDefinition</b>(<i>params</i>) 699 <b>__queryDefinition</b>(<i>params</i>)
699
700 <p> 700 <p>
701 Private method to handle the Find Definition action. 701 Private method to handle the Find Definition action.
702 </p> 702 </p>
703
703 <dl> 704 <dl>
704 705
705 <dt><i>params</i> (dict)</dt> 706 <dt><i>params</i> (dict)</dt>
706 <dd> 707 <dd>
707 dictionary containing the method parameters sent by 708 dictionary containing the method parameters sent by
709 </dd> 710 </dd>
710 </dl> 711 </dl>
711 <a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a> 712 <a NAME="RefactoringClient.__queryImplementations" ID="RefactoringClient.__queryImplementations"></a>
712 <h4>RefactoringClient.__queryImplementations</h4> 713 <h4>RefactoringClient.__queryImplementations</h4>
713 <b>__queryImplementations</b>(<i>params</i>) 714 <b>__queryImplementations</b>(<i>params</i>)
714
715 <p> 715 <p>
716 Private method to handle the Find Implementations action. 716 Private method to handle the Find Implementations action.
717 </p> 717 </p>
718
718 <dl> 719 <dl>
719 720
720 <dt><i>params</i> (dict)</dt> 721 <dt><i>params</i> (dict)</dt>
721 <dd> 722 <dd>
722 dictionary containing the method parameters sent by 723 dictionary containing the method parameters sent by
724 </dd> 725 </dd>
725 </dl> 726 </dl>
726 <a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a> 727 <a NAME="RefactoringClient.__queryReferences" ID="RefactoringClient.__queryReferences"></a>
727 <h4>RefactoringClient.__queryReferences</h4> 728 <h4>RefactoringClient.__queryReferences</h4>
728 <b>__queryReferences</b>(<i>params</i>) 729 <b>__queryReferences</b>(<i>params</i>)
729
730 <p> 730 <p>
731 Private method to handle the Find References action. 731 Private method to handle the Find References action.
732 </p> 732 </p>
733
733 <dl> 734 <dl>
734 735
735 <dt><i>params</i> (dict)</dt> 736 <dt><i>params</i> (dict)</dt>
736 <dd> 737 <dd>
737 dictionary containing the method parameters sent by 738 dictionary containing the method parameters sent by
739 </dd> 740 </dd>
740 </dl> 741 </dl>
741 <a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a> 742 <a NAME="RefactoringClient.__reportChanged" ID="RefactoringClient.__reportChanged"></a>
742 <h4>RefactoringClient.__reportChanged</h4> 743 <h4>RefactoringClient.__reportChanged</h4>
743 <b>__reportChanged</b>(<i>params</i>) 744 <b>__reportChanged</b>(<i>params</i>)
744
745 <p> 745 <p>
746 Private method to register some changed sources. 746 Private method to register some changed sources.
747 </p> 747 </p>
748
748 <dl> 749 <dl>
749 750
750 <dt><i>params</i> (dict)</dt> 751 <dt><i>params</i> (dict)</dt>
751 <dd> 752 <dd>
752 dictionary containing the method parameters sent by 753 dictionary containing the method parameters sent by
754 </dd> 755 </dd>
755 </dl> 756 </dl>
756 <a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a> 757 <a NAME="RefactoringClient.__requestFieldName" ID="RefactoringClient.__requestFieldName"></a>
757 <h4>RefactoringClient.__requestFieldName</h4> 758 <h4>RefactoringClient.__requestFieldName</h4>
758 <b>__requestFieldName</b>(<i>params</i>) 759 <b>__requestFieldName</b>(<i>params</i>)
759
760 <p> 760 <p>
761 Private method to calculate the 'Field Name' based on the parameters 761 Private method to calculate the 'Field Name' based on the parameters
762 sent by the server. 762 sent by the server.
763 </p> 763 </p>
764
764 <dl> 765 <dl>
765 766
766 <dt><i>params</i> (dict)</dt> 767 <dt><i>params</i> (dict)</dt>
767 <dd> 768 <dd>
768 dictionary containing the method parameters sent by 769 dictionary containing the method parameters sent by
770 </dd> 771 </dd>
771 </dl> 772 </dl>
772 <a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a> 773 <a NAME="RefactoringClient.__requestInlineType" ID="RefactoringClient.__requestInlineType"></a>
773 <h4>RefactoringClient.__requestInlineType</h4> 774 <h4>RefactoringClient.__requestInlineType</h4>
774 <b>__requestInlineType</b>(<i>params</i>) 775 <b>__requestInlineType</b>(<i>params</i>)
775
776 <p> 776 <p>
777 Private method to determine the 'Inline' changes type based on the 777 Private method to determine the 'Inline' changes type based on the
778 parameters sent by the server. 778 parameters sent by the server.
779 </p> 779 </p>
780
780 <dl> 781 <dl>
781 782
782 <dt><i>params</i> (dict)</dt> 783 <dt><i>params</i> (dict)</dt>
783 <dd> 784 <dd>
784 dictionary containing the method parameters sent by 785 dictionary containing the method parameters sent by
786 </dd> 787 </dd>
787 </dl> 788 </dl>
788 <a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a> 789 <a NAME="RefactoringClient.__requestMoveType" ID="RefactoringClient.__requestMoveType"></a>
789 <h4>RefactoringClient.__requestMoveType</h4> 790 <h4>RefactoringClient.__requestMoveType</h4>
790 <b>__requestMoveType</b>(<i>params</i>) 791 <b>__requestMoveType</b>(<i>params</i>)
791
792 <p> 792 <p>
793 Private method to determine the 'Move Method' changes type based on the 793 Private method to determine the 'Move Method' changes type based on the
794 parameters sent by the server. 794 parameters sent by the server.
795 </p> 795 </p>
796
796 <dl> 797 <dl>
797 798
798 <dt><i>params</i> (dict)</dt> 799 <dt><i>params</i> (dict)</dt>
799 <dd> 800 <dd>
800 dictionary containing the method parameters sent by 801 dictionary containing the method parameters sent by
802 </dd> 803 </dd>
803 </dl> 804 </dl>
804 <a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a> 805 <a NAME="RefactoringClient.__requestSignature" ID="RefactoringClient.__requestSignature"></a>
805 <h4>RefactoringClient.__requestSignature</h4> 806 <h4>RefactoringClient.__requestSignature</h4>
806 <b>__requestSignature</b>(<i>params</i>) 807 <b>__requestSignature</b>(<i>params</i>)
807
808 <p> 808 <p>
809 Private method to calculate the 'Signature' based on the parameters 809 Private method to calculate the 'Signature' based on the parameters
810 sent by the server. 810 sent by the server.
811 </p> 811 </p>
812
812 <dl> 813 <dl>
813 814
814 <dt><i>params</i> (dict)</dt> 815 <dt><i>params</i> (dict)</dt>
815 <dd> 816 <dd>
816 dictionary containing the method parameters sent by 817 dictionary containing the method parameters sent by
818 </dd> 819 </dd>
819 </dl> 820 </dl>
820 <a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a> 821 <a NAME="RefactoringClient.__requestUseFunction" ID="RefactoringClient.__requestUseFunction"></a>
821 <h4>RefactoringClient.__requestUseFunction</h4> 822 <h4>RefactoringClient.__requestUseFunction</h4>
822 <b>__requestUseFunction</b>(<i>params</i>) 823 <b>__requestUseFunction</b>(<i>params</i>)
823
824 <p> 824 <p>
825 Private method to determine the 'Use Function' function name based on 825 Private method to determine the 'Use Function' function name based on
826 the parameters sent by the server. 826 the parameters sent by the server.
827 </p> 827 </p>
828
828 <dl> 829 <dl>
829 830
830 <dt><i>params</i> (dict)</dt> 831 <dt><i>params</i> (dict)</dt>
831 <dd> 832 <dd>
832 dictionary containing the method parameters sent by 833 dictionary containing the method parameters sent by
834 </dd> 835 </dd>
835 </dl> 836 </dl>
836 <a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a> 837 <a NAME="RefactoringClient.__validate" ID="RefactoringClient.__validate"></a>
837 <h4>RefactoringClient.__validate</h4> 838 <h4>RefactoringClient.__validate</h4>
838 <b>__validate</b>(<i>params</i>) 839 <b>__validate</b>(<i>params</i>)
839
840 <p> 840 <p>
841 Private slot to validate the project. 841 Private slot to validate the project.
842 </p> 842 </p>
843
843 <dl> 844 <dl>
844 845
845 <dt><i>params</i> (dict)</dt> 846 <dt><i>params</i> (dict)</dt>
846 <dd> 847 <dd>
847 dictionary containing the method parameters sent by 848 dictionary containing the method parameters sent by
849 </dd> 850 </dd>
850 </dl> 851 </dl>
851 <a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a> 852 <a NAME="RefactoringClient.handleCall" ID="RefactoringClient.handleCall"></a>
852 <h4>RefactoringClient.handleCall</h4> 853 <h4>RefactoringClient.handleCall</h4>
853 <b>handleCall</b>(<i>method, params</i>) 854 <b>handleCall</b>(<i>method, params</i>)
854
855 <p> 855 <p>
856 Public method to handle a method call from the server. 856 Public method to handle a method call from the server.
857 </p> 857 </p>
858
858 <dl> 859 <dl>
859 860
860 <dt><i>method</i> (str)</dt> 861 <dt><i>method</i> (str)</dt>
861 <dd> 862 <dd>
862 requested method name 863 requested method name

Mercurial Repository: Rope Refactoring

eric ide

mercurial