Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html

src/eric7/Documentation/Source/eric7.VCS.StatusMonitorThread.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.VCS.StatusMonitorThread</h1> 9 <h1>eric7.VCS.StatusMonitorThread</h1>
10
11 <p> 10 <p>
12 Module implementing the VCS status monitor thread base class. 11 Module implementing the VCS status monitor thread base class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#VcsStatusMonitorThread">VcsStatusMonitorThread</a></td> 22 <td><a href="#VcsStatusMonitorThread">VcsStatusMonitorThread</a></td>
25 <td>Class implementing the VCS status monitor thread base class.</td> 23 <td>Class implementing the VCS status monitor thread base class.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="VcsStatusMonitorThread" ID="VcsStatusMonitorThread"></a> 34 <a NAME="VcsStatusMonitorThread" ID="VcsStatusMonitorThread"></a>
36 <h2>VcsStatusMonitorThread</h2> 35 <h2>VcsStatusMonitorThread</h2>
37
38 <p> 36 <p>
39 Class implementing the VCS status monitor thread base class. 37 Class implementing the VCS status monitor thread base class.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>vcsStatusMonitorAllData(dict)</dt> 43 <dt>vcsStatusMonitorAllData(dict)</dt>
45 <dd> 44 <dd>
62 </dd> 61 </dd>
63 </dl> 62 </dl>
64 <h3>Derived from</h3> 63 <h3>Derived from</h3>
65 QThread 64 QThread
66 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
67 66 <table>
68 <table> 67 <tr><td>None</td></tr>
69 <tr><td>None</td></tr> 68 </table>
70 </table> 69
71 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
72 71 <table>
73 <table> 72 <tr><td>None</td></tr>
74 <tr><td>None</td></tr> 73 </table>
75 </table> 74
76 <h3>Methods</h3> 75 <h3>Methods</h3>
77 76 <table>
78 <table>
79
80 <tr> 77 <tr>
81 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td> 78 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td>
82 <td>Constructor</td> 79 <td>Constructor</td>
83 </tr> 80 </tr>
84 <tr> 81 <tr>
124 <tr> 121 <tr>
125 <td><a href="#VcsStatusMonitorThread.stop">stop</a></td> 122 <td><a href="#VcsStatusMonitorThread.stop">stop</a></td>
126 <td>Public method to stop the monitor thread.</td> 123 <td>Public method to stop the monitor thread.</td>
127 </tr> 124 </tr>
128 </table> 125 </table>
126
129 <h3>Static Methods</h3> 127 <h3>Static Methods</h3>
130 128 <table>
131 <table> 129 <tr><td>None</td></tr>
132 <tr><td>None</td></tr> 130 </table>
133 </table> 131
134 132
135 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a> 133 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a>
136 <h4>VcsStatusMonitorThread (Constructor)</h4> 134 <h4>VcsStatusMonitorThread (Constructor)</h4>
137 <b>VcsStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) 135 <b>VcsStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>)
138
139 <p> 136 <p>
140 Constructor 137 Constructor
141 </p> 138 </p>
139
142 <dl> 140 <dl>
143 141
144 <dt><i>interval</i> (int)</dt> 142 <dt><i>interval</i> (int)</dt>
145 <dd> 143 <dd>
146 new interval in seconds 144 new interval in seconds
159 </dd> 157 </dd>
160 </dl> 158 </dl>
161 <a NAME="VcsStatusMonitorThread._getInfo" ID="VcsStatusMonitorThread._getInfo"></a> 159 <a NAME="VcsStatusMonitorThread._getInfo" ID="VcsStatusMonitorThread._getInfo"></a>
162 <h4>VcsStatusMonitorThread._getInfo</h4> 160 <h4>VcsStatusMonitorThread._getInfo</h4>
163 <b>_getInfo</b>(<i></i>) 161 <b>_getInfo</b>(<i></i>)
164
165 <p> 162 <p>
166 Protected method implementing the real info action. 163 Protected method implementing the real info action.
167 </p> 164 </p>
168 <p> 165 <p>
169 This method should be overridden and create a short info message to be 166 This method should be overridden and create a short info message to be
170 shown in the main window status bar right next to the status indicator. 167 shown in the main window status bar right next to the status indicator.
171 </p> 168 </p>
169
172 <dl> 170 <dl>
173 <dt>Return:</dt> 171 <dt>Return:</dt>
174 <dd> 172 <dd>
175 short info message 173 short info message
176 </dd> 174 </dd>
182 </dd> 180 </dd>
183 </dl> 181 </dl>
184 <a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a> 182 <a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a>
185 <h4>VcsStatusMonitorThread._performMonitor</h4> 183 <h4>VcsStatusMonitorThread._performMonitor</h4>
186 <b>_performMonitor</b>(<i></i>) 184 <b>_performMonitor</b>(<i></i>)
187
188 <p> 185 <p>
189 Protected method implementing the real monitoring action. 186 Protected method implementing the real monitoring action.
190 </p> 187 </p>
191 <p> 188 <p>
192 This method must be overridden and populate the statusList member 189 This method must be overridden and populate the statusList member
203 <li>"?" path is not tracked</li> 200 <li>"?" path is not tracked</li>
204 <li>"!" path is missing</li> 201 <li>"!" path is missing</li>
205 <li>" " path is back at normal</li> 202 <li>" " path is back at normal</li>
206 </ul> 203 </ul>
207 </p> 204 </p>
205
208 <dl> 206 <dl>
209 <dt>Return:</dt> 207 <dt>Return:</dt>
210 <dd> 208 <dd>
211 tuple of flag indicating successful operation and 209 tuple of flag indicating successful operation and
212 a status message in case of non successful operation 210 a status message in case of non successful operation
227 </dd> 225 </dd>
228 </dl> 226 </dl>
229 <a NAME="VcsStatusMonitorThread._shutdown" ID="VcsStatusMonitorThread._shutdown"></a> 227 <a NAME="VcsStatusMonitorThread._shutdown" ID="VcsStatusMonitorThread._shutdown"></a>
230 <h4>VcsStatusMonitorThread._shutdown</h4> 228 <h4>VcsStatusMonitorThread._shutdown</h4>
231 <b>_shutdown</b>(<i></i>) 229 <b>_shutdown</b>(<i></i>)
232
233 <p> 230 <p>
234 Protected method performing shutdown actions. 231 Protected method performing shutdown actions.
235 </p> 232 </p>
236 <p> 233 <p>
237 The default implementation does nothing. 234 The default implementation does nothing.
238 </p> 235 </p>
236
239 <a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a> 237 <a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a>
240 <h4>VcsStatusMonitorThread.checkStatus</h4> 238 <h4>VcsStatusMonitorThread.checkStatus</h4>
241 <b>checkStatus</b>(<i></i>) 239 <b>checkStatus</b>(<i></i>)
242
243 <p> 240 <p>
244 Public method to wake up the status monitor thread. 241 Public method to wake up the status monitor thread.
245 </p> 242 </p>
243
246 <a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a> 244 <a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a>
247 <h4>VcsStatusMonitorThread.clearCachedState</h4> 245 <h4>VcsStatusMonitorThread.clearCachedState</h4>
248 <b>clearCachedState</b>(<i>name</i>) 246 <b>clearCachedState</b>(<i>name</i>)
249
250 <p> 247 <p>
251 Public method to clear the cached VCS state of a file/directory. 248 Public method to clear the cached VCS state of a file/directory.
252 </p> 249 </p>
250
253 <dl> 251 <dl>
254 252
255 <dt><i>name</i> (str)</dt> 253 <dt><i>name</i> (str)</dt>
256 <dd> 254 <dd>
257 name of the entry to be cleared 255 name of the entry to be cleared
258 </dd> 256 </dd>
259 </dl> 257 </dl>
260 <a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> 258 <a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a>
261 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> 259 <h4>VcsStatusMonitorThread.getAutoUpdate</h4>
262 <b>getAutoUpdate</b>(<i></i>) 260 <b>getAutoUpdate</b>(<i></i>)
263
264 <p> 261 <p>
265 Public method to retrieve the status of the auto update function. 262 Public method to retrieve the status of the auto update function.
266 </p> 263 </p>
264
267 <dl> 265 <dl>
268 <dt>Return:</dt> 266 <dt>Return:</dt>
269 <dd> 267 <dd>
270 status of the auto update function 268 status of the auto update function
271 </dd> 269 </dd>
277 </dd> 275 </dd>
278 </dl> 276 </dl>
279 <a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> 277 <a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a>
280 <h4>VcsStatusMonitorThread.getInterval</h4> 278 <h4>VcsStatusMonitorThread.getInterval</h4>
281 <b>getInterval</b>(<i></i>) 279 <b>getInterval</b>(<i></i>)
282
283 <p> 280 <p>
284 Public method to get the monitor interval. 281 Public method to get the monitor interval.
285 </p> 282 </p>
283
286 <dl> 284 <dl>
287 <dt>Return:</dt> 285 <dt>Return:</dt>
288 <dd> 286 <dd>
289 interval in seconds 287 interval in seconds
290 </dd> 288 </dd>
296 </dd> 294 </dd>
297 </dl> 295 </dl>
298 <a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> 296 <a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a>
299 <h4>VcsStatusMonitorThread.run</h4> 297 <h4>VcsStatusMonitorThread.run</h4>
300 <b>run</b>(<i></i>) 298 <b>run</b>(<i></i>)
301
302 <p> 299 <p>
303 Public method implementing the tasks action. 300 Public method implementing the tasks action.
304 </p> 301 </p>
302
305 <a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a> 303 <a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a>
306 <h4>VcsStatusMonitorThread.setAutoUpdate</h4> 304 <h4>VcsStatusMonitorThread.setAutoUpdate</h4>
307 <b>setAutoUpdate</b>(<i>auto</i>) 305 <b>setAutoUpdate</b>(<i>auto</i>)
308
309 <p> 306 <p>
310 Public method to enable the auto update function. 307 Public method to enable the auto update function.
311 </p> 308 </p>
309
312 <dl> 310 <dl>
313 311
314 <dt><i>auto</i> (bool)</dt> 312 <dt><i>auto</i> (bool)</dt>
315 <dd> 313 <dd>
316 status of the auto update function 314 status of the auto update function
317 </dd> 315 </dd>
318 </dl> 316 </dl>
319 <a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> 317 <a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a>
320 <h4>VcsStatusMonitorThread.setInterval</h4> 318 <h4>VcsStatusMonitorThread.setInterval</h4>
321 <b>setInterval</b>(<i>interval</i>) 319 <b>setInterval</b>(<i>interval</i>)
322
323 <p> 320 <p>
324 Public method to change the monitor interval. 321 Public method to change the monitor interval.
325 </p> 322 </p>
323
326 <dl> 324 <dl>
327 325
328 <dt><i>interval</i> (int)</dt> 326 <dt><i>interval</i> (int)</dt>
329 <dd> 327 <dd>
330 new interval in seconds 328 new interval in seconds
331 </dd> 329 </dd>
332 </dl> 330 </dl>
333 <a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> 331 <a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a>
334 <h4>VcsStatusMonitorThread.stop</h4> 332 <h4>VcsStatusMonitorThread.stop</h4>
335 <b>stop</b>(<i></i>) 333 <b>stop</b>(<i></i>)
336
337 <p> 334 <p>
338 Public method to stop the monitor thread. 335 Public method to stop the monitor thread.
339 </p> 336 </p>
337
340 <div align="right"><a href="#top">Up</a></div> 338 <div align="right"><a href="#top">Up</a></div>
341 <hr /> 339 <hr />
342 </body></html> 340 </body></html>

Mercurial Repository: eric

eric ide

mercurial