Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.VCS.VersionControl.html
eric7/Documentation/Source/eric7.VCS.VersionControl.html
- branch
- eric7
- changeset 8623
- fced5aa98d41
- parent 8596
- d64760b2da50
- child 8652
- 8cacde11f4fd
equal
deleted
inserted
replaced
| 8622:149d51870ce8 | 8623:fced5aa98d41 |
|---|---|
| 45 and the common methods. | 45 and the common methods. |
| 46 </p> | 46 </p> |
| 47 <h3>Signals</h3> | 47 <h3>Signals</h3> |
| 48 <dl> | 48 <dl> |
| 49 | 49 |
| 50 <dt>committed()</dt> | |
| 51 <dd> | |
| 52 emitted after the commit action has completed | |
| 53 </dd> | |
| 50 <dt>vcsStatusChanged()</dt> | 54 <dt>vcsStatusChanged()</dt> |
| 51 <dd> | 55 <dd> |
| 52 emitted to indicate a change of the overall | 56 emitted to indicate a change of the overall |
| 53 VCS status | 57 VCS status |
| 58 </dd> | |
| 59 <dt>vcsStatusMonitorAllData(dict)</dt> | |
| 60 <dd> | |
| 61 emitted to signal all VCS status | |
| 62 (key is project relative file name, value is status) | |
| 54 </dd> | 63 </dd> |
| 55 <dt>vcsStatusMonitorData(list of str)</dt> | 64 <dt>vcsStatusMonitorData(list of str)</dt> |
| 56 <dd> | 65 <dd> |
| 57 emitted to update the VCS status | 66 emitted to update the VCS status |
| 58 </dd> | 67 </dd> |
| 86 <tr> | 95 <tr> |
| 87 <td><a href="#VersionControl.__init__">VersionControl</a></td> | 96 <td><a href="#VersionControl.__init__">VersionControl</a></td> |
| 88 <td>Constructor</td> | 97 <td>Constructor</td> |
| 89 </tr> | 98 </tr> |
| 90 <tr> | 99 <tr> |
| 100 <td><a href="#VersionControl.__statusMonitorAllData">__statusMonitorAllData</a></td> | |
| 101 <td>Private method to receive all status monitor data.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 91 <td><a href="#VersionControl.__statusMonitorData">__statusMonitorData</a></td> | 104 <td><a href="#VersionControl.__statusMonitorData">__statusMonitorData</a></td> |
| 92 <td>Private method to receive the status monitor status.</td> | 105 <td>Private method to receive the status monitor data update.</td> |
| 93 </tr> | 106 </tr> |
| 94 <tr> | 107 <tr> |
| 95 <td><a href="#VersionControl.__statusMonitorInfo">__statusMonitorInfo</a></td> | 108 <td><a href="#VersionControl.__statusMonitorInfo">__statusMonitorInfo</a></td> |
| 96 <td>Private slot to receive the status monitor info message.</td> | 109 <td>Private slot to receive the status monitor info message.</td> |
| 97 </tr> | 110 </tr> |
| 202 <tr> | 215 <tr> |
| 203 <td><a href="#VersionControl.vcsExport">vcsExport</a></td> | 216 <td><a href="#VersionControl.vcsExport">vcsExport</a></td> |
| 204 <td>Public method used to export a directory from the vcs.</td> | 217 <td>Public method used to export a directory from the vcs.</td> |
| 205 </tr> | 218 </tr> |
| 206 <tr> | 219 <tr> |
| 220 <td><a href="#VersionControl.vcsForget">vcsForget</a></td> | |
| 221 <td>Public method used to remove a file from the repository.</td> | |
| 222 </tr> | |
| 223 <tr> | |
| 207 <td><a href="#VersionControl.vcsGetOptions">vcsGetOptions</a></td> | 224 <td><a href="#VersionControl.vcsGetOptions">vcsGetOptions</a></td> |
| 208 <td>Public method used to retrieve the options of the vcs.</td> | 225 <td>Public method used to retrieve the options of the vcs.</td> |
| 209 </tr> | 226 </tr> |
| 210 <tr> | 227 <tr> |
| 211 <td><a href="#VersionControl.vcsGetOtherData">vcsGetOtherData</a></td> | 228 <td><a href="#VersionControl.vcsGetOtherData">vcsGetOtherData</a></td> |
| 266 <tr> | 283 <tr> |
| 267 <td><a href="#VersionControl.vcsRepositoryInfos">vcsRepositoryInfos</a></td> | 284 <td><a href="#VersionControl.vcsRepositoryInfos">vcsRepositoryInfos</a></td> |
| 268 <td>Public method to retrieve information about the repository.</td> | 285 <td>Public method to retrieve information about the repository.</td> |
| 269 </tr> | 286 </tr> |
| 270 <tr> | 287 <tr> |
| 288 <td><a href="#VersionControl.vcsResolved">vcsResolved</a></td> | |
| 289 <td>Public method used to resolve conflicts of a file/directory.</td> | |
| 290 </tr> | |
| 291 <tr> | |
| 271 <td><a href="#VersionControl.vcsRevert">vcsRevert</a></td> | 292 <td><a href="#VersionControl.vcsRevert">vcsRevert</a></td> |
| 272 <td>Public method used to revert changes made to a file/directory.</td> | 293 <td>Public method used to revert changes made to a file/directory.</td> |
| 294 </tr> | |
| 295 <tr> | |
| 296 <td><a href="#VersionControl.vcsSbsDiff">vcsSbsDiff</a></td> | |
| 297 <td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td> | |
| 273 </tr> | 298 </tr> |
| 274 <tr> | 299 <tr> |
| 275 <td><a href="#VersionControl.vcsSetData">vcsSetData</a></td> | 300 <td><a href="#VersionControl.vcsSetData">vcsSetData</a></td> |
| 276 <td>Public method used to set an entry in the otherData dictionary.</td> | 301 <td>Public method used to set an entry in the otherData dictionary.</td> |
| 277 </tr> | 302 </tr> |
| 334 <dt><i>name</i></dt> | 359 <dt><i>name</i></dt> |
| 335 <dd> | 360 <dd> |
| 336 name of this object (string) | 361 name of this object (string) |
| 337 </dd> | 362 </dd> |
| 338 </dl> | 363 </dl> |
| 364 <a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a> | |
| 365 <h4>VersionControl.__statusMonitorAllData</h4> | |
| 366 <b>__statusMonitorAllData</b>(<i>statusDict</i>) | |
| 367 | |
| 368 <p> | |
| 369 Private method to receive all status monitor data. | |
| 370 </p> | |
| 371 <p> | |
| 372 It simply re-emits the received status list. | |
| 373 </p> | |
| 374 <dl> | |
| 375 | |
| 376 <dt><i>statusDict</i> (dict)</dt> | |
| 377 <dd> | |
| 378 dictionary of status records | |
| 379 </dd> | |
| 380 </dl> | |
| 339 <a NAME="VersionControl.__statusMonitorData" ID="VersionControl.__statusMonitorData"></a> | 381 <a NAME="VersionControl.__statusMonitorData" ID="VersionControl.__statusMonitorData"></a> |
| 340 <h4>VersionControl.__statusMonitorData</h4> | 382 <h4>VersionControl.__statusMonitorData</h4> |
| 341 <b>__statusMonitorData</b>(<i>statusList</i>) | 383 <b>__statusMonitorData</b>(<i>statusList</i>) |
| 342 | 384 |
| 343 <p> | 385 <p> |
| 344 Private method to receive the status monitor status. | 386 Private method to receive the status monitor data update. |
| 345 </p> | 387 </p> |
| 346 <p> | 388 <p> |
| 347 It simply re-emits the received status list. | 389 It simply re-emits the received status list. |
| 348 </p> | 390 </p> |
| 349 <dl> | 391 <dl> |
| 964 <dd> | 1006 <dd> |
| 965 to indicate that this method must be | 1007 to indicate that this method must be |
| 966 implemented by a subclass | 1008 implemented by a subclass |
| 967 </dd> | 1009 </dd> |
| 968 </dl> | 1010 </dl> |
| 1011 <a NAME="VersionControl.vcsForget" ID="VersionControl.vcsForget"></a> | |
| 1012 <h4>VersionControl.vcsForget</h4> | |
| 1013 <b>vcsForget</b>(<i>name</i>) | |
| 1014 | |
| 1015 <p> | |
| 1016 Public method used to remove a file from the repository. | |
| 1017 </p> | |
| 1018 <dl> | |
| 1019 | |
| 1020 <dt><i>name</i> (str or list of str)</dt> | |
| 1021 <dd> | |
| 1022 file/directory name to be removed | |
| 1023 </dd> | |
| 1024 </dl> | |
| 1025 <dl> | |
| 1026 | |
| 1027 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 1028 <dd> | |
| 1029 to indicate that this method must be | |
| 1030 implemented by a subclass | |
| 1031 </dd> | |
| 1032 </dl> | |
| 969 <a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a> | 1033 <a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a> |
| 970 <h4>VersionControl.vcsGetOptions</h4> | 1034 <h4>VersionControl.vcsGetOptions</h4> |
| 971 <b>vcsGetOptions</b>(<i></i>) | 1035 <b>vcsGetOptions</b>(<i></i>) |
| 972 | 1036 |
| 973 <p> | 1037 <p> |
| 1416 <dd> | 1480 <dd> |
| 1417 to indicate that this method must be | 1481 to indicate that this method must be |
| 1418 implemented by a subclass | 1482 implemented by a subclass |
| 1419 </dd> | 1483 </dd> |
| 1420 </dl> | 1484 </dl> |
| 1485 <a NAME="VersionControl.vcsResolved" ID="VersionControl.vcsResolved"></a> | |
| 1486 <h4>VersionControl.vcsResolved</h4> | |
| 1487 <b>vcsResolved</b>(<i>name</i>) | |
| 1488 | |
| 1489 <p> | |
| 1490 Public method used to resolve conflicts of a file/directory. | |
| 1491 </p> | |
| 1492 <dl> | |
| 1493 | |
| 1494 <dt><i>name</i> (str)</dt> | |
| 1495 <dd> | |
| 1496 file/directory name to be resolved | |
| 1497 </dd> | |
| 1498 </dl> | |
| 1421 <a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a> | 1499 <a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a> |
| 1422 <h4>VersionControl.vcsRevert</h4> | 1500 <h4>VersionControl.vcsRevert</h4> |
| 1423 <b>vcsRevert</b>(<i>name</i>) | 1501 <b>vcsRevert</b>(<i>name</i>) |
| 1424 | 1502 |
| 1425 <p> | 1503 <p> |
| 1426 Public method used to revert changes made to a file/directory. | 1504 Public method used to revert changes made to a file/directory. |
| 1427 </p> | 1505 </p> |
| 1428 <dl> | 1506 <dl> |
| 1429 | 1507 |
| 1430 <dt><i>name</i></dt> | 1508 <dt><i>name</i> (str)</dt> |
| 1431 <dd> | 1509 <dd> |
| 1432 file/directory name to be reverted (string) | 1510 file/directory name to be reverted |
| 1511 </dd> | |
| 1512 </dl> | |
| 1513 <dl> | |
| 1514 <dt>Return:</dt> | |
| 1515 <dd> | |
| 1516 flag indicating, that the update contained an add | |
| 1517 or delete | |
| 1518 </dd> | |
| 1519 </dl> | |
| 1520 <dl> | |
| 1521 <dt>Return Type:</dt> | |
| 1522 <dd> | |
| 1523 bool | |
| 1524 </dd> | |
| 1525 </dl> | |
| 1526 <dl> | |
| 1527 | |
| 1528 <dt>Raises <b>RuntimeError</b>:</dt> | |
| 1529 <dd> | |
| 1530 to indicate that this method must be | |
| 1531 implemented by a subclass | |
| 1532 </dd> | |
| 1533 </dl> | |
| 1534 <a NAME="VersionControl.vcsSbsDiff" ID="VersionControl.vcsSbsDiff"></a> | |
| 1535 <h4>VersionControl.vcsSbsDiff</h4> | |
| 1536 <b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>) | |
| 1537 | |
| 1538 <p> | |
| 1539 Public method used to view the difference of a file to the Mercurial | |
| 1540 repository side-by-side. | |
| 1541 </p> | |
| 1542 <dl> | |
| 1543 | |
| 1544 <dt><i>name</i> (str)</dt> | |
| 1545 <dd> | |
| 1546 file name to be diffed | |
| 1547 </dd> | |
| 1548 <dt><i>extended</i> (bool)</dt> | |
| 1549 <dd> | |
| 1550 flag indicating the extended variant | |
| 1551 </dd> | |
| 1552 <dt><i>revisions</i> (tuple of two str)</dt> | |
| 1553 <dd> | |
| 1554 tuple of two revisions | |
| 1433 </dd> | 1555 </dd> |
| 1434 </dl> | 1556 </dl> |
| 1435 <dl> | 1557 <dl> |
| 1436 | 1558 |
| 1437 <dt>Raises <b>RuntimeError</b>:</dt> | 1559 <dt>Raises <b>RuntimeError</b>:</dt> |
