Documentation/Source/eric6.VCS.StatusMonitorThread.html

changeset 6529
1c2968f124b7
parent 3673
e26d7d0c1088
--- a/Documentation/Source/eric6.VCS.StatusMonitorThread.html	Wed Oct 03 14:31:58 2018 +0200
+++ b/Documentation/Source/eric6.VCS.StatusMonitorThread.html	Wed Oct 03 17:33:40 2018 +0200
@@ -48,6 +48,10 @@
 <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
@@ -70,6 +74,9 @@
 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td>
 <td>Constructor</td>
 </tr><tr>
+<td><a href="#VcsStatusMonitorThread._getInfo">_getInfo</a></td>
+<td>Protected method implementing the real info action.</td>
+</tr><tr>
 <td><a href="#VcsStatusMonitorThread._performMonitor">_performMonitor</a></td>
 <td>Protected method implementing the real monitoring action.</td>
 </tr><tr>
@@ -124,6 +131,24 @@
 <dd>
 reference to the parent object (QObject)
 </dd>
+</dl><a NAME="VcsStatusMonitorThread._getInfo" ID="VcsStatusMonitorThread._getInfo"></a>
+<h4>VcsStatusMonitorThread._getInfo</h4>
+<b>_getInfo</b>(<i></i>)
+<p>
+        Protected method implementing the real info action.
+</p><p>
+        This method should be overridden and create a short info message to be
+        shown in the main window status bar right next to the status indicator.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+short info message
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
 </dl><a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a>
 <h4>VcsStatusMonitorThread._performMonitor</h4>
 <b>_performMonitor</b>(<i></i>)

eric ide

mercurial