Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.VCS.VersionControl.html

src/eric7/Documentation/Source/eric7.VCS.VersionControl.html

branch
eric7
changeset 10436
f6881d10e995
parent 10259
b51dfacef37f
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10435:c712d09cc839 10436:f6881d10e995
374 <p> 374 <p>
375 Constructor 375 Constructor
376 </p> 376 </p>
377 <dl> 377 <dl>
378 378
379 <dt><i>parent</i></dt> 379 <dt><i>parent</i> (QWidget)</dt>
380 <dd> 380 <dd>
381 parent widget (QWidget) 381 parent widget
382 </dd> 382 </dd>
383 <dt><i>name</i></dt> 383 <dt><i>name</i> (str)</dt>
384 <dd> 384 <dd>
385 name of this object (string) 385 name of this object
386 </dd> 386 </dd>
387 </dl> 387 </dl>
388 <a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a> 388 <a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a>
389 <h4>VersionControl.__statusMonitorAllData</h4> 389 <h4>VersionControl.__statusMonitorAllData</h4>
390 <b>__statusMonitorAllData</b>(<i>statusDict</i>) 390 <b>__statusMonitorAllData</b>(<i>statusDict</i>)
469 Note: This method should be overwritten in subclasses in order to 469 Note: This method should be overwritten in subclasses in order to
470 support VCS status monitoring. 470 support VCS status monitoring.
471 </p> 471 </p>
472 <dl> 472 <dl>
473 473
474 <dt><i>interval</i></dt> 474 <dt><i>interval</i> (int)</dt>
475 <dd> 475 <dd>
476 check interval for the monitor thread in seconds 476 check interval for the monitor thread in seconds
477 (integer) 477 </dd>
478 </dd> 478 <dt><i>project</i> (Project)</dt>
479 <dt><i>project</i></dt>
480 <dd> 479 <dd>
481 reference to the project object 480 reference to the project object
482 </dd> 481 </dd>
483 </dl> 482 </dl>
484 <dl> 483 <dl>
485 <dt>Return:</dt> 484 <dt>Return:</dt>
486 <dd> 485 <dd>
487 reference to the monitor thread (QThread) 486 reference to the monitor thread
487 </dd>
488 </dl>
489 <dl>
490 <dt>Return Type:</dt>
491 <dd>
492 QThread
488 </dd> 493 </dd>
489 </dl> 494 </dl>
490 <a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a> 495 <a NAME="VersionControl._vcsAddProjectCommitMessage" ID="VersionControl._vcsAddProjectCommitMessage"></a>
491 <h4>VersionControl._vcsAddProjectCommitMessage</h4> 496 <h4>VersionControl._vcsAddProjectCommitMessage</h4>
492 <b>_vcsAddProjectCommitMessage</b>(<i>message</i>) 497 <b>_vcsAddProjectCommitMessage</b>(<i>message</i>)
560 Public method to add an argument list to the already present 565 Public method to add an argument list to the already present
561 arguments. 566 arguments.
562 </p> 567 </p>
563 <dl> 568 <dl>
564 569
565 <dt><i>args</i></dt> 570 <dt><i>args</i> (list of str)</dt>
566 <dd> 571 <dd>
567 current arguments list (list of strings) 572 current arguments list
568 </dd> 573 </dd>
569 <dt><i>argslist</i></dt> 574 <dt><i>argslist</i> (list of str)</dt>
570 <dd> 575 <dd>
571 list of arguments (list of strings) 576 list of arguments
572 </dd> 577 </dd>
573 </dl> 578 </dl>
574 <a NAME="VersionControl.checkVCSStatus" ID="VersionControl.checkVCSStatus"></a> 579 <a NAME="VersionControl.checkVCSStatus" ID="VersionControl.checkVCSStatus"></a>
575 <h4>VersionControl.checkVCSStatus</h4> 580 <h4>VersionControl.checkVCSStatus</h4>
576 <b>checkVCSStatus</b>(<i></i>) 581 <b>checkVCSStatus</b>(<i></i>)
592 <p> 597 <p>
593 Public method to clear the cached VCS state of a file/directory. 598 Public method to clear the cached VCS state of a file/directory.
594 </p> 599 </p>
595 <dl> 600 <dl>
596 601
597 <dt><i>name</i></dt> 602 <dt><i>name</i> (str)</dt>
598 <dd> 603 <dd>
599 name of the entry to be cleared (string) 604 name of the entry to be cleared
600 </dd> 605 </dd>
601 </dl> 606 </dl>
602 <a NAME="VersionControl.getStatusMonitorAutoUpdate" ID="VersionControl.getStatusMonitorAutoUpdate"></a> 607 <a NAME="VersionControl.getStatusMonitorAutoUpdate" ID="VersionControl.getStatusMonitorAutoUpdate"></a>
603 <h4>VersionControl.getStatusMonitorAutoUpdate</h4> 608 <h4>VersionControl.getStatusMonitorAutoUpdate</h4>
604 <b>getStatusMonitorAutoUpdate</b>(<i></i>) 609 <b>getStatusMonitorAutoUpdate</b>(<i></i>)
607 Public method to retrieve the status of the auto update function. 612 Public method to retrieve the status of the auto update function.
608 </p> 613 </p>
609 <dl> 614 <dl>
610 <dt>Return:</dt> 615 <dt>Return:</dt>
611 <dd> 616 <dd>
612 status of the auto update function (boolean) 617 status of the auto update function
618 </dd>
619 </dl>
620 <dl>
621 <dt>Return Type:</dt>
622 <dd>
623 bool
613 </dd> 624 </dd>
614 </dl> 625 </dl>
615 <a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a> 626 <a NAME="VersionControl.getStatusMonitorInterval" ID="VersionControl.getStatusMonitorInterval"></a>
616 <h4>VersionControl.getStatusMonitorInterval</h4> 627 <h4>VersionControl.getStatusMonitorInterval</h4>
617 <b>getStatusMonitorInterval</b>(<i></i>) 628 <b>getStatusMonitorInterval</b>(<i></i>)
620 Public method to get the monitor interval. 631 Public method to get the monitor interval.
621 </p> 632 </p>
622 <dl> 633 <dl>
623 <dt>Return:</dt> 634 <dt>Return:</dt>
624 <dd> 635 <dd>
625 interval in seconds (integer) 636 interval in seconds
637 </dd>
638 </dl>
639 <dl>
640 <dt>Return Type:</dt>
641 <dd>
642 int
626 </dd> 643 </dd>
627 </dl> 644 </dl>
628 <a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a> 645 <a NAME="VersionControl.setStatusMonitorAutoUpdate" ID="VersionControl.setStatusMonitorAutoUpdate"></a>
629 <h4>VersionControl.setStatusMonitorAutoUpdate</h4> 646 <h4>VersionControl.setStatusMonitorAutoUpdate</h4>
630 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>) 647 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>)
632 <p> 649 <p>
633 Public method to enable the auto update function. 650 Public method to enable the auto update function.
634 </p> 651 </p>
635 <dl> 652 <dl>
636 653
637 <dt><i>auto</i></dt> 654 <dt><i>auto</i> (bool)</dt>
638 <dd> 655 <dd>
639 status of the auto update function (boolean) 656 status of the auto update function
640 </dd> 657 </dd>
641 </dl> 658 </dl>
642 <a NAME="VersionControl.setStatusMonitorInterval" ID="VersionControl.setStatusMonitorInterval"></a> 659 <a NAME="VersionControl.setStatusMonitorInterval" ID="VersionControl.setStatusMonitorInterval"></a>
643 <h4>VersionControl.setStatusMonitorInterval</h4> 660 <h4>VersionControl.setStatusMonitorInterval</h4>
644 <b>setStatusMonitorInterval</b>(<i>interval, project</i>) 661 <b>setStatusMonitorInterval</b>(<i>interval, project</i>)
646 <p> 663 <p>
647 Public method to change the monitor interval. 664 Public method to change the monitor interval.
648 </p> 665 </p>
649 <dl> 666 <dl>
650 667
651 <dt><i>interval</i></dt> 668 <dt><i>interval</i> (int)</dt>
652 <dd> 669 <dd>
653 new interval in seconds (integer) 670 new interval in seconds
654 </dd> 671 </dd>
655 <dt><i>project</i></dt> 672 <dt><i>project</i> (Project)</dt>
656 <dd> 673 <dd>
657 reference to the project object 674 reference to the project object
658 </dd> 675 </dd>
659 </dl> 676 </dl>
660 <a NAME="VersionControl.splitPath" ID="VersionControl.splitPath"></a> 677 <a NAME="VersionControl.splitPath" ID="VersionControl.splitPath"></a>
664 <p> 681 <p>
665 Public method splitting name into a directory part and a file part. 682 Public method splitting name into a directory part and a file part.
666 </p> 683 </p>
667 <dl> 684 <dl>
668 685
669 <dt><i>name</i></dt> 686 <dt><i>name</i> (str)</dt>
670 <dd> 687 <dd>
671 path name (string) 688 path name
672 </dd> 689 </dd>
673 </dl> 690 </dl>
674 <dl> 691 <dl>
675 <dt>Return:</dt> 692 <dt>Return:</dt>
676 <dd> 693 <dd>
677 a tuple of 2 strings (dirname, filename). 694 tuple containing the directory name and the file name
695 </dd>
696 </dl>
697 <dl>
698 <dt>Return Type:</dt>
699 <dd>
700 tuple of (str, str)
678 </dd> 701 </dd>
679 </dl> 702 </dl>
680 <a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> 703 <a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a>
681 <h4>VersionControl.splitPathList</h4> 704 <h4>VersionControl.splitPathList</h4>
682 <b>splitPathList</b>(<i>names</i>) 705 <b>splitPathList</b>(<i>names</i>)
685 Public method splitting the list of names into a common directory part 708 Public method splitting the list of names into a common directory part
686 and a file list. 709 and a file list.
687 </p> 710 </p>
688 <dl> 711 <dl>
689 712
690 <dt><i>names</i></dt> 713 <dt><i>names</i> (list of str)</dt>
691 <dd> 714 <dd>
692 list of paths (list of strings) 715 list of paths
693 </dd> 716 </dd>
694 </dl> 717 </dl>
695 <dl> 718 <dl>
696 <dt>Return:</dt> 719 <dt>Return:</dt>
697 <dd> 720 <dd>
698 a tuple of string and list of strings (dirname, filenamelist) 721 tuple containing the directory name and the file name list
722 </dd>
723 </dl>
724 <dl>
725 <dt>Return Type:</dt>
726 <dd>
727 tuple of (str, list of str)
699 </dd> 728 </dd>
700 </dl> 729 </dl>
701 <a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a> 730 <a NAME="VersionControl.startStatusMonitor" ID="VersionControl.startStatusMonitor"></a>
702 <h4>VersionControl.startStatusMonitor</h4> 731 <h4>VersionControl.startStatusMonitor</h4>
703 <b>startStatusMonitor</b>(<i>project</i>) 732 <b>startStatusMonitor</b>(<i>project</i>)
705 <p> 734 <p>
706 Public method to start the VCS status monitor thread. 735 Public method to start the VCS status monitor thread.
707 </p> 736 </p>
708 <dl> 737 <dl>
709 738
710 <dt><i>project</i></dt> 739 <dt><i>project</i> (Project)</dt>
711 <dd> 740 <dd>
712 reference to the project object 741 reference to the project object
713 </dd> 742 </dd>
714 </dl> 743 </dl>
715 <dl> 744 <dl>
716 <dt>Return:</dt> 745 <dt>Return:</dt>
717 <dd> 746 <dd>
718 reference to the monitor thread (QThread) 747 reference to the monitor thread
748 </dd>
749 </dl>
750 <dl>
751 <dt>Return Type:</dt>
752 <dd>
753 QThread
719 </dd> 754 </dd>
720 </dl> 755 </dl>
721 <a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> 756 <a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a>
722 <h4>VersionControl.startSynchronizedProcess</h4> 757 <h4>VersionControl.startSynchronizedProcess</h4>
723 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>) 758 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>)
729 This method starts a process and waits 764 This method starts a process and waits
730 for its end while still serving the Qt event loop. 765 for its end while still serving the Qt event loop.
731 </p> 766 </p>
732 <dl> 767 <dl>
733 768
734 <dt><i>proc</i></dt> 769 <dt><i>proc</i> (QProcess)</dt>
735 <dd> 770 <dd>
736 process to start (QProcess) 771 process to start
737 </dd> 772 </dd>
738 <dt><i>program</i></dt> 773 <dt><i>program</i> (str)</dt>
739 <dd> 774 <dd>
740 path of the executable to start (string) 775 path of the executable to start
741 </dd> 776 </dd>
742 <dt><i>arguments</i></dt> 777 <dt><i>arguments</i> (list of str)</dt>
743 <dd> 778 <dd>
744 list of arguments for the process (list of strings) 779 list of arguments for the process
745 </dd> 780 </dd>
746 <dt><i>workingDir</i></dt> 781 <dt><i>workingDir</i> (str)</dt>
747 <dd> 782 <dd>
748 working directory for the process (string) 783 working directory for the process
749 </dd> 784 </dd>
750 </dl> 785 </dl>
751 <dl> 786 <dl>
752 <dt>Return:</dt> 787 <dt>Return:</dt>
753 <dd> 788 <dd>
754 flag indicating normal exit (boolean) 789 flag indicating normal exit
790 </dd>
791 </dl>
792 <dl>
793 <dt>Return Type:</dt>
794 <dd>
795 bool
755 </dd> 796 </dd>
756 </dl> 797 </dl>
757 <a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a> 798 <a NAME="VersionControl.stopStatusMonitor" ID="VersionControl.stopStatusMonitor"></a>
758 <h4>VersionControl.stopStatusMonitor</h4> 799 <h4>VersionControl.stopStatusMonitor</h4>
759 <b>stopStatusMonitor</b>(<i></i>) 800 <b>stopStatusMonitor</b>(<i></i>)
768 <p> 809 <p>
769 Public method used to add a file/directory in the vcs. 810 Public method used to add a file/directory in the vcs.
770 </p> 811 </p>
771 <dl> 812 <dl>
772 813
773 <dt><i>name</i></dt> 814 <dt><i>name</i> (str)</dt>
774 <dd> 815 <dd>
775 file/directory name to be added (string) 816 file/directory name to be added
776 </dd> 817 </dd>
777 <dt><i>isDir</i></dt> 818 <dt><i>isDir</i> (bool)</dt>
778 <dd> 819 <dd>
779 flag indicating name is a directory (boolean) 820 flag indicating name is a directory
780 </dd> 821 </dd>
781 <dt><i>noDialog</i></dt> 822 <dt><i>noDialog</i> (bool)</dt>
782 <dd> 823 <dd>
783 flag indicating quiet operations (boolean) 824 flag indicating quiet operations
784 </dd> 825 </dd>
785 </dl> 826 </dl>
786 <dl> 827 <dl>
787 828
788 <dt>Raises <b>NotImplementedError</b>:</dt> 829 <dt>Raises <b>NotImplementedError</b>:</dt>
798 <p> 839 <p>
799 Public method used to add a file/directory in binary mode in the vcs. 840 Public method used to add a file/directory in binary mode in the vcs.
800 </p> 841 </p>
801 <dl> 842 <dl>
802 843
803 <dt><i>name</i></dt> 844 <dt><i>name</i> (str)</dt>
804 <dd> 845 <dd>
805 file/directory name to be added (string) 846 file/directory name to be added
806 </dd> 847 </dd>
807 <dt><i>isDir</i></dt> 848 <dt><i>isDir</i> (bool)</dt>
808 <dd> 849 <dd>
809 flag indicating name is a directory (boolean) 850 flag indicating name is a directory
810 </dd> 851 </dd>
811 </dl> 852 </dl>
812 <dl> 853 <dl>
813 854
814 <dt>Raises <b>NotImplementedError</b>:</dt> 855 <dt>Raises <b>NotImplementedError</b>:</dt>
846 <p> 887 <p>
847 Public method to add a directory tree rooted at path in the vcs. 888 Public method to add a directory tree rooted at path in the vcs.
848 </p> 889 </p>
849 <dl> 890 <dl>
850 891
851 <dt><i>path</i></dt> 892 <dt><i>path</i> (str)</dt>
852 <dd> 893 <dd>
853 root directory of the tree to be added (string) 894 root directory of the tree to be added
854 </dd> 895 </dd>
855 </dl> 896 </dl>
856 <dl> 897 <dl>
857 898
858 <dt>Raises <b>NotImplementedError</b>:</dt> 899 <dt>Raises <b>NotImplementedError</b>:</dt>
869 Public method used to get the registered states of a number of files 910 Public method used to get the registered states of a number of files
870 in the vcs. 911 in the vcs.
871 </p> 912 </p>
872 <dl> 913 <dl>
873 914
874 <dt><i>names</i></dt> 915 <dt><i>names</i> (dict)</dt>
875 <dd> 916 <dd>
876 dictionary with all filenames to be checked as keys 917 dictionary with all filenames to be checked as keys
877 </dd> 918 </dd>
878 <dt><i>dname</i></dt> 919 <dt><i>dname</i> (str)</dt>
879 <dd> 920 <dd>
880 directory to check in (string) 921 directory to check in
881 </dd> 922 </dd>
882 </dl> 923 </dl>
883 <dl> 924 <dl>
884 <dt>Return:</dt> 925 <dt>Return:</dt>
885 <dd> 926 <dd>
886 the received dictionary completed with a combination of 927 the received dictionary completed with a combination of
887 canBeCommited and canBeAdded or None in order to signal an error 928 canBeCommited and canBeAdded or None in order to signal an error
929 </dd>
930 </dl>
931 <dl>
932 <dt>Return Type:</dt>
933 <dd>
934 dict
888 </dd> 935 </dd>
889 </dl> 936 </dl>
890 <dl> 937 <dl>
891 938
892 <dt>Raises <b>NotImplementedError</b>:</dt> 939 <dt>Raises <b>NotImplementedError</b>:</dt>
902 <p> 949 <p>
903 Public method used to check the project out of the vcs. 950 Public method used to check the project out of the vcs.
904 </p> 951 </p>
905 <dl> 952 <dl>
906 953
907 <dt><i>vcsDataDict</i></dt> 954 <dt><i>vcsDataDict</i> (dict)</dt>
908 <dd> 955 <dd>
909 dictionary of data required for the checkout 956 dictionary of data required for the checkout
910 </dd> 957 </dd>
911 <dt><i>projectDir</i></dt> 958 <dt><i>projectDir</i> (str)</dt>
912 <dd> 959 <dd>
913 project directory to create (string) 960 project directory to create
914 </dd> 961 </dd>
915 <dt><i>noDialog</i></dt> 962 <dt><i>noDialog</i> (bool)</dt>
916 <dd> 963 <dd>
917 flag indicating quiet operations 964 flag indicating quiet operations
918 </dd> 965 </dd>
919 </dl> 966 </dl>
920 <dl> 967 <dl>
921 <dt>Return:</dt> 968 <dt>Return:</dt>
922 <dd> 969 <dd>
923 flag indicating an execution without errors (boolean) 970 flag indicating an execution without errors
971 </dd>
972 </dl>
973 <dl>
974 <dt>Return Type:</dt>
975 <dd>
976 bool
924 </dd> 977 </dd>
925 </dl> 978 </dl>
926 <dl> 979 <dl>
927 980
928 <dt>Raises <b>NotImplementedError</b>:</dt> 981 <dt>Raises <b>NotImplementedError</b>:</dt>
938 <p> 991 <p>
939 Public method used to cleanup the local copy. 992 Public method used to cleanup the local copy.
940 </p> 993 </p>
941 <dl> 994 <dl>
942 995
943 <dt><i>name</i></dt> 996 <dt><i>name</i> (str)</dt>
944 <dd> 997 <dd>
945 directory name to be cleaned up (string) 998 directory name to be cleaned up
946 </dd> 999 </dd>
947 </dl> 1000 </dl>
948 <dl> 1001 <dl>
949 1002
950 <dt>Raises <b>NotImplementedError</b>:</dt> 1003 <dt>Raises <b>NotImplementedError</b>:</dt>
975 <p> 1028 <p>
976 Public method used to execute arbitrary vcs commands. 1029 Public method used to execute arbitrary vcs commands.
977 </p> 1030 </p>
978 <dl> 1031 <dl>
979 1032
980 <dt><i>name</i></dt> 1033 <dt><i>name</i> (str)</dt>
981 <dd> 1034 <dd>
982 directory name of the working directory (string) 1035 directory name of the working directory
983 </dd> 1036 </dd>
984 </dl> 1037 </dl>
985 <dl> 1038 <dl>
986 1039
987 <dt>Raises <b>NotImplementedError</b>:</dt> 1040 <dt>Raises <b>NotImplementedError</b>:</dt>
998 Public method used to make the change of a file/directory permanent in 1051 Public method used to make the change of a file/directory permanent in
999 the vcs. 1052 the vcs.
1000 </p> 1053 </p>
1001 <dl> 1054 <dl>
1002 1055
1003 <dt><i>name</i></dt> 1056 <dt><i>name</i> (str)</dt>
1004 <dd> 1057 <dd>
1005 file/directory name to be committed (string) 1058 file/directory name to be committed
1006 </dd> 1059 </dd>
1007 <dt><i>message</i></dt> 1060 <dt><i>message</i> (str)</dt>
1008 <dd> 1061 <dd>
1009 message for this operation (string) 1062 message for this operation
1010 </dd> 1063 </dd>
1011 <dt><i>noDialog</i></dt> 1064 <dt><i>noDialog</i> (bool)</dt>
1012 <dd> 1065 <dd>
1013 flag indicating quiet operations (boolean) 1066 flag indicating quiet operations
1014 </dd> 1067 </dd>
1015 </dl> 1068 </dl>
1016 <dl> 1069 <dl>
1017 <dt>Return:</dt> 1070 <dt>Return:</dt>
1018 <dd> 1071 <dd>
1019 flag indicating success (boolean) 1072 flag indicating success
1073 </dd>
1074 </dl>
1075 <dl>
1076 <dt>Return Type:</dt>
1077 <dd>
1078 bool
1020 </dd> 1079 </dd>
1021 </dl> 1080 </dl>
1022 <dl> 1081 <dl>
1023 1082
1024 <dt>Raises <b>NotImplementedError</b>:</dt> 1083 <dt>Raises <b>NotImplementedError</b>:</dt>
1092 <p> 1151 <p>
1093 Public method used to view the diff of a file/directory in the vcs. 1152 Public method used to view the diff of a file/directory in the vcs.
1094 </p> 1153 </p>
1095 <dl> 1154 <dl>
1096 1155
1097 <dt><i>name</i></dt> 1156 <dt><i>name</i> (str)</dt>
1098 <dd> 1157 <dd>
1099 file/directory name to be diffed (string) 1158 file/directory name to be diffed
1100 </dd> 1159 </dd>
1101 </dl> 1160 </dl>
1102 <dl> 1161 <dl>
1103 1162
1104 <dt>Raises <b>NotImplementedError</b>:</dt> 1163 <dt>Raises <b>NotImplementedError</b>:</dt>
1115 Public method used to test for the presence of the vcs. 1174 Public method used to test for the presence of the vcs.
1116 </p> 1175 </p>
1117 <dl> 1176 <dl>
1118 <dt>Return:</dt> 1177 <dt>Return:</dt>
1119 <dd> 1178 <dd>
1120 tuple of flag indicating the existence and a string 1179 tuple of flag indicating the existence and an error message
1121 giving an error message in case of failure 1180 in case of failure
1181 </dd>
1182 </dl>
1183 <dl>
1184 <dt>Return Type:</dt>
1185 <dd>
1186 tuple of (bool, str)
1122 </dd> 1187 </dd>
1123 </dl> 1188 </dl>
1124 <dl> 1189 <dl>
1125 1190
1126 <dt>Raises <b>NotImplementedError</b>:</dt> 1191 <dt>Raises <b>NotImplementedError</b>:</dt>
1136 <p> 1201 <p>
1137 Public method used to export a directory from the vcs. 1202 Public method used to export a directory from the vcs.
1138 </p> 1203 </p>
1139 <dl> 1204 <dl>
1140 1205
1141 <dt><i>vcsDataDict</i></dt> 1206 <dt><i>vcsDataDict</i> (dict)</dt>
1142 <dd> 1207 <dd>
1143 dictionary of data required for the export 1208 dictionary of data required for the export
1144 </dd> 1209 </dd>
1145 <dt><i>projectDir</i></dt> 1210 <dt><i>projectDir</i> (str)</dt>
1146 <dd> 1211 <dd>
1147 project directory to create (string) 1212 project directory to create
1148 </dd> 1213 </dd>
1149 </dl> 1214 </dl>
1150 <dl> 1215 <dl>
1151 <dt>Return:</dt> 1216 <dt>Return:</dt>
1152 <dd> 1217 <dd>
1153 flag indicating an execution without errors (boolean) 1218 flag indicating an execution without errors
1219 </dd>
1220 </dl>
1221 <dl>
1222 <dt>Return Type:</dt>
1223 <dd>
1224 bool
1154 </dd> 1225 </dd>
1155 </dl> 1226 </dl>
1156 <dl> 1227 <dl>
1157 1228
1158 <dt>Raises <b>NotImplementedError</b>:</dt> 1229 <dt>Raises <b>NotImplementedError</b>:</dt>
1195 <dd> 1266 <dd>
1196 a dictionary of option strings that can be passed to 1267 a dictionary of option strings that can be passed to
1197 vcsSetOptions. 1268 vcsSetOptions.
1198 </dd> 1269 </dd>
1199 </dl> 1270 </dl>
1271 <dl>
1272 <dt>Return Type:</dt>
1273 <dd>
1274 dict
1275 </dd>
1276 </dl>
1200 <a NAME="VersionControl.vcsGetOtherData" ID="VersionControl.vcsGetOtherData"></a> 1277 <a NAME="VersionControl.vcsGetOtherData" ID="VersionControl.vcsGetOtherData"></a>
1201 <h4>VersionControl.vcsGetOtherData</h4> 1278 <h4>VersionControl.vcsGetOtherData</h4>
1202 <b>vcsGetOtherData</b>(<i></i>) 1279 <b>vcsGetOtherData</b>(<i></i>)
1203 1280
1204 <p> 1281 <p>
1208 <dt>Return:</dt> 1285 <dt>Return:</dt>
1209 <dd> 1286 <dd>
1210 a dictionary of vcs specific data 1287 a dictionary of vcs specific data
1211 </dd> 1288 </dd>
1212 </dl> 1289 </dl>
1290 <dl>
1291 <dt>Return Type:</dt>
1292 <dd>
1293 dict
1294 </dd>
1295 </dl>
1213 <a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> 1296 <a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a>
1214 <h4>VersionControl.vcsGetProjectBrowserHelper</h4> 1297 <h4>VersionControl.vcsGetProjectBrowserHelper</h4>
1215 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 1298 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
1216 1299
1217 <p> 1300 <p>
1218 Public method to instanciate a helper object for the different 1301 Public method to instanciate a helper object for the different
1219 project browsers. 1302 project browsers.
1220 </p> 1303 </p>
1221 <dl> 1304 <dl>
1222 1305
1223 <dt><i>browser</i></dt> 1306 <dt><i>browser</i> (ProjectBaseBrowser)</dt>
1224 <dd> 1307 <dd>
1225 reference to the project browser object 1308 reference to the project browser object
1226 </dd> 1309 </dd>
1227 <dt><i>project</i></dt> 1310 <dt><i>project</i> (Project)</dt>
1228 <dd> 1311 <dd>
1229 reference to the project object 1312 reference to the project object
1230 </dd> 1313 </dd>
1231 <dt><i>isTranslationsBrowser</i></dt> 1314 <dt><i>isTranslationsBrowser</i> (bool)</dt>
1232 <dd> 1315 <dd>
1233 flag indicating, the helper is requested 1316 flag indicating, the helper is requested
1234 for the translations browser (this needs some special treatment) 1317 for the translations browser (this needs some special treatment)
1235 </dd> 1318 </dd>
1236 </dl> 1319 </dl>
1237 <dl> 1320 <dl>
1238 <dt>Return:</dt> 1321 <dt>Return:</dt>
1239 <dd> 1322 <dd>
1240 the project browser helper object 1323 the project browser helper object
1324 </dd>
1325 </dl>
1326 <dl>
1327 <dt>Return Type:</dt>
1328 <dd>
1329 VcsProjectBrowserHelper
1241 </dd> 1330 </dd>
1242 </dl> 1331 </dl>
1243 <dl> 1332 <dl>
1244 1333
1245 <dt>Raises <b>NotImplementedError</b>:</dt> 1334 <dt>Raises <b>NotImplementedError</b>:</dt>
1255 <p> 1344 <p>
1256 Public method to instanciate a helper object for the project. 1345 Public method to instanciate a helper object for the project.
1257 </p> 1346 </p>
1258 <dl> 1347 <dl>
1259 1348
1260 <dt><i>project</i></dt> 1349 <dt><i>project</i> (Project)</dt>
1261 <dd> 1350 <dd>
1262 reference to the project object 1351 reference to the project object
1263 </dd> 1352 </dd>
1264 </dl> 1353 </dl>
1265 <dl> 1354 <dl>
1266 <dt>Return:</dt> 1355 <dt>Return:</dt>
1267 <dd> 1356 <dd>
1268 the project helper object 1357 the project helper object
1358 </dd>
1359 </dl>
1360 <dl>
1361 <dt>Return Type:</dt>
1362 <dd>
1363 VcsProjectHelper
1269 </dd> 1364 </dd>
1270 </dl> 1365 </dl>
1271 <dl> 1366 <dl>
1272 1367
1273 <dt>Raises <b>NotImplementedError</b>:</dt> 1368 <dt>Raises <b>NotImplementedError</b>:</dt>
1289 <dd> 1384 <dd>
1290 dictionary of data required for the import 1385 dictionary of data required for the import
1291 </dd> 1386 </dd>
1292 <dt><i>projectDir</i> (str)</dt> 1387 <dt><i>projectDir</i> (str)</dt>
1293 <dd> 1388 <dd>
1294 project directory (string) 1389 project directory
1295 </dd> 1390 </dd>
1296 <dt><i>noDialog</i> (bool)</dt> 1391 <dt><i>noDialog</i> (bool)</dt>
1297 <dd> 1392 <dd>
1298 flag indicating quiet operations 1393 flag indicating quiet operations
1299 </dd> 1394 </dd>
1330 <p> 1425 <p>
1331 Public method used to initialize the vcs. 1426 Public method used to initialize the vcs.
1332 </p> 1427 </p>
1333 <dl> 1428 <dl>
1334 1429
1335 <dt><i>vcsDir</i></dt> 1430 <dt><i>vcsDir</i> (str)</dt>
1336 <dd> 1431 <dd>
1337 name of the VCS directory (string) 1432 name of the VCS directory
1338 </dd> 1433 </dd>
1339 <dt><i>noDialog</i></dt> 1434 <dt><i>noDialog</i> (bool)</dt>
1340 <dd> 1435 <dd>
1341 flag indicating quiet operations (boolean) 1436 flag indicating quiet operations
1342 </dd> 1437 </dd>
1343 </dl> 1438 </dl>
1344 <dl> 1439 <dl>
1345 <dt>Return:</dt> 1440 <dt>Return:</dt>
1346 <dd> 1441 <dd>
1347 flag indicating success (boolean) 1442 flag indicating success
1443 </dd>
1444 </dl>
1445 <dl>
1446 <dt>Return Type:</dt>
1447 <dd>
1448 bool
1348 </dd> 1449 </dd>
1349 </dl> 1450 </dl>
1350 <dl> 1451 <dl>
1351 1452
1352 <dt>Raises <b>NotImplementedError</b>:</dt> 1453 <dt>Raises <b>NotImplementedError</b>:</dt>
1366 This method could ensure, that certain files or directories are 1467 This method could ensure, that certain files or directories are
1367 exclude from being version controlled. 1468 exclude from being version controlled.
1368 </p> 1469 </p>
1369 <dl> 1470 <dl>
1370 1471
1371 <dt><i>project</i></dt> 1472 <dt><i>project</i> (Project)</dt>
1372 <dd> 1473 <dd>
1373 reference to the project (Project) 1474 reference to the project
1374 </dd> 1475 </dd>
1375 </dl> 1476 </dl>
1376 <a NAME="VersionControl.vcsLogBrowser" ID="VersionControl.vcsLogBrowser"></a> 1477 <a NAME="VersionControl.vcsLogBrowser" ID="VersionControl.vcsLogBrowser"></a>
1377 <h4>VersionControl.vcsLogBrowser</h4> 1478 <h4>VersionControl.vcsLogBrowser</h4>
1378 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>) 1479 <b>vcsLogBrowser</b>(<i>name, isFile=False</i>)
1381 Public method used to view the log of a file/directory in the vcs 1482 Public method used to view the log of a file/directory in the vcs
1382 with a log browser dialog. 1483 with a log browser dialog.
1383 </p> 1484 </p>
1384 <dl> 1485 <dl>
1385 1486
1386 <dt><i>name</i></dt> 1487 <dt><i>name</i> (str)</dt>
1387 <dd> 1488 <dd>
1388 file/directory name to show the log for (string) 1489 file/directory name to show the log for
1389 </dd> 1490 </dd>
1390 <dt><i>isFile</i></dt> 1491 <dt><i>isFile</i> (bool)</dt>
1391 <dd> 1492 <dd>
1392 flag indicating log for a file is to be shown 1493 flag indicating log for a file is to be shown
1393 (boolean)
1394 </dd> 1494 </dd>
1395 </dl> 1495 </dl>
1396 <dl> 1496 <dl>
1397 1497
1398 <dt>Raises <b>NotImplementedError</b>:</dt> 1498 <dt>Raises <b>NotImplementedError</b>:</dt>
1408 <p> 1508 <p>
1409 Public method used to merge a tag/branch into the local project. 1509 Public method used to merge a tag/branch into the local project.
1410 </p> 1510 </p>
1411 <dl> 1511 <dl>
1412 1512
1413 <dt><i>name</i></dt> 1513 <dt><i>name</i> (str)</dt>
1414 <dd> 1514 <dd>
1415 file/directory name to be merged (string) 1515 file/directory name to be merged
1416 </dd> 1516 </dd>
1417 </dl> 1517 </dl>
1418 <dl> 1518 <dl>
1419 1519
1420 <dt>Raises <b>NotImplementedError</b>:</dt> 1520 <dt>Raises <b>NotImplementedError</b>:</dt>
1430 <p> 1530 <p>
1431 Public method used to move a file/directory. 1531 Public method used to move a file/directory.
1432 </p> 1532 </p>
1433 <dl> 1533 <dl>
1434 1534
1435 <dt><i>name</i></dt> 1535 <dt><i>name</i> (str)</dt>
1436 <dd> 1536 <dd>
1437 file/directory name to be moved (string) 1537 file/directory name to be moved
1438 </dd> 1538 </dd>
1439 <dt><i>project</i></dt> 1539 <dt><i>project</i> (Project)</dt>
1440 <dd> 1540 <dd>
1441 reference to the project object 1541 reference to the project object
1442 </dd> 1542 </dd>
1443 <dt><i>target</i></dt> 1543 <dt><i>target</i> (str)</dt>
1444 <dd> 1544 <dd>
1445 new name of the file/directory (string) 1545 new name of the file/directory
1446 </dd> 1546 </dd>
1447 <dt><i>noDialog</i></dt> 1547 <dt><i>noDialog</i> (bool)</dt>
1448 <dd> 1548 <dd>
1449 flag indicating quiet operations 1549 flag indicating quiet operations
1450 </dd> 1550 </dd>
1451 </dl> 1551 </dl>
1452 <dl> 1552 <dl>
1453 <dt>Return:</dt> 1553 <dt>Return:</dt>
1454 <dd> 1554 <dd>
1455 flag indicating successfull operation (boolean) 1555 flag indicating successfull operation
1556 </dd>
1557 </dl>
1558 <dl>
1559 <dt>Return Type:</dt>
1560 <dd>
1561 bool
1456 </dd> 1562 </dd>
1457 </dl> 1563 </dl>
1458 <dl> 1564 <dl>
1459 1565
1460 <dt>Raises <b>NotImplementedError</b>:</dt> 1566 <dt>Raises <b>NotImplementedError</b>:</dt>
1471 Public method returning the name of the vcs. 1577 Public method returning the name of the vcs.
1472 </p> 1578 </p>
1473 <dl> 1579 <dl>
1474 <dt>Return:</dt> 1580 <dt>Return:</dt>
1475 <dd> 1581 <dd>
1476 name of the vcs (string) 1582 name of the vcs
1583 </dd>
1584 </dl>
1585 <dl>
1586 <dt>Return Type:</dt>
1587 <dd>
1588 str
1477 </dd> 1589 </dd>
1478 </dl> 1590 </dl>
1479 <dl> 1591 <dl>
1480 1592
1481 <dt>Raises <b>NotImplementedError</b>:</dt> 1593 <dt>Raises <b>NotImplementedError</b>:</dt>
1492 Public method to get a dialog to enter repository info for getting a 1604 Public method to get a dialog to enter repository info for getting a
1493 new project. 1605 new project.
1494 </p> 1606 </p>
1495 <dl> 1607 <dl>
1496 1608
1497 <dt><i>parent</i></dt> 1609 <dt><i>parent</i> (QWidget)</dt>
1498 <dd> 1610 <dd>
1499 parent widget (QWidget) 1611 parent widget
1500 </dd> 1612 </dd>
1501 </dl> 1613 </dl>
1502 <dl> 1614 <dl>
1503 1615
1504 <dt>Raises <b>NotImplementedError</b>:</dt> 1616 <dt>Raises <b>NotImplementedError</b>:</dt>
1514 <p> 1626 <p>
1515 Public method to get a dialog to enter repository info. 1627 Public method to get a dialog to enter repository info.
1516 </p> 1628 </p>
1517 <dl> 1629 <dl>
1518 1630
1519 <dt><i>project</i></dt> 1631 <dt><i>project</i> (Project)</dt>
1520 <dd> 1632 <dd>
1521 reference to the project object 1633 reference to the project object
1522 </dd> 1634 </dd>
1523 <dt><i>archive</i></dt> 1635 <dt><i>archive</i> (str)</dt>
1524 <dd> 1636 <dd>
1525 name of the project in the repository (string) 1637 name of the project in the repository
1526 </dd> 1638 </dd>
1527 <dt><i>editable</i></dt> 1639 <dt><i>editable</i> (bool)</dt>
1528 <dd> 1640 <dd>
1529 flag indicating that the project name is editable 1641 flag indicating that the project name is editable
1530 (boolean) 1642 </dd>
1531 </dd> 1643 <dt><i>parent</i> (QWidget)</dt>
1532 <dt><i>parent</i></dt> 1644 <dd>
1533 <dd> 1645 parent widget
1534 parent widget (QWidget)
1535 </dd> 1646 </dd>
1536 </dl> 1647 </dl>
1537 <dl> 1648 <dl>
1538 1649
1539 <dt>Raises <b>NotImplementedError</b>:</dt> 1650 <dt>Raises <b>NotImplementedError</b>:</dt>
1549 <p> 1660 <p>
1550 Public method used to get the registered state of a file in the vcs. 1661 Public method used to get the registered state of a file in the vcs.
1551 </p> 1662 </p>
1552 <dl> 1663 <dl>
1553 1664
1554 <dt><i>name</i></dt> 1665 <dt><i>name</i> (str)</dt>
1555 <dd> 1666 <dd>
1556 filename to check (string) 1667 filename to check
1557 </dd> 1668 </dd>
1558 </dl> 1669 </dl>
1559 <dl> 1670 <dl>
1560 <dt>Return:</dt> 1671 <dt>Return:</dt>
1561 <dd> 1672 <dd>
1562 a combination of canBeCommited and canBeAdded or 1673 a combination of canBeCommited and canBeAdded or
1563 0 in order to signal an error 1674 0 in order to signal an error
1675 </dd>
1676 </dl>
1677 <dl>
1678 <dt>Return Type:</dt>
1679 <dd>
1680 int
1564 </dd> 1681 </dd>
1565 </dl> 1682 </dl>
1566 <dl> 1683 <dl>
1567 1684
1568 <dt>Raises <b>NotImplementedError</b>:</dt> 1685 <dt>Raises <b>NotImplementedError</b>:</dt>
1578 <p> 1695 <p>
1579 Public method used to add a file/directory in the vcs. 1696 Public method used to add a file/directory in the vcs.
1580 </p> 1697 </p>
1581 <dl> 1698 <dl>
1582 1699
1583 <dt><i>name</i></dt> 1700 <dt><i>name</i> (str)</dt>
1584 <dd> 1701 <dd>
1585 file/directory name to be removed (string) 1702 file/directory name to be removed
1586 </dd> 1703 </dd>
1587 <dt><i>project</i></dt> 1704 <dt><i>project</i> (bool)</dt>
1588 <dd> 1705 <dd>
1589 flag indicating deletion of a project tree (boolean) 1706 flag indicating deletion of a project tree
1590 </dd> 1707 </dd>
1591 <dt><i>noDialog</i></dt> 1708 <dt><i>noDialog</i> (bool)</dt>
1592 <dd> 1709 <dd>
1593 flag indicating quiet operations 1710 flag indicating quiet operations
1594 </dd> 1711 </dd>
1595 </dl> 1712 </dl>
1596 <dl> 1713 <dl>
1597 <dt>Return:</dt> 1714 <dt>Return:</dt>
1598 <dd> 1715 <dd>
1599 flag indicating success (boolean) 1716 flag indicating success
1717 </dd>
1718 </dl>
1719 <dl>
1720 <dt>Return Type:</dt>
1721 <dd>
1722 bool
1600 </dd> 1723 </dd>
1601 </dl> 1724 </dl>
1602 <dl> 1725 <dl>
1603 1726
1604 <dt>Raises <b>NotImplementedError</b>:</dt> 1727 <dt>Raises <b>NotImplementedError</b>:</dt>
1614 <p> 1737 <p>
1615 Public method to retrieve information about the repository. 1738 Public method to retrieve information about the repository.
1616 </p> 1739 </p>
1617 <dl> 1740 <dl>
1618 1741
1619 <dt><i>ppath</i></dt> 1742 <dt><i>ppath</i> (str)</dt>
1620 <dd> 1743 <dd>
1621 local path to get the repository infos (string) 1744 local path to get the repository infos
1622 </dd> 1745 </dd>
1623 </dl> 1746 </dl>
1624 <dl> 1747 <dl>
1625 <dt>Return:</dt> 1748 <dt>Return:</dt>
1626 <dd> 1749 <dd>
1627 string with ready formated info for display (string) 1750 string with ready formated info for display
1751 </dd>
1752 </dl>
1753 <dl>
1754 <dt>Return Type:</dt>
1755 <dd>
1756 str
1628 </dd> 1757 </dd>
1629 </dl> 1758 </dl>
1630 <dl> 1759 <dl>
1631 1760
1632 <dt>Raises <b>NotImplementedError</b>:</dt> 1761 <dt>Raises <b>NotImplementedError</b>:</dt>
1722 <p> 1851 <p>
1723 Public method used to set an entry in the otherData dictionary. 1852 Public method used to set an entry in the otherData dictionary.
1724 </p> 1853 </p>
1725 <dl> 1854 <dl>
1726 1855
1727 <dt><i>key</i></dt> 1856 <dt><i>key</i> (str)</dt>
1728 <dd> 1857 <dd>
1729 the key of the data (string) 1858 the key of the data
1730 </dd> 1859 </dd>
1731 <dt><i>value</i></dt> 1860 <dt><i>value</i> (Any)</dt>
1732 <dd> 1861 <dd>
1733 the value of the data 1862 the value of the data
1734 </dd> 1863 </dd>
1735 </dl> 1864 </dl>
1736 <a NAME="VersionControl.vcsSetDataFromDict" ID="VersionControl.vcsSetDataFromDict"></a> 1865 <a NAME="VersionControl.vcsSetDataFromDict" ID="VersionControl.vcsSetDataFromDict"></a>
1740 <p> 1869 <p>
1741 Public method used to set entries in the otherData dictionary. 1870 Public method used to set entries in the otherData dictionary.
1742 </p> 1871 </p>
1743 <dl> 1872 <dl>
1744 1873
1745 <dt><i>dictionary</i></dt> 1874 <dt><i>dictionary</i> (dict)</dt>
1746 <dd> 1875 <dd>
1747 dictionary to pick entries from 1876 dictionary to pick entries from
1748 </dd> 1877 </dd>
1749 </dl> 1878 </dl>
1750 <a NAME="VersionControl.vcsSetOptions" ID="VersionControl.vcsSetOptions"></a> 1879 <a NAME="VersionControl.vcsSetOptions" ID="VersionControl.vcsSetOptions"></a>
1754 <p> 1883 <p>
1755 Public method used to set the options for the vcs. 1884 Public method used to set the options for the vcs.
1756 </p> 1885 </p>
1757 <dl> 1886 <dl>
1758 1887
1759 <dt><i>options</i></dt> 1888 <dt><i>options</i> (dict)</dt>
1760 <dd> 1889 <dd>
1761 a dictionary of option strings with keys as 1890 a dictionary of option strings with keys as
1762 defined by the default options 1891 defined by the default options
1763 </dd> 1892 </dd>
1764 </dl> 1893 </dl>
1765 <a NAME="VersionControl.vcsSetOtherData" ID="VersionControl.vcsSetOtherData"></a> 1894 <a NAME="VersionControl.vcsSetOtherData" ID="VersionControl.vcsSetOtherData"></a>
1766 <h4>VersionControl.vcsSetOtherData</h4> 1895 <h4>VersionControl.vcsSetOtherData</h4>
1767 <b>vcsSetOtherData</b>(<i>data</i>) 1896 <b>vcsSetOtherData</b>(<i>data</i>)
1769 <p> 1898 <p>
1770 Public method used to set vcs specific data. 1899 Public method used to set vcs specific data.
1771 </p> 1900 </p>
1772 <dl> 1901 <dl>
1773 1902
1774 <dt><i>data</i></dt> 1903 <dt><i>data</i> (dict)</dt>
1775 <dd> 1904 <dd>
1776 a dictionary of vcs specific data 1905 a dictionary of vcs specific data
1777 </dd> 1906 </dd>
1778 </dl> 1907 </dl>
1779 <a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a> 1908 <a NAME="VersionControl.vcsShutdown" ID="VersionControl.vcsShutdown"></a>
1798 <p> 1927 <p>
1799 Public method used to view the status of a file/directory in the vcs. 1928 Public method used to view the status of a file/directory in the vcs.
1800 </p> 1929 </p>
1801 <dl> 1930 <dl>
1802 1931
1803 <dt><i>name</i></dt> 1932 <dt><i>name</i> (str)</dt>
1804 <dd> 1933 <dd>
1805 file/directory name to show the status for (string) 1934 file/directory name to show the status for
1806 </dd> 1935 </dd>
1807 </dl> 1936 </dl>
1808 <dl> 1937 <dl>
1809 1938
1810 <dt>Raises <b>NotImplementedError</b>:</dt> 1939 <dt>Raises <b>NotImplementedError</b>:</dt>
1822 </p> 1951 </p>
1823 <dl> 1952 <dl>
1824 <dt>Return:</dt> 1953 <dt>Return:</dt>
1825 <dd> 1954 <dd>
1826 flag indicating the support of user settable command options 1955 flag indicating the support of user settable command options
1827 (boolean) 1956 </dd>
1957 </dl>
1958 <dl>
1959 <dt>Return Type:</dt>
1960 <dd>
1961 bool
1828 </dd> 1962 </dd>
1829 </dl> 1963 </dl>
1830 <a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a> 1964 <a NAME="VersionControl.vcsSwitch" ID="VersionControl.vcsSwitch"></a>
1831 <h4>VersionControl.vcsSwitch</h4> 1965 <h4>VersionControl.vcsSwitch</h4>
1832 <b>vcsSwitch</b>(<i>name</i>) 1966 <b>vcsSwitch</b>(<i>name</i>)
1834 <p> 1968 <p>
1835 Public method used to switch a directory to a different tag/branch. 1969 Public method used to switch a directory to a different tag/branch.
1836 </p> 1970 </p>
1837 <dl> 1971 <dl>
1838 1972
1839 <dt><i>name</i></dt> 1973 <dt><i>name</i> (str)</dt>
1840 <dd> 1974 <dd>
1841 directory name to be switched (string) 1975 directory name to be switched
1842 </dd> 1976 </dd>
1843 </dl> 1977 </dl>
1844 <dl> 1978 <dl>
1845 <dt>Return:</dt> 1979 <dt>Return:</dt>
1846 <dd> 1980 <dd>
1847 flag indicating, that the switch contained an add 1981 flag indicating, that the switch contained an add
1848 or delete (boolean) 1982 or delete
1983 </dd>
1984 </dl>
1985 <dl>
1986 <dt>Return Type:</dt>
1987 <dd>
1988 bool
1849 </dd> 1989 </dd>
1850 </dl> 1990 </dl>
1851 <dl> 1991 <dl>
1852 1992
1853 <dt>Raises <b>NotImplementedError</b>:</dt> 1993 <dt>Raises <b>NotImplementedError</b>:</dt>
1863 <p> 2003 <p>
1864 Public method used to set the tag of a file/directory in the vcs. 2004 Public method used to set the tag of a file/directory in the vcs.
1865 </p> 2005 </p>
1866 <dl> 2006 <dl>
1867 2007
1868 <dt><i>name</i></dt> 2008 <dt><i>name</i> (str)</dt>
1869 <dd> 2009 <dd>
1870 file/directory name to be tagged (string) 2010 file/directory name to be tagged
1871 </dd> 2011 </dd>
1872 </dl> 2012 </dl>
1873 <dl> 2013 <dl>
1874 2014
1875 <dt>Raises <b>NotImplementedError</b>:</dt> 2015 <dt>Raises <b>NotImplementedError</b>:</dt>
1885 <p> 2025 <p>
1886 Public method used to update a file/directory in the vcs. 2026 Public method used to update a file/directory in the vcs.
1887 </p> 2027 </p>
1888 <dl> 2028 <dl>
1889 2029
1890 <dt><i>name</i></dt> 2030 <dt><i>name</i> (str)</dt>
1891 <dd> 2031 <dd>
1892 file/directory name to be updated (string) 2032 file/directory name to be updated
1893 </dd> 2033 </dd>
1894 <dt><i>noDialog</i></dt> 2034 <dt><i>noDialog</i> (bool)</dt>
1895 <dd> 2035 <dd>
1896 flag indicating quiet operations (boolean) 2036 flag indicating quiet operations
1897 </dd> 2037 </dd>
1898 </dl> 2038 </dl>
1899 <dl> 2039 <dl>
1900 <dt>Return:</dt> 2040 <dt>Return:</dt>
1901 <dd> 2041 <dd>
1902 flag indicating, that the update contained an add 2042 flag indicating, that the update contained an add
1903 or delete (boolean) 2043 or delete
2044 </dd>
2045 </dl>
2046 <dl>
2047 <dt>Return Type:</dt>
2048 <dd>
2049 bool
1904 </dd> 2050 </dd>
1905 </dl> 2051 </dl>
1906 <dl> 2052 <dl>
1907 2053
1908 <dt>Raises <b>NotImplementedError</b>:</dt> 2054 <dt>Raises <b>NotImplementedError</b>:</dt>

Mercurial Repository: eric

eric ide

mercurial