Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer.html

branch
eric7
changeset 416
45159308166f
parent 394
b34f5dd3db27
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.RefactoringServer</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer</h1>
10
11 <p> 10 <p>
12 Module implementing the refactoring interface to rope. 11 Module implementing the refactoring interface to rope.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#RefactoringServer">RefactoringServer</a></td> 22 <td><a href="#RefactoringServer">RefactoringServer</a></td>
25 <td>Class implementing the refactoring interface to rope.</td> 23 <td>Class implementing the refactoring interface to rope.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="RefactoringServer" ID="RefactoringServer"></a> 34 <a NAME="RefactoringServer" ID="RefactoringServer"></a>
36 <h2>RefactoringServer</h2> 35 <h2>RefactoringServer</h2>
37
38 <p> 36 <p>
39 Class implementing the refactoring interface to rope. 37 Class implementing the refactoring interface to rope.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 EricJsonServer 41 EricJsonServer
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#RefactoringServer.__init__">RefactoringServer</a></td> 55 <td><a href="#RefactoringServer.__init__">RefactoringServer</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
333 <tr> 330 <tr>
334 <td><a href="#RefactoringServer.reportChanged">reportChanged</a></td> 331 <td><a href="#RefactoringServer.reportChanged">reportChanged</a></td>
335 <td>Public slot to report some changed sources.</td> 332 <td>Public slot to report some changed sources.</td>
336 </tr> 333 </tr>
337 </table> 334 </table>
335
338 <h3>Static Methods</h3> 336 <h3>Static Methods</h3>
339
340 <table> 337 <table>
341 <tr><td>None</td></tr> 338 <tr><td>None</td></tr>
342 </table> 339 </table>
343 340
341
344 <a NAME="RefactoringServer.__init__" ID="RefactoringServer.__init__"></a> 342 <a NAME="RefactoringServer.__init__" ID="RefactoringServer.__init__"></a>
345 <h4>RefactoringServer (Constructor)</h4> 343 <h4>RefactoringServer (Constructor)</h4>
346 <b>RefactoringServer</b>(<i>plugin, parent=None</i>) 344 <b>RefactoringServer</b>(<i>plugin, parent=None</i>)
347
348 <p> 345 <p>
349 Constructor 346 Constructor
350 </p> 347 </p>
348
351 <dl> 349 <dl>
352 350
353 <dt><i>plugin</i> (RefactoringRopePlugin)</dt> 351 <dt><i>plugin</i> (RefactoringRopePlugin)</dt>
354 <dd> 352 <dd>
355 reference to the plugin object 353 reference to the plugin object
360 </dd> 358 </dd>
361 </dl> 359 </dl>
362 <a NAME="RefactoringServer.__changeOccurrences" ID="RefactoringServer.__changeOccurrences"></a> 360 <a NAME="RefactoringServer.__changeOccurrences" ID="RefactoringServer.__changeOccurrences"></a>
363 <h4>RefactoringServer.__changeOccurrences</h4> 361 <h4>RefactoringServer.__changeOccurrences</h4>
364 <b>__changeOccurrences</b>(<i></i>) 362 <b>__changeOccurrences</b>(<i></i>)
365
366 <p> 363 <p>
367 Private slot to perform the Change Occurrences refactoring. 364 Private slot to perform the Change Occurrences refactoring.
368 </p> 365 </p>
366
369 <a NAME="RefactoringServer.__changeSignature" ID="RefactoringServer.__changeSignature"></a> 367 <a NAME="RefactoringServer.__changeSignature" ID="RefactoringServer.__changeSignature"></a>
370 <h4>RefactoringServer.__changeSignature</h4> 368 <h4>RefactoringServer.__changeSignature</h4>
371 <b>__changeSignature</b>(<i></i>) 369 <b>__changeSignature</b>(<i></i>)
372
373 <p> 370 <p>
374 Private slot to change the signature of a method or function. 371 Private slot to change the signature of a method or function.
375 </p> 372 </p>
373
376 <a NAME="RefactoringServer.__clearHistory" ID="RefactoringServer.__clearHistory"></a> 374 <a NAME="RefactoringServer.__clearHistory" ID="RefactoringServer.__clearHistory"></a>
377 <h4>RefactoringServer.__clearHistory</h4> 375 <h4>RefactoringServer.__clearHistory</h4>
378 <b>__clearHistory</b>(<i></i>) 376 <b>__clearHistory</b>(<i></i>)
379
380 <p> 377 <p>
381 Private slot to clear the redo and undo lists. 378 Private slot to clear the redo and undo lists.
382 </p> 379 </p>
380
383 <a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a> 381 <a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a>
384 <h4>RefactoringServer.__configChanged</h4> 382 <h4>RefactoringServer.__configChanged</h4>
385 <b>__configChanged</b>(<i></i>) 383 <b>__configChanged</b>(<i></i>)
386
387 <p> 384 <p>
388 Private slot called, when the rope config file has changed. 385 Private slot called, when the rope config file has changed.
389 </p> 386 </p>
387
390 <a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a> 388 <a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a>
391 <h4>RefactoringServer.__convertLocalToAttribute</h4> 389 <h4>RefactoringServer.__convertLocalToAttribute</h4>
392 <b>__convertLocalToAttribute</b>(<i></i>) 390 <b>__convertLocalToAttribute</b>(<i></i>)
393
394 <p> 391 <p>
395 Private slot to convert a local variable to an attribute. 392 Private slot to convert a local variable to an attribute.
396 </p> 393 </p>
394
397 <a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a> 395 <a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a>
398 <h4>RefactoringServer.__defaultConfig</h4> 396 <h4>RefactoringServer.__defaultConfig</h4>
399 <b>__defaultConfig</b>(<i></i>) 397 <b>__defaultConfig</b>(<i></i>)
400
401 <p> 398 <p>
402 Private slot to return the contents of rope's default configuration. 399 Private slot to return the contents of rope's default configuration.
403 </p> 400 </p>
401
404 <dl> 402 <dl>
405 <dt>Return:</dt> 403 <dt>Return:</dt>
406 <dd> 404 <dd>
407 string containing the source of rope's default 405 string containing the source of rope's default
408 configuration 406 configuration
415 </dd> 413 </dd>
416 </dl> 414 </dl>
417 <a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a> 415 <a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a>
418 <h4>RefactoringServer.__doExtract</h4> 416 <h4>RefactoringServer.__doExtract</h4>
419 <b>__doExtract</b>(<i>title, kind</i>) 417 <b>__doExtract</b>(<i>title, kind</i>)
420
421 <p> 418 <p>
422 Private method to perform the extract refactoring. 419 Private method to perform the extract refactoring.
423 </p> 420 </p>
421
424 <dl> 422 <dl>
425 423
426 <dt><i>title</i> (str)</dt> 424 <dt><i>title</i> (str)</dt>
427 <dd> 425 <dd>
428 title of the refactoring 426 title of the refactoring
433 </dd> 431 </dd>
434 </dl> 432 </dl>
435 <a NAME="RefactoringServer.__doImports" ID="RefactoringServer.__doImports"></a> 433 <a NAME="RefactoringServer.__doImports" ID="RefactoringServer.__doImports"></a>
436 <h4>RefactoringServer.__doImports</h4> 434 <h4>RefactoringServer.__doImports</h4>
437 <b>__doImports</b>(<i>title, methodName</i>) 435 <b>__doImports</b>(<i>title, methodName</i>)
438
439 <p> 436 <p>
440 Private method to perform the various imports refactorings. 437 Private method to perform the various imports refactorings.
441 </p> 438 </p>
439
442 <dl> 440 <dl>
443 441
444 <dt><i>title</i> (str)</dt> 442 <dt><i>title</i> (str)</dt>
445 <dd> 443 <dd>
446 title to be used for the import refactoring 444 title to be used for the import refactoring
451 </dd> 449 </dd>
452 </dl> 450 </dl>
453 <a NAME="RefactoringServer.__doRename" ID="RefactoringServer.__doRename"></a> 451 <a NAME="RefactoringServer.__doRename" ID="RefactoringServer.__doRename"></a>
454 <h4>RefactoringServer.__doRename</h4> 452 <h4>RefactoringServer.__doRename</h4>
455 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>) 453 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>)
456
457 <p> 454 <p>
458 Private method to perform the various renaming refactorings. 455 Private method to perform the various renaming refactorings.
459 </p> 456 </p>
457
460 <dl> 458 <dl>
461 459
462 <dt><i>title</i> (str)</dt> 460 <dt><i>title</i> (str)</dt>
463 <dd> 461 <dd>
464 title of the refactoring 462 title of the refactoring
474 </dd> 472 </dd>
475 </dl> 473 </dl>
476 <a NAME="RefactoringServer.__editConfig" ID="RefactoringServer.__editConfig"></a> 474 <a NAME="RefactoringServer.__editConfig" ID="RefactoringServer.__editConfig"></a>
477 <h4>RefactoringServer.__editConfig</h4> 475 <h4>RefactoringServer.__editConfig</h4>
478 <b>__editConfig</b>(<i></i>) 476 <b>__editConfig</b>(<i></i>)
479
480 <p> 477 <p>
481 Private slot to open the rope configuration file in an editor. 478 Private slot to open the rope configuration file in an editor.
482 </p> 479 </p>
480
483 <a NAME="RefactoringServer.__encapsulateAttribute" ID="RefactoringServer.__encapsulateAttribute"></a> 481 <a NAME="RefactoringServer.__encapsulateAttribute" ID="RefactoringServer.__encapsulateAttribute"></a>
484 <h4>RefactoringServer.__encapsulateAttribute</h4> 482 <h4>RefactoringServer.__encapsulateAttribute</h4>
485 <b>__encapsulateAttribute</b>(<i></i>) 483 <b>__encapsulateAttribute</b>(<i></i>)
486
487 <p> 484 <p>
488 Private slot to encapsulate an attribute. 485 Private slot to encapsulate an attribute.
489 </p> 486 </p>
487
490 <a NAME="RefactoringServer.__extractLocalVariable" ID="RefactoringServer.__extractLocalVariable"></a> 488 <a NAME="RefactoringServer.__extractLocalVariable" ID="RefactoringServer.__extractLocalVariable"></a>
491 <h4>RefactoringServer.__extractLocalVariable</h4> 489 <h4>RefactoringServer.__extractLocalVariable</h4>
492 <b>__extractLocalVariable</b>(<i></i>) 490 <b>__extractLocalVariable</b>(<i></i>)
493
494 <p> 491 <p>
495 Private slot to handle the Extract Local Variable action. 492 Private slot to handle the Extract Local Variable action.
496 </p> 493 </p>
494
497 <a NAME="RefactoringServer.__extractMethod" ID="RefactoringServer.__extractMethod"></a> 495 <a NAME="RefactoringServer.__extractMethod" ID="RefactoringServer.__extractMethod"></a>
498 <h4>RefactoringServer.__extractMethod</h4> 496 <h4>RefactoringServer.__extractMethod</h4>
499 <b>__extractMethod</b>(<i></i>) 497 <b>__extractMethod</b>(<i></i>)
500
501 <p> 498 <p>
502 Private slot to handle the Extract Method action. 499 Private slot to handle the Extract Method action.
503 </p> 500 </p>
501
504 <a NAME="RefactoringServer.__getOffset" ID="RefactoringServer.__getOffset"></a> 502 <a NAME="RefactoringServer.__getOffset" ID="RefactoringServer.__getOffset"></a>
505 <h4>RefactoringServer.__getOffset</h4> 503 <h4>RefactoringServer.__getOffset</h4>
506 <b>__getOffset</b>(<i>editor, line, index</i>) 504 <b>__getOffset</b>(<i>editor, line, index</i>)
507
508 <p> 505 <p>
509 Private method to get the offset into the text treating CRLF as ONE 506 Private method to get the offset into the text treating CRLF as ONE
510 character. 507 character.
511 </p> 508 </p>
512 <p> 509 <p>
513 Note: rope seems to convert all EOL styles to just \n. 510 Note: rope seems to convert all EOL styles to just \n.
514 </p> 511 </p>
512
515 <dl> 513 <dl>
516 514
517 <dt><i>editor</i> (Editor)</dt> 515 <dt><i>editor</i> (Editor)</dt>
518 <dd> 516 <dd>
519 reference to the editor 517 reference to the editor
540 </dd> 538 </dd>
541 </dl> 539 </dl>
542 <a NAME="RefactoringServer.__historyDialogClosed" ID="RefactoringServer.__historyDialogClosed"></a> 540 <a NAME="RefactoringServer.__historyDialogClosed" ID="RefactoringServer.__historyDialogClosed"></a>
543 <h4>RefactoringServer.__historyDialogClosed</h4> 541 <h4>RefactoringServer.__historyDialogClosed</h4>
544 <b>__historyDialogClosed</b>(<i></i>) 542 <b>__historyDialogClosed</b>(<i></i>)
545
546 <p> 543 <p>
547 Private slot handling the closing of the history dialog. 544 Private slot handling the closing of the history dialog.
548 </p> 545 </p>
546
549 <a NAME="RefactoringServer.__importsExpandStar" ID="RefactoringServer.__importsExpandStar"></a> 547 <a NAME="RefactoringServer.__importsExpandStar" ID="RefactoringServer.__importsExpandStar"></a>
550 <h4>RefactoringServer.__importsExpandStar</h4> 548 <h4>RefactoringServer.__importsExpandStar</h4>
551 <b>__importsExpandStar</b>(<i></i>) 549 <b>__importsExpandStar</b>(<i></i>)
552
553 <p> 550 <p>
554 Private slot to expand star imports. 551 Private slot to expand star imports.
555 </p> 552 </p>
553
556 <a NAME="RefactoringServer.__importsFromToImport" ID="RefactoringServer.__importsFromToImport"></a> 554 <a NAME="RefactoringServer.__importsFromToImport" ID="RefactoringServer.__importsFromToImport"></a>
557 <h4>RefactoringServer.__importsFromToImport</h4> 555 <h4>RefactoringServer.__importsFromToImport</h4>
558 <b>__importsFromToImport</b>(<i></i>) 556 <b>__importsFromToImport</b>(<i></i>)
559
560 <p> 557 <p>
561 Private slot to transform from imports to plain imports. 558 Private slot to transform from imports to plain imports.
562 </p> 559 </p>
560
563 <a NAME="RefactoringServer.__importsHandleLong" ID="RefactoringServer.__importsHandleLong"></a> 561 <a NAME="RefactoringServer.__importsHandleLong" ID="RefactoringServer.__importsHandleLong"></a>
564 <h4>RefactoringServer.__importsHandleLong</h4> 562 <h4>RefactoringServer.__importsHandleLong</h4>
565 <b>__importsHandleLong</b>(<i></i>) 563 <b>__importsHandleLong</b>(<i></i>)
566
567 <p> 564 <p>
568 Private slot to handle long imports. 565 Private slot to handle long imports.
569 </p> 566 </p>
567
570 <a NAME="RefactoringServer.__importsOrganize" ID="RefactoringServer.__importsOrganize"></a> 568 <a NAME="RefactoringServer.__importsOrganize" ID="RefactoringServer.__importsOrganize"></a>
571 <h4>RefactoringServer.__importsOrganize</h4> 569 <h4>RefactoringServer.__importsOrganize</h4>
572 <b>__importsOrganize</b>(<i></i>) 570 <b>__importsOrganize</b>(<i></i>)
573
574 <p> 571 <p>
575 Private slot to organize imports. 572 Private slot to organize imports.
576 </p> 573 </p>
574
577 <a NAME="RefactoringServer.__importsRelativeToAbsolute" ID="RefactoringServer.__importsRelativeToAbsolute"></a> 575 <a NAME="RefactoringServer.__importsRelativeToAbsolute" ID="RefactoringServer.__importsRelativeToAbsolute"></a>
578 <h4>RefactoringServer.__importsRelativeToAbsolute</h4> 576 <h4>RefactoringServer.__importsRelativeToAbsolute</h4>
579 <b>__importsRelativeToAbsolute</b>(<i></i>) 577 <b>__importsRelativeToAbsolute</b>(<i></i>)
580
581 <p> 578 <p>
582 Private slot to transform relative to absolute imports. 579 Private slot to transform relative to absolute imports.
583 </p> 580 </p>
581
584 <a NAME="RefactoringServer.__initActions" ID="RefactoringServer.__initActions"></a> 582 <a NAME="RefactoringServer.__initActions" ID="RefactoringServer.__initActions"></a>
585 <h4>RefactoringServer.__initActions</h4> 583 <h4>RefactoringServer.__initActions</h4>
586 <b>__initActions</b>(<i></i>) 584 <b>__initActions</b>(<i></i>)
587
588 <p> 585 <p>
589 Private method to define the refactoring actions. 586 Private method to define the refactoring actions.
590 </p> 587 </p>
588
591 <a NAME="RefactoringServer.__initMenu" ID="RefactoringServer.__initMenu"></a> 589 <a NAME="RefactoringServer.__initMenu" ID="RefactoringServer.__initMenu"></a>
592 <h4>RefactoringServer.__initMenu</h4> 590 <h4>RefactoringServer.__initMenu</h4>
593 <b>__initMenu</b>(<i></i>) 591 <b>__initMenu</b>(<i></i>)
594
595 <p> 592 <p>
596 Private slot to initialize the refactoring menu. 593 Private slot to initialize the refactoring menu.
597 </p> 594 </p>
595
598 <dl> 596 <dl>
599 <dt>Return:</dt> 597 <dt>Return:</dt>
600 <dd> 598 <dd>
601 the menu generated 599 the menu generated
602 </dd> 600 </dd>
608 </dd> 606 </dd>
609 </dl> 607 </dl>
610 <a NAME="RefactoringServer.__inline" ID="RefactoringServer.__inline"></a> 608 <a NAME="RefactoringServer.__inline" ID="RefactoringServer.__inline"></a>
611 <h4>RefactoringServer.__inline</h4> 609 <h4>RefactoringServer.__inline</h4>
612 <b>__inline</b>(<i></i>) 610 <b>__inline</b>(<i></i>)
613
614 <p> 611 <p>
615 Private slot to handle the Inline Local Variable action. 612 Private slot to handle the Inline Local Variable action.
616 </p> 613 </p>
614
617 <a NAME="RefactoringServer.__inlineArgumentDefault" ID="RefactoringServer.__inlineArgumentDefault"></a> 615 <a NAME="RefactoringServer.__inlineArgumentDefault" ID="RefactoringServer.__inlineArgumentDefault"></a>
618 <h4>RefactoringServer.__inlineArgumentDefault</h4> 616 <h4>RefactoringServer.__inlineArgumentDefault</h4>
619 <b>__inlineArgumentDefault</b>(<i></i>) 617 <b>__inlineArgumentDefault</b>(<i></i>)
620
621 <p> 618 <p>
622 Private slot to inline the default value of a parameter of a 619 Private slot to inline the default value of a parameter of a
623 method or function. 620 method or function.
624 </p> 621 </p>
622
625 <a NAME="RefactoringServer.__introduceFactoryMethod" ID="RefactoringServer.__introduceFactoryMethod"></a> 623 <a NAME="RefactoringServer.__introduceFactoryMethod" ID="RefactoringServer.__introduceFactoryMethod"></a>
626 <h4>RefactoringServer.__introduceFactoryMethod</h4> 624 <h4>RefactoringServer.__introduceFactoryMethod</h4>
627 <b>__introduceFactoryMethod</b>(<i></i>) 625 <b>__introduceFactoryMethod</b>(<i></i>)
628
629 <p> 626 <p>
630 Private slot to introduce a factory method or global function. 627 Private slot to introduce a factory method or global function.
631 </p> 628 </p>
629
632 <a NAME="RefactoringServer.__introduceParameter" ID="RefactoringServer.__introduceParameter"></a> 630 <a NAME="RefactoringServer.__introduceParameter" ID="RefactoringServer.__introduceParameter"></a>
633 <h4>RefactoringServer.__introduceParameter</h4> 631 <h4>RefactoringServer.__introduceParameter</h4>
634 <b>__introduceParameter</b>(<i></i>) 632 <b>__introduceParameter</b>(<i></i>)
635
636 <p> 633 <p>
637 Private slot to introduce a parameter in a function. 634 Private slot to introduce a parameter in a function.
638 </p> 635 </p>
636
639 <a NAME="RefactoringServer.__methodToMethodObject" ID="RefactoringServer.__methodToMethodObject"></a> 637 <a NAME="RefactoringServer.__methodToMethodObject" ID="RefactoringServer.__methodToMethodObject"></a>
640 <h4>RefactoringServer.__methodToMethodObject</h4> 638 <h4>RefactoringServer.__methodToMethodObject</h4>
641 <b>__methodToMethodObject</b>(<i></i>) 639 <b>__methodToMethodObject</b>(<i></i>)
642
643 <p> 640 <p>
644 Private slot to change the signature of a method or function. 641 Private slot to change the signature of a method or function.
645 </p> 642 </p>
643
646 <a NAME="RefactoringServer.__move" ID="RefactoringServer.__move"></a> 644 <a NAME="RefactoringServer.__move" ID="RefactoringServer.__move"></a>
647 <h4>RefactoringServer.__move</h4> 645 <h4>RefactoringServer.__move</h4>
648 <b>__move</b>(<i>moveKind</i>) 646 <b>__move</b>(<i>moveKind</i>)
649
650 <p> 647 <p>
651 Private slot to handle the Move Method action. 648 Private slot to handle the Move Method action.
652 </p> 649 </p>
650
653 <dl> 651 <dl>
654 652
655 <dt><i>moveKind</i> (str (one of 'move_method' or 'move_module'))</dt> 653 <dt><i>moveKind</i> (str (one of 'move_method' or 'move_module'))</dt>
656 <dd> 654 <dd>
657 kind of move to be performed 655 kind of move to be performed
658 </dd> 656 </dd>
659 </dl> 657 </dl>
660 <a NAME="RefactoringServer.__performSOA" ID="RefactoringServer.__performSOA"></a> 658 <a NAME="RefactoringServer.__performSOA" ID="RefactoringServer.__performSOA"></a>
661 <h4>RefactoringServer.__performSOA</h4> 659 <h4>RefactoringServer.__performSOA</h4>
662 <b>__performSOA</b>(<i></i>) 660 <b>__performSOA</b>(<i></i>)
663
664 <p> 661 <p>
665 Private slot to perform SOA on all modules. 662 Private slot to perform SOA on all modules.
666 </p> 663 </p>
664
667 <a NAME="RefactoringServer.__processChanges" ID="RefactoringServer.__processChanges"></a> 665 <a NAME="RefactoringServer.__processChanges" ID="RefactoringServer.__processChanges"></a>
668 <h4>RefactoringServer.__processChanges</h4> 666 <h4>RefactoringServer.__processChanges</h4>
669 <b>__processChanges</b>(<i>result</i>) 667 <b>__processChanges</b>(<i>result</i>)
670
671 <p> 668 <p>
672 Private method to process the changes data sent by the refactoring 669 Private method to process the changes data sent by the refactoring
673 client. 670 client.
674 </p> 671 </p>
672
675 <dl> 673 <dl>
676 674
677 <dt><i>result</i> (dict)</dt> 675 <dt><i>result</i> (dict)</dt>
678 <dd> 676 <dd>
679 dictionary containing the changes data 677 dictionary containing the changes data
680 </dd> 678 </dd>
681 </dl> 679 </dl>
682 <a NAME="RefactoringServer.__processClientException" ID="RefactoringServer.__processClientException"></a> 680 <a NAME="RefactoringServer.__processClientException" ID="RefactoringServer.__processClientException"></a>
683 <h4>RefactoringServer.__processClientException</h4> 681 <h4>RefactoringServer.__processClientException</h4>
684 <b>__processClientException</b>(<i>params</i>) 682 <b>__processClientException</b>(<i>params</i>)
685
686 <p> 683 <p>
687 Private method to handle exceptions of the refactoring client. 684 Private method to handle exceptions of the refactoring client.
688 </p> 685 </p>
686
689 <dl> 687 <dl>
690 688
691 <dt><i>params</i> (dict)</dt> 689 <dt><i>params</i> (dict)</dt>
692 <dd> 690 <dd>
693 dictionary containing the exception data 691 dictionary containing the exception data
694 </dd> 692 </dd>
695 </dl> 693 </dl>
696 <a NAME="RefactoringServer.__processHistoryResult" ID="RefactoringServer.__processHistoryResult"></a> 694 <a NAME="RefactoringServer.__processHistoryResult" ID="RefactoringServer.__processHistoryResult"></a>
697 <h4>RefactoringServer.__processHistoryResult</h4> 695 <h4>RefactoringServer.__processHistoryResult</h4>
698 <b>__processHistoryResult</b>(<i>result</i>) 696 <b>__processHistoryResult</b>(<i>result</i>)
699
700 <p> 697 <p>
701 Private method to process the history data sent by the refactoring 698 Private method to process the history data sent by the refactoring
702 client. 699 client.
703 </p> 700 </p>
701
704 <dl> 702 <dl>
705 703
706 <dt><i>result</i> (dict)</dt> 704 <dt><i>result</i> (dict)</dt>
707 <dd> 705 <dd>
708 dictionary containing the history data 706 dictionary containing the history data
709 </dd> 707 </dd>
710 </dl> 708 </dl>
711 <a NAME="RefactoringServer.__processProgress" ID="RefactoringServer.__processProgress"></a> 709 <a NAME="RefactoringServer.__processProgress" ID="RefactoringServer.__processProgress"></a>
712 <h4>RefactoringServer.__processProgress</h4> 710 <h4>RefactoringServer.__processProgress</h4>
713 <b>__processProgress</b>(<i>params</i>) 711 <b>__processProgress</b>(<i>params</i>)
714
715 <p> 712 <p>
716 Private method to handle Progress commands. 713 Private method to handle Progress commands.
717 </p> 714 </p>
715
718 <dl> 716 <dl>
719 717
720 <dt><i>params</i> (dict)</dt> 718 <dt><i>params</i> (dict)</dt>
721 <dd> 719 <dd>
722 dictionary containing the progress data 720 dictionary containing the progress data
723 </dd> 721 </dd>
724 </dl> 722 </dl>
725 <a NAME="RefactoringServer.__queryDefinition" ID="RefactoringServer.__queryDefinition"></a> 723 <a NAME="RefactoringServer.__queryDefinition" ID="RefactoringServer.__queryDefinition"></a>
726 <h4>RefactoringServer.__queryDefinition</h4> 724 <h4>RefactoringServer.__queryDefinition</h4>
727 <b>__queryDefinition</b>(<i></i>) 725 <b>__queryDefinition</b>(<i></i>)
728
729 <p> 726 <p>
730 Private slot to handle the Find Definition action. 727 Private slot to handle the Find Definition action.
731 </p> 728 </p>
729
732 <a NAME="RefactoringServer.__queryDefinitionResult" ID="RefactoringServer.__queryDefinitionResult"></a> 730 <a NAME="RefactoringServer.__queryDefinitionResult" ID="RefactoringServer.__queryDefinitionResult"></a>
733 <h4>RefactoringServer.__queryDefinitionResult</h4> 731 <h4>RefactoringServer.__queryDefinitionResult</h4>
734 <b>__queryDefinitionResult</b>(<i>result</i>) 732 <b>__queryDefinitionResult</b>(<i>result</i>)
735
736 <p> 733 <p>
737 Private method to handle the "Query Definition" result sent by 734 Private method to handle the "Query Definition" result sent by
738 the client. 735 the client.
739 </p> 736 </p>
737
740 <dl> 738 <dl>
741 739
742 <dt><i>result</i> (dict)</dt> 740 <dt><i>result</i> (dict)</dt>
743 <dd> 741 <dd>
744 dictionary containing the result data 742 dictionary containing the result data
745 </dd> 743 </dd>
746 </dl> 744 </dl>
747 <a NAME="RefactoringServer.__queryImplementations" ID="RefactoringServer.__queryImplementations"></a> 745 <a NAME="RefactoringServer.__queryImplementations" ID="RefactoringServer.__queryImplementations"></a>
748 <h4>RefactoringServer.__queryImplementations</h4> 746 <h4>RefactoringServer.__queryImplementations</h4>
749 <b>__queryImplementations</b>(<i></i>) 747 <b>__queryImplementations</b>(<i></i>)
750
751 <p> 748 <p>
752 Private slot to handle the Find Implementations action. 749 Private slot to handle the Find Implementations action.
753 </p> 750 </p>
751
754 <a NAME="RefactoringServer.__queryImplementationsResult" ID="RefactoringServer.__queryImplementationsResult"></a> 752 <a NAME="RefactoringServer.__queryImplementationsResult" ID="RefactoringServer.__queryImplementationsResult"></a>
755 <h4>RefactoringServer.__queryImplementationsResult</h4> 753 <h4>RefactoringServer.__queryImplementationsResult</h4>
756 <b>__queryImplementationsResult</b>(<i>result</i>) 754 <b>__queryImplementationsResult</b>(<i>result</i>)
757
758 <p> 755 <p>
759 Private method to handle the "Query Implementations" result sent by 756 Private method to handle the "Query Implementations" result sent by
760 the client. 757 the client.
761 </p> 758 </p>
759
762 <dl> 760 <dl>
763 761
764 <dt><i>result</i> (dict)</dt> 762 <dt><i>result</i> (dict)</dt>
765 <dd> 763 <dd>
766 dictionary containing the result data 764 dictionary containing the result data
767 </dd> 765 </dd>
768 </dl> 766 </dl>
769 <a NAME="RefactoringServer.__queryReferences" ID="RefactoringServer.__queryReferences"></a> 767 <a NAME="RefactoringServer.__queryReferences" ID="RefactoringServer.__queryReferences"></a>
770 <h4>RefactoringServer.__queryReferences</h4> 768 <h4>RefactoringServer.__queryReferences</h4>
771 <b>__queryReferences</b>(<i></i>) 769 <b>__queryReferences</b>(<i></i>)
772
773 <p> 770 <p>
774 Private slot to handle the Find References action. 771 Private slot to handle the Find References action.
775 </p> 772 </p>
773
776 <a NAME="RefactoringServer.__queryReferencesResult" ID="RefactoringServer.__queryReferencesResult"></a> 774 <a NAME="RefactoringServer.__queryReferencesResult" ID="RefactoringServer.__queryReferencesResult"></a>
777 <h4>RefactoringServer.__queryReferencesResult</h4> 775 <h4>RefactoringServer.__queryReferencesResult</h4>
778 <b>__queryReferencesResult</b>(<i>result</i>) 776 <b>__queryReferencesResult</b>(<i>result</i>)
779
780 <p> 777 <p>
781 Private method to handle the "Query References" result sent by 778 Private method to handle the "Query References" result sent by
782 the client. 779 the client.
783 </p> 780 </p>
781
784 <dl> 782 <dl>
785 783
786 <dt><i>result</i> (dict)</dt> 784 <dt><i>result</i> (dict)</dt>
787 <dd> 785 <dd>
788 dictionary containing the result data 786 dictionary containing the result data
789 </dd> 787 </dd>
790 </dl> 788 </dl>
791 <a NAME="RefactoringServer.__refactoringDialogClosed" ID="RefactoringServer.__refactoringDialogClosed"></a> 789 <a NAME="RefactoringServer.__refactoringDialogClosed" ID="RefactoringServer.__refactoringDialogClosed"></a>
792 <h4>RefactoringServer.__refactoringDialogClosed</h4> 790 <h4>RefactoringServer.__refactoringDialogClosed</h4>
793 <b>__refactoringDialogClosed</b>(<i>changeGroup</i>) 791 <b>__refactoringDialogClosed</b>(<i>changeGroup</i>)
794
795 <p> 792 <p>
796 Private slot handling the closing of a refactoring dialog. 793 Private slot handling the closing of a refactoring dialog.
797 </p> 794 </p>
795
798 <dl> 796 <dl>
799 797
800 <dt><i>changeGroup</i> (str)</dt> 798 <dt><i>changeGroup</i> (str)</dt>
801 <dd> 799 <dd>
802 name of the refactoring change group the dialog 800 name of the refactoring change group the dialog
804 </dd> 802 </dd>
805 </dl> 803 </dl>
806 <a NAME="RefactoringServer.__rename" ID="RefactoringServer.__rename"></a> 804 <a NAME="RefactoringServer.__rename" ID="RefactoringServer.__rename"></a>
807 <h4>RefactoringServer.__rename</h4> 805 <h4>RefactoringServer.__rename</h4>
808 <b>__rename</b>(<i></i>) 806 <b>__rename</b>(<i></i>)
809
810 <p> 807 <p>
811 Private slot to handle the Rename action. 808 Private slot to handle the Rename action.
812 </p> 809 </p>
810
813 <a NAME="RefactoringServer.__renameLocal" ID="RefactoringServer.__renameLocal"></a> 811 <a NAME="RefactoringServer.__renameLocal" ID="RefactoringServer.__renameLocal"></a>
814 <h4>RefactoringServer.__renameLocal</h4> 812 <h4>RefactoringServer.__renameLocal</h4>
815 <b>__renameLocal</b>(<i></i>) 813 <b>__renameLocal</b>(<i></i>)
816
817 <p> 814 <p>
818 Private slot to handle the Local Rename action. 815 Private slot to handle the Local Rename action.
819 </p> 816 </p>
817
820 <a NAME="RefactoringServer.__renameModule" ID="RefactoringServer.__renameModule"></a> 818 <a NAME="RefactoringServer.__renameModule" ID="RefactoringServer.__renameModule"></a>
821 <h4>RefactoringServer.__renameModule</h4> 819 <h4>RefactoringServer.__renameModule</h4>
822 <b>__renameModule</b>(<i></i>) 820 <b>__renameModule</b>(<i></i>)
823
824 <p> 821 <p>
825 Private slot to handle the Rename Current Module action. 822 Private slot to handle the Rename Current Module action.
826 </p> 823 </p>
824
827 <a NAME="RefactoringServer.__restructure" ID="RefactoringServer.__restructure"></a> 825 <a NAME="RefactoringServer.__restructure" ID="RefactoringServer.__restructure"></a>
828 <h4>RefactoringServer.__restructure</h4> 826 <h4>RefactoringServer.__restructure</h4>
829 <b>__restructure</b>(<i></i>) 827 <b>__restructure</b>(<i></i>)
830
831 <p> 828 <p>
832 Private slot to restructure code. 829 Private slot to restructure code.
833 </p> 830 </p>
831
834 <a NAME="RefactoringServer.__ropeConfigFile" ID="RefactoringServer.__ropeConfigFile"></a> 832 <a NAME="RefactoringServer.__ropeConfigFile" ID="RefactoringServer.__ropeConfigFile"></a>
835 <h4>RefactoringServer.__ropeConfigFile</h4> 833 <h4>RefactoringServer.__ropeConfigFile</h4>
836 <b>__ropeConfigFile</b>(<i>writing=False</i>) 834 <b>__ropeConfigFile</b>(<i>writing=False</i>)
837
838 <p> 835 <p>
839 Private method to get the name of the rope configuration file. 836 Private method to get the name of the rope configuration file.
840 </p> 837 </p>
838
841 <dl> 839 <dl>
842 840
843 <dt><i>writing</i> (bool (optional))</dt> 841 <dt><i>writing</i> (bool (optional))</dt>
844 <dd> 842 <dd>
845 flag indicating to get the name for writing (defaults to False) 843 flag indicating to get the name for writing (defaults to False)
858 </dd> 856 </dd>
859 </dl> 857 </dl>
860 <a NAME="RefactoringServer.__ropeInfo" ID="RefactoringServer.__ropeInfo"></a> 858 <a NAME="RefactoringServer.__ropeInfo" ID="RefactoringServer.__ropeInfo"></a>
861 <h4>RefactoringServer.__ropeInfo</h4> 859 <h4>RefactoringServer.__ropeInfo</h4>
862 <b>__ropeInfo</b>(<i></i>) 860 <b>__ropeInfo</b>(<i></i>)
863
864 <p> 861 <p>
865 Private slot to show some info about rope. 862 Private slot to show some info about rope.
866 </p> 863 </p>
864
867 <a NAME="RefactoringServer.__setConfig" ID="RefactoringServer.__setConfig"></a> 865 <a NAME="RefactoringServer.__setConfig" ID="RefactoringServer.__setConfig"></a>
868 <h4>RefactoringServer.__setConfig</h4> 866 <h4>RefactoringServer.__setConfig</h4>
869 <b>__setConfig</b>(<i>params</i>) 867 <b>__setConfig</b>(<i>params</i>)
870
871 <p> 868 <p>
872 Private method to set the rope client configuration data. 869 Private method to set the rope client configuration data.
873 </p> 870 </p>
871
874 <dl> 872 <dl>
875 873
876 <dt><i>params</i> (dict)</dt> 874 <dt><i>params</i> (dict)</dt>
877 <dd> 875 <dd>
878 dictionary containing the configuration data 876 dictionary containing the configuration data
879 </dd> 877 </dd>
880 </dl> 878 </dl>
881 <a NAME="RefactoringServer.__showFileHistory" ID="RefactoringServer.__showFileHistory"></a> 879 <a NAME="RefactoringServer.__showFileHistory" ID="RefactoringServer.__showFileHistory"></a>
882 <h4>RefactoringServer.__showFileHistory</h4> 880 <h4>RefactoringServer.__showFileHistory</h4>
883 <b>__showFileHistory</b>(<i></i>) 881 <b>__showFileHistory</b>(<i></i>)
884
885 <p> 882 <p>
886 Private method to show the refactoring history of the current file. 883 Private method to show the refactoring history of the current file.
887 </p> 884 </p>
885
888 <a NAME="RefactoringServer.__showProjectHistory" ID="RefactoringServer.__showProjectHistory"></a> 886 <a NAME="RefactoringServer.__showProjectHistory" ID="RefactoringServer.__showProjectHistory"></a>
889 <h4>RefactoringServer.__showProjectHistory</h4> 887 <h4>RefactoringServer.__showProjectHistory</h4>
890 <b>__showProjectHistory</b>(<i></i>) 888 <b>__showProjectHistory</b>(<i></i>)
891
892 <p> 889 <p>
893 Private method to show the project refactoring history. 890 Private method to show the project refactoring history.
894 </p> 891 </p>
892
895 <a NAME="RefactoringServer.__showRefactoringHistoryMenu" ID="RefactoringServer.__showRefactoringHistoryMenu"></a> 893 <a NAME="RefactoringServer.__showRefactoringHistoryMenu" ID="RefactoringServer.__showRefactoringHistoryMenu"></a>
896 <h4>RefactoringServer.__showRefactoringHistoryMenu</h4> 894 <h4>RefactoringServer.__showRefactoringHistoryMenu</h4>
897 <b>__showRefactoringHistoryMenu</b>(<i></i>) 895 <b>__showRefactoringHistoryMenu</b>(<i></i>)
898
899 <p> 896 <p>
900 Private slot called before the refactoring history menu is shown. 897 Private slot called before the refactoring history menu is shown.
901 </p> 898 </p>
899
902 <a NAME="RefactoringServer.__showRopeHelp" ID="RefactoringServer.__showRopeHelp"></a> 900 <a NAME="RefactoringServer.__showRopeHelp" ID="RefactoringServer.__showRopeHelp"></a>
903 <h4>RefactoringServer.__showRopeHelp</h4> 901 <h4>RefactoringServer.__showRopeHelp</h4>
904 <b>__showRopeHelp</b>(<i></i>) 902 <b>__showRopeHelp</b>(<i></i>)
905
906 <p> 903 <p>
907 Private slot to show help about the refactorings offered by Rope. 904 Private slot to show help about the refactorings offered by Rope.
908 </p> 905 </p>
906
909 <a NAME="RefactoringServer.__soaFinished" ID="RefactoringServer.__soaFinished"></a> 907 <a NAME="RefactoringServer.__soaFinished" ID="RefactoringServer.__soaFinished"></a>
910 <h4>RefactoringServer.__soaFinished</h4> 908 <h4>RefactoringServer.__soaFinished</h4>
911 <b>__soaFinished</b>(<i>result</i>) 909 <b>__soaFinished</b>(<i>result</i>)
912
913 <p> 910 <p>
914 Private method to handle the "Soa Finished" result sent by 911 Private method to handle the "Soa Finished" result sent by
915 the client. 912 the client.
916 </p> 913 </p>
914
917 <dl> 915 <dl>
918 916
919 <dt><i>result</i> (dict)</dt> 917 <dt><i>result</i> (dict)</dt>
920 <dd> 918 <dd>
921 dictionary containing the result data 919 dictionary containing the result data
922 </dd> 920 </dd>
923 </dl> 921 </dl>
924 <a NAME="RefactoringServer.__startRefactoringClient" ID="RefactoringServer.__startRefactoringClient"></a> 922 <a NAME="RefactoringServer.__startRefactoringClient" ID="RefactoringServer.__startRefactoringClient"></a>
925 <h4>RefactoringServer.__startRefactoringClient</h4> 923 <h4>RefactoringServer.__startRefactoringClient</h4>
926 <b>__startRefactoringClient</b>(<i>interpreter, clientEnv</i>) 924 <b>__startRefactoringClient</b>(<i>interpreter, clientEnv</i>)
927
928 <p> 925 <p>
929 Private method to start the refactoring client. 926 Private method to start the refactoring client.
930 </p> 927 </p>
928
931 <dl> 929 <dl>
932 930
933 <dt><i>interpreter</i> (str)</dt> 931 <dt><i>interpreter</i> (str)</dt>
934 <dd> 932 <dd>
935 interpreter to be used for the refactoring client 933 interpreter to be used for the refactoring client
953 </dd> 951 </dd>
954 </dl> 952 </dl>
955 <a NAME="RefactoringServer.__transformModuleToPackage" ID="RefactoringServer.__transformModuleToPackage"></a> 953 <a NAME="RefactoringServer.__transformModuleToPackage" ID="RefactoringServer.__transformModuleToPackage"></a>
956 <h4>RefactoringServer.__transformModuleToPackage</h4> 954 <h4>RefactoringServer.__transformModuleToPackage</h4>
957 <b>__transformModuleToPackage</b>(<i></i>) 955 <b>__transformModuleToPackage</b>(<i></i>)
958
959 <p> 956 <p>
960 Private slot to transform a module to a package. 957 Private slot to transform a module to a package.
961 </p> 958 </p>
959
962 <a NAME="RefactoringServer.__updateConfig" ID="RefactoringServer.__updateConfig"></a> 960 <a NAME="RefactoringServer.__updateConfig" ID="RefactoringServer.__updateConfig"></a>
963 <h4>RefactoringServer.__updateConfig</h4> 961 <h4>RefactoringServer.__updateConfig</h4>
964 <b>__updateConfig</b>(<i></i>) 962 <b>__updateConfig</b>(<i></i>)
965
966 <p> 963 <p>
967 Private slot to update the configuration file. 964 Private slot to update the configuration file.
968 </p> 965 </p>
966
969 <a NAME="RefactoringServer.__useFunction" ID="RefactoringServer.__useFunction"></a> 967 <a NAME="RefactoringServer.__useFunction" ID="RefactoringServer.__useFunction"></a>
970 <h4>RefactoringServer.__useFunction</h4> 968 <h4>RefactoringServer.__useFunction</h4>
971 <b>__useFunction</b>(<i></i>) 969 <b>__useFunction</b>(<i></i>)
972
973 <p> 970 <p>
974 Private slot to use a function wherever possible. 971 Private slot to use a function wherever possible.
975 </p> 972 </p>
973
976 <a NAME="RefactoringServer.activate" ID="RefactoringServer.activate"></a> 974 <a NAME="RefactoringServer.activate" ID="RefactoringServer.activate"></a>
977 <h4>RefactoringServer.activate</h4> 975 <h4>RefactoringServer.activate</h4>
978 <b>activate</b>(<i></i>) 976 <b>activate</b>(<i></i>)
979
980 <p> 977 <p>
981 Public method to activate the refactoring server. 978 Public method to activate the refactoring server.
982 </p> 979 </p>
983 <p> 980 <p>
984 This is performed when the rope plug-in is activated. 981 This is performed when the rope plug-in is activated.
985 </p> 982 </p>
983
986 <a NAME="RefactoringServer.confirmAllBuffersSaved" ID="RefactoringServer.confirmAllBuffersSaved"></a> 984 <a NAME="RefactoringServer.confirmAllBuffersSaved" ID="RefactoringServer.confirmAllBuffersSaved"></a>
987 <h4>RefactoringServer.confirmAllBuffersSaved</h4> 985 <h4>RefactoringServer.confirmAllBuffersSaved</h4>
988 <b>confirmAllBuffersSaved</b>(<i></i>) 986 <b>confirmAllBuffersSaved</b>(<i></i>)
989
990 <p> 987 <p>
991 Public method to check, if any editor has unsaved changes. 988 Public method to check, if any editor has unsaved changes.
992 </p> 989 </p>
990
993 <dl> 991 <dl>
994 <dt>Return:</dt> 992 <dt>Return:</dt>
995 <dd> 993 <dd>
996 flag indicating, that no editor contains unsaved edits 994 flag indicating, that no editor contains unsaved edits
997 </dd> 995 </dd>
1003 </dd> 1001 </dd>
1004 </dl> 1002 </dl>
1005 <a NAME="RefactoringServer.confirmBufferIsSaved" ID="RefactoringServer.confirmBufferIsSaved"></a> 1003 <a NAME="RefactoringServer.confirmBufferIsSaved" ID="RefactoringServer.confirmBufferIsSaved"></a>
1006 <h4>RefactoringServer.confirmBufferIsSaved</h4> 1004 <h4>RefactoringServer.confirmBufferIsSaved</h4>
1007 <b>confirmBufferIsSaved</b>(<i>editor</i>) 1005 <b>confirmBufferIsSaved</b>(<i>editor</i>)
1008
1009 <p> 1006 <p>
1010 Public method to check, if an editor has unsaved changes. 1007 Public method to check, if an editor has unsaved changes.
1011 </p> 1008 </p>
1009
1012 <dl> 1010 <dl>
1013 1011
1014 <dt><i>editor</i> (Editor)</dt> 1012 <dt><i>editor</i> (Editor)</dt>
1015 <dd> 1013 <dd>
1016 reference to the editor to be checked 1014 reference to the editor to be checked
1030 </dd> 1028 </dd>
1031 </dl> 1029 </dl>
1032 <a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a> 1030 <a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a>
1033 <h4>RefactoringServer.deactivate</h4> 1031 <h4>RefactoringServer.deactivate</h4>
1034 <b>deactivate</b>(<i></i>) 1032 <b>deactivate</b>(<i></i>)
1035
1036 <p> 1033 <p>
1037 Public method to deactivate the refactoring server. 1034 Public method to deactivate the refactoring server.
1038 </p> 1035 </p>
1036
1039 <a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a> 1037 <a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a>
1040 <h4>RefactoringServer.getActions</h4> 1038 <h4>RefactoringServer.getActions</h4>
1041 <b>getActions</b>(<i></i>) 1039 <b>getActions</b>(<i></i>)
1042
1043 <p> 1040 <p>
1044 Public method to get a list of all actions. 1041 Public method to get a list of all actions.
1045 </p> 1042 </p>
1043
1046 <dl> 1044 <dl>
1047 <dt>Return:</dt> 1045 <dt>Return:</dt>
1048 <dd> 1046 <dd>
1049 list of all actions 1047 list of all actions
1050 </dd> 1048 </dd>
1056 </dd> 1054 </dd>
1057 </dl> 1055 </dl>
1058 <a NAME="RefactoringServer.getMainWindow" ID="RefactoringServer.getMainWindow"></a> 1056 <a NAME="RefactoringServer.getMainWindow" ID="RefactoringServer.getMainWindow"></a>
1059 <h4>RefactoringServer.getMainWindow</h4> 1057 <h4>RefactoringServer.getMainWindow</h4>
1060 <b>getMainWindow</b>(<i></i>) 1058 <b>getMainWindow</b>(<i></i>)
1061
1062 <p> 1059 <p>
1063 Public method to get a reference to the IDE main window. 1060 Public method to get a reference to the IDE main window.
1064 </p> 1061 </p>
1062
1065 <dl> 1063 <dl>
1066 <dt>Return:</dt> 1064 <dt>Return:</dt>
1067 <dd> 1065 <dd>
1068 reference to the IDE main window 1066 reference to the IDE main window
1069 </dd> 1067 </dd>
1075 </dd> 1073 </dd>
1076 </dl> 1074 </dl>
1077 <a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a> 1075 <a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a>
1078 <h4>RefactoringServer.handleCall</h4> 1076 <h4>RefactoringServer.handleCall</h4>
1079 <b>handleCall</b>(<i>method, params</i>) 1077 <b>handleCall</b>(<i>method, params</i>)
1080
1081 <p> 1078 <p>
1082 Public method to handle a method call from the client. 1079 Public method to handle a method call from the client.
1083 </p> 1080 </p>
1081
1084 <dl> 1082 <dl>
1085 1083
1086 <dt><i>method</i> (str)</dt> 1084 <dt><i>method</i> (str)</dt>
1087 <dd> 1085 <dd>
1088 requested method name 1086 requested method name
1093 </dd> 1091 </dd>
1094 </dl> 1092 </dl>
1095 <a NAME="RefactoringServer.handleNewConnection" ID="RefactoringServer.handleNewConnection"></a> 1093 <a NAME="RefactoringServer.handleNewConnection" ID="RefactoringServer.handleNewConnection"></a>
1096 <h4>RefactoringServer.handleNewConnection</h4> 1094 <h4>RefactoringServer.handleNewConnection</h4>
1097 <b>handleNewConnection</b>(<i></i>) 1095 <b>handleNewConnection</b>(<i></i>)
1098
1099 <p> 1096 <p>
1100 Public slot for new incoming connections from a client. 1097 Public slot for new incoming connections from a client.
1101 </p> 1098 </p>
1099
1102 <a NAME="RefactoringServer.handleRopeError" ID="RefactoringServer.handleRopeError"></a> 1100 <a NAME="RefactoringServer.handleRopeError" ID="RefactoringServer.handleRopeError"></a>
1103 <h4>RefactoringServer.handleRopeError</h4> 1101 <h4>RefactoringServer.handleRopeError</h4>
1104 <b>handleRopeError</b>(<i>result</i>) 1102 <b>handleRopeError</b>(<i>result</i>)
1105
1106 <p> 1103 <p>
1107 Public method to handle a rope error. 1104 Public method to handle a rope error.
1108 </p> 1105 </p>
1106
1109 <dl> 1107 <dl>
1110 1108
1111 <dt><i>result</i> (dict)</dt> 1109 <dt><i>result</i> (dict)</dt>
1112 <dd> 1110 <dd>
1113 dictionary containing the error information 1111 dictionary containing the error information
1126 </dd> 1124 </dd>
1127 </dl> 1125 </dl>
1128 <a NAME="RefactoringServer.projectClosed" ID="RefactoringServer.projectClosed"></a> 1126 <a NAME="RefactoringServer.projectClosed" ID="RefactoringServer.projectClosed"></a>
1129 <h4>RefactoringServer.projectClosed</h4> 1127 <h4>RefactoringServer.projectClosed</h4>
1130 <b>projectClosed</b>(<i></i>) 1128 <b>projectClosed</b>(<i></i>)
1131
1132 <p> 1129 <p>
1133 Public slot to handle the projectClosed signal. 1130 Public slot to handle the projectClosed signal.
1134 </p> 1131 </p>
1132
1135 <a NAME="RefactoringServer.projectOpened" ID="RefactoringServer.projectOpened"></a> 1133 <a NAME="RefactoringServer.projectOpened" ID="RefactoringServer.projectOpened"></a>
1136 <h4>RefactoringServer.projectOpened</h4> 1134 <h4>RefactoringServer.projectOpened</h4>
1137 <b>projectOpened</b>(<i></i>) 1135 <b>projectOpened</b>(<i></i>)
1138
1139 <p> 1136 <p>
1140 Public slot to handle the projectOpened signal. 1137 Public slot to handle the projectOpened signal.
1141 </p> 1138 </p>
1139
1142 <a NAME="RefactoringServer.refreshEditors" ID="RefactoringServer.refreshEditors"></a> 1140 <a NAME="RefactoringServer.refreshEditors" ID="RefactoringServer.refreshEditors"></a>
1143 <h4>RefactoringServer.refreshEditors</h4> 1141 <h4>RefactoringServer.refreshEditors</h4>
1144 <b>refreshEditors</b>(<i>changedFiles</i>) 1142 <b>refreshEditors</b>(<i>changedFiles</i>)
1145
1146 <p> 1143 <p>
1147 Public method to refresh modified editors. 1144 Public method to refresh modified editors.
1148 </p> 1145 </p>
1146
1149 <dl> 1147 <dl>
1150 1148
1151 <dt><i>changedFiles</i> (list of str)</dt> 1149 <dt><i>changedFiles</i> (list of str)</dt>
1152 <dd> 1150 <dd>
1153 list of changed files 1151 list of changed files
1154 </dd> 1152 </dd>
1155 </dl> 1153 </dl>
1156 <a NAME="RefactoringServer.reportChanged" ID="RefactoringServer.reportChanged"></a> 1154 <a NAME="RefactoringServer.reportChanged" ID="RefactoringServer.reportChanged"></a>
1157 <h4>RefactoringServer.reportChanged</h4> 1155 <h4>RefactoringServer.reportChanged</h4>
1158 <b>reportChanged</b>(<i>filename, oldSource</i>) 1156 <b>reportChanged</b>(<i>filename, oldSource</i>)
1159
1160 <p> 1157 <p>
1161 Public slot to report some changed sources. 1158 Public slot to report some changed sources.
1162 </p> 1159 </p>
1160
1163 <dl> 1161 <dl>
1164 1162
1165 <dt><i>filename</i> (str)</dt> 1163 <dt><i>filename</i> (str)</dt>
1166 <dd> 1164 <dd>
1167 file name of the changed source 1165 file name of the changed source

Mercurial Repository: Rope Refactoring

eric ide

mercurial