Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.VCS.StatusMonitorLed.html
Documentation/Source/eric4.VCS.StatusMonitorLed.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.StatusMonitorLed</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.StatusMonitorLed</h1> | |
| 24 <p> | |
| 25 Module implementing a LED to indicate the status of the VCS status monitor 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> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a> | |
| 44 <h2>StatusMonitorLed</h2> | |
| 45 <p> | |
| 46 Class implementing a LED to indicate the status of the VCS status monitor thread. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 E4Led | |
| 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="#StatusMonitorLed.__init__">StatusMonitorLed</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#StatusMonitorLed.__checkActions">__checkActions</a></td> | |
| 61 <td>Private method to set the enabled status of the context menu actions.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td> | |
| 64 <td>Private slot to initiate a new status check.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td> | |
| 67 <td>Private method to receive the status monitor status.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td> | |
| 70 <td>Private slot to change the status check interval.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td> | |
| 73 <td>Private slot to switch the status monitor thread to Off.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td> | |
| 76 <td>Private slot to switch the status monitor thread to On.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td> | |
| 79 <td>Protected slot to show the context menu.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a> | |
| 83 <h4>StatusMonitorLed (Constructor)</h4> | |
| 84 <b>StatusMonitorLed</b>(<i>project, parent</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>project</i></dt> | |
| 89 <dd> | |
| 90 reference to the project object (Project.Project) | |
| 91 </dd><dt><i>parent</i></dt> | |
| 92 <dd> | |
| 93 reference to the parent object (QWidget) | |
| 94 </dd> | |
| 95 </dl><a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a> | |
| 96 <h4>StatusMonitorLed.__checkActions</h4> | |
| 97 <b>__checkActions</b>(<i></i>) | |
| 98 <p> | |
| 99 Private method to set the enabled status of the context menu actions. | |
| 100 </p><a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a> | |
| 101 <h4>StatusMonitorLed.__checkStatus</h4> | |
| 102 <b>__checkStatus</b>(<i></i>) | |
| 103 <p> | |
| 104 Private slot to initiate a new status check. | |
| 105 </p><a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a> | |
| 106 <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4> | |
| 107 <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>) | |
| 108 <p> | |
| 109 Private method to receive the status monitor status. | |
| 110 </p><dl> | |
| 111 <dt><i>status</i></dt> | |
| 112 <dd> | |
| 113 status of the monitoring thread (string, ok, nok or off) | |
| 114 </dd><dt><i>statusMsg</i></dt> | |
| 115 <dd> | |
| 116 explanotory text for the signaled status (string) | |
| 117 </dd> | |
| 118 </dl><a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a> | |
| 119 <h4>StatusMonitorLed.__setInterval</h4> | |
| 120 <b>__setInterval</b>(<i></i>) | |
| 121 <p> | |
| 122 Private slot to change the status check interval. | |
| 123 </p><a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a> | |
| 124 <h4>StatusMonitorLed.__switchOff</h4> | |
| 125 <b>__switchOff</b>(<i></i>) | |
| 126 <p> | |
| 127 Private slot to switch the status monitor thread to Off. | |
| 128 </p><a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a> | |
| 129 <h4>StatusMonitorLed.__switchOn</h4> | |
| 130 <b>__switchOn</b>(<i></i>) | |
| 131 <p> | |
| 132 Private slot to switch the status monitor thread to On. | |
| 133 </p><a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a> | |
| 134 <h4>StatusMonitorLed._showContextMenu</h4> | |
| 135 <b>_showContextMenu</b>(<i>coord</i>) | |
| 136 <p> | |
| 137 Protected slot to show the context menu. | |
| 138 </p><dl> | |
| 139 <dt><i>coord</i></dt> | |
| 140 <dd> | |
| 141 the position of the mouse pointer (QPoint) | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <div align="right"><a href="#top">Up</a></div> | |
| 145 <hr /> | |
| 146 </body></html> |
