|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</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.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread</h1> |
|
23 <p> |
|
24 Module implementing the VCS status monitor thread class for Mercurial. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#HgStatusMonitorThread">HgStatusMonitorThread</a></td> |
|
34 <td>Class implementing the VCS status monitor thread class for Mercurial.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="HgStatusMonitorThread" ID="HgStatusMonitorThread"></a> |
|
43 <h2>HgStatusMonitorThread</h2> |
|
44 <p> |
|
45 Class implementing the VCS status monitor thread class for Mercurial. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 VcsStatusMonitorThread |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#HgStatusMonitorThread.__init__">HgStatusMonitorThread</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#HgStatusMonitorThread._performMonitor">_performMonitor</a></td> |
|
64 <td>Protected method implementing the monitoring action.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#HgStatusMonitorThread._shutdown">_shutdown</a></td> |
|
67 <td>Protected method performing shutdown actions.</td> |
|
68 </tr> |
|
69 </table> |
|
70 <h3>Static Methods</h3> |
|
71 <table> |
|
72 <tr><td>None</td></tr> |
|
73 </table> |
|
74 <a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a> |
|
75 <h4>HgStatusMonitorThread (Constructor)</h4> |
|
76 <b>HgStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) |
|
77 <p> |
|
78 Constructor |
|
79 </p><dl> |
|
80 <dt><i>interval</i></dt> |
|
81 <dd> |
|
82 new interval in seconds (integer) |
|
83 </dd><dt><i>project</i></dt> |
|
84 <dd> |
|
85 reference to the project object (Project) |
|
86 </dd><dt><i>vcs</i></dt> |
|
87 <dd> |
|
88 reference to the version control object |
|
89 </dd><dt><i>parent</i></dt> |
|
90 <dd> |
|
91 reference to the parent object (QObject) |
|
92 </dd> |
|
93 </dl><a NAME="HgStatusMonitorThread._performMonitor" ID="HgStatusMonitorThread._performMonitor"></a> |
|
94 <h4>HgStatusMonitorThread._performMonitor</h4> |
|
95 <b>_performMonitor</b>(<i></i>) |
|
96 <p> |
|
97 Protected method implementing the monitoring action. |
|
98 </p><p> |
|
99 This method populates the statusList member variable |
|
100 with a list of strings giving the status in the first column and the |
|
101 path relative to the project directory starting with the third column. |
|
102 The allowed status flags are: |
|
103 <ul> |
|
104 <li>"A" path was added but not yet comitted</li> |
|
105 <li>"M" path has local changes</li> |
|
106 <li>"O" path was removed</li> |
|
107 <li>"R" path was deleted and then re-added</li> |
|
108 <li>"U" path needs an update</li> |
|
109 <li>"Z" path contains a conflict</li> |
|
110 <li>" " path is back at normal</li> |
|
111 </ul> |
|
112 </p><dl> |
|
113 <dt>Returns:</dt> |
|
114 <dd> |
|
115 tuple of flag indicating successful operation (boolean) and |
|
116 a status message in case of non successful operation (string) |
|
117 </dd> |
|
118 </dl><a NAME="HgStatusMonitorThread._shutdown" ID="HgStatusMonitorThread._shutdown"></a> |
|
119 <h4>HgStatusMonitorThread._shutdown</h4> |
|
120 <b>_shutdown</b>(<i></i>) |
|
121 <p> |
|
122 Protected method performing shutdown actions. |
|
123 </p> |
|
124 <div align="right"><a href="#top">Up</a></div> |
|
125 <hr /> |
|
126 </body></html> |