Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html

changeset 178
dd9f0bca5e2f
child 217
8ce554fb0bee
diff -r c822ccc4d138 -r dd9f0bca5e2f Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html	Mon Apr 12 18:00:42 2010 +0000
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.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 />
+<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>Methods</h3>
+<table>
+<tr>
+<td><a href="#HgStatusMonitorThread.__init__">HgStatusMonitorThread</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#HgStatusMonitorThread._performMonitor">_performMonitor</a></td>
+<td>Protected method implementing the monitoring action.</td>
+</tr>
+</table>
+<a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a>
+<h4>HgStatusMonitorThread (Constructor)</h4>
+<b>HgStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>interval</i></dt>
+<dd>
+new interval in seconds (integer)
+</dd><dt><i>projectDir</i></dt>
+<dd>
+project directory to monitor (string)
+</dd><dt><i>vcs</i></dt>
+<dd>
+reference to the version control object
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</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>
+        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.
+        The allowed status flags are:
+        <ul>
+            <li>"A" path was added but not yet comitted</li>
+            <li>"M" path has local changes</li>
+            <li>"R" path was deleted and then re-added</li>
+            <li>"U" path needs an update</li>
+            <li>"Z" path contains a conflict</li>
+            <li>" " path is back at normal</li>
+        </ul>
+</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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial