Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.VCS.StatusMonitorLed.html
Documentation/Source/eric5.VCS.StatusMonitorLed.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.VCS.StatusMonitorLed</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.VCS.StatusMonitorLed</h1> | |
| 12 <p> | |
| 13 Module implementing a LED to indicate the status of the VCS status monitor thread. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#StatusMonitorLed">StatusMonitorLed</a></td> | |
| 23 <td>Class implementing a LED to indicate the status of the VCS status monitor thread.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a> | |
| 32 <h2>StatusMonitorLed</h2> | |
| 33 <p> | |
| 34 Class implementing a LED to indicate the status of the VCS status monitor thread. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 E4Led | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#StatusMonitorLed.__init__">StatusMonitorLed</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#StatusMonitorLed.__checkActions">__checkActions</a></td> | |
| 49 <td>Private method to set the enabled status of the context menu actions.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td> | |
| 52 <td>Private slot to initiate a new status check.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td> | |
| 55 <td>Private method to receive the status monitor status.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td> | |
| 58 <td>Private slot to change the status check interval.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td> | |
| 61 <td>Private slot to switch the status monitor thread to Off.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td> | |
| 64 <td>Private slot to switch the status monitor thread to On.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td> | |
| 67 <td>Protected slot to show the context menu.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a> | |
| 71 <h4>StatusMonitorLed (Constructor)</h4> | |
| 72 <b>StatusMonitorLed</b>(<i>project, parent</i>) | |
| 73 <p> | |
| 74 Constructor | |
| 75 </p><dl> | |
| 76 <dt><i>project</i></dt> | |
| 77 <dd> | |
| 78 reference to the project object (Project.Project) | |
| 79 </dd><dt><i>parent</i></dt> | |
| 80 <dd> | |
| 81 reference to the parent object (QWidget) | |
| 82 </dd> | |
| 83 </dl><a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a> | |
| 84 <h4>StatusMonitorLed.__checkActions</h4> | |
| 85 <b>__checkActions</b>(<i></i>) | |
| 86 <p> | |
| 87 Private method to set the enabled status of the context menu actions. | |
| 88 </p><a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a> | |
| 89 <h4>StatusMonitorLed.__checkStatus</h4> | |
| 90 <b>__checkStatus</b>(<i></i>) | |
| 91 <p> | |
| 92 Private slot to initiate a new status check. | |
| 93 </p><a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a> | |
| 94 <h4>StatusMonitorLed.__projectVcsMonitorStatus</h4> | |
| 95 <b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>) | |
| 96 <p> | |
| 97 Private method to receive the status monitor status. | |
| 98 </p><dl> | |
| 99 <dt><i>status</i></dt> | |
| 100 <dd> | |
| 101 status of the monitoring thread (string, ok, nok or off) | |
| 102 </dd><dt><i>statusMsg</i></dt> | |
| 103 <dd> | |
| 104 explanotory text for the signaled status (string) | |
| 105 </dd> | |
| 106 </dl><a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a> | |
| 107 <h4>StatusMonitorLed.__setInterval</h4> | |
| 108 <b>__setInterval</b>(<i></i>) | |
| 109 <p> | |
| 110 Private slot to change the status check interval. | |
| 111 </p><a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a> | |
| 112 <h4>StatusMonitorLed.__switchOff</h4> | |
| 113 <b>__switchOff</b>(<i></i>) | |
| 114 <p> | |
| 115 Private slot to switch the status monitor thread to Off. | |
| 116 </p><a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a> | |
| 117 <h4>StatusMonitorLed.__switchOn</h4> | |
| 118 <b>__switchOn</b>(<i></i>) | |
| 119 <p> | |
| 120 Private slot to switch the status monitor thread to On. | |
| 121 </p><a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a> | |
| 122 <h4>StatusMonitorLed._showContextMenu</h4> | |
| 123 <b>_showContextMenu</b>(<i>coord</i>) | |
| 124 <p> | |
| 125 Protected slot to show the context menu. | |
| 126 </p><dl> | |
| 127 <dt><i>coord</i></dt> | |
| 128 <dd> | |
| 129 the position of the mouse pointer (QPoint) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <div align="right"><a href="#top">Up</a></div> | |
| 133 <hr /> | |
| 134 </body></html> |
