diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html Wed Sep 25 19:42:44 2019 +0200
@@ -18,113 +18,147 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</h1>
+
<p>
Module implementing the VCS status monitor thread class for Mercurial.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#HgStatusMonitorThread">HgStatusMonitorThread</a></td>
<td>Class implementing the VCS status monitor thread class for Mercurial.</td>
</tr>
</table>
<h3>Functions</h3>
+
<table>
<tr><td>None</td></tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="HgStatusMonitorThread" ID="HgStatusMonitorThread"></a>
<h2>HgStatusMonitorThread</h2>
+
<p>
Class implementing the VCS status monitor thread class for Mercurial.
</p>
<h3>Derived from</h3>
VcsStatusMonitorThread
<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="#HgStatusMonitorThread.__init__">HgStatusMonitorThread</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#HgStatusMonitorThread.__initClient">__initClient</a></td>
<td>Private method to initialize the Mercurial client.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#HgStatusMonitorThread._getInfo">_getInfo</a></td>
<td>Protected method implementing the real info action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#HgStatusMonitorThread._performMonitor">_performMonitor</a></td>
<td>Protected method implementing the monitoring action.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#HgStatusMonitorThread._shutdown">_shutdown</a></td>
<td>Protected method performing shutdown actions.</td>
</tr>
</table>
<h3>Static Methods</h3>
+
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a>
<h4>HgStatusMonitorThread (Constructor)</h4>
<b>HgStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>)
+
<p>
Constructor
-</p><dl>
+</p>
+<dl>
+
<dt><i>interval</i></dt>
<dd>
new interval in seconds (integer)
-</dd><dt><i>project</i></dt>
+</dd>
+<dt><i>project</i></dt>
<dd>
reference to the project object (Project)
-</dd><dt><i>vcs</i></dt>
+</dd>
+<dt><i>vcs</i></dt>
<dd>
reference to the version control object
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
-</dl><a NAME="HgStatusMonitorThread.__initClient" ID="HgStatusMonitorThread.__initClient"></a>
+</dl>
+<a NAME="HgStatusMonitorThread.__initClient" ID="HgStatusMonitorThread.__initClient"></a>
<h4>HgStatusMonitorThread.__initClient</h4>
<b>__initClient</b>(<i></i>)
+
<p>
Private method to initialize the Mercurial client.
-</p><a NAME="HgStatusMonitorThread._getInfo" ID="HgStatusMonitorThread._getInfo"></a>
+</p>
+<a NAME="HgStatusMonitorThread._getInfo" ID="HgStatusMonitorThread._getInfo"></a>
<h4>HgStatusMonitorThread._getInfo</h4>
<b>_getInfo</b>(<i></i>)
+
<p>
Protected method implementing the real info action.
-</p><p>
+</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>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
short info message
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
-</dl><a NAME="HgStatusMonitorThread._performMonitor" ID="HgStatusMonitorThread._performMonitor"></a>
+</dl>
+<a NAME="HgStatusMonitorThread._performMonitor" ID="HgStatusMonitorThread._performMonitor"></a>
<h4>HgStatusMonitorThread._performMonitor</h4>
<b>_performMonitor</b>(<i></i>)
+
<p>
Protected method implementing the monitoring action.
-</p><p>
+</p>
+<p>
This method populates the statusList member variable
with a list of strings giving the status in the first column and the
path relative to the project directory starting with the third column.
@@ -138,15 +172,18 @@
<li>"Z" path contains a conflict</li>
<li>" " path is back at normal</li>
</ul>
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
tuple of flag indicating successful operation (boolean) and
a status message in case of non successful operation (string)
</dd>
-</dl><a NAME="HgStatusMonitorThread._shutdown" ID="HgStatusMonitorThread._shutdown"></a>
+</dl>
+<a NAME="HgStatusMonitorThread._shutdown" ID="HgStatusMonitorThread._shutdown"></a>
<h4>HgStatusMonitorThread._shutdown</h4>
<b>_shutdown</b>(<i></i>)
+
<p>
Protected method performing shutdown actions.
</p>
