Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.VCS.StatusMonitorLed.html

eric6/Documentation/Source/eric6.VCS.StatusMonitorLed.html

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

Mercurial Repository: eric

eric ide

mercurial