|
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.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog</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.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to show the output of the svn status command process. |
|
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="#SvnStatusDialog">SvnStatusDialog</a></td> |
|
23 <td>Class implementing a dialog to show the output of the svn status command process.</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="SvnStatusDialog" ID="SvnStatusDialog"></a> |
|
32 <h2>SvnStatusDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to show the output of the svn status command process. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QWidget, Ui_SvnStatusDialog |
|
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="#SvnStatusDialog.__init__">SvnStatusDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SvnStatusDialog.__add">__add</a></td> |
|
49 <td>Private slot to handle the Add context menu entry.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SvnStatusDialog.__addToChangelist">__addToChangelist</a></td> |
|
52 <td>Private slot to add entries to a changelist.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SvnStatusDialog.__breakLock">__breakLock</a></td> |
|
55 <td>Private slot to handle the Break Lock context menu entry.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SvnStatusDialog.__commit">__commit</a></td> |
|
58 <td>Private slot to handle the Commit context menu entry.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SvnStatusDialog.__committed">__committed</a></td> |
|
61 <td>Private slot called after the commit has finished.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SvnStatusDialog.__finish">__finish</a></td> |
|
64 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SvnStatusDialog.__generateItem">__generateItem</a></td> |
|
67 <td>Private method to generate a status item in the status list.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SvnStatusDialog.__getChangelistItems">__getChangelistItems</a></td> |
|
70 <td>Private method to retrieve all entries, that are members of a changelist.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#SvnStatusDialog.__getLockActionItems">__getLockActionItems</a></td> |
|
73 <td>Private method to retrieve all emtries, that have a locked status.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#SvnStatusDialog.__getModifiedItems">__getModifiedItems</a></td> |
|
76 <td>Private method to retrieve all entries, that have a modified status.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#SvnStatusDialog.__getNonChangelistItems">__getNonChangelistItems</a></td> |
|
79 <td>Private method to retrieve all entries, that are not members of a changelist.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#SvnStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td> |
|
82 <td>Private method to retrieve all entries, that have an unversioned status.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#SvnStatusDialog.__lock">__lock</a></td> |
|
85 <td>Private slot to handle the Lock context menu entry.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#SvnStatusDialog.__procFinished">__procFinished</a></td> |
|
88 <td>Private slot connected to the finished signal.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#SvnStatusDialog.__readStderr">__readStderr</a></td> |
|
91 <td>Private slot to handle the readyReadStandardError signal.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#SvnStatusDialog.__readStdout">__readStdout</a></td> |
|
94 <td>Private slot to handle the readyReadStandardOutput signal.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#SvnStatusDialog.__removeFromChangelist">__removeFromChangelist</a></td> |
|
97 <td>Private slot to remove entries from their changelists.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td> |
|
100 <td>Private method to resize the list columns.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#SvnStatusDialog.__resort">__resort</a></td> |
|
103 <td>Private method to resort the tree.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#SvnStatusDialog.__revert">__revert</a></td> |
|
106 <td>Private slot to handle the Revert context menu entry.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#SvnStatusDialog.__showContextMenu">__showContextMenu</a></td> |
|
109 <td>Protected slot to show the context menu of the status list.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#SvnStatusDialog.__stealLock">__stealLock</a></td> |
|
112 <td>Private slot to handle the Break Lock context menu entry.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#SvnStatusDialog.__unlock">__unlock</a></td> |
|
115 <td>Private slot to handle the Unlock context menu entry.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#SvnStatusDialog.closeEvent">closeEvent</a></td> |
|
118 <td>Private slot implementing a close event handler.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#SvnStatusDialog.keyPressEvent">keyPressEvent</a></td> |
|
121 <td>Protected slot to handle a key press event.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#SvnStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
124 <td>Private slot called by a button of the button box clicked.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#SvnStatusDialog.on_input_returnPressed">on_input_returnPressed</a></td> |
|
127 <td>Private slot to handle the press of the return key in the input field.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#SvnStatusDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> |
|
130 <td>Private slot to handle the password checkbox toggled.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#SvnStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
|
133 <td>Private slot to refresh the status display.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#SvnStatusDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> |
|
136 <td>Private slot to send the input to the subversion process.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#SvnStatusDialog.start">start</a></td> |
|
139 <td>Public slot to start the svn status command.</td> |
|
140 </tr> |
|
141 </table> |
|
142 <a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a> |
|
143 <h4>SvnStatusDialog (Constructor)</h4> |
|
144 <b>SvnStatusDialog</b>(<i>vcs, parent = None</i>) |
|
145 <p> |
|
146 Constructor |
|
147 </p><dl> |
|
148 <dt><i>vcs</i></dt> |
|
149 <dd> |
|
150 reference to the vcs object |
|
151 </dd><dt><i>parent</i></dt> |
|
152 <dd> |
|
153 parent widget (QWidget) |
|
154 </dd> |
|
155 </dl><a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a> |
|
156 <h4>SvnStatusDialog.__add</h4> |
|
157 <b>__add</b>(<i></i>) |
|
158 <p> |
|
159 Private slot to handle the Add context menu entry. |
|
160 </p><a NAME="SvnStatusDialog.__addToChangelist" ID="SvnStatusDialog.__addToChangelist"></a> |
|
161 <h4>SvnStatusDialog.__addToChangelist</h4> |
|
162 <b>__addToChangelist</b>(<i></i>) |
|
163 <p> |
|
164 Private slot to add entries to a changelist. |
|
165 </p><a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a> |
|
166 <h4>SvnStatusDialog.__breakLock</h4> |
|
167 <b>__breakLock</b>(<i></i>) |
|
168 <p> |
|
169 Private slot to handle the Break Lock context menu entry. |
|
170 </p><a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a> |
|
171 <h4>SvnStatusDialog.__commit</h4> |
|
172 <b>__commit</b>(<i></i>) |
|
173 <p> |
|
174 Private slot to handle the Commit context menu entry. |
|
175 </p><a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a> |
|
176 <h4>SvnStatusDialog.__committed</h4> |
|
177 <b>__committed</b>(<i></i>) |
|
178 <p> |
|
179 Private slot called after the commit has finished. |
|
180 </p><a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a> |
|
181 <h4>SvnStatusDialog.__finish</h4> |
|
182 <b>__finish</b>(<i></i>) |
|
183 <p> |
|
184 Private slot called when the process finished or the user pressed the button. |
|
185 </p><a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a> |
|
186 <h4>SvnStatusDialog.__generateItem</h4> |
|
187 <b>__generateItem</b>(<i>status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path</i>) |
|
188 <p> |
|
189 Private method to generate a status item in the status list. |
|
190 </p><dl> |
|
191 <dt><i>status</i></dt> |
|
192 <dd> |
|
193 status indicator (string) |
|
194 </dd><dt><i>propStatus</i></dt> |
|
195 <dd> |
|
196 property status indicator (string) |
|
197 </dd><dt><i>locked</i></dt> |
|
198 <dd> |
|
199 locked indicator (string) |
|
200 </dd><dt><i>history</i></dt> |
|
201 <dd> |
|
202 history indicator (string) |
|
203 </dd><dt><i>switched</i></dt> |
|
204 <dd> |
|
205 switched indicator (string) |
|
206 </dd><dt><i>lockinfo</i></dt> |
|
207 <dd> |
|
208 lock indicator (string) |
|
209 </dd><dt><i>uptodate</i></dt> |
|
210 <dd> |
|
211 up to date indicator (string) |
|
212 </dd><dt><i>revision</i></dt> |
|
213 <dd> |
|
214 revision string (string) |
|
215 </dd><dt><i>change</i></dt> |
|
216 <dd> |
|
217 revision of last change (string) |
|
218 </dd><dt><i>author</i></dt> |
|
219 <dd> |
|
220 author of the last change (string) |
|
221 </dd><dt><i>path</i></dt> |
|
222 <dd> |
|
223 path of the file or directory (string) |
|
224 </dd> |
|
225 </dl><a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a> |
|
226 <h4>SvnStatusDialog.__getChangelistItems</h4> |
|
227 <b>__getChangelistItems</b>(<i></i>) |
|
228 <p> |
|
229 Private method to retrieve all entries, that are members of a changelist. |
|
230 </p><dl> |
|
231 <dt>Returns:</dt> |
|
232 <dd> |
|
233 list of all items belonging to a changelist |
|
234 </dd> |
|
235 </dl><a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a> |
|
236 <h4>SvnStatusDialog.__getLockActionItems</h4> |
|
237 <b>__getLockActionItems</b>(<i>indicators</i>) |
|
238 <p> |
|
239 Private method to retrieve all emtries, that have a locked status. |
|
240 </p><dl> |
|
241 <dt>Returns:</dt> |
|
242 <dd> |
|
243 list of all items with a locked status |
|
244 </dd> |
|
245 </dl><a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a> |
|
246 <h4>SvnStatusDialog.__getModifiedItems</h4> |
|
247 <b>__getModifiedItems</b>(<i></i>) |
|
248 <p> |
|
249 Private method to retrieve all entries, that have a modified status. |
|
250 </p><dl> |
|
251 <dt>Returns:</dt> |
|
252 <dd> |
|
253 list of all items with a modified status |
|
254 </dd> |
|
255 </dl><a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a> |
|
256 <h4>SvnStatusDialog.__getNonChangelistItems</h4> |
|
257 <b>__getNonChangelistItems</b>(<i></i>) |
|
258 <p> |
|
259 Private method to retrieve all entries, that are not members of a changelist. |
|
260 </p><dl> |
|
261 <dt>Returns:</dt> |
|
262 <dd> |
|
263 list of all items not belonging to a changelist |
|
264 </dd> |
|
265 </dl><a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a> |
|
266 <h4>SvnStatusDialog.__getUnversionedItems</h4> |
|
267 <b>__getUnversionedItems</b>(<i></i>) |
|
268 <p> |
|
269 Private method to retrieve all entries, that have an unversioned status. |
|
270 </p><dl> |
|
271 <dt>Returns:</dt> |
|
272 <dd> |
|
273 list of all items with an unversioned status |
|
274 </dd> |
|
275 </dl><a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a> |
|
276 <h4>SvnStatusDialog.__lock</h4> |
|
277 <b>__lock</b>(<i></i>) |
|
278 <p> |
|
279 Private slot to handle the Lock context menu entry. |
|
280 </p><a NAME="SvnStatusDialog.__procFinished" ID="SvnStatusDialog.__procFinished"></a> |
|
281 <h4>SvnStatusDialog.__procFinished</h4> |
|
282 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
283 <p> |
|
284 Private slot connected to the finished signal. |
|
285 </p><dl> |
|
286 <dt><i>exitCode</i></dt> |
|
287 <dd> |
|
288 exit code of the process (integer) |
|
289 </dd><dt><i>exitStatus</i></dt> |
|
290 <dd> |
|
291 exit status of the process (QProcess.ExitStatus) |
|
292 </dd> |
|
293 </dl><a NAME="SvnStatusDialog.__readStderr" ID="SvnStatusDialog.__readStderr"></a> |
|
294 <h4>SvnStatusDialog.__readStderr</h4> |
|
295 <b>__readStderr</b>(<i></i>) |
|
296 <p> |
|
297 Private slot to handle the readyReadStandardError signal. |
|
298 </p><p> |
|
299 It reads the error output of the process and inserts it into the |
|
300 error pane. |
|
301 </p><a NAME="SvnStatusDialog.__readStdout" ID="SvnStatusDialog.__readStdout"></a> |
|
302 <h4>SvnStatusDialog.__readStdout</h4> |
|
303 <b>__readStdout</b>(<i></i>) |
|
304 <p> |
|
305 Private slot to handle the readyReadStandardOutput signal. |
|
306 </p><p> |
|
307 It reads the output of the process, formats it and inserts it into |
|
308 the contents pane. |
|
309 </p><a NAME="SvnStatusDialog.__removeFromChangelist" ID="SvnStatusDialog.__removeFromChangelist"></a> |
|
310 <h4>SvnStatusDialog.__removeFromChangelist</h4> |
|
311 <b>__removeFromChangelist</b>(<i></i>) |
|
312 <p> |
|
313 Private slot to remove entries from their changelists. |
|
314 </p><a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a> |
|
315 <h4>SvnStatusDialog.__resizeColumns</h4> |
|
316 <b>__resizeColumns</b>(<i></i>) |
|
317 <p> |
|
318 Private method to resize the list columns. |
|
319 </p><a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a> |
|
320 <h4>SvnStatusDialog.__resort</h4> |
|
321 <b>__resort</b>(<i></i>) |
|
322 <p> |
|
323 Private method to resort the tree. |
|
324 </p><a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a> |
|
325 <h4>SvnStatusDialog.__revert</h4> |
|
326 <b>__revert</b>(<i></i>) |
|
327 <p> |
|
328 Private slot to handle the Revert context menu entry. |
|
329 </p><a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a> |
|
330 <h4>SvnStatusDialog.__showContextMenu</h4> |
|
331 <b>__showContextMenu</b>(<i>coord</i>) |
|
332 <p> |
|
333 Protected slot to show the context menu of the status list. |
|
334 </p><dl> |
|
335 <dt><i>coord</i></dt> |
|
336 <dd> |
|
337 the position of the mouse pointer (QPoint) |
|
338 </dd> |
|
339 </dl><a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a> |
|
340 <h4>SvnStatusDialog.__stealLock</h4> |
|
341 <b>__stealLock</b>(<i></i>) |
|
342 <p> |
|
343 Private slot to handle the Break Lock context menu entry. |
|
344 </p><a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a> |
|
345 <h4>SvnStatusDialog.__unlock</h4> |
|
346 <b>__unlock</b>(<i></i>) |
|
347 <p> |
|
348 Private slot to handle the Unlock context menu entry. |
|
349 </p><a NAME="SvnStatusDialog.closeEvent" ID="SvnStatusDialog.closeEvent"></a> |
|
350 <h4>SvnStatusDialog.closeEvent</h4> |
|
351 <b>closeEvent</b>(<i>e</i>) |
|
352 <p> |
|
353 Private slot implementing a close event handler. |
|
354 </p><dl> |
|
355 <dt><i>e</i></dt> |
|
356 <dd> |
|
357 close event (QCloseEvent) |
|
358 </dd> |
|
359 </dl><a NAME="SvnStatusDialog.keyPressEvent" ID="SvnStatusDialog.keyPressEvent"></a> |
|
360 <h4>SvnStatusDialog.keyPressEvent</h4> |
|
361 <b>keyPressEvent</b>(<i>evt</i>) |
|
362 <p> |
|
363 Protected slot to handle a key press event. |
|
364 </p><dl> |
|
365 <dt><i>evt</i></dt> |
|
366 <dd> |
|
367 the key press event (QKeyEvent) |
|
368 </dd> |
|
369 </dl><a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a> |
|
370 <h4>SvnStatusDialog.on_buttonBox_clicked</h4> |
|
371 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
372 <p> |
|
373 Private slot called by a button of the button box clicked. |
|
374 </p><dl> |
|
375 <dt><i>button</i></dt> |
|
376 <dd> |
|
377 button that was clicked (QAbstractButton) |
|
378 </dd> |
|
379 </dl><a NAME="SvnStatusDialog.on_input_returnPressed" ID="SvnStatusDialog.on_input_returnPressed"></a> |
|
380 <h4>SvnStatusDialog.on_input_returnPressed</h4> |
|
381 <b>on_input_returnPressed</b>(<i></i>) |
|
382 <p> |
|
383 Private slot to handle the press of the return key in the input field. |
|
384 </p><a NAME="SvnStatusDialog.on_passwordCheckBox_toggled" ID="SvnStatusDialog.on_passwordCheckBox_toggled"></a> |
|
385 <h4>SvnStatusDialog.on_passwordCheckBox_toggled</h4> |
|
386 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) |
|
387 <p> |
|
388 Private slot to handle the password checkbox toggled. |
|
389 </p><dl> |
|
390 <dt><i>isOn</i></dt> |
|
391 <dd> |
|
392 flag indicating the status of the check box (boolean) |
|
393 </dd> |
|
394 </dl><a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a> |
|
395 <h4>SvnStatusDialog.on_refreshButton_clicked</h4> |
|
396 <b>on_refreshButton_clicked</b>(<i></i>) |
|
397 <p> |
|
398 Private slot to refresh the status display. |
|
399 </p><a NAME="SvnStatusDialog.on_sendButton_clicked" ID="SvnStatusDialog.on_sendButton_clicked"></a> |
|
400 <h4>SvnStatusDialog.on_sendButton_clicked</h4> |
|
401 <b>on_sendButton_clicked</b>(<i></i>) |
|
402 <p> |
|
403 Private slot to send the input to the subversion process. |
|
404 </p><a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a> |
|
405 <h4>SvnStatusDialog.start</h4> |
|
406 <b>start</b>(<i>fn</i>) |
|
407 <p> |
|
408 Public slot to start the svn status command. |
|
409 </p><dl> |
|
410 <dt><i>fn</i></dt> |
|
411 <dd> |
|
412 filename(s)/directoryname(s) to show the status of |
|
413 (string or list of strings) |
|
414 </dd> |
|
415 </dl> |
|
416 <div align="right"><a href="#top">Up</a></div> |
|
417 <hr /> |
|
418 </body></html> |