Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Plugins.VcsPlugins.vcsPySvn.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.vcsPySvn.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.vcsPySvn.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, SvnDialogMixin, 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 entries, 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.__removeFromChangelist">__removeFromChangelist</a></td>
100 <td>Private slot to remove entries from their changelists.</td>
101 </tr><tr>
102 <td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td>
103 <td>Private method to resize the list columns.</td>
104 </tr><tr>
105 <td><a href="#SvnStatusDialog.__resort">__resort</a></td>
106 <td>Private method to resort the tree.</td>
107 </tr><tr>
108 <td><a href="#SvnStatusDialog.__revert">__revert</a></td>
109 <td>Private slot to handle the Revert context menu entry.</td>
110 </tr><tr>
111 <td><a href="#SvnStatusDialog.__showContextMenu">__showContextMenu</a></td>
112 <td>Protected slot to show the context menu of the status list.</td>
113 </tr><tr>
114 <td><a href="#SvnStatusDialog.__showError">__showError</a></td>
115 <td>Private slot to show an error message.</td>
116 </tr><tr>
117 <td><a href="#SvnStatusDialog.__stealLock">__stealLock</a></td>
118 <td>Private slot to handle the Break Lock context menu entry.</td>
119 </tr><tr>
120 <td><a href="#SvnStatusDialog.__unlock">__unlock</a></td>
121 <td>Private slot to handle the Unlock context menu entry.</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_refreshButton_clicked">on_refreshButton_clicked</a></td>
127 <td>Private slot to refresh the status display.</td>
128 </tr><tr>
129 <td><a href="#SvnStatusDialog.start">start</a></td>
130 <td>Public slot to start the svn status command.</td>
131 </tr>
132 </table>
133 <a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a>
134 <h4>SvnStatusDialog (Constructor)</h4>
135 <b>SvnStatusDialog</b>(<i>vcs, parent = None</i>)
136 <p>
137 Constructor
138 </p><dl>
139 <dt><i>vcs</i></dt>
140 <dd>
141 reference to the vcs object
142 </dd><dt><i>parent</i></dt>
143 <dd>
144 parent widget (QWidget)
145 </dd>
146 </dl><a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a>
147 <h4>SvnStatusDialog.__add</h4>
148 <b>__add</b>(<i></i>)
149 <p>
150 Private slot to handle the Add context menu entry.
151 </p><a NAME="SvnStatusDialog.__addToChangelist" ID="SvnStatusDialog.__addToChangelist"></a>
152 <h4>SvnStatusDialog.__addToChangelist</h4>
153 <b>__addToChangelist</b>(<i></i>)
154 <p>
155 Private slot to add entries to a changelist.
156 </p><a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a>
157 <h4>SvnStatusDialog.__breakLock</h4>
158 <b>__breakLock</b>(<i></i>)
159 <p>
160 Private slot to handle the Break Lock context menu entry.
161 </p><a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a>
162 <h4>SvnStatusDialog.__commit</h4>
163 <b>__commit</b>(<i></i>)
164 <p>
165 Private slot to handle the Commit context menu entry.
166 </p><a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a>
167 <h4>SvnStatusDialog.__committed</h4>
168 <b>__committed</b>(<i></i>)
169 <p>
170 Private slot called after the commit has finished.
171 </p><a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a>
172 <h4>SvnStatusDialog.__finish</h4>
173 <b>__finish</b>(<i></i>)
174 <p>
175 Private slot called when the process finished or the user pressed the button.
176 </p><a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a>
177 <h4>SvnStatusDialog.__generateItem</h4>
178 <b>__generateItem</b>(<i>changelist, status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path</i>)
179 <p>
180 Private method to generate a status item in the status list.
181 </p><dl>
182 <dt><i>changelist</i></dt>
183 <dd>
184 name of the changelist (string)
185 </dd><dt><i>status</i></dt>
186 <dd>
187 text status (pysvn.wc_status_kind)
188 </dd><dt><i>propStatus</i></dt>
189 <dd>
190 property status (pysvn.wc_status_kind)
191 </dd><dt><i>locked</i></dt>
192 <dd>
193 locked flag (boolean)
194 </dd><dt><i>history</i></dt>
195 <dd>
196 history flag (boolean)
197 </dd><dt><i>switched</i></dt>
198 <dd>
199 switched flag (boolean)
200 </dd><dt><i>lockinfo</i></dt>
201 <dd>
202 lock indicator (string)
203 </dd><dt><i>uptodate</i></dt>
204 <dd>
205 up to date flag (boolean)
206 </dd><dt><i>revision</i></dt>
207 <dd>
208 revision (integer)
209 </dd><dt><i>change</i></dt>
210 <dd>
211 revision of last change (integer)
212 </dd><dt><i>author</i></dt>
213 <dd>
214 author of the last change (string)
215 </dd><dt><i>path</i></dt>
216 <dd>
217 path of the file or directory (string)
218 </dd>
219 </dl><a NAME="SvnStatusDialog.__getChangelistItems" ID="SvnStatusDialog.__getChangelistItems"></a>
220 <h4>SvnStatusDialog.__getChangelistItems</h4>
221 <b>__getChangelistItems</b>(<i></i>)
222 <p>
223 Private method to retrieve all entries, that are members of a changelist.
224 </p><dl>
225 <dt>Returns:</dt>
226 <dd>
227 list of all items belonging to a changelist
228 </dd>
229 </dl><a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a>
230 <h4>SvnStatusDialog.__getLockActionItems</h4>
231 <b>__getLockActionItems</b>(<i>indicators</i>)
232 <p>
233 Private method to retrieve all entries, that have a locked status.
234 </p><dl>
235 <dt>Returns:</dt>
236 <dd>
237 list of all items with a locked status
238 </dd>
239 </dl><a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a>
240 <h4>SvnStatusDialog.__getModifiedItems</h4>
241 <b>__getModifiedItems</b>(<i></i>)
242 <p>
243 Private method to retrieve all entries, that have a modified status.
244 </p><dl>
245 <dt>Returns:</dt>
246 <dd>
247 list of all items with a modified status
248 </dd>
249 </dl><a NAME="SvnStatusDialog.__getNonChangelistItems" ID="SvnStatusDialog.__getNonChangelistItems"></a>
250 <h4>SvnStatusDialog.__getNonChangelistItems</h4>
251 <b>__getNonChangelistItems</b>(<i></i>)
252 <p>
253 Private method to retrieve all entries, that are not members of a changelist.
254 </p><dl>
255 <dt>Returns:</dt>
256 <dd>
257 list of all items not belonging to a changelist
258 </dd>
259 </dl><a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a>
260 <h4>SvnStatusDialog.__getUnversionedItems</h4>
261 <b>__getUnversionedItems</b>(<i></i>)
262 <p>
263 Private method to retrieve all entries, that have an unversioned status.
264 </p><dl>
265 <dt>Returns:</dt>
266 <dd>
267 list of all items with an unversioned status
268 </dd>
269 </dl><a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a>
270 <h4>SvnStatusDialog.__lock</h4>
271 <b>__lock</b>(<i></i>)
272 <p>
273 Private slot to handle the Lock context menu entry.
274 </p><a NAME="SvnStatusDialog.__removeFromChangelist" ID="SvnStatusDialog.__removeFromChangelist"></a>
275 <h4>SvnStatusDialog.__removeFromChangelist</h4>
276 <b>__removeFromChangelist</b>(<i></i>)
277 <p>
278 Private slot to remove entries from their changelists.
279 </p><a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a>
280 <h4>SvnStatusDialog.__resizeColumns</h4>
281 <b>__resizeColumns</b>(<i></i>)
282 <p>
283 Private method to resize the list columns.
284 </p><a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a>
285 <h4>SvnStatusDialog.__resort</h4>
286 <b>__resort</b>(<i></i>)
287 <p>
288 Private method to resort the tree.
289 </p><a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a>
290 <h4>SvnStatusDialog.__revert</h4>
291 <b>__revert</b>(<i></i>)
292 <p>
293 Private slot to handle the Revert context menu entry.
294 </p><a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a>
295 <h4>SvnStatusDialog.__showContextMenu</h4>
296 <b>__showContextMenu</b>(<i>coord</i>)
297 <p>
298 Protected slot to show the context menu of the status list.
299 </p><dl>
300 <dt><i>coord</i></dt>
301 <dd>
302 the position of the mouse pointer (QPoint)
303 </dd>
304 </dl><a NAME="SvnStatusDialog.__showError" ID="SvnStatusDialog.__showError"></a>
305 <h4>SvnStatusDialog.__showError</h4>
306 <b>__showError</b>(<i>msg</i>)
307 <p>
308 Private slot to show an error message.
309 </p><dl>
310 <dt><i>msg</i></dt>
311 <dd>
312 error message to show (string)
313 </dd>
314 </dl><a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a>
315 <h4>SvnStatusDialog.__stealLock</h4>
316 <b>__stealLock</b>(<i></i>)
317 <p>
318 Private slot to handle the Break Lock context menu entry.
319 </p><a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a>
320 <h4>SvnStatusDialog.__unlock</h4>
321 <b>__unlock</b>(<i></i>)
322 <p>
323 Private slot to handle the Unlock context menu entry.
324 </p><a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a>
325 <h4>SvnStatusDialog.on_buttonBox_clicked</h4>
326 <b>on_buttonBox_clicked</b>(<i>button</i>)
327 <p>
328 Private slot called by a button of the button box clicked.
329 </p><dl>
330 <dt><i>button</i></dt>
331 <dd>
332 button that was clicked (QAbstractButton)
333 </dd>
334 </dl><a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a>
335 <h4>SvnStatusDialog.on_refreshButton_clicked</h4>
336 <b>on_refreshButton_clicked</b>(<i></i>)
337 <p>
338 Private slot to refresh the status display.
339 </p><a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a>
340 <h4>SvnStatusDialog.start</h4>
341 <b>start</b>(<i>fn</i>)
342 <p>
343 Public slot to start the svn status command.
344 </p><dl>
345 <dt><i>fn</i></dt>
346 <dd>
347 filename(s)/directoryname(s) to show the status of
348 (string or list of strings)
349 </dd>
350 </dl>
351 <div align="right"><a href="#top">Up</a></div>
352 <hr />
353 </body></html>

Mercurial Repository: eric

eric ide

mercurial