Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.VCS.VersionControl.html
Documentation/Source/eric5.VCS.VersionControl.html
- changeset 945
- 8cd4d08fa9f6
- parent 767
- 27554f80d08f
- child 1083
- dc680a0ce221
equal
deleted
inserted
replaced
| 944:1b59c4ba121e | 945:8cd4d08fa9f6 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.VCS.VersionControl</h1> | 23 <h1>eric5.VCS.VersionControl</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing an abstract base class to be subclassed by all specific | 25 Module implementing an abstract base class to be subclassed by all specific |
| 26 VCS interfaces. | 26 VCS interfaces. |
| 27 </p> | 27 </p> |
| 28 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 <table> | 29 <table> |
| 30 <tr><td>None</td></tr> | 30 <tr><td>None</td></tr> |
| 42 </table> | 42 </table> |
| 43 <hr /><hr /> | 43 <hr /><hr /> |
| 44 <a NAME="VersionControl" ID="VersionControl"></a> | 44 <a NAME="VersionControl" ID="VersionControl"></a> |
| 45 <h2>VersionControl</h2> | 45 <h2>VersionControl</h2> |
| 46 <p> | 46 <p> |
| 47 Class implementing an abstract base class to be subclassed by all specific | 47 Class implementing an abstract base class to be subclassed by all specific |
| 48 VCS interfaces. | 48 VCS interfaces. |
| 49 </p><p> | 49 </p><p> |
| 50 It defines the vcs interface to be implemented by subclasses | 50 It defines the vcs interface to be implemented by subclasses |
| 51 and the common methods. | 51 and the common methods. |
| 52 </p><h4>Signals</h4> | 52 </p><h4>Signals</h4> |
| 238 <td>Public method used to update a file/directory in the vcs.</td> | 238 <td>Public method used to update a file/directory in the vcs.</td> |
| 239 </tr> | 239 </tr> |
| 240 </table> | 240 </table> |
| 241 <a NAME="VersionControl.__init__" ID="VersionControl.__init__"></a> | 241 <a NAME="VersionControl.__init__" ID="VersionControl.__init__"></a> |
| 242 <h4>VersionControl (Constructor)</h4> | 242 <h4>VersionControl (Constructor)</h4> |
| 243 <b>VersionControl</b>(<i>parent = None, name = None</i>) | 243 <b>VersionControl</b>(<i>parent=None, name=None</i>) |
| 244 <p> | 244 <p> |
| 245 Constructor | 245 Constructor |
| 246 </p><dl> | 246 </p><dl> |
| 247 <dt><i>parent</i></dt> | 247 <dt><i>parent</i></dt> |
| 248 <dd> | 248 <dd> |
| 392 </dd> | 392 </dd> |
| 393 </dl><a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> | 393 </dl><a NAME="VersionControl.splitPathList" ID="VersionControl.splitPathList"></a> |
| 394 <h4>VersionControl.splitPathList</h4> | 394 <h4>VersionControl.splitPathList</h4> |
| 395 <b>splitPathList</b>(<i>names</i>) | 395 <b>splitPathList</b>(<i>names</i>) |
| 396 <p> | 396 <p> |
| 397 Public method splitting the list of names into a common directory part and | 397 Public method splitting the list of names into a common directory part and |
| 398 a file list. | 398 a file list. |
| 399 </p><dl> | 399 </p><dl> |
| 400 <dt><i>names</i></dt> | 400 <dt><i>names</i></dt> |
| 401 <dd> | 401 <dd> |
| 402 list of paths (list of strings) | 402 list of paths (list of strings) |
| 421 <dd> | 421 <dd> |
| 422 reference to the monitor thread (QThread) | 422 reference to the monitor thread (QThread) |
| 423 </dd> | 423 </dd> |
| 424 </dl><a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> | 424 </dl><a NAME="VersionControl.startSynchronizedProcess" ID="VersionControl.startSynchronizedProcess"></a> |
| 425 <h4>VersionControl.startSynchronizedProcess</h4> | 425 <h4>VersionControl.startSynchronizedProcess</h4> |
| 426 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir = None</i>) | 426 <b>startSynchronizedProcess</b>(<i>proc, program, arguments, workingDir=None</i>) |
| 427 <p> | 427 <p> |
| 428 Public method to start a synchroneous process | 428 Public method to start a synchroneous process |
| 429 </p><p> | 429 </p><p> |
| 430 This method starts a process and waits | 430 This method starts a process and waits |
| 431 for its end while still serving the Qt event loop. | 431 for its end while still serving the Qt event loop. |
| 453 <b>stopStatusMonitor</b>(<i></i>) | 453 <b>stopStatusMonitor</b>(<i></i>) |
| 454 <p> | 454 <p> |
| 455 Public method to stop the VCS status monitor thread. | 455 Public method to stop the VCS status monitor thread. |
| 456 </p><a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a> | 456 </p><a NAME="VersionControl.vcsAdd" ID="VersionControl.vcsAdd"></a> |
| 457 <h4>VersionControl.vcsAdd</h4> | 457 <h4>VersionControl.vcsAdd</h4> |
| 458 <b>vcsAdd</b>(<i>name, isDir = False, noDialog = False</i>) | 458 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) |
| 459 <p> | 459 <p> |
| 460 Public method used to add a file/directory in the vcs. | 460 Public method used to add a file/directory in the vcs. |
| 461 </p><p> | 461 </p><p> |
| 462 It must not return anything. | 462 It must not return anything. |
| 463 </p><dl> | 463 </p><dl> |
| 476 <dd> | 476 <dd> |
| 477 not implemented | 477 not implemented |
| 478 </dd> | 478 </dd> |
| 479 </dl><a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a> | 479 </dl><a NAME="VersionControl.vcsAddBinary" ID="VersionControl.vcsAddBinary"></a> |
| 480 <h4>VersionControl.vcsAddBinary</h4> | 480 <h4>VersionControl.vcsAddBinary</h4> |
| 481 <b>vcsAddBinary</b>(<i>name, isDir = False</i>) | 481 <b>vcsAddBinary</b>(<i>name, isDir=False</i>) |
| 482 <p> | 482 <p> |
| 483 Public method used to add a file/directory in binary mode in the vcs. | 483 Public method used to add a file/directory in binary mode in the vcs. |
| 484 </p><p> | 484 </p><p> |
| 485 It must not return anything. | 485 It must not return anything. |
| 486 </p><dl> | 486 </p><dl> |
| 537 <dd> | 537 <dd> |
| 538 not implemented | 538 not implemented |
| 539 </dd> | 539 </dd> |
| 540 </dl><a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a> | 540 </dl><a NAME="VersionControl.vcsCheckout" ID="VersionControl.vcsCheckout"></a> |
| 541 <h4>VersionControl.vcsCheckout</h4> | 541 <h4>VersionControl.vcsCheckout</h4> |
| 542 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog = False</i>) | 542 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
| 543 <p> | 543 <p> |
| 544 Public method used to check the project out of the vcs. | 544 Public method used to check the project out of the vcs. |
| 545 </p><dl> | 545 </p><dl> |
| 546 <dt><i>vcsDataDict</i></dt> | 546 <dt><i>vcsDataDict</i></dt> |
| 547 <dd> | 547 <dd> |
| 593 <dd> | 593 <dd> |
| 594 not implemented | 594 not implemented |
| 595 </dd> | 595 </dd> |
| 596 </dl><a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a> | 596 </dl><a NAME="VersionControl.vcsCommit" ID="VersionControl.vcsCommit"></a> |
| 597 <h4>VersionControl.vcsCommit</h4> | 597 <h4>VersionControl.vcsCommit</h4> |
| 598 <b>vcsCommit</b>(<i>name, message, noDialog = False</i>) | 598 <b>vcsCommit</b>(<i>name, message, noDialog=False</i>) |
| 599 <p> | 599 <p> |
| 600 Public method used to make the change of a file/directory permanent in the vcs. | 600 Public method used to make the change of a file/directory permanent in the vcs. |
| 601 </p><p> | 601 </p><p> |
| 602 It must return a boolean to indicate an execution without errors. | 602 It must return a boolean to indicate an execution without errors. |
| 603 </p><dl> | 603 </p><dl> |
| 723 <dd> | 723 <dd> |
| 724 a dictionary of vcs specific data | 724 a dictionary of vcs specific data |
| 725 </dd> | 725 </dd> |
| 726 </dl><a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> | 726 </dl><a NAME="VersionControl.vcsGetProjectBrowserHelper" ID="VersionControl.vcsGetProjectBrowserHelper"></a> |
| 727 <h4>VersionControl.vcsGetProjectBrowserHelper</h4> | 727 <h4>VersionControl.vcsGetProjectBrowserHelper</h4> |
| 728 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser = False</i>) | 728 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) |
| 729 <p> | 729 <p> |
| 730 Public method to instanciate a helper object for the different project browsers. | 730 Public method to instanciate a helper object for the different project browsers. |
| 731 </p><dl> | 731 </p><dl> |
| 732 <dt><i>browser</i></dt> | 732 <dt><i>browser</i></dt> |
| 733 <dd> | 733 <dd> |
| 777 <dd> | 777 <dd> |
| 778 not implemented | 778 not implemented |
| 779 </dd> | 779 </dd> |
| 780 </dl><a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a> | 780 </dl><a NAME="VersionControl.vcsImport" ID="VersionControl.vcsImport"></a> |
| 781 <h4>VersionControl.vcsImport</h4> | 781 <h4>VersionControl.vcsImport</h4> |
| 782 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog = False</i>) | 782 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False</i>) |
| 783 <p> | 783 <p> |
| 784 Public method used to import the project into the vcs. | 784 Public method used to import the project into the vcs. |
| 785 </p><dl> | 785 </p><dl> |
| 786 <dt><i>vcsDataDict</i></dt> | 786 <dt><i>vcsDataDict</i></dt> |
| 787 <dd> | 787 <dd> |
| 804 <dd> | 804 <dd> |
| 805 not implemented | 805 not implemented |
| 806 </dd> | 806 </dd> |
| 807 </dl><a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a> | 807 </dl><a NAME="VersionControl.vcsInit" ID="VersionControl.vcsInit"></a> |
| 808 <h4>VersionControl.vcsInit</h4> | 808 <h4>VersionControl.vcsInit</h4> |
| 809 <b>vcsInit</b>(<i>vcsDir, noDialog = False</i>) | 809 <b>vcsInit</b>(<i>vcsDir, noDialog=False</i>) |
| 810 <p> | 810 <p> |
| 811 Public method used to initialize the vcs. | 811 Public method used to initialize the vcs. |
| 812 </p><p> | 812 </p><p> |
| 813 It must return a boolean to indicate an execution without errors. | 813 It must return a boolean to indicate an execution without errors. |
| 814 </p><dl> | 814 </p><dl> |
| 858 <dd> | 858 <dd> |
| 859 not implemented | 859 not implemented |
| 860 </dd> | 860 </dd> |
| 861 </dl><a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a> | 861 </dl><a NAME="VersionControl.vcsMove" ID="VersionControl.vcsMove"></a> |
| 862 <h4>VersionControl.vcsMove</h4> | 862 <h4>VersionControl.vcsMove</h4> |
| 863 <b>vcsMove</b>(<i>name, project, target = None, noDialog = False</i>) | 863 <b>vcsMove</b>(<i>name, project, target=None, noDialog=False</i>) |
| 864 <p> | 864 <p> |
| 865 Public method used to move a file/directory. | 865 Public method used to move a file/directory. |
| 866 </p><dl> | 866 </p><dl> |
| 867 <dt><i>name</i></dt> | 867 <dt><i>name</i></dt> |
| 868 <dd> | 868 <dd> |
| 902 <dd> | 902 <dd> |
| 903 not implemented | 903 not implemented |
| 904 </dd> | 904 </dd> |
| 905 </dl><a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a> | 905 </dl><a NAME="VersionControl.vcsNewProjectOptionsDialog" ID="VersionControl.vcsNewProjectOptionsDialog"></a> |
| 906 <h4>VersionControl.vcsNewProjectOptionsDialog</h4> | 906 <h4>VersionControl.vcsNewProjectOptionsDialog</h4> |
| 907 <b>vcsNewProjectOptionsDialog</b>(<i>parent = None</i>) | 907 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>) |
| 908 <p> | 908 <p> |
| 909 Public method to get a dialog to enter repository info for getting a new project. | 909 Public method to get a dialog to enter repository info for getting a new project. |
| 910 </p><dl> | 910 </p><dl> |
| 911 <dt><i>parent</i></dt> | 911 <dt><i>parent</i></dt> |
| 912 <dd> | 912 <dd> |
| 913 parent widget (QWidget) | 913 parent widget (QWidget) |
| 914 </dd> | 914 </dd> |
| 915 </dl><a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a> | 915 </dl><a NAME="VersionControl.vcsOptionsDialog" ID="VersionControl.vcsOptionsDialog"></a> |
| 916 <h4>VersionControl.vcsOptionsDialog</h4> | 916 <h4>VersionControl.vcsOptionsDialog</h4> |
| 917 <b>vcsOptionsDialog</b>(<i>project, archive, editable = False, parent = None</i>) | 917 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>) |
| 918 <p> | 918 <p> |
| 919 Public method to get a dialog to enter repository info. | 919 Public method to get a dialog to enter repository info. |
| 920 </p><dl> | 920 </p><dl> |
| 921 <dt><i>project</i></dt> | 921 <dt><i>project</i></dt> |
| 922 <dd> | 922 <dd> |
| 952 <dd> | 952 <dd> |
| 953 not implemented | 953 not implemented |
| 954 </dd> | 954 </dd> |
| 955 </dl><a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a> | 955 </dl><a NAME="VersionControl.vcsRemove" ID="VersionControl.vcsRemove"></a> |
| 956 <h4>VersionControl.vcsRemove</h4> | 956 <h4>VersionControl.vcsRemove</h4> |
| 957 <b>vcsRemove</b>(<i>name, project = False, noDialog = False</i>) | 957 <b>vcsRemove</b>(<i>name, project=False, noDialog=False</i>) |
| 958 <p> | 958 <p> |
| 959 Public method used to add a file/directory in the vcs. | 959 Public method used to add a file/directory in the vcs. |
| 960 </p><p> | 960 </p><p> |
| 961 It must return a flag indicating successfull operation | 961 It must return a flag indicating successfull operation |
| 962 </p><dl> | 962 </p><dl> |
| 1107 <dd> | 1107 <dd> |
| 1108 not implemented | 1108 not implemented |
| 1109 </dd> | 1109 </dd> |
| 1110 </dl><a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a> | 1110 </dl><a NAME="VersionControl.vcsUpdate" ID="VersionControl.vcsUpdate"></a> |
| 1111 <h4>VersionControl.vcsUpdate</h4> | 1111 <h4>VersionControl.vcsUpdate</h4> |
| 1112 <b>vcsUpdate</b>(<i>name, noDialog = False</i>) | 1112 <b>vcsUpdate</b>(<i>name, noDialog=False</i>) |
| 1113 <p> | 1113 <p> |
| 1114 Public method used to update a file/directory in the vcs. | 1114 Public method used to update a file/directory in the vcs. |
| 1115 </p><p> | 1115 </p><p> |
| 1116 It must not return anything. | 1116 It must not return anything. |
| 1117 </p><dl> | 1117 </p><dl> |
