~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.VCS.vcsPySvn.SvnStatusDialog.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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.VCS.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.VCS.vcsPySvn.SvnStatusDialog</h1>
 
24
<p>
 
25
Module implementing a dialog to show the output of the svn status command process.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#SvnStatusDialog">SvnStatusDialog</a></td>
 
31
<td>Module implementing a dialog to show the output of the svn status command process.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="SvnStatusDialog" ID="SvnStatusDialog"></a>
 
40
<h2>SvnStatusDialog</h2>
 
41
<p>
 
42
    Module implementing a dialog to show the output of the svn status command process.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
QWidget, SvnDialogMixin, Ui_SvnStatusDialog
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#SvnStatusDialog.__init__">SvnStatusDialog</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#SvnStatusDialog.__add">__add</a></td>
 
53
<td>Private slot to handle the Add context menu entry.</td>
 
54
</tr><tr>
 
55
<td><a href="#SvnStatusDialog.__breakLock">__breakLock</a></td>
 
56
<td>Private slot to handle the Break Lock context menu entry.</td>
 
57
</tr><tr>
 
58
<td><a href="#SvnStatusDialog.__commit">__commit</a></td>
 
59
<td>Private slot to handle the Commit context menu entry.</td>
 
60
</tr><tr>
 
61
<td><a href="#SvnStatusDialog.__committed">__committed</a></td>
 
62
<td>Private slot called after the commit has finished.</td>
 
63
</tr><tr>
 
64
<td><a href="#SvnStatusDialog.__finish">__finish</a></td>
 
65
<td>Private slot called when the process finished or the user pressed the button.</td>
 
66
</tr><tr>
 
67
<td><a href="#SvnStatusDialog.__generateItem">__generateItem</a></td>
 
68
<td>Private method to generate a status item in the status list.</td>
 
69
</tr><tr>
 
70
<td><a href="#SvnStatusDialog.__getLockActionItems">__getLockActionItems</a></td>
 
71
<td>Private method to retrieve all emtries, that have a locked status.</td>
 
72
</tr><tr>
 
73
<td><a href="#SvnStatusDialog.__getModifiedItems">__getModifiedItems</a></td>
 
74
<td>Private method to retrieve all entries, that have a modified status.</td>
 
75
</tr><tr>
 
76
<td><a href="#SvnStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td>
 
77
<td>Private method to retrieve all entries, that have an unversioned status.</td>
 
78
</tr><tr>
 
79
<td><a href="#SvnStatusDialog.__lock">__lock</a></td>
 
80
<td>Private slot to handle the Lock context menu entry.</td>
 
81
</tr><tr>
 
82
<td><a href="#SvnStatusDialog.__resizeColumns">__resizeColumns</a></td>
 
83
<td>Private method to resize the list columns.</td>
 
84
</tr><tr>
 
85
<td><a href="#SvnStatusDialog.__resort">__resort</a></td>
 
86
<td>Private method to resort the tree.</td>
 
87
</tr><tr>
 
88
<td><a href="#SvnStatusDialog.__revert">__revert</a></td>
 
89
<td>Private slot to handle the Revert context menu entry.</td>
 
90
</tr><tr>
 
91
<td><a href="#SvnStatusDialog.__showContextMenu">__showContextMenu</a></td>
 
92
<td>Protected slot to show the context menu of the status list.</td>
 
93
</tr><tr>
 
94
<td><a href="#SvnStatusDialog.__showError">__showError</a></td>
 
95
<td>Private slot to show an error message.</td>
 
96
</tr><tr>
 
97
<td><a href="#SvnStatusDialog.__stealLock">__stealLock</a></td>
 
98
<td>Private slot to handle the Break Lock context menu entry.</td>
 
99
</tr><tr>
 
100
<td><a href="#SvnStatusDialog.__unlock">__unlock</a></td>
 
101
<td>Private slot to handle the Unlock context menu entry.</td>
 
102
</tr><tr>
 
103
<td><a href="#SvnStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 
104
<td>Private slot called by a button of the button box clicked.</td>
 
105
</tr><tr>
 
106
<td><a href="#SvnStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
 
107
<td>Private slot to refresh the status display.</td>
 
108
</tr><tr>
 
109
<td><a href="#SvnStatusDialog.start">start</a></td>
 
110
<td>Public slot to start the svn status command.</td>
 
111
</tr>
 
112
</table>
 
113
<p><a NAME="SvnStatusDialog.__init__" ID="SvnStatusDialog.__init__"></a>
 
114
<h4>SvnStatusDialog (Constructor)</h4>
 
115
<b>SvnStatusDialog</b>(<i>vcs, parent = None</i>)
 
116
<p>
 
117
        Constructor
 
118
</p><dl>
 
119
<dt><i>vcs</i></dt>
 
120
<dd>
 
121
reference to the vcs object
 
