Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the VCS status monitor thread class for Mercurial. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#HgStatusMonitorThread">HgStatusMonitorThread</a></td> | |
| 39 <td>Class implementing the VCS status monitor thread class for Mercurial.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="HgStatusMonitorThread" ID="HgStatusMonitorThread"></a> | |
| 50 <h2>HgStatusMonitorThread</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the VCS status monitor thread class for Mercurial. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 VcsStatusMonitorThread | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#HgStatusMonitorThread.__init__">HgStatusMonitorThread</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#HgStatusMonitorThread.__initClient">__initClient</a></td> | |
| 77 <td>Private method to initialize the Mercurial client.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#HgStatusMonitorThread._getInfo">_getInfo</a></td> | |
| 81 <td>Protected method implementing the real info action.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#HgStatusMonitorThread._performMonitor">_performMonitor</a></td> | |
| 85 <td>Protected method implementing the monitoring action.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#HgStatusMonitorThread._shutdown">_shutdown</a></td> | |
| 89 <td>Protected method performing shutdown actions.</td> | |
| 90 </tr> | |
| 91 </table> | |
| 92 <h3>Static Methods</h3> | |
| 93 | |
| 94 <table> | |
| 95 <tr><td>None</td></tr> | |
| 96 </table> | |
| 97 | |
| 98 <a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a> | |
| 99 <h4>HgStatusMonitorThread (Constructor)</h4> | |
| 100 <b>HgStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) | |
| 101 | |
| 102 <p> | |
| 103 Constructor | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>interval</i></dt> | |
| 108 <dd> | |
| 109 new interval in seconds (integer) | |
| 110 </dd> | |
| 111 <dt><i>project</i></dt> | |
| 112 <dd> | |
| 113 reference to the project object (Project) | |
| 114 </dd> | |
| 115 <dt><i>vcs</i></dt> | |
| 116 <dd> | |
| 117 reference to the version control object | |
| 118 </dd> | |
| 119 <dt><i>parent</i></dt> | |
| 120 <dd> | |
| 121 reference to the parent object (QObject) | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="HgStatusMonitorThread.__initClient" ID="HgStatusMonitorThread.__initClient"></a> | |
| 125 <h4>HgStatusMonitorThread.__initClient</h4> | |
| 126 <b>__initClient</b>(<i></i>) | |
| 127 | |
| 128 <p> | |
| 129 Private method to initialize the Mercurial client. | |
| 130 </p> | |
| 131 <dl> | |
| 132 <dt>Return:</dt> | |
| 133 <dd> | |
| 134 tuple containing an OK flag and potentially an error message | |
| 135 </dd> | |
| 136 </dl> | |
| 137 <dl> | |
| 138 <dt>Return Type:</dt> | |
| 139 <dd> | |
| 140 tuple of (bool, str) | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="HgStatusMonitorThread._getInfo" ID="HgStatusMonitorThread._getInfo"></a> | |
| 144 <h4>HgStatusMonitorThread._getInfo</h4> | |
| 145 <b>_getInfo</b>(<i></i>) | |
| 146 | |
| 147 <p> | |
| 148 Protected method implementing the real info action. | |
| 149 </p> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 short info message | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return Type:</dt> | |
| 158 <dd> | |
| 159 str | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="HgStatusMonitorThread._performMonitor" ID="HgStatusMonitorThread._performMonitor"></a> | |
| 163 <h4>HgStatusMonitorThread._performMonitor</h4> | |
| 164 <b>_performMonitor</b>(<i></i>) | |
| 165 | |
| 166 <p> | |
| 167 Protected method implementing the monitoring action. | |
| 168 </p> | |
| 169 <p> | |
| 170 This method populates the statusList member variable with a list of | |
| 171 strings giving the status in the first column and the path relative | |
| 172 to the project directory starting with the third column. The allowed | |
| 173 status flags are: | |
| 174 <ul> | |
| 175 <li>"A" path was added but not yet comitted</li> | |
| 176 <li>"M" path has local changes</li> | |
| 177 <li>"O" path was removed</li> | |
| 178 <li>"R" path was deleted and then re-added</li> | |
| 179 <li>"U" path needs an update</li> | |
| 180 <li>"Z" path contains a conflict</li> | |
| 181 <li>" " path is back at normal</li> | |
| 182 </ul> | |
| 183 </p> | |
| 184 <dl> | |
| 185 <dt>Return:</dt> | |
| 186 <dd> | |
| 187 tuple of flag indicating successful operation and a status | |
| 188 message in case of non successful operation | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <dl> | |
| 192 <dt>Return Type:</dt> | |
| 193 <dd> | |
| 194 tuple of (bool, str) | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="HgStatusMonitorThread._shutdown" ID="HgStatusMonitorThread._shutdown"></a> | |
| 198 <h4>HgStatusMonitorThread._shutdown</h4> | |
| 199 <b>_shutdown</b>(<i></i>) | |
| 200 | |
| 201 <p> | |
| 202 Protected method performing shutdown actions. | |
| 203 </p> | |
| 204 <div align="right"><a href="#top">Up</a></div> | |
| 205 <hr /> | |
| 206 </body></html> |
