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

branch
eric7
changeset 8623
fced5aa98d41
parent 8596
d64760b2da50
child 8652
8cacde11f4fd
diff -r 149d51870ce8 -r fced5aa98d41 eric7/Documentation/Source/eric7.VCS.VersionControl.html
--- a/eric7/Documentation/Source/eric7.VCS.VersionControl.html	Wed Sep 22 18:20:06 2021 +0200
+++ b/eric7/Documentation/Source/eric7.VCS.VersionControl.html	Wed Sep 22 19:52:28 2021 +0200
@@ -47,11 +47,20 @@
 <h3>Signals</h3>
 <dl>
 
+<dt>committed()</dt>
+<dd>
+emitted after the commit action has completed
+</dd>
 <dt>vcsStatusChanged()</dt>
 <dd>
 emitted to indicate a change of the overall
         VCS status
 </dd>
+<dt>vcsStatusMonitorAllData(dict)</dt>
+<dd>
+emitted to signal all VCS status
+        (key is project relative file name, value is status)
+</dd>
 <dt>vcsStatusMonitorData(list of str)</dt>
 <dd>
 emitted to update the VCS status
@@ -88,8 +97,12 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#VersionControl.__statusMonitorAllData">__statusMonitorAllData</a></td>
+<td>Private method to receive all status monitor data.</td>
+</tr>
+<tr>
 <td><a href="#VersionControl.__statusMonitorData">__statusMonitorData</a></td>
-<td>Private method to receive the status monitor status.</td>
+<td>Private method to receive the status monitor data update.</td>
 </tr>
 <tr>
 <td><a href="#VersionControl.__statusMonitorInfo">__statusMonitorInfo</a></td>
@@ -204,6 +217,10 @@
 <td>Public method used to export a directory from the vcs.</td>
 </tr>
 <tr>
+<td><a href="#VersionControl.vcsForget">vcsForget</a></td>
+<td>Public method used to remove a file from the repository.</td>
+</tr>
+<tr>
 <td><a href="#VersionControl.vcsGetOptions">vcsGetOptions</a></td>
 <td>Public method used to retrieve the options of the vcs.</td>
 </tr>
@@ -268,10 +285,18 @@
 <td>Public method to retrieve information about the repository.</td>
 </tr>
 <tr>
+<td><a href="#VersionControl.vcsResolved">vcsResolved</a></td>
+<td>Public method used to resolve conflicts of a file/directory.</td>
+</tr>
+<tr>
 <td><a href="#VersionControl.vcsRevert">vcsRevert</a></td>
 <td>Public method used to revert changes made to a file/directory.</td>
 </tr>
 <tr>
+<td><a href="#VersionControl.vcsSbsDiff">vcsSbsDiff</a></td>
+<td>Public method used to view the difference of a file to the Mercurial repository side-by-side.</td>
+</tr>
+<tr>
 <td><a href="#VersionControl.vcsSetData">vcsSetData</a></td>
 <td>Public method used to set an entry in the otherData dictionary.</td>
 </tr>
@@ -336,12 +361,29 @@
 name of this object (string)
 </dd>
 </dl>
+<a NAME="VersionControl.__statusMonitorAllData" ID="VersionControl.__statusMonitorAllData"></a>
+<h4>VersionControl.__statusMonitorAllData</h4>
+<b>__statusMonitorAllData</b>(<i>statusDict</i>)
+
+<p>
+        Private method to receive all status monitor data.
+</p>
+<p>
+        It simply re-emits the received status list.
+</p>
+<dl>
+
+<dt><i>statusDict</i> (dict)</dt>
+<dd>
+dictionary of status records
+</dd>
+</dl>
 <a NAME="VersionControl.__statusMonitorData" ID="VersionControl.__statusMonitorData"></a>
 <h4>VersionControl.__statusMonitorData</h4>
 <b>__statusMonitorData</b>(<i>statusList</i>)
 
 <p>
-        Private method to receive the status monitor status.
+        Private method to receive the status monitor data update.
 </p>
 <p>
         It simply re-emits the received status list.
@@ -966,6 +1008,28 @@
             implemented by a subclass
 </dd>
 </dl>
+<a NAME="VersionControl.vcsForget" ID="VersionControl.vcsForget"></a>
+<h4>VersionControl.vcsForget</h4>
+<b>vcsForget</b>(<i>name</i>)
+
+<p>
+        Public method used to remove a file from the repository.
+</p>
+<dl>
+
+<dt><i>name</i> (str or list of str)</dt>
+<dd>
+file/directory name to be removed
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+to indicate that this method must be
+            implemented by a subclass
+</dd>
+</dl>
 <a NAME="VersionControl.vcsGetOptions" ID="VersionControl.vcsGetOptions"></a>
 <h4>VersionControl.vcsGetOptions</h4>
 <b>vcsGetOptions</b>(<i></i>)
@@ -1418,6 +1482,20 @@
             implemented by a subclass
 </dd>
 </dl>
+<a NAME="VersionControl.vcsResolved" ID="VersionControl.vcsResolved"></a>
+<h4>VersionControl.vcsResolved</h4>
+<b>vcsResolved</b>(<i>name</i>)
+
+<p>
+        Public method used to resolve conflicts of a file/directory.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be resolved
+</dd>
+</dl>
 <a NAME="VersionControl.vcsRevert" ID="VersionControl.vcsRevert"></a>
 <h4>VersionControl.vcsRevert</h4>
 <b>vcsRevert</b>(<i>name</i>)
@@ -1427,9 +1505,53 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
+<dd>
+file/directory name to be reverted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating, that the update contained an add
+            or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
 <dd>
-file/directory name to be reverted (string)
+to indicate that this method must be
+            implemented by a subclass
+</dd>
+</dl>
+<a NAME="VersionControl.vcsSbsDiff" ID="VersionControl.vcsSbsDiff"></a>
+<h4>VersionControl.vcsSbsDiff</h4>
+<b>vcsSbsDiff</b>(<i>name, extended=False, revisions=None</i>)
+
+<p>
+        Public method used to view the difference of a file to the Mercurial
+        repository side-by-side.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+file name to be diffed
+</dd>
+<dt><i>extended</i> (bool)</dt>
+<dd>
+flag indicating the extended variant
+</dd>
+<dt><i>revisions</i> (tuple of two str)</dt>
+<dd>
+tuple of two revisions
 </dd>
 </dl>
 <dl>

eric ide

mercurial