Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.VCS.VersionControl.html

Documentation/Source/eric5.VCS.VersionControl.html

changeset 2966
f85f686981ad
parent 2853
0866c3aac79f
child 3302
e92f0dd51979
equal deleted inserted replaced
2965:d133c7edd88a 2966:f85f686981ad
50 and the common methods. 50 and the common methods.
51 </p><h3>Signals</h3> 51 </p><h3>Signals</h3>
52 <dl> 52 <dl>
53 <dt>vcsStatusChanged()</dt> 53 <dt>vcsStatusChanged()</dt>
54 <dd> 54 <dd>
55 emitted to indicate a change of the overall VCS status 55 emitted to indicate a change of the overall
56 VCS status
56 </dd><dt>vcsStatusMonitorData(list of str)</dt> 57 </dd><dt>vcsStatusMonitorData(list of str)</dt>
57 <dd> 58 <dd>
58 emitted to update the VCS status 59 emitted to update the VCS status
59 </dd><dt>vcsStatusMonitorStatus(str, str)</dt> 60 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
60 <dd> 61 <dd>
61 emitted to signal the status of the 62 emitted to signal the status of
62 monitoring thread (ok, nok, op, off) and a status message 63 the monitoring thread (ok, nok, op, off) and a status message
63 </dd> 64 </dd>
64 </dl> 65 </dl>
65 <h3>Derived from</h3> 66 <h3>Derived from</h3>
66 QObject 67 QObject
67 <h3>Class Attributes</h3> 68 <h3>Class Attributes</h3>
119 </tr><tr> 120 </tr><tr>
120 <td><a href="#VersionControl.startStatusMonitor">startStatusMonitor</a></td> 121 <td><a href="#VersionControl.startStatusMonitor">startStatusMonitor</a></td>
121 <td>Public method to start the VCS status monitor thread.</td> 122 <td>Public method to start the VCS status monitor thread.</td>
122 </tr><tr> 123 </tr><tr>
123 <td><a href="#VersionControl.startSynchronizedProcess">startSynchronizedProcess</a></td> 124 <td><a href="#VersionControl.startSynchronizedProcess">startSynchronizedProcess</a></td>
124 <td>Public method to start a synchroneous process</td> 125 <td>Public method to start a synchroneous process.</td>
125 </tr><tr> 126 </tr><tr>
126 <td><a href="#VersionControl.stopStatusMonitor">stopStatusMonitor</a></td> 127 <td><a href="#VersionControl.stopStatusMonitor">stopStatusMonitor</a></td>
127 <td>Public method to stop the VCS status monitor thread.</td> 128 <td>Public method to stop the VCS status monitor thread.</td>
128 </tr><tr> 129 </tr><tr>
129 <td><a href="#VersionControl.vcsAdd">vcsAdd</a></td> 130 <td><a href="#VersionControl.vcsAdd">vcsAdd</a></td>
293 </dd> 294 </dd>
294 </dl><a NAME="VersionControl._createStatusMonitorThread" ID="VersionControl._createStatusMonitorThread"></a> 295 </dl><a NAME="VersionControl._createStatusMonitorThread" ID="VersionControl._createStatusMonitorThread"></a>
295 <h4>VersionControl._createStatusMonitorThread</h4> 296 <h4>VersionControl._createStatusMonitorThread</h4>
296 <b>_createStatusMonitorThread</b>(<i>interval, project</i>) 297 <b>_createStatusMonitorThread</b>(<i>interval, project</i>)
297 <p> 298 <p>
298 Protected method to create an instance of the VCS status monitor thread. 299 Protected method to create an instance of the VCS status monitor
300 thread.
299 </p><p> 301 </p><p>
300 Note: This method should be overwritten in subclasses in order to support 302 Note: This method should be overwritten in subclasses in order to
301 VCS status monitoring. 303 support VCS status monitoring.
302 </p><dl> 304 </p><dl>
303 <dt><i>interval</i></dt> 305 <dt><i>interval</i></dt>
304 <dd> 306 <dd>
305 check interval for the monitor thread in seconds (integer) 307 check interval for the monitor thread in seconds
308 (integer)
306 </dd><dt><i>project</i></dt> 309 </dd><dt><i>project</i></dt>
307 <dd> 310 <dd>
308 reference to the project object 311 reference to the project object
309 </dd> 312 </dd>
310 </dl><dl> 313 </dl><dl>
314 </dd> 317 </dd>
315 </dl><a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a> 318 </dl><a NAME="VersionControl.addArguments" ID="VersionControl.addArguments"></a>
316 <h4>VersionControl.addArguments</h4> 319 <h4>VersionControl.addArguments</h4>
317 <b>addArguments</b>(<i>args, argslist</i>) 320 <b>addArguments</b>(<i>args, argslist</i>)
318 <p> 321 <p>
319 Protected method to add an argument list to the already present arguments. 322 Protected method to add an argument list to the already present
323 arguments.
320 </p><dl> 324 </p><dl>
321 <dt><i>args</i></dt> 325 <dt><i>args</i></dt>
322 <dd> 326 <dd>
323 current arguments list (list of strings) 327 current arguments list (list of strings)
324 </dd><dt><i>argslist</i></dt> 328 </dd><dt><i>argslist</i></dt>
405 </dd> 409 </dd>
406 </dl><a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> 410 </dl><a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a>
407 <h4>VersionControl.splitPathList</h4> 411 <h4>VersionControl.splitPathList</h4>
408 <b>splitPathList</b>(<i>names</i>) 412 <b>splitPathList</b>(<i>names</i>)
409 <p> 413 <p>
410 Public method splitting the list of names into a common directory part and 414 Public method splitting the list of names into a common directory part
411 a file list. 415 and a file list.
412 </p><dl> 416 </p><dl>
413 <dt><i>names</i></dt> 417 <dt><i>names</i></dt>
414 <dd> 418 <dd>
415 list of paths (list of strings) 419 list of paths (list of strings)
416 </dd> 420 </dd>
436 </dd> 440 </dd>
437 </dl><a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> 441 </dl><a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a>
438 <h4>VersionControl.startSynchronizedProcess</h4> 442 <h4>VersionControl.startSynchronizedProcess</h4>
439 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>) 443 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>)
440 <p> 444 <p>
441 Public method to start a synchroneous process 445 Public method to start a synchroneous process.
442 </p><p> 446 </p><p>
443 This method starts a process and waits 447 This method starts a process and waits
444 for its end while still serving the Qt event loop. 448 for its end while still serving the Qt event loop.
445 </p><dl> 449 </p><dl>
446 <dt><i>proc</i></dt> 450 <dt><i>proc</i></dt>
469 </p><a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a> 473 </p><a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a>
470 <h4>VersionControl.vcsAdd</h4> 474 <h4>VersionControl.vcsAdd</h4>
471 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) 475 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
472 <p> 476 <p>
473 Public method used to add a file/directory in the vcs. 477 Public method used to add a file/directory in the vcs.
474 </p><p>
475 It must not return anything.
476 </p><dl> 478 </p><dl>
477 <dt><i>name</i></dt> 479 <dt><i>name</i></dt>
478 <dd> 480 <dd>
479 file/directory name to be added (string) 481 file/directory name to be added (string)
480 </dd><dt><i>isDir</i></dt> 482 </dd><dt><i>isDir</i></dt>
485 flag indicating quiet operations (boolean) 487 flag indicating quiet operations (boolean)
486 </dd> 488 </dd>
487 </dl><dl> 489 </dl><dl>
488 <dt>Raises <b>RuntimeError</b>:</dt> 490 <dt>Raises <b>RuntimeError</b>:</dt>
489 <dd> 491 <dd>
490 not implemented 492 to indicate that this method must be
493 implemented by a subclass
491 </dd> 494 </dd>
492 </dl><a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a> 495 </dl><a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a>
493 <h4>VersionControl.vcsAddBinary</h4> 496 <h4>VersionControl.vcsAddBinary</h4>
494 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) 497 <b>vcsAddBinary</b>(<i>name, isDir=False</i>)
495 <p> 498 <p>
496 Public method used to add a file/directory in binary mode in the vcs. 499 Public method used to add a file/directory in binary mode in the vcs.
497 </p><p>
498 It must not return anything.
499 </p><dl> 500 </p><dl>
500 <dt><i>name</i></dt> 501 <dt><i>name</i></dt>
501 <dd> 502 <dd>
502 file/directory name to be added (string) 503 file/directory name to be added (string)
503 </dd><dt><i>isDir</i></dt> 504 </dd><dt><i>isDir</i></dt>
505 flag indicating name is a directory (boolean) 506 flag indicating name is a directory (boolean)
506 </dd> 507 </dd>
507 </dl><dl> 508 </dl><dl>
508 <dt>Raises <b>RuntimeError</b>:</dt> 509 <dt>Raises <b>RuntimeError</b>:</dt>
509 <dd> 510 <dd>
510 not implemented 511 to indicate that this method must be
512 implemented by a subclass
511 </dd> 513 </dd>
512 </dl><a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a> 514 </dl><a NAME="VersionControl.vcsAddTree" ID="VersionControl.vcsAddTree"></a>
513 <h4>VersionControl.vcsAddTree</h4> 515 <h4>VersionControl.vcsAddTree</h4>
514 <b>vcsAddTree</b>(<i>path</i>) 516 <b>vcsAddTree</b>(<i>path</i>)
515 <p> 517 <p>
516 Public method to add a directory tree rooted at path in the vcs. 518 Public method to add a directory tree rooted at path in the vcs.
517 </p><p>
518 It must not return anything.
519 </p><dl> 519 </p><dl>
520 <dt><i>path</i></dt> 520 <dt><i>path</i></dt>
521 <dd> 521 <dd>
522 root directory of the tree to be added (string) 522 root directory of the tree to be added (string)
523 </dd> 523 </dd>
524 </dl><dl> 524 </dl><dl>
525 <dt>Raises <b>RuntimeError</b>:</dt> 525 <dt>Raises <b>RuntimeError</b>:</dt>
526 <dd> 526 <dd>
527 not implemented 527 to indicate that this method must be
528 implemented by a subclass
528 </dd> 529 </dd>
529 </dl><a NAME="VersionControl.vcsAllRegisteredStates" ID="VersionControl.vcsAllRegisteredStates"></a> 530 </dl><a NAME="VersionControl.vcsAllRegisteredStates" ID="VersionControl.vcsAllRegisteredStates"></a>
530 <h4>VersionControl.vcsAllRegisteredStates</h4> 531 <h4>VersionControl.vcsAllRegisteredStates</h4>
531 <b>vcsAllRegisteredStates</b>(<i>names, dname</i>) 532 <b>vcsAllRegisteredStates</b>(<i>names, dname</i>)
532 <p> 533 <p>
533 Public method used to get the registered states of a number of files in the vcs. 534 Public method used to get the registered states of a number of files
535 in the vcs.
534 </p><dl> 536 </p><dl>
535 <dt><i>names</i></dt> 537 <dt><i>names</i></dt>
536 <dd> 538 <dd>
537 dictionary with all filenames to be checked as keys 539 dictionary with all filenames to be checked as keys
538 </dd><dt><i>dname</i></dt> 540 </dd><dt><i>dname</i></dt>
546 canBeCommited and canBeAdded or None in order to signal an error 548 canBeCommited and canBeAdded or None in order to signal an error
547 </dd> 549 </dd>
548 </dl><dl> 550 </dl><dl>
549 <dt>Raises <b>RuntimeError</b>:</dt> 551 <dt>Raises <b>RuntimeError</b>:</dt>
550 <dd> 552 <dd>
551 not implemented 553 to indicate that this method must be
554 implemented by a subclass
552 </dd> 555 </dd>
553 </dl><a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a> 556 </dl><a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a>
554 <h4>VersionControl.vcsCheckout</h4> 557 <h4>VersionControl.vcsCheckout</h4>
555 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 558 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
556 <p> 559 <p>
572 flag indicating an execution without errors (boolean) 575 flag indicating an execution without errors (boolean)
573 </dd> 576 </dd>
574 </dl><dl> 577 </dl><dl>
575 <dt>Raises <b>RuntimeError</b>:</dt> 578 <dt>Raises <b>RuntimeError</b>:</dt>
576 <dd> 579 <dd>
577 not implemented 580 to indicate that this method must be
581 implemented by a subclass
578 </dd> 582 </dd>
579 </dl><a NAME="VersionControl.vcsCleanup" ID="VersionControl.vcsCleanup"></a> 583 </dl><a NAME="VersionControl.vcsCleanup" ID="VersionControl.vcsCleanup"></a>
580 <h4>VersionControl.vcsCleanup</h4> 584 <h4>VersionControl.vcsCleanup</h4>
581 <b>vcsCleanup</b>(<i>name</i>) 585 <b>vcsCleanup</b>(<i>name</i>)
582 <p> 586 <p>
587 directory name to be cleaned up (string) 591 directory name to be cleaned up (string)
588 </dd> 592 </dd>
589 </dl><dl> 593 </dl><dl>
590 <dt>Raises <b>RuntimeError</b>:</dt> 594 <dt>Raises <b>RuntimeError</b>:</dt>
591 <dd> 595 <dd>
592 not implemented 596 to indicate that this method must be
597 implemented by a subclass
593 </dd> 598 </dd>
594 </dl><a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a> 599 </dl><a NAME="VersionControl.vcsCommandLine" ID="VersionControl.vcsCommandLine"></a>
595 <h4>VersionControl.vcsCommandLine</h4> 600 <h4>VersionControl.vcsCommandLine</h4>
596 <b>vcsCommandLine</b>(<i>name</i>) 601 <b>vcsCommandLine</b>(<i>name</i>)
597 <p> 602 <p>
602 directory name of the working directory (string) 607 directory name of the working directory (string)
603 </dd> 608 </dd>
604 </dl><dl> 609 </dl><dl>
605 <dt>Raises <b>RuntimeError</b>:</dt> 610 <dt>Raises <b>RuntimeError</b>:</dt>
606 <dd> 611 <dd>
607 not implemented 612 to indicate that this method must be
613 implemented by a subclass
608 </dd> 614 </dd>
609 </dl><a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a> 615 </dl><a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a>
610 <h4>VersionControl.vcsCommit</h4> 616 <h4>VersionControl.vcsCommit</h4>
611 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>) 617 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>)
612 <p> 618 <p>
613 Public method used to make the change of a file/directory permanent in the vcs. 619 Public method used to make the change of a file/directory permanent in
614 </p><p> 620 the vcs.
615 It must return a boolean to indicate an execution without errors.
616 </p><dl> 621 </p><dl>
617 <dt><i>name</i></dt> 622 <dt><i>name</i></dt>
618 <dd> 623 <dd>
619 file/directory name to be committed (string) 624 file/directory name to be committed (string)
620 </dd><dt><i>message</i></dt> 625 </dd><dt><i>message</i></dt>
621 <dd> 626 <dd>
622 message for this operation (string) 627 message for this operation (string)
623 </dd><dt><i>noDialog</i></dt> 628 </dd><dt><i>noDialog</i></dt>
624 <dd> 629 <dd>
625 flag indicating quiet operations 630 flag indicating quiet operations (boolean)
626 </dd> 631 </dd>
627 </dl><dl> 632 </dl><dl>
628 <dt>Raises <b>RuntimeError</b>:</dt> 633 <dt>Returns:</dt>
629 <dd> 634 <dd>
630 not implemented 635 flag indicating success (boolean)
636 </dd>
637 </dl><dl>
638 <dt>Raises <b>RuntimeError</b>:</dt>
639 <dd>
640 to indicate that this method must be
641 implemented by a subclass
631 </dd> 642 </dd>
632 </dl><a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a> 643 </dl><a NAME="VersionControl.vcsConvertProject" ID="VersionControl.vcsConvertProject"></a>
633 <h4>VersionControl.vcsConvertProject</h4> 644 <h4>VersionControl.vcsConvertProject</h4>
634 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>) 645 <b>vcsConvertProject</b>(<i>vcsDataDict, project</i>)
635 <p> 646 <p>
636 Public method to convert an uncontrolled project to a version controlled project. 647 Public method to convert an uncontrolled project to a version
648 controlled project.
637 </p><dl> 649 </p><dl>
638 <dt><i>vcsDataDict</i></dt> 650 <dt><i>vcsDataDict</i></dt>
639 <dd> 651 <dd>
640 dictionary of data required for the conversion 652 dictionary of data required for the conversion
641 </dd><dt><i>project</i></dt> 653 </dd><dt><i>project</i></dt>
643 reference to the project object 655 reference to the project object
644 </dd> 656 </dd>
645 </dl><dl> 657 </dl><dl>
646 <dt>Raises <b>RuntimeError</b>:</dt> 658 <dt>Raises <b>RuntimeError</b>:</dt>
647 <dd> 659 <dd>
648 not implemented 660 to indicate that this method must be
661 implemented by a subclass
649 </dd> 662 </dd>
650 </dl><a NAME="VersionControl.vcsDefaultOptions" ID="VersionControl.vcsDefaultOptions"></a> 663 </dl><a NAME="VersionControl.vcsDefaultOptions" ID="VersionControl.vcsDefaultOptions"></a>
651 <h4>VersionControl.vcsDefaultOptions</h4> 664 <h4>VersionControl.vcsDefaultOptions</h4>
652 <b>vcsDefaultOptions</b>(<i></i>) 665 <b>vcsDefaultOptions</b>(<i></i>)
653 <p> 666 <p>
656 <dt>Returns:</dt> 669 <dt>Returns:</dt>
657 <dd> 670 <dd>
658 a dictionary with the vcs operations as key and 671 a dictionary with the vcs operations as key and
659 the respective options as values. The key 'global' must contain 672 the respective options as values. The key 'global' must contain
660 the global options. The other keys must be 'commit', 'update', 673 the global options. The other keys must be 'commit', 'update',
661 'add', 'remove', 'diff', 'log', 'history', 'tag', 'status' and 'export'. 674 'add', 'remove', 'diff', 'log', 'history', 'tag', 'status' and
675 'export'.
662 </dd> 676 </dd>
663 </dl><a NAME="VersionControl.vcsDiff" ID="VersionControl.vcsDiff"></a> 677 </dl><a NAME="VersionControl.vcsDiff" ID="VersionControl.vcsDiff"></a>
664 <h4>VersionControl.vcsDiff</h4> 678 <h4>VersionControl.vcsDiff</h4>
665 <b>vcsDiff</b>(<i>name</i>) 679 <b>vcsDiff</b>(<i>name</i>)
666 <p> 680 <p>
667 Public method used to view the diff of a file/directory in the vcs. 681 Public method used to view the diff of a file/directory in the vcs.
668 </p><p>
669 It must not return anything.
670 </p><dl> 682 </p><dl>
671 <dt><i>name</i></dt> 683 <dt><i>name</i></dt>
672 <dd> 684 <dd>
673 file/directory name to be diffed (string) 685 file/directory name to be diffed (string)
674 </dd> 686 </dd>
675 </dl><dl> 687 </dl><dl>
676 <dt>Raises <b>RuntimeError</b>:</dt> 688 <dt>Raises <b>RuntimeError</b>:</dt>
677 <dd> 689 <dd>
678 not implemented 690 to indicate that this method must be
691 implemented by a subclass
679 </dd> 692 </dd>
680 </dl><a NAME="VersionControl.vcsExists" ID="VersionControl.vcsExists"></a> 693 </dl><a NAME="VersionControl.vcsExists" ID="VersionControl.vcsExists"></a>
681 <h4>VersionControl.vcsExists</h4> 694 <h4>VersionControl.vcsExists</h4>
682 <b>vcsExists</b>(<i></i>) 695 <b>vcsExists</b>(<i></i>)
683 <p> 696 <p>
684 Public method used to test for the presence of the vcs. 697 Public method used to test for the presence of the vcs.
685 </p><p> 698 </p><dl>
686 It must return a bool to indicate the existance and a string giving 699 <dt>Returns:</dt>
687 an error message in case of failure. 700 <dd>
688 </p><dl> 701 tuple of flag indicating the existence and a string
689 <dt>Raises <b>RuntimeError</b>:</dt> 702 giving an error message in case of failure
690 <dd> 703 </dd>
691 not implemented 704 </dl><dl>
705 <dt>Raises <b>RuntimeError</b>:</dt>
706 <dd>
707 to indicate that this method must be
708 implemented by a subclass
692 </dd> 709 </dd>
693 </dl><a NAME="VersionControl.vcsExport" ID="VersionControl.vcsExport"></a> 710 </dl><a NAME="VersionControl.vcsExport" ID="VersionControl.vcsExport"></a>
694 <h4>VersionControl.vcsExport</h4> 711 <h4>VersionControl.vcsExport</h4>
695 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>) 712 <b>vcsExport</b>(<i>vcsDataDict, projectDir</i>)
696 <p> 713 <p>
697 Public method used to export a directory from the vcs. 714 Public method used to export a directory from the vcs.
698 </p><p>
699 It must return a boolean to indicate an execution without errors.
700 </p><dl> 715 </p><dl>
701 <dt><i>vcsDataDict</i></dt> 716 <dt><i>vcsDataDict</i></dt>
702 <dd> 717 <dd>
703 dictionary of data required for the export 718 dictionary of data required for the export
704 </dd><dt><i>projectDir</i></dt> 719 </dd><dt><i>projectDir</i></dt>
711 flag indicating an execution without errors (boolean) 726 flag indicating an execution without errors (boolean)
712 </dd> 727 </dd>
713 </dl><dl> 728 </dl><dl>
714 <dt>Raises <b>RuntimeError</b>:</dt> 729 <dt>Raises <b>RuntimeError</b>:</dt>
715 <dd> 730 <dd>
716 not implemented 731 to indicate that this method must be
732 implemented by a subclass
717 </dd> 733 </dd>
718 </dl><a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a> 734 </dl><a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a>
719 <h4>VersionControl.vcsGetOptions</h4> 735 <h4>VersionControl.vcsGetOptions</h4>
720 <b>vcsGetOptions</b>(<i></i>) 736 <b>vcsGetOptions</b>(<i></i>)
721 <p> 737 <p>
738 </dd> 754 </dd>
739 </dl><a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> 755 </dl><a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a>
740 <h4>VersionControl.vcsGetProjectBrowserHelper</h4> 756 <h4>VersionControl.vcsGetProjectBrowserHelper</h4>
741 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 757 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
742 <p> 758 <p>
743 Public method to instanciate a helper object for the different project browsers. 759 Public method to instanciate a helper object for the different
760 project browsers.
744 </p><dl> 761 </p><dl>
745 <dt><i>browser</i></dt> 762 <dt><i>browser</i></dt>
746 <dd> 763 <dd>
747 reference to the project browser object 764 reference to the project browser object
748 </dd><dt><i>project</i></dt> 765 </dd><dt><i>project</i></dt>
749 <dd> 766 <dd>
750 reference to the project object 767 reference to the project object
751 </dd><dt><i>isTranslationsBrowser</i></dt> 768 </dd><dt><i>isTranslationsBrowser</i></dt>
752 <dd> 769 <dd>
753 flag indicating, the helper is requested for the 770 flag indicating, the helper is requested
754 translations browser (this needs some special treatment) 771 for the translations browser (this needs some special treatment)
755 </dd> 772 </dd>
756 </dl><dl> 773 </dl><dl>
757 <dt>Returns:</dt> 774 <dt>Returns:</dt>
758 <dd> 775 <dd>
759 the project browser helper object 776 the project browser helper object
777 </dd>
778 </dl><dl>
779 <dt>Raises <b>RuntimeError</b>:</dt>
780 <dd>
781 to indicate that this method must be
782 implemented by a subclass
760 </dd> 783 </dd>
761 </dl><a NAME="VersionControl.vcsGetProjectHelper" ID="VersionControl.vcsGetProjectHelper"></a> 784 </dl><a NAME="VersionControl.vcsGetProjectHelper" ID="VersionControl.vcsGetProjectHelper"></a>
762 <h4>VersionControl.vcsGetProjectHelper</h4> 785 <h4>VersionControl.vcsGetProjectHelper</h4>
763 <b>vcsGetProjectHelper</b>(<i>project</i>) 786 <b>vcsGetProjectHelper</b>(<i>project</i>)
764 <p> 787 <p>
771 </dl><dl> 794 </dl><dl>
772 <dt>Returns:</dt> 795 <dt>Returns:</dt>
773 <dd> 796 <dd>
774 the project helper object 797 the project helper object
775 </dd> 798 </dd>
799 </dl><dl>
800 <dt>Raises <b>RuntimeError</b>:</dt>
801 <dd>
802 to indicate that this method must be
803 implemented by a subclass
804 </dd>
776 </dl><a NAME="VersionControl.vcsHistory" ID="VersionControl.vcsHistory"></a> 805 </dl><a NAME="VersionControl.vcsHistory" ID="VersionControl.vcsHistory"></a>
777 <h4>VersionControl.vcsHistory</h4> 806 <h4>VersionControl.vcsHistory</h4>
778 <b>vcsHistory</b>(<i>name</i>) 807 <b>vcsHistory</b>(<i>name</i>)
779 <p> 808 <p>
780 Public method used to view the history of a file/directory in the vcs. 809 Public method used to view the history of a file/directory in the vcs.
781 </p><p>
782 It must not return anything.
783 </p><dl> 810 </p><dl>
784 <dt><i>name</i></dt> 811 <dt><i>name</i></dt>
785 <dd> 812 <dd>
786 file/directory name to show the history for (string) 813 file/directory name to show the history for (string)
787 </dd> 814 </dd>
788 </dl><dl> 815 </dl><dl>
789 <dt>Raises <b>RuntimeError</b>:</dt> 816 <dt>Raises <b>RuntimeError</b>:</dt>
790 <dd> 817 <dd>
791 not implemented 818 to indicate that this method must be
819 implemented by a subclass
792 </dd> 820 </dd>
793 </dl><a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a> 821 </dl><a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a>
794 <h4>VersionControl.vcsImport</h4> 822 <h4>VersionControl.vcsImport</h4>
795 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) 823 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
796 <p> 824 <p>
813 and a flag indicating the version controll status (boolean) 841 and a flag indicating the version controll status (boolean)
814 </dd> 842 </dd>
815 </dl><dl> 843 </dl><dl>
816 <dt>Raises <b>RuntimeError</b>:</dt> 844 <dt>Raises <b>RuntimeError</b>:</dt>
817 <dd> 845 <dd>
818 not implemented 846 to indicate that this method must be
847 implemented by a subclass
819 </dd> 848 </dd>
820 </dl><a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a> 849 </dl><a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a>
821 <h4>VersionControl.vcsInit</h4> 850 <h4>VersionControl.vcsInit</h4>
822 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) 851 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>)
823 <p> 852 <p>
824 Public method used to initialize the vcs. 853 Public method used to initialize the vcs.
825 </p><p>
826 It must return a boolean to indicate an execution without errors.
827 </p><dl> 854 </p><dl>
828 <dt><i>vcsDir</i></dt> 855 <dt><i>vcsDir</i></dt>
829 <dd> 856 <dd>
830 name of the VCS directory (string) 857 name of the VCS directory (string)
831 </dd><dt><i>noDialog</i></dt> 858 </dd><dt><i>noDialog</i></dt>
832 <dd> 859 <dd>
833 flag indicating quiet operations (boolean) 860 flag indicating quiet operations (boolean)
834 </dd> 861 </dd>
835 </dl><dl> 862 </dl><dl>
836 <dt>Raises <b>RuntimeError</b>:</dt> 863 <dt>Returns:</dt>
837 <dd> 864 <dd>
838 not implemented 865 flag indicating success (boolean)
866 </dd>
867 </dl><dl>
868 <dt>Raises <b>RuntimeError</b>:</dt>
869 <dd>
870 to indicate that this method must be
871 implemented by a subclass
839 </dd> 872 </dd>
840 </dl><a NAME="VersionControl.vcsInitConfig" ID="VersionControl.vcsInitConfig"></a> 873 </dl><a NAME="VersionControl.vcsInitConfig" ID="VersionControl.vcsInitConfig"></a>
841 <h4>VersionControl.vcsInitConfig</h4> 874 <h4>VersionControl.vcsInitConfig</h4>
842 <b>vcsInitConfig</b>(<i>project</i>) 875 <b>vcsInitConfig</b>(<i>project</i>)
843 <p> 876 <p>
853 </dl><a NAME="VersionControl.vcsLog" ID="VersionControl.vcsLog"></a> 886 </dl><a NAME="VersionControl.vcsLog" ID="VersionControl.vcsLog"></a>
854 <h4>VersionControl.vcsLog</h4> 887 <h4>VersionControl.vcsLog</h4>
855 <b>vcsLog</b>(<i>name</i>) 888 <b>vcsLog</b>(<i>name</i>)
856 <p> 889 <p>
857 Public method used to view the log of a file/directory in the vcs. 890 Public method used to view the log of a file/directory in the vcs.
858 </p><p>
859 It must not return anything.
860 </p><dl> 891 </p><dl>
861 <dt><i>name</i></dt> 892 <dt><i>name</i></dt>
862 <dd> 893 <dd>
863 file/directory name to show the log for (string) 894 file/directory name to show the log for (string)
864 </dd> 895 </dd>
865 </dl><dl> 896 </dl><dl>
866 <dt>Raises <b>RuntimeError</b>:</dt> 897 <dt>Raises <b>RuntimeError</b>:</dt>
867 <dd> 898 <dd>
868 not implemented 899 to indicate that this method must be
900 implemented by a subclass
869 </dd> 901 </dd>
870 </dl><a NAME="VersionControl.vcsMerge" ID="VersionControl.vcsMerge"></a> 902 </dl><a NAME="VersionControl.vcsMerge" ID="VersionControl.vcsMerge"></a>
871 <h4>VersionControl.vcsMerge</h4> 903 <h4>VersionControl.vcsMerge</h4>
872 <b>vcsMerge</b>(<i>name</i>) 904 <b>vcsMerge</b>(<i>name</i>)
873 <p> 905 <p>
874 Public method used to merge a tag/branch into the local project. 906 Public method used to merge a tag/branch into the local project.
875 </p><p>
876 It must not return anything.
877 </p><dl> 907 </p><dl>
878 <dt><i>name</i></dt> 908 <dt><i>name</i></dt>
879 <dd> 909 <dd>
880 file/directory name to be merged (string) 910 file/directory name to be merged (string)
881 </dd> 911 </dd>
882 </dl><dl> 912 </dl><dl>
883 <dt>Raises <b>RuntimeError</b>:</dt> 913 <dt>Raises <b>RuntimeError</b>:</dt>
884 <dd> 914 <dd>
885 not implemented 915 to indicate that this method must be
916 implemented by a subclass
886 </dd> 917 </dd>
887 </dl><a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a> 918 </dl><a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a>
888 <h4>VersionControl.vcsMove</h4> 919 <h4>VersionControl.vcsMove</h4>
889 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) 920 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>)
890 <p> 921 <p>
909 flag indicating successfull operation (boolean) 940 flag indicating successfull operation (boolean)
910 </dd> 941 </dd>
911 </dl><dl> 942 </dl><dl>
912 <dt>Raises <b>RuntimeError</b>:</dt> 943 <dt>Raises <b>RuntimeError</b>:</dt>
913 <dd> 944 <dd>
914 not implemented 945 to indicate that this method must be
946 implemented by a subclass
915 </dd> 947 </dd>
916 </dl><a NAME="VersionControl.vcsName" ID="VersionControl.vcsName"></a> 948 </dl><a NAME="VersionControl.vcsName" ID="VersionControl.vcsName"></a>
917 <h4>VersionControl.vcsName</h4> 949 <h4>VersionControl.vcsName</h4>
918 <b>vcsName</b>(<i></i>) 950 <b>vcsName</b>(<i></i>)
919 <p> 951 <p>
924 name of the vcs (string) 956 name of the vcs (string)
925 </dd> 957 </dd>
926 </dl><dl> 958 </dl><dl>
927 <dt>Raises <b>RuntimeError</b>:</dt> 959 <dt>Raises <b>RuntimeError</b>:</dt>
928 <dd> 960 <dd>
929 not implemented 961 to indicate that this method must be
962 implemented by a subclass
930 </dd> 963 </dd>
931 </dl><a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a> 964 </dl><a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a>
932 <h4>VersionControl.vcsNewProjectOptionsDialog</h4> 965 <h4>VersionControl.vcsNewProjectOptionsDialog</h4>
933 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) 966 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
934 <p> 967 <p>
935 Public method to get a dialog to enter repository info for getting a new project. 968 Public method to get a dialog to enter repository info for getting a
969 new project.
936 </p><dl> 970 </p><dl>
937 <dt><i>parent</i></dt> 971 <dt><i>parent</i></dt>
938 <dd> 972 <dd>
939 parent widget (QWidget) 973 parent widget (QWidget)
974 </dd>
975 </dl><dl>
976 <dt>Raises <b>RuntimeError</b>:</dt>
977 <dd>
978 to indicate that this method must be
979 implemented by a subclass
940 </dd> 980 </dd>
941 </dl><a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a> 981 </dl><a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a>
942 <h4>VersionControl.vcsOptionsDialog</h4> 982 <h4>VersionControl.vcsOptionsDialog</h4>
943 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) 983 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
944 <p> 984 <p>
950 </dd><dt><i>archive</i></dt> 990 </dd><dt><i>archive</i></dt>
951 <dd> 991 <dd>
952 name of the project in the repository (string) 992 name of the project in the repository (string)
953 </dd><dt><i>editable</i></dt> 993 </dd><dt><i>editable</i></dt>
954 <dd> 994 <dd>
955 flag indicating that the project name is editable (boolean) 995 flag indicating that the project name is editable
996 (boolean)
956 </dd><dt><i>parent</i></dt> 997 </dd><dt><i>parent</i></dt>
957 <dd> 998 <dd>
958 parent widget (QWidget) 999 parent widget (QWidget)
1000 </dd>
1001 </dl><dl>
1002 <dt>Raises <b>RuntimeError</b>:</dt>
1003 <dd>
1004 to indicate that this method must be
1005 implemented by a subclass
959 </dd> 1006 </dd>
960 </dl><a NAME="VersionControl.vcsRegisteredState" ID="VersionControl.vcsRegisteredState"></a> 1007 </dl><a NAME="VersionControl.vcsRegisteredState" ID="VersionControl.vcsRegisteredState"></a>
961 <h4>VersionControl.vcsRegisteredState</h4> 1008 <h4>VersionControl.vcsRegisteredState</h4>
962 <b>vcsRegisteredState</b>(<i>name</i>) 1009 <b>vcsRegisteredState</b>(<i>name</i>)
963 <p> 1010 <p>
974 0 in order to signal an error 1021 0 in order to signal an error
975 </dd> 1022 </dd>
976 </dl><dl> 1023 </dl><dl>
977 <dt>Raises <b>RuntimeError</b>:</dt> 1024 <dt>Raises <b>RuntimeError</b>:</dt>
978 <dd> 1025 <dd>
979 not implemented 1026 to indicate that this method must be
1027 implemented by a subclass
980 </dd> 1028 </dd>
981 </dl><a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a> 1029 </dl><a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a>
982 <h4>VersionControl.vcsRemove</h4> 1030 <h4>VersionControl.vcsRemove</h4>
983 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) 1031 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>)
984 <p> 1032 <p>
985 Public method used to add a file/directory in the vcs. 1033 Public method used to add a file/directory in the vcs.
986 </p><p>
987 It must return a flag indicating successfull operation
988 </p><dl> 1034 </p><dl>
989 <dt><i>name</i></dt> 1035 <dt><i>name</i></dt>
990 <dd> 1036 <dd>
991 file/directory name to be removed (string) 1037 file/directory name to be removed (string)
992 </dd><dt><i>project</i></dt> 1038 </dd><dt><i>project</i></dt>
995 </dd><dt><i>noDialog</i></dt> 1041 </dd><dt><i>noDialog</i></dt>
996 <dd> 1042 <dd>
997 flag indicating quiet operations 1043 flag indicating quiet operations
998 </dd> 1044 </dd>
999 </dl><dl> 1045 </dl><dl>
1000 <dt>Raises <b>RuntimeError</b>:</dt> 1046 <dt>Returns:</dt>
1001 <dd> 1047 <dd>
1002 not implemented 1048 flag indicating success (boolean)
1049 </dd>
1050 </dl><dl>
1051 <dt>Raises <b>RuntimeError</b>:</dt>
1052 <dd>
1053 to indicate that this method must be
1054 implemented by a subclass
1003 </dd> 1055 </dd>
1004 </dl><a NAME="VersionControl.vcsRepositoryInfos" ID="VersionControl.vcsRepositoryInfos"></a> 1056 </dl><a NAME="VersionControl.vcsRepositoryInfos" ID="VersionControl.vcsRepositoryInfos"></a>
1005 <h4>VersionControl.vcsRepositoryInfos</h4> 1057 <h4>VersionControl.vcsRepositoryInfos</h4>
1006 <b>vcsRepositoryInfos</b>(<i>ppath</i>) 1058 <b>vcsRepositoryInfos</b>(<i>ppath</i>)
1007 <p> 1059 <p>
1014 </dl><dl> 1066 </dl><dl>
1015 <dt>Returns:</dt> 1067 <dt>Returns:</dt>
1016 <dd> 1068 <dd>
1017 string with ready formated info for display (string) 1069 string with ready formated info for display (string)
1018 </dd> 1070 </dd>
1071 </dl><dl>
1072 <dt>Raises <b>RuntimeError</b>:</dt>
1073 <dd>
1074 to indicate that this method must be
1075 implemented by a subclass
1076 </dd>
1019 </dl><a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a> 1077 </dl><a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a>
1020 <h4>VersionControl.vcsRevert</h4> 1078 <h4>VersionControl.vcsRevert</h4>
1021 <b>vcsRevert</b>(<i>name</i>) 1079 <b>vcsRevert</b>(<i>name</i>)
1022 <p> 1080 <p>
1023 Public method used to revert changes made to a file/directory. 1081 Public method used to revert changes made to a file/directory.
1024 </p><p>
1025 It must not return anything.
1026 </p><dl> 1082 </p><dl>
1027 <dt><i>name</i></dt> 1083 <dt><i>name</i></dt>
1028 <dd> 1084 <dd>
1029 file/directory name to be reverted (string) 1085 file/directory name to be reverted (string)
1030 </dd> 1086 </dd>
1031 </dl><dl> 1087 </dl><dl>
1032 <dt>Raises <b>RuntimeError</b>:</dt> 1088 <dt>Raises <b>RuntimeError</b>:</dt>
1033 <dd> 1089 <dd>
1034 not implemented 1090 to indicate that this method must be
1091 implemented by a subclass
1035 </dd> 1092 </dd>
1036 </dl><a NAME="VersionControl.vcsSetData" ID="VersionControl.vcsSetData"></a> 1093 </dl><a NAME="VersionControl.vcsSetData" ID="VersionControl.vcsSetData"></a>
1037 <h4>VersionControl.vcsSetData</h4> 1094 <h4>VersionControl.vcsSetData</h4>
1038 <b>vcsSetData</b>(<i>key, value</i>) 1095 <b>vcsSetData</b>(<i>key, value</i>)
1039 <p> 1096 <p>
1080 </dl><a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a> 1137 </dl><a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a>
1081 <h4>VersionControl.vcsShutdown</h4> 1138 <h4>VersionControl.vcsShutdown</h4>
1082 <b>vcsShutdown</b>(<i></i>) 1139 <b>vcsShutdown</b>(<i></i>)
1083 <p> 1140 <p>
1084 Public method used to shutdown the vcs interface. 1141 Public method used to shutdown the vcs interface.
1085 </p><a NAME="VersionControl.vcsStatus" ID="VersionControl.vcsStatus"></a> 1142 </p><dl>
1143 <dt>Raises <b>RuntimeError</b>:</dt>
1144 <dd>
1145 to indicate that this method must be
1146 implemented by a subclass
1147 </dd>
1148 </dl><a NAME="VersionControl.vcsStatus" ID="VersionControl.vcsStatus"></a>
1086 <h4>VersionControl.vcsStatus</h4> 1149 <h4>VersionControl.vcsStatus</h4>
1087 <b>vcsStatus</b>(<i>name</i>) 1150 <b>vcsStatus</b>(<i>name</i>)
1088 <p> 1151 <p>
1089 Public method used to view the status of a file/directory in the vcs. 1152 Public method used to view the status of a file/directory in the vcs.
1090 </p><p>
1091 It must not return anything.
1092 </p><dl> 1153 </p><dl>
1093 <dt><i>name</i></dt> 1154 <dt><i>name</i></dt>
1094 <dd> 1155 <dd>
1095 file/directory name to show the status for (string) 1156 file/directory name to show the status for (string)
1096 </dd> 1157 </dd>
1097 </dl><dl> 1158 </dl><dl>
1098 <dt>Raises <b>RuntimeError</b>:</dt> 1159 <dt>Raises <b>RuntimeError</b>:</dt>
1099 <dd> 1160 <dd>
1100 not implemented 1161 to indicate that this method must be
1162 implemented by a subclass
1101 </dd> 1163 </dd>
1102 </dl><a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a> 1164 </dl><a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a>
1103 <h4>VersionControl.vcsSwitch</h4> 1165 <h4>VersionControl.vcsSwitch</h4>
1104 <b>vcsSwitch</b>(<i>name</i>) 1166 <b>vcsSwitch</b>(<i>name</i>)
1105 <p> 1167 <p>
1106 Public method used to switch a directory to a different tag/branch. 1168 Public method used to switch a directory to a different tag/branch.
1107 </p><p>
1108 It must not return anything.
1109 </p><dl> 1169 </p><dl>
1110 <dt><i>name</i></dt> 1170 <dt><i>name</i></dt>
1111 <dd> 1171 <dd>
1112 directory name to be switched (string) 1172 directory name to be switched (string)
1113 </dd> 1173 </dd>
1118 or delete (boolean) 1178 or delete (boolean)
1119 </dd> 1179 </dd>
1120 </dl><dl> 1180 </dl><dl>
1121 <dt>Raises <b>RuntimeError</b>:</dt> 1181 <dt>Raises <b>RuntimeError</b>:</dt>
1122 <dd> 1182 <dd>
1123 not implemented 1183 to indicate that this method must be
1184 implemented by a subclass
1124 </dd> 1185 </dd>
1125 </dl><a NAME="VersionControl.vcsTag" ID="VersionControl.vcsTag"></a> 1186 </dl><a NAME="VersionControl.vcsTag" ID="VersionControl.vcsTag"></a>
1126 <h4>VersionControl.vcsTag</h4> 1187 <h4>VersionControl.vcsTag</h4>
1127 <b>vcsTag</b>(<i>name</i>) 1188 <b>vcsTag</b>(<i>name</i>)
1128 <p> 1189 <p>
1129 Public method used to set the tag of a file/directory in the vcs. 1190 Public method used to set the tag of a file/directory in the vcs.
1130 </p><p>
1131 It must not return anything.
1132 </p><dl> 1191 </p><dl>
1133 <dt><i>name</i></dt> 1192 <dt><i>name</i></dt>
1134 <dd> 1193 <dd>
1135 file/directory name to be tagged (string) 1194 file/directory name to be tagged (string)
1136 </dd> 1195 </dd>
1137 </dl><dl> 1196 </dl><dl>
1138 <dt>Raises <b>RuntimeError</b>:</dt> 1197 <dt>Raises <b>RuntimeError</b>:</dt>
1139 <dd> 1198 <dd>
1140 not implemented 1199 to indicate that this method must be
1200 implemented by a subclass
1141 </dd> 1201 </dd>
1142 </dl><a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a> 1202 </dl><a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a>
1143 <h4>VersionControl.vcsUpdate</h4> 1203 <h4>VersionControl.vcsUpdate</h4>
1144 <b>vcsUpdate</b>(<i>name, noDialog=False</i>) 1204 <b>vcsUpdate</b>(<i>name, noDialog=False</i>)
1145 <p> 1205 <p>
1146 Public method used to update a file/directory in the vcs. 1206 Public method used to update a file/directory in the vcs.
1147 </p><p>
1148 It must not return anything.
1149 </p><dl> 1207 </p><dl>
1150 <dt><i>name</i></dt> 1208 <dt><i>name</i></dt>
1151 <dd> 1209 <dd>
1152 file/directory name to be updated (string) 1210 file/directory name to be updated (string)
1153 </dd><dt><i>noDialog</i></dt> 1211 </dd><dt><i>noDialog</i></dt>
1161 or delete (boolean) 1219 or delete (boolean)
1162 </dd> 1220 </dd>
1163 </dl><dl> 1221 </dl><dl>
1164 <dt>Raises <b>RuntimeError</b>:</dt> 1222 <dt>Raises <b>RuntimeError</b>:</dt>
1165 <dd> 1223 <dd>
1166 not implemented 1224 to indicate that this method must be
1225 implemented by a subclass
1167 </dd> 1226 </dd>
1168 </dl> 1227 </dl>
1169 <div align="right"><a href="#top">Up</a></div> 1228 <div align="right"><a href="#top">Up</a></div>
1170 <hr /> 1229 <hr />
1171 </body></html> 1230 </body></html>

Mercurial Repository: eric

eric ide

mercurial