122
</dd><dt><i>parent</i></dt>
 
123
<dd>
 
124
parent widget (QWidget)
 
125
</dd>
 
126
</dl><a NAME="SvnStatusDialog.__add" ID="SvnStatusDialog.__add"></a>
 
127
<h4>SvnStatusDialog.__add</h4>
 
128
<b>__add</b>(<i></i>)
 
129
<p>
 
130
        Private slot to handle the Add context menu entry.
 
131
</p><a NAME="SvnStatusDialog.__breakLock" ID="SvnStatusDialog.__breakLock"></a>
 
132
<h4>SvnStatusDialog.__breakLock</h4>
 
133
<b>__breakLock</b>(<i></i>)
 
134
<p>
 
135
        Private slot to handle the Break Lock context menu entry.
 
136
</p><a NAME="SvnStatusDialog.__commit" ID="SvnStatusDialog.__commit"></a>
 
137
<h4>SvnStatusDialog.__commit</h4>
 
138
<b>__commit</b>(<i></i>)
 
139
<p>
 
140
        Private slot to handle the Commit context menu entry.
 
141
</p><a NAME="SvnStatusDialog.__committed" ID="SvnStatusDialog.__committed"></a>
 
142
<h4>SvnStatusDialog.__committed</h4>
 
143
<b>__committed</b>(<i></i>)
 
144
<p>
 
145
        Private slot called after the commit has finished.
 
146
</p><a NAME="SvnStatusDialog.__finish" ID="SvnStatusDialog.__finish"></a>
 
147
<h4>SvnStatusDialog.__finish</h4>
 
148
<b>__finish</b>(<i></i>)
 
149
<p>
 
150
        Private slot called when the process finished or the user pressed the button.
 
151
</p><a NAME="SvnStatusDialog.__generateItem" ID="SvnStatusDialog.__generateItem"></a>
 
152
<h4>SvnStatusDialog.__generateItem</h4>
 
153
<b>__generateItem</b>(<i>status, propStatus, locked, history, switched, lockinfo, uptodate, revision, change, author, path</i>)
 
154
<p>
 
155
        Private method to generate a status item in the status list.
 
156
</p><dl>
 
157
<dt><i>status</i></dt>
 
158
<dd>
 
159
text status (pysvn.wc_status_kind)
 
160
</dd><dt><i>propStatus</i></dt>
 
161
<dd>
 
162
property status (pysvn.wc_status_kind)
 
163
</dd><dt><i>locked</i></dt>
 
164
<dd>
 
165
locked flag (boolean)
 
166
</dd><dt><i>history</i></dt>
 
167
<dd>
 
168
history flag (boolean)
 
169
</dd><dt><i>switched</i></dt>
 
170
<dd>
 
171
switched flag (boolean)
 
172
</dd><dt><i>lockinfo</i></dt>
 
173
<dd>
 
174
lock indicator (string)
 
175
</dd><dt><i>uptodate</i></dt>
 
176
<dd>
 
177
up to date flag (boolean)
 
178
</dd><dt><i>revision</i></dt>
 
179
<dd>
 
180
revision (integer)
 
181
</dd><dt><i>change</i></dt>
 
182
<dd>
 
183
revision of last change (integer)
 
184
</dd><dt><i>author</i></dt>
 
185
<dd>
 
186
author of the last change (string or QString)
 
187
</dd><dt><i>path</i></dt>
 
188
<dd>
 
189
path of the file or directory (string or QString)
 
190
</dd>
 
191
</dl><a NAME="SvnStatusDialog.__getLockActionItems" ID="SvnStatusDialog.__getLockActionItems"></a>
 
192
<h4>SvnStatusDialog.__getLockActionItems</h4>
 
193
<b>__getLockActionItems</b>(<i>indicators</i>)
 
194
<p>
 
195
        Private method to retrieve all emtries, that have a locked status.
 
196
</p><dl>
 
197
<dt>Returns:</dt>
 
198
<dd>
 
199
list of all items with a locked status
 
200
</dd>
 
201
</dl><a NAME="SvnStatusDialog.__getModifiedItems" ID="SvnStatusDialog.__getModifiedItems"></a>
 
202
<h4>SvnStatusDialog.__getModifiedItems</h4>
 
203
<b>__getModifiedItems</b>(<i></i>)
 
204
<p>
 
205
        Private method to retrieve all entries, that have a modified status.
 
206
</p><dl>
 
207
<dt>Returns:</dt>
 
208
<dd>
 
209
list of all items with a modified status
 
210
</dd>
 
211
</dl><a NAME="SvnStatusDialog.__getUnversionedItems" ID="SvnStatusDialog.__getUnversionedItems"></a>
 
212
<h4>SvnStatusDialog.__getUnversionedItems</h4>
 
213
<b>__getUnversionedItems</b>(<i></i>)
 
