Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VCS.StatusMonitorLed.html
src/eric7/Documentation/Source/eric7.VCS.StatusMonitorLed.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VCS.StatusMonitorLed</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.VCS.StatusMonitorLed</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a LED to indicate the status of the VCS status monitor | |
| 13 thread. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#StatusMonitorLed">StatusMonitorLed</a></td> | |
| 26 <td>Class implementing a LED to indicate the status of the VCS status monitor thread.</td> | |
| 27 </tr> | |
| 28 <tr> | |
| 29 <td><a href="#StatusMonitorLedWidget">StatusMonitorLedWidget</a></td> | |
| 30 <td>Class implementing a widget containing a LED to indicate the status of the VCS status monitor thread and a short info message.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <h3>Functions</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <hr /> | |
| 39 <hr /> | |
| 40 <a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a> | |
| 41 <h2>StatusMonitorLed</h2> | |
| 42 | |
| 43 <p> | |
| 44 Class implementing a LED to indicate the status of the VCS status monitor | |
| 45 thread. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 EricClickableLed | |
| 49 <h3>Class Attributes</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 | |
| 61 <table> | |
| 62 | |
| 63 <tr> | |
| 64 <td><a href="#StatusMonitorLed.__init__">StatusMonitorLed</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#StatusMonitorLed.__checkActions">__checkActions</a></td> | |
| 69 <td>Private method to set the enabled status of the context menu actions.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td> | |
| 73 <td>Private slot to initiate a new status check.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#StatusMonitorLed.__ledClicked">__ledClicked</a></td> | |
| 77 <td>Private slot to react upon clicks on the LED.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td> | |
| 81 <td>Private method to receive the status monitor status.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td> | |
| 85 <td>Private slot to change the status check interval.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td> | |
| 89 <td>Private slot to switch the status monitor thread to Off.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td> | |
| 93 <td>Private slot to switch the status monitor thread to On.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#StatusMonitorLed.__vcsStateChanged">__vcsStateChanged</a></td> | |
| 97 <td>Private slot to handle a change in the vcs state.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td> | |
| 101 <td>Protected slot to show the context menu.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 <h3>Static Methods</h3> | |
| 105 | |
| 106 <table> | |
| 107 <tr><td>None</td></tr> | |
| 108 </table> | |
| 109 | |
| 110 <a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a> | |
| 111 <h4>StatusMonitorLed (Constructor)</h4> | |
| 112 <b>StatusMonitorLed</b>(<i>project, parent</i>) | |
| 113 | |
| 114 <p> | |
| 115 Constructor | |
| 116 </p> | |
| 117 <dl> | |
| 118 | |
| 119 <dt><i>project</i></dt> | |
| 120 <dd> | |
| 121 reference to the project object (Project.Project) | |
| 122 </dd> | |
| 123 <dt><i>parent</i></dt> | |
| 124 <dd> | |
| 125 reference to the parent object (QWidget) | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a> | |
| 129 <h4>StatusMonitorLed.__checkActions</h4> | |
| 130 <b>__checkActions</b>(<i></i>) | |
| 131 | |
| 132 <p> | |
| 133 Private method to set the enabled status of the context menu actions. | |
| 134 </p> | |
| 135 <a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a> | |
| 136 <h4>StatusMonitorLed.__checkStatus</h4> | |
| 137 <b>__checkStatus</b>(<i></i>) | |
| 138 | |
| 139 <p> | |
| 140 Private slot to initiate a new status check. | |
| 141 </p> | |
| 142 <a NAME="StatusMonitorLed.__ledClicked" ID="StatusMonitorLed.__ledClicked"></a> | |
| 143 <h4>StatusMonitorLed.__ledClicked</h4> | |
| 144 <b>__ledClicked</b>(<i>pos</i>) | |
| 145 | |
| 146 <p> | |
| 147 Private slot to react upon clicks on the LED. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>pos</i></dt> | |
| 152 <dd> | |
| 153 position of the click (QPoint) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a> | |
| 157 <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4> | |
| 158 <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>) | |
| 159 | |
| 160 <p> | |
| 161 Private method to receive the status monitor status. | |
| 162 </p> | |
| 163 <dl> | |
| 164 | |
| 165 <dt><i>status</i></dt> | |
| 166 <dd> | |
| 167 status of the monitoring thread (string, ok, nok or off) | |
| 168 </dd> | |
| 169 <dt><i>statusMsg</i></dt> | |
| 170 <dd> | |
| 171 explanotory text for the signaled status (string) | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a> | |
| 175 <h4>StatusMonitorLed.__setInterval</h4> | |
| 176 <b>__setInterval</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Private slot to change the status check interval. | |
| 180 </p> | |
| 181 <a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a> | |
| 182 <h4>StatusMonitorLed.__switchOff</h4> | |
| 183 <b>__switchOff</b>(<i></i>) | |
| 184 | |
| 185 <p> | |
| 186 Private slot to switch the status monitor thread to Off. | |
| 187 </p> | |
| 188 <a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a> | |
| 189 <h4>StatusMonitorLed.__switchOn</h4> | |
| 190 <b>__switchOn</b>(<i></i>) | |
| 191 | |
| 192 <p> | |
| 193 Private slot to switch the status monitor thread to On. | |
| 194 </p> | |
| 195 <a NAME="StatusMonitorLed.__vcsStateChanged" ID="StatusMonitorLed.__vcsStateChanged"></a> | |
| 196 <h4>StatusMonitorLed.__vcsStateChanged</h4> | |
| 197 <b>__vcsStateChanged</b>(<i>state</i>) | |
| 198 | |
| 199 <p> | |
| 200 Private slot to handle a change in the vcs state. | |
| 201 </p> | |
| 202 <dl> | |
| 203 | |
| 204 <dt><i>state</i></dt> | |
| 205 <dd> | |
| 206 new vcs state (string) | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a> | |
| 210 <h4>StatusMonitorLed._showContextMenu</h4> | |
| 211 <b>_showContextMenu</b>(<i>coord</i>) | |
| 212 | |
| 213 <p> | |
| 214 Protected slot to show the context menu. | |
| 215 </p> | |
| 216 <dl> | |
| 217 | |
| 218 <dt><i>coord</i></dt> | |
| 219 <dd> | |
| 220 the position of the mouse pointer (QPoint) | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <div align="right"><a href="#top">Up</a></div> | |
| 224 <hr /> | |
| 225 <hr /> | |
| 226 <a NAME="StatusMonitorLedWidget" ID="StatusMonitorLedWidget"></a> | |
| 227 <h2>StatusMonitorLedWidget</h2> | |
| 228 | |
| 229 <p> | |
| 230 Class implementing a widget containing a LED to indicate the status of the | |
| 231 VCS status monitor thread and a short info message. | |
| 232 </p> | |
| 233 <h3>Derived from</h3> | |
| 234 QWidget | |
| 235 <h3>Class Attributes</h3> | |
| 236 | |
| 237 <table> | |
| 238 <tr><td>None</td></tr> | |
| 239 </table> | |
| 240 <h3>Class Methods</h3> | |
| 241 | |
| 242 <table> | |
| 243 <tr><td>None</td></tr> | |
| 244 </table> | |
| 245 <h3>Methods</h3> | |
| 246 | |
| 247 <table> | |
| 248 | |
| 249 <tr> | |
| 250 <td><a href="#StatusMonitorLedWidget.__init__">StatusMonitorLedWidget</a></td> | |
| 251 <td>Constructor</td> | |
| 252 </tr> | |
| 253 <tr> | |
| 254 <td><a href="#StatusMonitorLedWidget.__projectVcsStatusMonitorInfo">__projectVcsStatusMonitorInfo</a></td> | |
| 255 <td>Private slot handling the receipt of an info message.</td> | |
| 256 </tr> | |
| 257 </table> | |
| 258 <h3>Static Methods</h3> | |
| 259 | |
| 260 <table> | |
| 261 <tr><td>None</td></tr> | |
| 262 </table> | |
| 263 | |
| 264 <a NAME="StatusMonitorLedWidget.__init__" ID="StatusMonitorLedWidget.__init__"></a> | |
| 265 <h4>StatusMonitorLedWidget (Constructor)</h4> | |
| 266 <b>StatusMonitorLedWidget</b>(<i>project, parent</i>) | |
| 267 | |
| 268 <p> | |
| 269 Constructor | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>project</i> (Project.Project)</dt> | |
| 274 <dd> | |
| 275 reference to the project object | |
| 276 </dd> | |
| 277 <dt><i>parent</i> (QWidget)</dt> | |
| 278 <dd> | |
| 279 reference to the parent object | |
| 280 </dd> | |
| 281 </dl> | |
| 282 <a NAME="StatusMonitorLedWidget.__projectVcsStatusMonitorInfo" ID="StatusMonitorLedWidget.__projectVcsStatusMonitorInfo"></a> | |
| 283 <h4>StatusMonitorLedWidget.__projectVcsStatusMonitorInfo</h4> | |
| 284 <b>__projectVcsStatusMonitorInfo</b>(<i>info</i>) | |
| 285 | |
| 286 <p> | |
| 287 Private slot handling the receipt of an info message. | |
| 288 </p> | |
| 289 <dl> | |
| 290 | |
| 291 <dt><i>info</i> (str)</dt> | |
| 292 <dd> | |
| 293 received info message | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /> | |
| 298 </body></html> |
