--- a/src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VCS.StatusMonitorThread</h1>
-
<p>
Module implementing the VCS status monitor thread base class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VcsStatusMonitorThread">VcsStatusMonitorThread</a></td>
<td>Class implementing the VCS status monitor thread base class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VcsStatusMonitorThread" ID="VcsStatusMonitorThread"></a>
<h2>VcsStatusMonitorThread</h2>
-
<p>
Class implementing the VCS status monitor thread base class.
</p>
+
<h3>Signals</h3>
<dl>
@@ -64,19 +63,17 @@
<h3>Derived from</h3>
QThread
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td>
<td>Constructor</td>
@@ -126,19 +123,20 @@
<td>Public method to stop the monitor thread.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a>
<h4>VcsStatusMonitorThread (Constructor)</h4>
<b>VcsStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>interval</i> (int)</dt>
@@ -161,7 +159,6 @@
<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>
@@ -169,6 +166,7 @@
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>Return:</dt>
<dd>
@@ -184,7 +182,6 @@
<a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a>
<h4>VcsStatusMonitorThread._performMonitor</h4>
<b>_performMonitor</b>(<i></i>)
-
<p>
Protected method implementing the real monitoring action.
</p>
@@ -205,6 +202,7 @@
<li>" " path is back at normal</li>
</ul>
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -229,27 +227,27 @@
<a NAME="VcsStatusMonitorThread._shutdown" ID="VcsStatusMonitorThread._shutdown"></a>
<h4>VcsStatusMonitorThread._shutdown</h4>
<b>_shutdown</b>(<i></i>)
-
<p>
Protected method performing shutdown actions.
</p>
<p>
The default implementation does nothing.
</p>
+
<a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a>
<h4>VcsStatusMonitorThread.checkStatus</h4>
<b>checkStatus</b>(<i></i>)
-
<p>
Public method to wake up the status monitor thread.
</p>
+
<a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a>
<h4>VcsStatusMonitorThread.clearCachedState</h4>
<b>clearCachedState</b>(<i>name</i>)
-
<p>
Public method to clear the cached VCS state of a file/directory.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -260,10 +258,10 @@
<a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a>
<h4>VcsStatusMonitorThread.getAutoUpdate</h4>
<b>getAutoUpdate</b>(<i></i>)
-
<p>
Public method to retrieve the status of the auto update function.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -279,10 +277,10 @@
<a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a>
<h4>VcsStatusMonitorThread.getInterval</h4>
<b>getInterval</b>(<i></i>)
-
<p>
Public method to get the monitor interval.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -298,17 +296,17 @@
<a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a>
<h4>VcsStatusMonitorThread.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method implementing the tasks action.
</p>
+
<a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a>
<h4>VcsStatusMonitorThread.setAutoUpdate</h4>
<b>setAutoUpdate</b>(<i>auto</i>)
-
<p>
Public method to enable the auto update function.
</p>
+
<dl>
<dt><i>auto</i> (bool)</dt>
@@ -319,10 +317,10 @@
<a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a>
<h4>VcsStatusMonitorThread.setInterval</h4>
<b>setInterval</b>(<i>interval</i>)
-
<p>
Public method to change the monitor interval.
</p>
+
<dl>
<dt><i>interval</i> (int)</dt>
@@ -333,10 +331,10 @@
<a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a>
<h4>VcsStatusMonitorThread.stop</h4>
<b>stop</b>(<i></i>)
-
<p>
Public method to stop the monitor thread.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
