63 </table> |
63 </table> |
64 <h3>Methods</h3> |
64 <h3>Methods</h3> |
65 <table> |
65 <table> |
66 <tr> |
66 <tr> |
67 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td> |
67 <td><a href="#VcsStatusMonitorThread.__init__">VcsStatusMonitorThread</a></td> |
68 <td>Constructor</td> |
68 <td>Constructor</td> |
69 </tr><tr> |
69 </tr><tr> |
70 <td><a href="#VcsStatusMonitorThread._performMonitor">_performMonitor</a></td> |
70 <td><a href="#VcsStatusMonitorThread._performMonitor">_performMonitor</a></td> |
71 <td>Protected method implementing the real monitoring action.</td> |
71 <td>Protected method implementing the real monitoring action.</td> |
72 </tr><tr> |
72 </tr><tr> |
73 <td><a href="#VcsStatusMonitorThread.checkStatus">checkStatus</a></td> |
73 <td><a href="#VcsStatusMonitorThread.checkStatus">checkStatus</a></td> |
74 <td>Public method to wake up the status monitor thread.</td> |
74 <td>Public method to wake up the status monitor thread.</td> |
75 </tr><tr> |
75 </tr><tr> |
76 <td><a href="#VcsStatusMonitorThread.clearCachedState">clearCachedState</a></td> |
76 <td><a href="#VcsStatusMonitorThread.clearCachedState">clearCachedState</a></td> |
77 <td>Public method to clear the cached VCS state of a file/directory.</td> |
77 <td>Public method to clear the cached VCS state of a file/directory.</td> |
78 </tr><tr> |
78 </tr><tr> |
79 <td><a href="#VcsStatusMonitorThread.getAutoUpdate">getAutoUpdate</a></td> |
79 <td><a href="#VcsStatusMonitorThread.getAutoUpdate">getAutoUpdate</a></td> |
80 <td>Public method to retrieve the status of the auto update function.</td> |
80 <td>Public method to retrieve the status of the auto update function.</td> |
81 </tr><tr> |
81 </tr><tr> |
82 <td><a href="#VcsStatusMonitorThread.getInterval">getInterval</a></td> |
82 <td><a href="#VcsStatusMonitorThread.getInterval">getInterval</a></td> |
83 <td>Public method to get the monitor interval.</td> |
83 <td>Public method to get the monitor interval.</td> |
84 </tr><tr> |
84 </tr><tr> |
85 <td><a href="#VcsStatusMonitorThread.run">run</a></td> |
85 <td><a href="#VcsStatusMonitorThread.run">run</a></td> |
86 <td>Protected method implementing the tasks action.</td> |
86 <td>Protected method implementing the tasks action.</td> |
87 </tr><tr> |
87 </tr><tr> |
88 <td><a href="#VcsStatusMonitorThread.setAutoUpdate">setAutoUpdate</a></td> |
88 <td><a href="#VcsStatusMonitorThread.setAutoUpdate">setAutoUpdate</a></td> |
89 <td>Public method to enable the auto update function.</td> |
89 <td>Public method to enable the auto update function.</td> |
90 </tr><tr> |
90 </tr><tr> |
91 <td><a href="#VcsStatusMonitorThread.setInterval">setInterval</a></td> |
91 <td><a href="#VcsStatusMonitorThread.setInterval">setInterval</a></td> |
92 <td>Public method to change the monitor interval.</td> |
92 <td>Public method to change the monitor interval.</td> |
93 </tr><tr> |
93 </tr><tr> |
94 <td><a href="#VcsStatusMonitorThread.stop">stop</a></td> |
94 <td><a href="#VcsStatusMonitorThread.stop">stop</a></td> |
95 <td>Public method to stop the monitor thread.</td> |
95 <td>Public method to stop the monitor thread.</td> |
96 </tr> |
96 </tr> |
97 </table> |
97 </table> |
98 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a> |
98 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a> |
99 <h4>VcsStatusMonitorThread (Constructor)</h4> |
99 <h4>VcsStatusMonitorThread (Constructor)</h4> |
100 <b>VcsStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>) |
100 <b>VcsStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>) |
101 <p> |
101 <p> |
102 Constructor |
102 Constructor |
103 </p><dl> |
103 </p><dl> |
104 <dt><i>interval</i></dt> |
104 <dt><i>interval</i></dt> |
105 <dd> |
105 <dd> |
106 new interval in seconds (integer) |
106 new interval in seconds (integer) |
107 </dd><dt><i>projectDir</i></dt> |
107 </dd><dt><i>projectDir</i></dt> |
108 <dd> |
108 <dd> |
109 project directory to monitor (string) |
109 project directory to monitor (string) |
110 </dd><dt><i>vcs</i></dt> |
110 </dd><dt><i>vcs</i></dt> |
111 <dd> |
111 <dd> |
112 reference to the version control object |
112 reference to the version control object |
113 </dd><dt><i>parent</i></dt> |
113 </dd><dt><i>parent</i></dt> |
114 <dd> |
114 <dd> |
115 reference to the parent object (QObject) |
115 reference to the parent object (QObject) |
116 </dd> |
116 </dd> |
117 </dl><a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a> |
117 </dl><a NAME="VcsStatusMonitorThread._performMonitor" ID="VcsStatusMonitorThread._performMonitor"></a> |
118 <h4>VcsStatusMonitorThread._performMonitor</h4> |
118 <h4>VcsStatusMonitorThread._performMonitor</h4> |
119 <b>_performMonitor</b>(<i></i>) |
119 <b>_performMonitor</b>(<i></i>) |
120 <p> |
120 <p> |
121 Protected method implementing the real monitoring action. |
121 Protected method implementing the real monitoring action. |
122 </p><p> |
122 </p><p> |
123 This method must be overridden and populate the statusList member variable |
123 This method must be overridden and populate the statusList member variable |
124 with a list of strings giving the status in the first column and the |
124 with a list of strings giving the status in the first column and the |
125 path relative to the project directory starting with the third column. |
125 path relative to the project directory starting with the third column. |
126 The allowed status flags are: |
126 The allowed status flags are: |
127 <ul> |
127 <ul> |
128 <li>"A" path was added but not yet comitted</li> |
128 <li>"A" path was added but not yet comitted</li> |
129 <li>"M" path has local changes</li> |
129 <li>"M" path has local changes</li> |
130 <li>"R" path was deleted and then re-added</li> |
130 <li>"R" path was deleted and then re-added</li> |
131 <li>"U" path needs an update</li> |
131 <li>"U" path needs an update</li> |
132 <li>"Z" path contains a conflict</li> |
132 <li>"Z" path contains a conflict</li> |
133 <li>" " path is back at normal</li> |
133 <li>" " path is back at normal</li> |
134 </ul> |
134 </ul> |
135 </p><dl> |
135 </p><dl> |
136 <dt>Returns:</dt> |
136 <dt>Returns:</dt> |
137 <dd> |
137 <dd> |
138 tuple of flag indicating successful operation (boolean) and |
138 tuple of flag indicating successful operation (boolean) and |
139 a status message in case of non successful operation (QString) |
139 a status message in case of non successful operation (QString) |
140 </dd> |
140 </dd> |
141 </dl><a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a> |
141 </dl><a NAME="VcsStatusMonitorThread.checkStatus" ID="VcsStatusMonitorThread.checkStatus"></a> |
142 <h4>VcsStatusMonitorThread.checkStatus</h4> |
142 <h4>VcsStatusMonitorThread.checkStatus</h4> |
143 <b>checkStatus</b>(<i></i>) |
143 <b>checkStatus</b>(<i></i>) |
144 <p> |
144 <p> |
145 Public method to wake up the status monitor thread. |
145 Public method to wake up the status monitor thread. |
146 </p><a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a> |
146 </p><a NAME="VcsStatusMonitorThread.clearCachedState" ID="VcsStatusMonitorThread.clearCachedState"></a> |
147 <h4>VcsStatusMonitorThread.clearCachedState</h4> |
147 <h4>VcsStatusMonitorThread.clearCachedState</h4> |
148 <b>clearCachedState</b>(<i>name</i>) |
148 <b>clearCachedState</b>(<i>name</i>) |
149 <p> |
149 <p> |
150 Public method to clear the cached VCS state of a file/directory. |
150 Public method to clear the cached VCS state of a file/directory. |
151 </p><dl> |
151 </p><dl> |
152 <dt><i>name</i></dt> |
152 <dt><i>name</i></dt> |
153 <dd> |
153 <dd> |
154 name of the entry to be cleared (string) |
154 name of the entry to be cleared (string) |
155 </dd> |
155 </dd> |
156 </dl><a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> |
156 </dl><a NAME="VcsStatusMonitorThread.getAutoUpdate" ID="VcsStatusMonitorThread.getAutoUpdate"></a> |
157 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> |
157 <h4>VcsStatusMonitorThread.getAutoUpdate</h4> |
158 <b>getAutoUpdate</b>(<i></i>) |
158 <b>getAutoUpdate</b>(<i></i>) |
159 <p> |
159 <p> |
160 Public method to retrieve the status of the auto update function. |
160 Public method to retrieve the status of the auto update function. |
161 </p><dl> |
161 </p><dl> |
162 <dt>Returns:</dt> |
162 <dt>Returns:</dt> |
163 <dd> |
163 <dd> |
164 status of the auto update function (boolean) |
164 status of the auto update function (boolean) |
165 </dd> |
165 </dd> |
166 </dl><a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> |
166 </dl><a NAME="VcsStatusMonitorThread.getInterval" ID="VcsStatusMonitorThread.getInterval"></a> |
167 <h4>VcsStatusMonitorThread.getInterval</h4> |
167 <h4>VcsStatusMonitorThread.getInterval</h4> |
168 <b>getInterval</b>(<i></i>) |
168 <b>getInterval</b>(<i></i>) |
169 <p> |
169 <p> |
170 Public method to get the monitor interval. |
170 Public method to get the monitor interval. |
171 </p><dl> |
171 </p><dl> |
172 <dt>Returns:</dt> |
172 <dt>Returns:</dt> |
173 <dd> |
173 <dd> |
174 interval in seconds (integer) |
174 interval in seconds (integer) |
175 </dd> |
175 </dd> |
176 </dl><a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> |
176 </dl><a NAME="VcsStatusMonitorThread.run" ID="VcsStatusMonitorThread.run"></a> |
177 <h4>VcsStatusMonitorThread.run</h4> |
177 <h4>VcsStatusMonitorThread.run</h4> |
178 <b>run</b>(<i></i>) |
178 <b>run</b>(<i></i>) |
179 <p> |
179 <p> |
180 Protected method implementing the tasks action. |
180 Protected method implementing the tasks action. |
181 </p><a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a> |
181 </p><a NAME="VcsStatusMonitorThread.setAutoUpdate" ID="VcsStatusMonitorThread.setAutoUpdate"></a> |
182 <h4>VcsStatusMonitorThread.setAutoUpdate</h4> |
182 <h4>VcsStatusMonitorThread.setAutoUpdate</h4> |
183 <b>setAutoUpdate</b>(<i>auto</i>) |
183 <b>setAutoUpdate</b>(<i>auto</i>) |
184 <p> |
184 <p> |
185 Public method to enable the auto update function. |
185 Public method to enable the auto update function. |
186 </p><dl> |
186 </p><dl> |
187 <dt><i>auto</i></dt> |
187 <dt><i>auto</i></dt> |
188 <dd> |
188 <dd> |
189 status of the auto update function (boolean) |
189 status of the auto update function (boolean) |
190 </dd> |
190 </dd> |
191 </dl><a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> |
191 </dl><a NAME="VcsStatusMonitorThread.setInterval" ID="VcsStatusMonitorThread.setInterval"></a> |
192 <h4>VcsStatusMonitorThread.setInterval</h4> |
192 <h4>VcsStatusMonitorThread.setInterval</h4> |
193 <b>setInterval</b>(<i>interval</i>) |
193 <b>setInterval</b>(<i>interval</i>) |
194 <p> |
194 <p> |
195 Public method to change the monitor interval. |
195 Public method to change the monitor interval. |
196 </p><dl> |
196 </p><dl> |
197 <dt><i>interval</i></dt> |
197 <dt><i>interval</i></dt> |
198 <dd> |
198 <dd> |
199 new interval in seconds (integer) |
199 new interval in seconds (integer) |
200 </dd> |
200 </dd> |
201 </dl><a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> |
201 </dl><a NAME="VcsStatusMonitorThread.stop" ID="VcsStatusMonitorThread.stop"></a> |
202 <h4>VcsStatusMonitorThread.stop</h4> |
202 <h4>VcsStatusMonitorThread.stop</h4> |
203 <b>stop</b>(<i></i>) |
203 <b>stop</b>(<i></i>) |
204 <p> |
204 <p> |
205 Public method to stop the monitor thread. |
205 Public method to stop the monitor thread. |
206 </p> |
206 </p> |
207 <div align="right"><a href="#top">Up</a></div> |
207 <div align="right"><a href="#top">Up</a></div> |
208 <hr /> |
208 <hr /> |
209 </body></html> |
209 </body></html> |