Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
- changeset 178
- dd9f0bca5e2f
- child 217
- 8ce554fb0bee
equal
deleted
inserted
replaced
| 177:c822ccc4d138 | 178:dd9f0bca5e2f |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</h1> | |
| 24 <p> | |
| 25 Module implementing the VCS status monitor thread class for Mercurial. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HgStatusMonitorThread">HgStatusMonitorThread</a></td> | |
| 35 <td>Class implementing the VCS status monitor thread class for Mercurial.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HgStatusMonitorThread" ID="HgStatusMonitorThread"></a> | |
| 44 <h2>HgStatusMonitorThread</h2> | |
| 45 <p> | |
| 46 Class implementing the VCS status monitor thread class for Mercurial. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 VcsStatusMonitorThread | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#HgStatusMonitorThread.__init__">HgStatusMonitorThread</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#HgStatusMonitorThread._performMonitor">_performMonitor</a></td> | |
| 61 <td>Protected method implementing the monitoring action.</td> | |
| 62 </tr> | |
| 63 </table> | |
| 64 <a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a> | |
| 65 <h4>HgStatusMonitorThread (Constructor)</h4> | |
| 66 <b>HgStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>) | |
| 67 <p> | |
| 68 Constructor | |
| 69 </p><dl> | |
| 70 <dt><i>interval</i></dt> | |
| 71 <dd> | |
| 72 new interval in seconds (integer) | |
| 73 </dd><dt><i>projectDir</i></dt> | |
| 74 <dd> | |
| 75 project directory to monitor (string) | |
| 76 </dd><dt><i>vcs</i></dt> | |
| 77 <dd> | |
| 78 reference to the version control object | |
| 79 </dd><dt><i>parent</i></dt> | |
| 80 <dd> | |
| 81 reference to the parent object (QObject) | |
| 82 </dd> | |
| 83 </dl><a NAME="HgStatusMonitorThread._performMonitor" ID="HgStatusMonitorThread._performMonitor"></a> | |
| 84 <h4>HgStatusMonitorThread._performMonitor</h4> | |
| 85 <b>_performMonitor</b>(<i></i>) | |
| 86 <p> | |
| 87 Protected method implementing the monitoring action. | |
| 88 </p><p> | |
| 89 This method populates the statusList member variable | |
| 90 with a list of strings giving the status in the first column and the | |
| 91 path relative to the project directory starting with the third column. | |
| 92 The allowed status flags are: | |
| 93 <ul> | |
| 94 <li>"A" path was added but not yet comitted</li> | |
| 95 <li>"M" path has local changes</li> | |
| 96 <li>"R" path was deleted and then re-added</li> | |
| 97 <li>"U" path needs an update</li> | |
| 98 <li>"Z" path contains a conflict</li> | |
| 99 <li>" " path is back at normal</li> | |
| 100 </ul> | |
| 101 </p><dl> | |
| 102 <dt>Returns:</dt> | |
| 103 <dd> | |
| 104 tuple of flag indicating successful operation (boolean) and | |
| 105 a status message in case of non successful operation (string) | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <div align="right"><a href="#top">Up</a></div> | |
| 109 <hr /> | |
| 110 </body></html> |