214
<p>
 
215
        Private method to retrieve all entries, that have an unversioned status.
 
216
</p><dl>
 
217
<dt>Returns:</dt>
 
218
<dd>
 
219
list of all items with an unversioned status
 
220
</dd>
 
221
</dl><a NAME="SvnStatusDialog.__lock" ID="SvnStatusDialog.__lock"></a>
 
222
<h4>SvnStatusDialog.__lock</h4>
 
223
<b>__lock</b>(<i></i>)
 
224
<p>
 
225
        Private slot to handle the Lock context menu entry.
 
226
</p><a NAME="SvnStatusDialog.__resizeColumns" ID="SvnStatusDialog.__resizeColumns"></a>
 
227
<h4>SvnStatusDialog.__resizeColumns</h4>
 
228
<b>__resizeColumns</b>(<i></i>)
 
229
<p>
 
230
        Private method to resize the list columns.
 
231
</p><a NAME="SvnStatusDialog.__resort" ID="SvnStatusDialog.__resort"></a>
 
232
<h4>SvnStatusDialog.__resort</h4>
 
233
<b>__resort</b>(<i></i>)
 
234
<p>
 
235
        Private method to resort the tree.
 
236
</p><a NAME="SvnStatusDialog.__revert" ID="SvnStatusDialog.__revert"></a>
 
237
<h4>SvnStatusDialog.__revert</h4>
 
238
<b>__revert</b>(<i></i>)
 
239
<p>
 
240
        Private slot to handle the Revert context menu entry.
 
241
</p><a NAME="SvnStatusDialog.__showContextMenu" ID="SvnStatusDialog.__showContextMenu"></a>
 
242
<h4>SvnStatusDialog.__showContextMenu</h4>
 
243
<b>__showContextMenu</b>(<i>coord</i>)
 
244
<p>
 
245
        Protected slot to show the context menu of the status list.
 
246
</p><dl>
 
247
<dt><i>coord</i></dt>
 
248
<dd>
 
249
the position of the mouse pointer (QPoint)
 
250
</dd>
 
251
</dl><a NAME="SvnStatusDialog.__showError" ID="SvnStatusDialog.__showError"></a>
 
252
<h4>SvnStatusDialog.__showError</h4>
 
253
<b>__showError</b>(<i>msg</i>)
 
254
<p>
 
255
        Private slot to show an error message.
 
256
</p><dl>
 
257
<dt><i>msg</i></dt>
 
258
<dd>
 
259
error message to show (string or QString)
 
260
</dd>
 
261
</dl><a NAME="SvnStatusDialog.__stealLock" ID="SvnStatusDialog.__stealLock"></a>
 
262
<h4>SvnStatusDialog.__stealLock</h4>
 
263
<b>__stealLock</b>(<i></i>)
 
264
<p>
 
265
        Private slot to handle the Break Lock context menu entry.
 
266
</p><a NAME="SvnStatusDialog.__unlock" ID="SvnStatusDialog.__unlock"></a>
 
267
<h4>SvnStatusDialog.__unlock</h4>
 
268
<b>__unlock</b>(<i></i>)
 
269
<p>
 
270
        Private slot to handle the Unlock context menu entry.
 
271
</p><a NAME="SvnStatusDialog.on_buttonBox_clicked" ID="SvnStatusDialog.on_buttonBox_clicked"></a>
 
272
<h4>SvnStatusDialog.on_buttonBox_clicked</h4>
 
273
<b>on_buttonBox_clicked</b>(<i>button</i>)
 
274
<p>
 
275
        Private slot called by a button of the button box clicked.
 
276
</p><dl>
 
277
<dt><i>button</i></dt>
 
278
<dd>
 
279
button that was clicked (QAbstractButton)
 
280
</dd>
 
281
</dl><a NAME="SvnStatusDialog.on_refreshButton_clicked" ID="SvnStatusDialog.on_refreshButton_clicked"></a>
 
282
<h4>SvnStatusDialog.on_refreshButton_clicked</h4>
 
283
<b>on_refreshButton_clicked</b>(<i></i>)
 
284
<p>
 
285
        Private slot to refresh the status display.
 
286
</p><a NAME="SvnStatusDialog.start" ID="SvnStatusDialog.start"></a>
 
287
<h4>SvnStatusDialog.start</h4>
 
288
<b>start</b>(<i>fn</i>)
 
289
<p>
 
290
        Public slot to start the svn status command.
 
291
</p><dl>
 
292
<dt><i>fn</i></dt>
 
293
<dd>
 
294
filename(s)/directoryname(s) to show the status of
 
295
            (string or list of strings)
 
296
</dd>
 
297
</dl></p>
 
298
<div align="right"><a href="#top">Up</a></div>
 
299
<hr />
 
300
</body></html>
 
 
b'\\ No newline at end of file'