Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.VCS.StatusMonitorLed.html
eric6/Documentation/Source/eric6.VCS.StatusMonitorLed.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.VCS.StatusMonitorLed</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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.VCS.StatusMonitorLed</h1> | |
| 23 <p> | |
| 24 Module implementing a LED to indicate the status of the VCS status monitor | |
| 25 thread. | |
| 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="#StatusMonitorLed">StatusMonitorLed</a></td> | |
| 35 <td>Class implementing a LED to indicate the status of the VCS status monitor thread.</td> | |
| 36 </tr><tr> | |
| 37 <td><a href="#StatusMonitorLedWidget">StatusMonitorLedWidget</a></td> | |
| 38 <td>Class implementing a widget containing a LED to indicate the status of the VCS status monitor thread and a short info message.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <h3>Functions</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <hr /><hr /> | |
| 46 <a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a> | |
| 47 <h2>StatusMonitorLed</h2> | |
| 48 <p> | |
| 49 Class implementing a LED to indicate the status of the VCS status monitor | |
| 50 thread. | |
| 51 </p> | |
| 52 <h3>Derived from</h3> | |
| 53 E5ClickableLed | |
| 54 <h3>Class Attributes</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Class Methods</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 <table> | |
| 64 <tr> | |
| 65 <td><a href="#StatusMonitorLed.__init__">StatusMonitorLed</a></td> | |
| 66 <td>Constructor</td> | |
| 67 </tr><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><tr> | |
| 71 <td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td> | |
| 72 <td>Private slot to initiate a new status check.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#StatusMonitorLed.__ledClicked">__ledClicked</a></td> | |
| 75 <td>Private slot to react upon clicks on the LED.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td> | |
| 78 <td>Private method to receive the status monitor status.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td> | |
| 81 <td>Private slot to change the status check interval.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td> | |
| 84 <td>Private slot to switch the status monitor thread to Off.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td> | |
| 87 <td>Private slot to switch the status monitor thread to On.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#StatusMonitorLed.__vcsStateChanged">__vcsStateChanged</a></td> | |
| 90 <td>Private slot to handle a change in the vcs state.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td> | |
| 93 <td>Protected slot to show the context menu.</td> | |
| 94 </tr> | |
| 95 </table> | |
| 96 <h3>Static Methods</h3> | |
| 97 <table> | |
| 98 <tr><td>None</td></tr> | |
| 99 </table> | |
| 100 <a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a> | |
| 101 <h4>StatusMonitorLed (Constructor)</h4> | |
| 102 <b>StatusMonitorLed</b>(<i>project, parent</i>) | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p><dl> | |
| 106 <dt><i>project</i></dt> | |
| 107 <dd> | |
| 108 reference to the project object (Project.Project) | |
| 109 </dd><dt><i>parent</i></dt> | |
| 110 <dd> | |
| 111 reference to the parent object (QWidget) | |
| 112 </dd> | |
| 113 </dl><a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a> | |
| 114 <h4>StatusMonitorLed.__checkActions</h4> | |
| 115 <b>__checkActions</b>(<i></i>) | |
| 116 <p> | |
| 117 Private method to set the enabled status of the context menu actions. | |
| 118 </p><a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a> | |
| 119 <h4>StatusMonitorLed.__checkStatus</h4> | |
| 120 <b>__checkStatus</b>(<i></i>) | |
| 121 <p> | |
| 122 Private slot to initiate a new status check. | |
| 123 </p><a NAME="StatusMonitorLed.__ledClicked" ID="StatusMonitorLed.__ledClicked"></a> | |
| 124 <h4>StatusMonitorLed.__ledClicked</h4> | |
| 125 <b>__ledClicked</b>(<i>pos</i>) | |
| 126 <p> | |
| 127 Private slot to react upon clicks on the LED. | |
| 128 </p><dl> | |
| 129 <dt><i>pos</i></dt> | |
| 130 <dd> | |
| 131 position of the click (QPoint) | |
| 132 </dd> | |
| 133 </dl><a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a> | |
| 134 <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4> | |
| 135 <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>) | |
| 136 <p> | |
| 137 Private method to receive the status monitor status. | |
| 138 </p><dl> | |
| 139 <dt><i>status</i></dt> | |
| 140 <dd> | |
| 141 status of the monitoring thread (string, ok, nok or off) | |
| 142 </dd><dt><i>statusMsg</i></dt> | |
| 143 <dd> | |
| 144 explanotory text for the signaled status (string) | |
| 145 </dd> | |
| 146 </dl><a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a> | |
| 147 <h4>StatusMonitorLed.__setInterval</h4> | |
| 148 <b>__setInterval</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot to change the status check interval. | |
| 151 </p><a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a> | |
| 152 <h4>StatusMonitorLed.__switchOff</h4> | |
| 153 <b>__switchOff</b>(<i></i>) | |
| 154 <p> | |
| 155 Private slot to switch the status monitor thread to Off. | |
| 156 </p><a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a> | |
| 157 <h4>StatusMonitorLed.__switchOn</h4> | |
| 158 <b>__switchOn</b>(<i></i>) | |
| 159 <p> | |
| 160 Private slot to switch the status monitor thread to On. | |
| 161 </p><a NAME="StatusMonitorLed.__vcsStateChanged" ID="StatusMonitorLed.__vcsStateChanged"></a> | |
| 162 <h4>StatusMonitorLed.__vcsStateChanged</h4> | |
| 163 <b>__vcsStateChanged</b>(<i>state</i>) | |
| 164 <p> | |
| 165 Private slot to handle a change in the vcs state. | |
| 166 </p><dl> | |
| 167 <dt><i>state</i></dt> | |
| 168 <dd> | |
| 169 new vcs state (string) | |
| 170 </dd> | |
| 171 </dl><a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a> | |
| 172 <h4>StatusMonitorLed._showContextMenu</h4> | |
| 173 <b>_showContextMenu</b>(<i>coord</i>) | |
| 174 <p> | |
| 175 Protected slot to show the context menu. | |
| 176 </p><dl> | |
| 177 <dt><i>coord</i></dt> | |
| 178 <dd> | |
| 179 the position of the mouse pointer (QPoint) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <div align="right"><a href="#top">Up</a></div> | |
| 183 <hr /><hr /> | |
| 184 <a NAME="StatusMonitorLedWidget" ID="StatusMonitorLedWidget"></a> | |
| 185 <h2>StatusMonitorLedWidget</h2> | |
| 186 <p> | |
| 187 Class implementing a widget containing a LED to indicate the status of the | |
| 188 VCS status monitor thread and a short info message. | |
| 189 </p> | |
| 190 <h3>Derived from</h3> | |
| 191 QWidget | |
| 192 <h3>Class Attributes</h3> | |
| 193 <table> | |
| 194 <tr><td>None</td></tr> | |
| 195 </table> | |
| 196 <h3>Class Methods</h3> | |
| 197 <table> | |
| 198 <tr><td>None</td></tr> | |
| 199 </table> | |
| 200 <h3>Methods</h3> | |
| 201 <table> | |
| 202 <tr> | |
| 203 <td><a href="#StatusMonitorLedWidget.__init__">StatusMonitorLedWidget</a></td> | |
| 204 <td>Constructor</td> | |
| 205 </tr><tr> | |
| 206 <td><a href="#StatusMonitorLedWidget.__projectVcsStatusMonitorInfo">__projectVcsStatusMonitorInfo</a></td> | |
| 207 <td>Private slot handling the receipt of an info message.</td> | |
| 208 </tr> | |
| 209 </table> | |
| 210 <h3>Static Methods</h3> | |
| 211 <table> | |
| 212 <tr><td>None</td></tr> | |
| 213 </table> | |
| 214 <a NAME="StatusMonitorLedWidget.__init__" ID="StatusMonitorLedWidget.__init__"></a> | |
| 215 <h4>StatusMonitorLedWidget (Constructor)</h4> | |
| 216 <b>StatusMonitorLedWidget</b>(<i>project, parent</i>) | |
| 217 <p> | |
| 218 Constructor | |
| 219 </p><dl> | |
| 220 <dt><i>project</i> (Project.Project)</dt> | |
| 221 <dd> | |
| 222 reference to the project object | |
| 223 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 224 <dd> | |
| 225 reference to the parent object | |
| 226 </dd> | |
| 227 </dl><a NAME="StatusMonitorLedWidget.__projectVcsStatusMonitorInfo" ID="StatusMonitorLedWidget.__projectVcsStatusMonitorInfo"></a> | |
| 228 <h4>StatusMonitorLedWidget.__projectVcsStatusMonitorInfo</h4> | |
| 229 <b>__projectVcsStatusMonitorInfo</b>(<i>info</i>) | |
| 230 <p> | |
| 231 Private slot handling the receipt of an info message. | |
| 232 </p><dl> | |
| 233 <dt><i>info</i> (str)</dt> | |
| 234 <dd> | |
| 235 received info message | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <div align="right"><a href="#top">Up</a></div> | |
| 239 <hr /> | |
| 240 </body></html> |
