Documentation/Source/eric6.VCS.VersionControl.html

changeset 6529
1c2968f124b7
parent 5606
da305d172769
--- a/Documentation/Source/eric6.VCS.VersionControl.html	Wed Oct 03 14:31:58 2018 +0200
+++ b/Documentation/Source/eric6.VCS.VersionControl.html	Wed Oct 03 17:33:40 2018 +0200
@@ -57,6 +57,10 @@
 </dd><dt>vcsStatusMonitorData(list of str)</dt>
 <dd>
 emitted to update the VCS status
+</dd><dt>vcsStatusMonitorInfo(str)</dt>
+<dd>
+emitted to signal some info of the
+        monitoring thread
 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
 <dd>
 emitted to signal the status of
@@ -82,8 +86,11 @@
 <td><a href="#VersionControl.__statusMonitorData">__statusMonitorData</a></td>
 <td>Private method to receive the status monitor status.</td>
 </tr><tr>
+<td><a href="#VersionControl.__statusMonitorInfo">__statusMonitorInfo</a></td>
+<td>Private slot to receive the status monitor info message.</td>
+</tr><tr>
 <td><a href="#VersionControl.__statusMonitorStatus">__statusMonitorStatus</a></td>
-<td>Private method to receive the status monitor status.</td>
+<td>Private slot to receive the status monitor status.</td>
 </tr><tr>
 <td><a href="#VersionControl._createStatusMonitorThread">_createStatusMonitorThread</a></td>
 <td>Protected method to create an instance of the VCS status monitor thread.</td>
@@ -268,26 +275,38 @@
 <p>
         Private method to receive the status monitor status.
 </p><p>
-        It simply reemits the received status list.
+        It simply re-emits the received status list.
 </p><dl>
-<dt><i>statusList</i></dt>
+<dt><i>statusList</i> (list of str)</dt>
 <dd>
-list of status records (list of strings)
+list of status records
+</dd>
+</dl><a NAME="VersionControl.__statusMonitorInfo" ID="VersionControl.__statusMonitorInfo"></a>
+<h4>VersionControl.__statusMonitorInfo</h4>
+<b>__statusMonitorInfo</b>(<i>info</i>)
+<p>
+        Private slot to receive the status monitor info message.
+</p><p>
+        It simply re-emits the received info message.
+</p><dl>
+<dt><i>info</i> (str)</dt>
+<dd>
+received info message
 </dd>
 </dl><a NAME="VersionControl.__statusMonitorStatus" ID="VersionControl.__statusMonitorStatus"></a>
 <h4>VersionControl.__statusMonitorStatus</h4>
 <b>__statusMonitorStatus</b>(<i>status, statusMsg</i>)
 <p>
-        Private method to receive the status monitor status.
+        Private slot to receive the status monitor status.
 </p><p>
-        It simply reemits the received status.
+        It simply re-emits the received status.
 </p><dl>
-<dt><i>status</i></dt>
+<dt><i>status</i> (str (one of ok, nok or off))</dt>
 <dd>
-status of the monitoring thread (string, ok, nok or off)
-</dd><dt><i>statusMsg</i></dt>
+status of the monitoring thread
+</dd><dt><i>statusMsg</i> (str)</dt>
 <dd>
-explanotory text for the signaled status (string)
+explanotory text for the signaled status
 </dd>
 </dl><a NAME="VersionControl._createStatusMonitorThread" ID="VersionControl._createStatusMonitorThread"></a>
 <h4>VersionControl._createStatusMonitorThread</h4>

eric ide

mercurial