Documentation/Source/eric6.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper</h1>
23 <p>
24 Module implementing the VCS project browser helper for subversion.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SvnProjectBrowserHelper">SvnProjectBrowserHelper</a></td>
34 <td>Class implementing the VCS project browser helper for subversion.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SvnProjectBrowserHelper" ID="SvnProjectBrowserHelper"></a>
43 <h2>SvnProjectBrowserHelper</h2>
44 <p>
45 Class implementing the VCS project browser helper for subversion.
46 </p>
47 <h3>Derived from</h3>
48 VcsProjectBrowserHelper
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#SvnProjectBrowserHelper.__init__">SvnProjectBrowserHelper</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SvnProjectBrowserHelper.__SVNAddToChangelist">__SVNAddToChangelist</a></td>
64 <td>Private slot called by the context menu to add files to a changelist.</td>
65 </tr><tr>
66 <td><a href="#SvnProjectBrowserHelper.__SVNBlame">__SVNBlame</a></td>
67 <td>Private slot called by the context menu to show the blame of a file.</td>
68 </tr><tr>
69 <td><a href="#SvnProjectBrowserHelper.__SVNBreakLock">__SVNBreakLock</a></td>
70 <td>Private slot called by the context menu to break lock files in the repository.</td>
71 </tr><tr>
72 <td><a href="#SvnProjectBrowserHelper.__SVNConfigure">__SVNConfigure</a></td>
73 <td>Private method to open the configuration dialog.</td>
74 </tr><tr>
75 <td><a href="#SvnProjectBrowserHelper.__SVNCopy">__SVNCopy</a></td>
76 <td>Private slot called by the context menu to copy the selected file.</td>
77 </tr><tr>
78 <td><a href="#SvnProjectBrowserHelper.__SVNDelProp">__SVNDelProp</a></td>
79 <td>Private slot called by the context menu to delete a subversion property of a file.</td>
80 </tr><tr>
81 <td><a href="#SvnProjectBrowserHelper.__SVNExtendedDiff">__SVNExtendedDiff</a></td>
82 <td>Private slot called by the context menu to show the difference of a file to the repository.</td>
83 </tr><tr>
84 <td><a href="#SvnProjectBrowserHelper.__SVNListProps">__SVNListProps</a></td>
85 <td>Private slot called by the context menu to list the subversion properties of a file.</td>
86 </tr><tr>
87 <td><a href="#SvnProjectBrowserHelper.__SVNLock">__SVNLock</a></td>
88 <td>Private slot called by the context menu to lock files in the repository.</td>
89 </tr><tr>
90 <td><a href="#SvnProjectBrowserHelper.__SVNMove">__SVNMove</a></td>
91 <td>Private slot called by the context menu to move the selected file.</td>
92 </tr><tr>
93 <td><a href="#SvnProjectBrowserHelper.__SVNRemoveFromChangelist">__SVNRemoveFromChangelist</a></td>
94 <td>Private slot called by the context menu to remove files from their changelist.</td>
95 </tr><tr>
96 <td><a href="#SvnProjectBrowserHelper.__SVNResolve">__SVNResolve</a></td>
97 <td>Private slot called by the context menu to resolve conflicts of a file.</td>
98 </tr><tr>
99 <td><a href="#SvnProjectBrowserHelper.__SVNSbsDiff">__SVNSbsDiff</a></td>
100 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
101 </tr><tr>
102 <td><a href="#SvnProjectBrowserHelper.__SVNSbsExtendedDiff">__SVNSbsExtendedDiff</a></td>
103 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
104 </tr><tr>
105 <td><a href="#SvnProjectBrowserHelper.__SVNSetProp">__SVNSetProp</a></td>
106 <td>Private slot called by the context menu to set a subversion property of a file.</td>
107 </tr><tr>
108 <td><a href="#SvnProjectBrowserHelper.__SVNStealLock">__SVNStealLock</a></td>
109 <td>Private slot called by the context menu to steal lock files in the repository.</td>
110 </tr><tr>
111 <td><a href="#SvnProjectBrowserHelper.__SVNUnlock">__SVNUnlock</a></td>
112 <td>Private slot called by the context menu to unlock files in the repository.</td>
113 </tr><tr>
114 <td><a href="#SvnProjectBrowserHelper.__SVNUrlDiff">__SVNUrlDiff</a></td>
115 <td>Private slot called by the context menu to show the difference of a file of two repository URLs.</td>
116 </tr><tr>
117 <td><a href="#SvnProjectBrowserHelper.__itemsHaveFiles">__itemsHaveFiles</a></td>
118 <td>Private method to check, if items contain file type items.</td>
119 </tr><tr>
120 <td><a href="#SvnProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
121 <td>Protected method used to add the VCS menu to all project browsers.</td>
122 </tr><tr>
123 <td><a href="#SvnProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td>
124 <td>Protected method used to add the VCS menu to all project browsers.</td>
125 </tr><tr>
126 <td><a href="#SvnProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td>
127 <td>Protected method used to add the VCS menu to all project browsers.</td>
128 </tr><tr>
129 <td><a href="#SvnProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td>
130 <td>Protected method used to add the VCS menu to all project browsers.</td>
131 </tr><tr>
132 <td><a href="#SvnProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td>
133 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
134 </tr><tr>
135 <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
136 <td>Public slot called before the context menu is shown.</td>
137 </tr><tr>
138 <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
139 <td>Public slot called before the context menu is shown.</td>
140 </tr><tr>
141 <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
142 <td>Public slot called before the context menu is shown.</td>
143 </tr><tr>
144 <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
145 <td>Public slot called before the context menu (multiple selections) is shown.</td>
146 </tr>
147 </table>
148 <h3>Static Methods</h3>
149 <table>
150 <tr><td>None</td></tr>
151 </table>
152 <a NAME="SvnProjectBrowserHelper.__init__" ID="SvnProjectBrowserHelper.__init__"></a>
153 <h4>SvnProjectBrowserHelper (Constructor)</h4>
154 <b>SvnProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
155 <p>
156 Constructor
157 </p><dl>
158 <dt><i>vcsObject</i></dt>
159 <dd>
160 reference to the vcs object
161 </dd><dt><i>browserObject</i></dt>
162 <dd>
163 reference to the project browser object
164 </dd><dt><i>projectObject</i></dt>
165 <dd>
166 reference to the project object
167 </dd><dt><i>isTranslationsBrowser</i></dt>
168 <dd>
169 flag indicating, the helper is requested
170 for the translations browser (this needs some special treatment)
171 </dd><dt><i>parent</i></dt>
172 <dd>
173 parent widget (QWidget)
174 </dd><dt><i>name</i></dt>
175 <dd>
176 name of this object (string)
177 </dd>
178 </dl><a NAME="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a>
179 <h4>SvnProjectBrowserHelper.__SVNAddToChangelist</h4>
180 <b>__SVNAddToChangelist</b>(<i></i>)
181 <p>
182 Private slot called by the context menu to add files to a changelist.
183 </p><a NAME="SvnProjectBrowserHelper.__SVNBlame" ID="SvnProjectBrowserHelper.__SVNBlame"></a>
184 <h4>SvnProjectBrowserHelper.__SVNBlame</h4>
185 <b>__SVNBlame</b>(<i></i>)
186 <p>
187 Private slot called by the context menu to show the blame of a file.
188 </p><a NAME="SvnProjectBrowserHelper.__SVNBreakLock" ID="SvnProjectBrowserHelper.__SVNBreakLock"></a>
189 <h4>SvnProjectBrowserHelper.__SVNBreakLock</h4>
190 <b>__SVNBreakLock</b>(<i></i>)
191 <p>
192 Private slot called by the context menu to break lock files in the
193 repository.
194 </p><a NAME="SvnProjectBrowserHelper.__SVNConfigure" ID="SvnProjectBrowserHelper.__SVNConfigure"></a>
195 <h4>SvnProjectBrowserHelper.__SVNConfigure</h4>
196 <b>__SVNConfigure</b>(<i></i>)
197 <p>
198 Private method to open the configuration dialog.
199 </p><a NAME="SvnProjectBrowserHelper.__SVNCopy" ID="SvnProjectBrowserHelper.__SVNCopy"></a>
200 <h4>SvnProjectBrowserHelper.__SVNCopy</h4>
201 <b>__SVNCopy</b>(<i></i>)
202 <p>
203 Private slot called by the context menu to copy the selected file.
204 </p><a NAME="SvnProjectBrowserHelper.__SVNDelProp" ID="SvnProjectBrowserHelper.__SVNDelProp"></a>
205 <h4>SvnProjectBrowserHelper.__SVNDelProp</h4>
206 <b>__SVNDelProp</b>(<i></i>)
207 <p>
208 Private slot called by the context menu to delete a subversion
209 property of a file.
210 </p><a NAME="SvnProjectBrowserHelper.__SVNExtendedDiff" ID="SvnProjectBrowserHelper.__SVNExtendedDiff"></a>
211 <h4>SvnProjectBrowserHelper.__SVNExtendedDiff</h4>
212 <b>__SVNExtendedDiff</b>(<i></i>)
213 <p>
214 Private slot called by the context menu to show the difference of a
215 file to the repository.
216 </p><p>
217 This gives the chance to enter the revisions to compare.
218 </p><a NAME="SvnProjectBrowserHelper.__SVNListProps" ID="SvnProjectBrowserHelper.__SVNListProps"></a>
219 <h4>SvnProjectBrowserHelper.__SVNListProps</h4>
220 <b>__SVNListProps</b>(<i></i>)
221 <p>
222 Private slot called by the context menu to list the subversion
223 properties of a file.
224 </p><a NAME="SvnProjectBrowserHelper.__SVNLock" ID="SvnProjectBrowserHelper.__SVNLock"></a>
225 <h4>SvnProjectBrowserHelper.__SVNLock</h4>
226 <b>__SVNLock</b>(<i></i>)
227 <p>
228 Private slot called by the context menu to lock files in the
229 repository.
230 </p><a NAME="SvnProjectBrowserHelper.__SVNMove" ID="SvnProjectBrowserHelper.__SVNMove"></a>
231 <h4>SvnProjectBrowserHelper.__SVNMove</h4>
232 <b>__SVNMove</b>(<i></i>)
233 <p>
234 Private slot called by the context menu to move the selected file.
235 </p><a NAME="SvnProjectBrowserHelper.__SVNRemoveFromChangelist" ID="SvnProjectBrowserHelper.__SVNRemoveFromChangelist"></a>
236 <h4>SvnProjectBrowserHelper.__SVNRemoveFromChangelist</h4>
237 <b>__SVNRemoveFromChangelist</b>(<i></i>)
238 <p>
239 Private slot called by the context menu to remove files from their
240 changelist.
241 </p><a NAME="SvnProjectBrowserHelper.__SVNResolve" ID="SvnProjectBrowserHelper.__SVNResolve"></a>
242 <h4>SvnProjectBrowserHelper.__SVNResolve</h4>
243 <b>__SVNResolve</b>(<i></i>)
244 <p>
245 Private slot called by the context menu to resolve conflicts of a file.
246 </p><a NAME="SvnProjectBrowserHelper.__SVNSbsDiff" ID="SvnProjectBrowserHelper.__SVNSbsDiff"></a>
247 <h4>SvnProjectBrowserHelper.__SVNSbsDiff</h4>
248 <b>__SVNSbsDiff</b>(<i></i>)
249 <p>
250 Private slot called by the context menu to show the difference of a
251 file to the repository side-by-side.
252 </p><a NAME="SvnProjectBrowserHelper.__SVNSbsExtendedDiff" ID="SvnProjectBrowserHelper.__SVNSbsExtendedDiff"></a>
253 <h4>SvnProjectBrowserHelper.__SVNSbsExtendedDiff</h4>
254 <b>__SVNSbsExtendedDiff</b>(<i></i>)
255 <p>
256 Private slot called by the context menu to show the difference of a
257 file to the repository side-by-side.
258 </p><p>
259 It allows the selection of revisions to compare.
260 </p><a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a>
261 <h4>SvnProjectBrowserHelper.__SVNSetProp</h4>
262 <b>__SVNSetProp</b>(<i></i>)
263 <p>
264 Private slot called by the context menu to set a subversion property
265 of a file.
266 </p><a NAME="SvnProjectBrowserHelper.__SVNStealLock" ID="SvnProjectBrowserHelper.__SVNStealLock"></a>
267 <h4>SvnProjectBrowserHelper.__SVNStealLock</h4>
268 <b>__SVNStealLock</b>(<i></i>)
269 <p>
270 Private slot called by the context menu to steal lock files in the
271 repository.
272 </p><a NAME="SvnProjectBrowserHelper.__SVNUnlock" ID="SvnProjectBrowserHelper.__SVNUnlock"></a>
273 <h4>SvnProjectBrowserHelper.__SVNUnlock</h4>
274 <b>__SVNUnlock</b>(<i></i>)
275 <p>
276 Private slot called by the context menu to unlock files in the
277 repository.
278 </p><a NAME="SvnProjectBrowserHelper.__SVNUrlDiff" ID="SvnProjectBrowserHelper.__SVNUrlDiff"></a>
279 <h4>SvnProjectBrowserHelper.__SVNUrlDiff</h4>
280 <b>__SVNUrlDiff</b>(<i></i>)
281 <p>
282 Private slot called by the context menu to show the difference of a
283 file of two repository URLs.
284 </p><p>
285 This gives the chance to enter the repository URLs to compare.
286 </p><a NAME="SvnProjectBrowserHelper.__itemsHaveFiles" ID="SvnProjectBrowserHelper.__itemsHaveFiles"></a>
287 <h4>SvnProjectBrowserHelper.__itemsHaveFiles</h4>
288 <b>__itemsHaveFiles</b>(<i>items</i>)
289 <p>
290 Private method to check, if items contain file type items.
291 </p><dl>
292 <dt><i>items</i></dt>
293 <dd>
294 items to check (list of QTreeWidgetItems)
295 </dd>
296 </dl><dl>
297 <dt>Returns:</dt>
298 <dd>
299 flag indicating items contain file type items (boolean)
300 </dd>
301 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a>
302 <h4>SvnProjectBrowserHelper._addVCSMenu</h4>
303 <b>_addVCSMenu</b>(<i>mainMenu</i>)
304 <p>
305 Protected method used to add the VCS menu to all project browsers.
306 </p><dl>
307 <dt><i>mainMenu</i></dt>
308 <dd>
309 reference to the menu to be amended
310 </dd>
311 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuBack" ID="SvnProjectBrowserHelper._addVCSMenuBack"></a>
312 <h4>SvnProjectBrowserHelper._addVCSMenuBack</h4>
313 <b>_addVCSMenuBack</b>(<i>mainMenu</i>)
314 <p>
315 Protected method used to add the VCS menu to all project browsers.
316 </p><dl>
317 <dt><i>mainMenu</i></dt>
318 <dd>
319 reference to the menu to be amended
320 </dd>
321 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDir" ID="SvnProjectBrowserHelper._addVCSMenuDir"></a>
322 <h4>SvnProjectBrowserHelper._addVCSMenuDir</h4>
323 <b>_addVCSMenuDir</b>(<i>mainMenu</i>)
324 <p>
325 Protected method used to add the VCS menu to all project browsers.
326 </p><dl>
327 <dt><i>mainMenu</i></dt>
328 <dd>
329 reference to the menu to be amended
330 </dd>
331 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDirMulti" ID="SvnProjectBrowserHelper._addVCSMenuDirMulti"></a>
332 <h4>SvnProjectBrowserHelper._addVCSMenuDirMulti</h4>
333 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
334 <p>
335 Protected method used to add the VCS menu to all project browsers.
336 </p><dl>
337 <dt><i>mainMenu</i></dt>
338 <dd>
339 reference to the menu to be amended
340 </dd>
341 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuMulti" ID="SvnProjectBrowserHelper._addVCSMenuMulti"></a>
342 <h4>SvnProjectBrowserHelper._addVCSMenuMulti</h4>
343 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
344 <p>
345 Protected method used to add the VCS menu for multi selection to all
346 project browsers.
347 </p><dl>
348 <dt><i>mainMenu</i></dt>
349 <dd>
350 reference to the menu to be amended
351 </dd>
352 </dl><a NAME="SvnProjectBrowserHelper.showContextMenu" ID="SvnProjectBrowserHelper.showContextMenu"></a>
353 <h4>SvnProjectBrowserHelper.showContextMenu</h4>
354 <b>showContextMenu</b>(<i>menu, standardItems</i>)
355 <p>
356 Public slot called before the context menu is shown.
357 </p><p>
358 It enables/disables the VCS menu entries depending on the overall
359 VCS status and the file status.
360 </p><dl>
361 <dt><i>menu</i></dt>
362 <dd>
363 reference to the menu to be shown
364 </dd><dt><i>standardItems</i></dt>
365 <dd>
366 array of standard items that need
367 activation/deactivation depending on the overall VCS status
368 </dd>
369 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a>
370 <h4>SvnProjectBrowserHelper.showContextMenuDir</h4>
371 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
372 <p>
373 Public slot called before the context menu is shown.
374 </p><p>
375 It enables/disables the VCS menu entries depending on the overall
376 VCS status and the directory status.
377 </p><dl>
378 <dt><i>menu</i></dt>
379 <dd>
380 reference to the menu to be shown
381 </dd><dt><i>standardItems</i></dt>
382 <dd>
383 array of standard items that need
384 activation/deactivation depending on the overall VCS status
385 </dd>
386 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a>
387 <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4>
388 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
389 <p>
390 Public slot called before the context menu is shown.
391 </p><p>
392 It enables/disables the VCS menu entries depending on the overall
393 VCS status and the directory status.
394 </p><dl>
395 <dt><i>menu</i></dt>
396 <dd>
397 reference to the menu to be shown
398 </dd><dt><i>standardItems</i></dt>
399 <dd>
400 array of standard items that need
401 activation/deactivation depending on the overall VCS status
402 </dd>
403 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a>
404 <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4>
405 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
406 <p>
407 Public slot called before the context menu (multiple selections) is
408 shown.
409 </p><p>
410 It enables/disables the VCS menu entries depending on the overall
411 VCS status and the files status.
412 </p><dl>
413 <dt><i>menu</i></dt>
414 <dd>
415 reference to the menu to be shown
416 </dd><dt><i>standardItems</i></dt>
417 <dd>
418 array of standard items that need
419 activation/deactivation depending on the overall VCS status
420 </dd>
421 </dl>
422 <div align="right"><a href="#top">Up</a></div>
423 <hr />
424 </body></html>

eric ide

mercurial