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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper</h1>
24
25 <p>
26 Module implementing the VCS project browser helper for subversion.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#SvnProjectBrowserHelper">SvnProjectBrowserHelper</a></td>
39 <td>Class implementing the VCS project browser helper for subversion.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="SvnProjectBrowserHelper" ID="SvnProjectBrowserHelper"></a>
50 <h2>SvnProjectBrowserHelper</h2>
51
52 <p>
53 Class implementing the VCS project browser helper for subversion.
54 </p>
55 <h3>Derived from</h3>
56 VcsProjectBrowserHelper
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#SvnProjectBrowserHelper.__init__">SvnProjectBrowserHelper</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#SvnProjectBrowserHelper.__SVNAddToChangelist">__SVNAddToChangelist</a></td>
77 <td>Private slot called by the context menu to add files to a changelist.</td>
78 </tr>
79 <tr>
80 <td><a href="#SvnProjectBrowserHelper.__SVNBlame">__SVNBlame</a></td>
81 <td>Private slot called by the context menu to show the blame of a file.</td>
82 </tr>
83 <tr>
84 <td><a href="#SvnProjectBrowserHelper.__SVNBreakLock">__SVNBreakLock</a></td>
85 <td>Private slot called by the context menu to break lock files in the repository.</td>
86 </tr>
87 <tr>
88 <td><a href="#SvnProjectBrowserHelper.__SVNConfigure">__SVNConfigure</a></td>
89 <td>Private method to open the configuration dialog.</td>
90 </tr>
91 <tr>
92 <td><a href="#SvnProjectBrowserHelper.__SVNCopy">__SVNCopy</a></td>
93 <td>Private slot called by the context menu to copy the selected file.</td>
94 </tr>
95 <tr>
96 <td><a href="#SvnProjectBrowserHelper.__SVNDelProp">__SVNDelProp</a></td>
97 <td>Private slot called by the context menu to delete a subversion property of a file.</td>
98 </tr>
99 <tr>
100 <td><a href="#SvnProjectBrowserHelper.__SVNExtendedDiff">__SVNExtendedDiff</a></td>
101 <td>Private slot called by the context menu to show the difference of a file to the repository.</td>
102 </tr>
103 <tr>
104 <td><a href="#SvnProjectBrowserHelper.__SVNListProps">__SVNListProps</a></td>
105 <td>Private slot called by the context menu to list the subversion properties of a file.</td>
106 </tr>
107 <tr>
108 <td><a href="#SvnProjectBrowserHelper.__SVNLock">__SVNLock</a></td>
109 <td>Private slot called by the context menu to lock files in the repository.</td>
110 </tr>
111 <tr>
112 <td><a href="#SvnProjectBrowserHelper.__SVNMove">__SVNMove</a></td>
113 <td>Private slot called by the context menu to move the selected file.</td>
114 </tr>
115 <tr>
116 <td><a href="#SvnProjectBrowserHelper.__SVNRemoveFromChangelist">__SVNRemoveFromChangelist</a></td>
117 <td>Private slot called by the context menu to remove files from their changelist.</td>
118 </tr>
119 <tr>
120 <td><a href="#SvnProjectBrowserHelper.__SVNResolve">__SVNResolve</a></td>
121 <td>Private slot called by the context menu to resolve conflicts of a file.</td>
122 </tr>
123 <tr>
124 <td><a href="#SvnProjectBrowserHelper.__SVNSbsDiff">__SVNSbsDiff</a></td>
125 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
126 </tr>
127 <tr>
128 <td><a href="#SvnProjectBrowserHelper.__SVNSbsExtendedDiff">__SVNSbsExtendedDiff</a></td>
129 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
130 </tr>
131 <tr>
132 <td><a href="#SvnProjectBrowserHelper.__SVNSetProp">__SVNSetProp</a></td>
133 <td>Private slot called by the context menu to set a subversion property of a file.</td>
134 </tr>
135 <tr>
136 <td><a href="#SvnProjectBrowserHelper.__SVNStealLock">__SVNStealLock</a></td>
137 <td>Private slot called by the context menu to steal lock files in the repository.</td>
138 </tr>
139 <tr>
140 <td><a href="#SvnProjectBrowserHelper.__SVNUnlock">__SVNUnlock</a></td>
141 <td>Private slot called by the context menu to unlock files in the repository.</td>
142 </tr>
143 <tr>
144 <td><a href="#SvnProjectBrowserHelper.__SVNUrlDiff">__SVNUrlDiff</a></td>
145 <td>Private slot called by the context menu to show the difference of a file of two repository URLs.</td>
146 </tr>
147 <tr>
148 <td><a href="#SvnProjectBrowserHelper.__itemsHaveFiles">__itemsHaveFiles</a></td>
149 <td>Private method to check, if items contain file type items.</td>
150 </tr>
151 <tr>
152 <td><a href="#SvnProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
153 <td>Protected method used to add the VCS menu to all project browsers.</td>
154 </tr>
155 <tr>
156 <td><a href="#SvnProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td>
157 <td>Protected method used to add the VCS menu to all project browsers.</td>
158 </tr>
159 <tr>
160 <td><a href="#SvnProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td>
161 <td>Protected method used to add the VCS menu to all project browsers.</td>
162 </tr>
163 <tr>
164 <td><a href="#SvnProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td>
165 <td>Protected method used to add the VCS menu to all project browsers.</td>
166 </tr>
167 <tr>
168 <td><a href="#SvnProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td>
169 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
170 </tr>
171 <tr>
172 <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
173 <td>Public slot called before the context menu is shown.</td>
174 </tr>
175 <tr>
176 <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
177 <td>Public slot called before the context menu is shown.</td>
178 </tr>
179 <tr>
180 <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
181 <td>Public slot called before the context menu is shown.</td>
182 </tr>
183 <tr>
184 <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
185 <td>Public slot called before the context menu (multiple selections) is shown.</td>
186 </tr>
187 </table>
188 <h3>Static Methods</h3>
189
190 <table>
191 <tr><td>None</td></tr>
192 </table>
193
194 <a NAME="SvnProjectBrowserHelper.__init__" ID="SvnProjectBrowserHelper.__init__"></a>
195 <h4>SvnProjectBrowserHelper (Constructor)</h4>
196 <b>SvnProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
197
198 <p>
199 Constructor
200 </p>
201 <dl>
202
203 <dt><i>vcsObject</i></dt>
204 <dd>
205 reference to the vcs object
206 </dd>
207 <dt><i>browserObject</i></dt>
208 <dd>
209 reference to the project browser object
210 </dd>
211 <dt><i>projectObject</i></dt>
212 <dd>
213 reference to the project object
214 </dd>
215 <dt><i>isTranslationsBrowser</i></dt>
216 <dd>
217 flag indicating, the helper is requested
218 for the translations browser (this needs some special treatment)
219 </dd>
220 <dt><i>parent</i></dt>
221 <dd>
222 parent widget (QWidget)
223 </dd>
224 <dt><i>name</i></dt>
225 <dd>
226 name of this object (string)
227 </dd>
228 </dl>
229 <a NAME="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a>
230 <h4>SvnProjectBrowserHelper.__SVNAddToChangelist</h4>
231 <b>__SVNAddToChangelist</b>(<i></i>)
232
233 <p>
234 Private slot called by the context menu to add files to a changelist.
235 </p>
236 <a NAME="SvnProjectBrowserHelper.__SVNBlame" ID="SvnProjectBrowserHelper.__SVNBlame"></a>
237 <h4>SvnProjectBrowserHelper.__SVNBlame</h4>
238 <b>__SVNBlame</b>(<i></i>)
239
240 <p>
241 Private slot called by the context menu to show the blame of a file.
242 </p>
243 <a NAME="SvnProjectBrowserHelper.__SVNBreakLock" ID="SvnProjectBrowserHelper.__SVNBreakLock"></a>
244 <h4>SvnProjectBrowserHelper.__SVNBreakLock</h4>
245 <b>__SVNBreakLock</b>(<i></i>)
246
247 <p>
248 Private slot called by the context menu to break lock files in the
249 repository.
250 </p>
251 <a NAME="SvnProjectBrowserHelper.__SVNConfigure" ID="SvnProjectBrowserHelper.__SVNConfigure"></a>
252 <h4>SvnProjectBrowserHelper.__SVNConfigure</h4>
253 <b>__SVNConfigure</b>(<i></i>)
254
255 <p>
256 Private method to open the configuration dialog.
257 </p>
258 <a NAME="SvnProjectBrowserHelper.__SVNCopy" ID="SvnProjectBrowserHelper.__SVNCopy"></a>
259 <h4>SvnProjectBrowserHelper.__SVNCopy</h4>
260 <b>__SVNCopy</b>(<i></i>)
261
262 <p>
263 Private slot called by the context menu to copy the selected file.
264 </p>
265 <a NAME="SvnProjectBrowserHelper.__SVNDelProp" ID="SvnProjectBrowserHelper.__SVNDelProp"></a>
266 <h4>SvnProjectBrowserHelper.__SVNDelProp</h4>
267 <b>__SVNDelProp</b>(<i></i>)
268
269 <p>
270 Private slot called by the context menu to delete a subversion
271 property of a file.
272 </p>
273 <a NAME="SvnProjectBrowserHelper.__SVNExtendedDiff" ID="SvnProjectBrowserHelper.__SVNExtendedDiff"></a>
274 <h4>SvnProjectBrowserHelper.__SVNExtendedDiff</h4>
275 <b>__SVNExtendedDiff</b>(<i></i>)
276
277 <p>
278 Private slot called by the context menu to show the difference of a
279 file to the repository.
280 </p>
281 <p>
282 This gives the chance to enter the revisions to compare.
283 </p>
284 <a NAME="SvnProjectBrowserHelper.__SVNListProps" ID="SvnProjectBrowserHelper.__SVNListProps"></a>
285 <h4>SvnProjectBrowserHelper.__SVNListProps</h4>
286 <b>__SVNListProps</b>(<i></i>)
287
288 <p>
289 Private slot called by the context menu to list the subversion
290 properties of a file.
291 </p>
292 <a NAME="SvnProjectBrowserHelper.__SVNLock" ID="SvnProjectBrowserHelper.__SVNLock"></a>
293 <h4>SvnProjectBrowserHelper.__SVNLock</h4>
294 <b>__SVNLock</b>(<i></i>)
295
296 <p>
297 Private slot called by the context menu to lock files in the
298 repository.
299 </p>
300 <a NAME="SvnProjectBrowserHelper.__SVNMove" ID="SvnProjectBrowserHelper.__SVNMove"></a>
301 <h4>SvnProjectBrowserHelper.__SVNMove</h4>
302 <b>__SVNMove</b>(<i></i>)
303
304 <p>
305 Private slot called by the context menu to move the selected file.
306 </p>
307 <a NAME="SvnProjectBrowserHelper.__SVNRemoveFromChangelist" ID="SvnProjectBrowserHelper.__SVNRemoveFromChangelist"></a>
308 <h4>SvnProjectBrowserHelper.__SVNRemoveFromChangelist</h4>
309 <b>__SVNRemoveFromChangelist</b>(<i></i>)
310
311 <p>
312 Private slot called by the context menu to remove files from their
313 changelist.
314 </p>
315 <a NAME="SvnProjectBrowserHelper.__SVNResolve" ID="SvnProjectBrowserHelper.__SVNResolve"></a>
316 <h4>SvnProjectBrowserHelper.__SVNResolve</h4>
317 <b>__SVNResolve</b>(<i></i>)
318
319 <p>
320 Private slot called by the context menu to resolve conflicts of a file.
321 </p>
322 <a NAME="SvnProjectBrowserHelper.__SVNSbsDiff" ID="SvnProjectBrowserHelper.__SVNSbsDiff"></a>
323 <h4>SvnProjectBrowserHelper.__SVNSbsDiff</h4>
324 <b>__SVNSbsDiff</b>(<i></i>)
325
326 <p>
327 Private slot called by the context menu to show the difference of a
328 file to the repository side-by-side.
329 </p>
330 <a NAME="SvnProjectBrowserHelper.__SVNSbsExtendedDiff" ID="SvnProjectBrowserHelper.__SVNSbsExtendedDiff"></a>
331 <h4>SvnProjectBrowserHelper.__SVNSbsExtendedDiff</h4>
332 <b>__SVNSbsExtendedDiff</b>(<i></i>)
333
334 <p>
335 Private slot called by the context menu to show the difference of a
336 file to the repository side-by-side.
337 </p>
338 <p>
339 It allows the selection of revisions to compare.
340 </p>
341 <a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a>
342 <h4>SvnProjectBrowserHelper.__SVNSetProp</h4>
343 <b>__SVNSetProp</b>(<i></i>)
344
345 <p>
346 Private slot called by the context menu to set a subversion property
347 of a file.
348 </p>
349 <a NAME="SvnProjectBrowserHelper.__SVNStealLock" ID="SvnProjectBrowserHelper.__SVNStealLock"></a>
350 <h4>SvnProjectBrowserHelper.__SVNStealLock</h4>
351 <b>__SVNStealLock</b>(<i></i>)
352
353 <p>
354 Private slot called by the context menu to steal lock files in the
355 repository.
356 </p>
357 <a NAME="SvnProjectBrowserHelper.__SVNUnlock" ID="SvnProjectBrowserHelper.__SVNUnlock"></a>
358 <h4>SvnProjectBrowserHelper.__SVNUnlock</h4>
359 <b>__SVNUnlock</b>(<i></i>)
360
361 <p>
362 Private slot called by the context menu to unlock files in the
363 repository.
364 </p>
365 <a NAME="SvnProjectBrowserHelper.__SVNUrlDiff" ID="SvnProjectBrowserHelper.__SVNUrlDiff"></a>
366 <h4>SvnProjectBrowserHelper.__SVNUrlDiff</h4>
367 <b>__SVNUrlDiff</b>(<i></i>)
368
369 <p>
370 Private slot called by the context menu to show the difference of a
371 file of two repository URLs.
372 </p>
373 <p>
374 This gives the chance to enter the repository URLs to compare.
375 </p>
376 <a NAME="SvnProjectBrowserHelper.__itemsHaveFiles" ID="SvnProjectBrowserHelper.__itemsHaveFiles"></a>
377 <h4>SvnProjectBrowserHelper.__itemsHaveFiles</h4>
378 <b>__itemsHaveFiles</b>(<i>items</i>)
379
380 <p>
381 Private method to check, if items contain file type items.
382 </p>
383 <dl>
384
385 <dt><i>items</i></dt>
386 <dd>
387 items to check (list of QTreeWidgetItems)
388 </dd>
389 </dl>
390 <dl>
391 <dt>Return:</dt>
392 <dd>
393 flag indicating items contain file type items (boolean)
394 </dd>
395 </dl>
396 <a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a>
397 <h4>SvnProjectBrowserHelper._addVCSMenu</h4>
398 <b>_addVCSMenu</b>(<i>mainMenu</i>)
399
400 <p>
401 Protected method used to add the VCS menu to all project browsers.
402 </p>
403 <dl>
404
405 <dt><i>mainMenu</i></dt>
406 <dd>
407 reference to the menu to be amended
408 </dd>
409 </dl>
410 <a NAME="SvnProjectBrowserHelper._addVCSMenuBack" ID="SvnProjectBrowserHelper._addVCSMenuBack"></a>
411 <h4>SvnProjectBrowserHelper._addVCSMenuBack</h4>
412 <b>_addVCSMenuBack</b>(<i>mainMenu</i>)
413
414 <p>
415 Protected method used to add the VCS menu to all project browsers.
416 </p>
417 <dl>
418
419 <dt><i>mainMenu</i></dt>
420 <dd>
421 reference to the menu to be amended
422 </dd>
423 </dl>
424 <a NAME="SvnProjectBrowserHelper._addVCSMenuDir" ID="SvnProjectBrowserHelper._addVCSMenuDir"></a>
425 <h4>SvnProjectBrowserHelper._addVCSMenuDir</h4>
426 <b>_addVCSMenuDir</b>(<i>mainMenu</i>)
427
428 <p>
429 Protected method used to add the VCS menu to all project browsers.
430 </p>
431 <dl>
432
433 <dt><i>mainMenu</i></dt>
434 <dd>
435 reference to the menu to be amended
436 </dd>
437 </dl>
438 <a NAME="SvnProjectBrowserHelper._addVCSMenuDirMulti" ID="SvnProjectBrowserHelper._addVCSMenuDirMulti"></a>
439 <h4>SvnProjectBrowserHelper._addVCSMenuDirMulti</h4>
440 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
441
442 <p>
443 Protected method used to add the VCS menu to all project browsers.
444 </p>
445 <dl>
446
447 <dt><i>mainMenu</i></dt>
448 <dd>
449 reference to the menu to be amended
450 </dd>
451 </dl>
452 <a NAME="SvnProjectBrowserHelper._addVCSMenuMulti" ID="SvnProjectBrowserHelper._addVCSMenuMulti"></a>
453 <h4>SvnProjectBrowserHelper._addVCSMenuMulti</h4>
454 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
455
456 <p>
457 Protected method used to add the VCS menu for multi selection to all
458 project browsers.
459 </p>
460 <dl>
461
462 <dt><i>mainMenu</i></dt>
463 <dd>
464 reference to the menu to be amended
465 </dd>
466 </dl>
467 <a NAME="SvnProjectBrowserHelper.showContextMenu" ID="SvnProjectBrowserHelper.showContextMenu"></a>
468 <h4>SvnProjectBrowserHelper.showContextMenu</h4>
469 <b>showContextMenu</b>(<i>menu, standardItems</i>)
470
471 <p>
472 Public slot called before the context menu is shown.
473 </p>
474 <p>
475 It enables/disables the VCS menu entries depending on the overall
476 VCS status and the file status.
477 </p>
478 <dl>
479
480 <dt><i>menu</i></dt>
481 <dd>
482 reference to the menu to be shown
483 </dd>
484 <dt><i>standardItems</i></dt>
485 <dd>
486 array of standard items that need
487 activation/deactivation depending on the overall VCS status
488 </dd>
489 </dl>
490 <a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a>
491 <h4>SvnProjectBrowserHelper.showContextMenuDir</h4>
492 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
493
494 <p>
495 Public slot called before the context menu is shown.
496 </p>
497 <p>
498 It enables/disables the VCS menu entries depending on the overall
499 VCS status and the directory status.
500 </p>
501 <dl>
502
503 <dt><i>menu</i></dt>
504 <dd>
505 reference to the menu to be shown
506 </dd>
507 <dt><i>standardItems</i></dt>
508 <dd>
509 array of standard items that need
510 activation/deactivation depending on the overall VCS status
511 </dd>
512 </dl>
513 <a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a>
514 <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4>
515 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
516
517 <p>
518 Public slot called before the context menu is shown.
519 </p>
520 <p>
521 It enables/disables the VCS menu entries depending on the overall
522 VCS status and the directory status.
523 </p>
524 <dl>
525
526 <dt><i>menu</i></dt>
527 <dd>
528 reference to the menu to be shown
529 </dd>
530 <dt><i>standardItems</i></dt>
531 <dd>
532 array of standard items that need
533 activation/deactivation depending on the overall VCS status
534 </dd>
535 </dl>
536 <a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a>
537 <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4>
538 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
539
540 <p>
541 Public slot called before the context menu (multiple selections) is
542 shown.
543 </p>
544 <p>
545 It enables/disables the VCS menu entries depending on the overall
546 VCS status and the files status.
547 </p>
548 <dl>
549
550 <dt><i>menu</i></dt>
551 <dd>
552 reference to the menu to be shown
553 </dd>
554 <dt><i>standardItems</i></dt>
555 <dd>
556 array of standard items that need
557 activation/deactivation depending on the overall VCS status
558 </dd>
559 </dl>
560 <div align="right"><a href="#top">Up</a></div>
561 <hr />
562 </body></html>

eric ide

mercurial