Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.VCS.StatusMonitorThread.html
Documentation/Source/eric4.VCS.StatusMonitorThread.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 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>eric4.VCS.StatusMonitorThread</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>eric4.VCS.StatusMonitorThread</h1> | |
| 24 <p> | |
| 25 Module implementing the VCS status monitor thread base class. | |
| 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="#VcsStatusMonitorThread">VcsStatusMonitorThread</a></td> | |
| 35 <td>Class implementing the VCS status monitor thread base class.</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="VcsStatusMonitorThread" ID="VcsStatusMonitorThread"></a> | |
| 44 <h2>VcsStatusMonitorThread</h2> | |
| 45 <p> | |
| 46 Class implementing the VCS status monitor thread base class. | |
| 47 </p><h4>Signals</h4> | |
| 48 <dl> | |
| 49 <dt>vcsStatusMonitorData(QStringList)</dt> | |
| 50 <dd> | |
| 51 emitted to update the VCS status | |
| 52 </dd><dt>vcsStatusMonitorStatus(QString, QString)</dt> | |
| 53 <dd> | |
| 54 emitted to signal the status of the | |
| 55 monitoring thread (ok, nok, op) and a status message | |
| 56 </dd> | |
| 57 </dl> | |
| 58 <h3>Derived from</h3> | |
| 59 QThread | |
| 60 <h3>Class Attributes</h3> | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Methods</h3> | |
| 65 <table> | |
| 66 <tr> | |
| 67 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#VcsStatusMonitorThread._performMonitor">_performMonitor</a></td> | |
| 71 <td>Protected method implementing the real monitoring action.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#VcsStatusMonitorThread.checkStatus">checkStatus</a></td> | |
| 74 <td>Public method to wake up the status monitor thread.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#VcsStatusMonitorThread.clearCachedState">clearCachedState</a></td> | |
| 77 <td>Public method to clear the cached VCS state of a file/directory.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#VcsStatusMonitorThread.getAutoUpdate">getAutoUpdate</a></td> | |
| 80 <td>Public method to retrieve the status of the auto update function.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#VcsStatusMonitorThread.getInterval">getInterval</a></td> | |
| 83 <td>Public method to get the monitor interval.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#VcsStatusMonitorThread.run">run</a></td> | |
| 86 <td>Protected method implementing the tasks action.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#VcsStatusMonitorThread.setAutoUpdate">setAutoUpdate</a></td> | |
| 89 <td>Public method to enable the auto update function.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#VcsStatusMonitorThread.setInterval">setInterval</a></td> | |
| 92 <td>Public method to change the monitor interval.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#VcsStatusMonitorThread.stop">stop</a></td> | |
| 95 <td>Public method to stop the monitor thread.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a> | |
| 99 <h4>VcsStatusMonitorThread (Constructor)</h4> | |
| 100 <b>VcsStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>) | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p><dl> | |
| 104 <dt><i>interval</i></dt> | |
| 105 <dd> | |
| 106 new interval in seconds (integer) | |
| 107 </dd><dt><i>projectDir</i></dt> | |
| 108 <dd> | |
| 109 project directory to monitor (string) | |
| 110 </dd><dt><i>vcs</i></dt> | |
| 111 <dd> | |
| 112 reference to the version control object | |
| 113 </dd><dt><i>parent</i></dt> | |
| 114 <dd> | |
| 115 reference to the parent object (QObject) | |
| 116 </dd> | |
| 117 </dl><a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a> | |
| 118 <h4>VcsStatusMonitorThread._performMonitor</h4> | |
| 119 <b>_performMonitor</b>(<i></i>) | |
| 120 <p> | |
| 121 Protected method implementing the real monitoring action. | |
| 122 </p><p> | |
| 123 This method must be overridden and populate the statusList member variable | |
| 124 with a list of strings giving the status in the first column and the | |
| 125 path relative to the project directory starting with the third column. | |
| 126 The allowed status flags are: | |
| 127 <ul> | |
| 128 <li>"A" path was added but not yet comitted</li> | |
| 129 <li>"M" path has local changes</li> | |
| 130 <li>"R" path was deleted and then re-added</li> | |
| 131 <li>"U" path needs an update</li> | |
| 132 <li>"Z" path contains a conflict</li> | |
| 133 <li>" " path is back at normal</li> | |
| 134 </ul> | |
| 135 </p><dl> | |
| 136 <dt>Returns:</dt> | |
| 137 <dd> | |
| 138 tuple of flag indicating successful operation (boolean) and | |
| 139 a status message in case of non successful operation (QString) | |
| 140 </dd> | |
| 141 </dl><a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a> | |
| 142 <h4>VcsStatusMonitorThread.checkStatus</h4> | |
| 143 <b>checkStatus</b>(<i></i>) | |
| 144 <p> | |
| 145 Public method to wake up the status monitor thread. | |
| 146 </p><a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a> | |
| 147 <h4>VcsStatusMonitorThread.clearCachedState</h4> | |
| 148 <b>clearCachedState</b>(<i>name</i>) | |
| 149 <p> | |
| 150 Public method to clear the cached VCS state of a file/directory. | |
| 151 </p><dl> | |
| 152 <dt><i>name</i></dt> | |
| 153 <dd> | |
| 154 name of the entry to be cleared (string) | |
| 155 </dd> | |
| 156 </dl><a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> | |
| 157 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> | |
| 158 <b>getAutoUpdate</b>(<i></i>) | |
| 159 <p> | |
| 160 Public method to retrieve the status of the auto update function. | |
| 161 </p><dl> | |
| 162 <dt>Returns:</dt> | |
| 163 <dd> | |
| 164 status of the auto update function (boolean) | |
| 165 </dd> | |
| 166 </dl><a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> | |
| 167 <h4>VcsStatusMonitorThread.getInterval</h4> | |
| 168 <b>getInterval</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method to get the monitor interval. | |
| 171 </p><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 interval in seconds (integer) | |
| 175 </dd> | |
| 176 </dl><a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> | |
| 177 <h4>VcsStatusMonitorThread.run</h4> | |
| 178 <b>run</b>(<i></i>) | |
| 179 <p> | |
| 180 Protected method implementing the tasks action. | |
| 181 </p><a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a> | |
| 182 <h4>VcsStatusMonitorThread.setAutoUpdate</h4> | |
| 183 <b>setAutoUpdate</b>(<i>auto</i>) | |
| 184 <p> | |
| 185 Public method to enable the auto update function. | |
| 186 </p><dl> | |
| 187 <dt><i>auto</i></dt> | |
| 188 <dd> | |
| 189 status of the auto update function (boolean) | |
| 190 </dd> | |
| 191 </dl><a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> | |
| 192 <h4>VcsStatusMonitorThread.setInterval</h4> | |
| 193 <b>setInterval</b>(<i>interval</i>) | |
| 194 <p> | |
| 195 Public method to change the monitor interval. | |
| 196 </p><dl> | |
| 197 <dt><i>interval</i></dt> | |
| 198 <dd> | |
| 199 new interval in seconds (integer) | |
| 200 </dd> | |
| 201 </dl><a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> | |
| 202 <h4>VcsStatusMonitorThread.stop</h4> | |
| 203 <b>stop</b>(<i></i>) | |
| 204 <p> | |
| 205 Public method to stop the monitor thread. | |
| 206 </p> | |
| 207 <div align="right"><a href="#top">Up</a></div> | |
| 208 <hr /> | |
| 209 </body></html> |
