src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.ProjectBrowserHelper.html

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

eric ide

mercurial