Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html

Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.html

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

Mercurial Repository: eric

eric ide

mercurial