src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.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.vcsSubversion.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.vcsSubversion.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.__SVNListProps">__SVNListProps</a></td>
91 <td>Private slot called by the context menu to list the subversion properties of a file.</td>
92 </tr>
93 <tr>
94 <td><a href="#SvnProjectBrowserHelper.__SVNLock">__SVNLock</a></td>
95 <td>Private slot called by the context menu to lock files in the repository.</td>
96 </tr>
97 <tr>
98 <td><a href="#SvnProjectBrowserHelper.__SVNMove">__SVNMove</a></td>
99 <td>Private slot called by the context menu to move the selected file.</td>
100 </tr>
101 <tr>
102 <td><a href="#SvnProjectBrowserHelper.__SVNRemoveFromChangelist">__SVNRemoveFromChangelist</a></td>
103 <td>Private slot called by the context menu to remove files from their changelist.</td>
104 </tr>
105 <tr>
106 <td><a href="#SvnProjectBrowserHelper.__SVNResolve">__SVNResolve</a></td>
107 <td>Private slot called by the context menu to resolve conflicts of a file.</td>
108 </tr>
109 <tr>
110 <td><a href="#SvnProjectBrowserHelper.__SVNSbsDiff">__SVNSbsDiff</a></td>
111 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
112 </tr>
113 <tr>
114 <td><a href="#SvnProjectBrowserHelper.__SVNSbsExtendedDiff">__SVNSbsExtendedDiff</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.__SVNSetProp">__SVNSetProp</a></td>
119 <td>Private slot called by the context menu to set a subversion property of a file.</td>
120 </tr>
121 <tr>
122 <td><a href="#SvnProjectBrowserHelper.__SVNStealLock">__SVNStealLock</a></td>
123 <td>Private slot called by the context menu to steal lock files in the repository.</td>
124 </tr>
125 <tr>
126 <td><a href="#SvnProjectBrowserHelper.__SVNUnlock">__SVNUnlock</a></td>
127 <td>Private slot called by the context menu to unlock files in the repository.</td>
128 </tr>
129 <tr>
130 <td><a href="#SvnProjectBrowserHelper.__SVNUrlDiff">__SVNUrlDiff</a></td>
131 <td>Private slot called by the context menu to show the difference of a file of two repository URLs.</td>
132 </tr>
133 <tr>
134 <td><a href="#SvnProjectBrowserHelper.__itemsHaveFiles">__itemsHaveFiles</a></td>
135 <td>Private method to check, if items contain file type items.</td>
136 </tr>
137 <tr>
138 <td><a href="#SvnProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
139 <td>Protected method used to add the VCS menu to all project browsers.</td>
140 </tr>
141 <tr>
142 <td><a href="#SvnProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</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._addVCSMenuDir">_addVCSMenuDir</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._addVCSMenuDirMulti">_addVCSMenuDirMulti</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._addVCSMenuMulti">_addVCSMenuMulti</a></td>
155 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
156 </tr>
157 <tr>
158 <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
159 <td>Public slot called before the context menu is shown.</td>
160 </tr>
161 <tr>
162 <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
163 <td>Public slot called before the context menu is shown.</td>
164 </tr>
165 <tr>
166 <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
167 <td>Public slot called before the context menu is shown.</td>
168 </tr>
169 <tr>
170 <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
171 <td>Public slot called before the context menu (multiple selections) is shown.</td>
172 </tr>
173 </table>
174 <h3>Static Methods</h3>
175
176 <table>
177 <tr><td>None</td></tr>
178 </table>
179
180 <a NAME="SvnProjectBrowserHelper.__init__" ID="SvnProjectBrowserHelper.__init__"></a>
181 <h4>SvnProjectBrowserHelper (Constructor)</h4>
182 <b>SvnProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
183
184 <p>
185 Constructor
186 </p>
187 <dl>
188
189 <dt><i>vcsObject</i></dt>
190 <dd>
191 reference to the vcs object
192 </dd>
193 <dt><i>browserObject</i></dt>
194 <dd>
195 reference to the project browser object
196 </dd>
197 <dt><i>projectObject</i></dt>
198 <dd>
199 reference to the project object
200 </dd>
201 <dt><i>isTranslationsBrowser</i></dt>
202 <dd>
203 flag indicating, the helper is requested
204 for the translations browser (this needs some special treatment)
205 </dd>
206 <dt><i>parent</i></dt>
207 <dd>
208 parent widget (QWidget)
209 </dd>
210 <dt><i>name</i></dt>
211 <dd>
212 name of this object (string)
213 </dd>
214 </dl>
215 <a NAME="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a>
216 <h4>SvnProjectBrowserHelper.__SVNAddToChangelist</h4>
217 <b>__SVNAddToChangelist</b>(<i></i>)
218
219 <p>
220 Private slot called by the context menu to add files to a changelist.
221 </p>
222 <a NAME="SvnProjectBrowserHelper.__SVNBlame" ID="SvnProjectBrowserHelper.__SVNBlame"></a>
223 <h4>SvnProjectBrowserHelper.__SVNBlame</h4>
224 <b>__SVNBlame</b>(<i></i>)
225
226 <p>
227 Private slot called by the context menu to show the blame of a file.
228 </p>
229 <a NAME="SvnProjectBrowserHelper.__SVNBreakLock" ID="SvnProjectBrowserHelper.__SVNBreakLock"></a>
230 <h4>SvnProjectBrowserHelper.__SVNBreakLock</h4>
231 <b>__SVNBreakLock</b>(<i></i>)
232
233 <p>
234 Private slot called by the context menu to break lock files in the
235 repository.
236 </p>
237 <a NAME="SvnProjectBrowserHelper.__SVNConfigure" ID="SvnProjectBrowserHelper.__SVNConfigure"></a>
238 <h4>SvnProjectBrowserHelper.__SVNConfigure</h4>
239 <b>__SVNConfigure</b>(<i></i>)
240
241 <p>
242 Private method to open the configuration dialog.
243 </p>
244 <a NAME="SvnProjectBrowserHelper.__SVNCopy" ID="SvnProjectBrowserHelper.__SVNCopy"></a>
245 <h4>SvnProjectBrowserHelper.__SVNCopy</h4>
246 <b>__SVNCopy</b>(<i></i>)
247
248 <p>
249 Private slot called by the context menu to copy the selected file.
250 </p>
251 <a NAME="SvnProjectBrowserHelper.__SVNDelProp" ID="SvnProjectBrowserHelper.__SVNDelProp"></a>
252 <h4>SvnProjectBrowserHelper.__SVNDelProp</h4>
253 <b>__SVNDelProp</b>(<i></i>)
254
255 <p>
256 Private slot called by the context menu to delete a subversion
257 property of a file.
258 </p>
259 <a NAME="SvnProjectBrowserHelper.__SVNExtendedDiff" ID="SvnProjectBrowserHelper.__SVNExtendedDiff"></a>
260 <h4>SvnProjectBrowserHelper.__SVNExtendedDiff</h4>
261 <b>__SVNExtendedDiff</b>(<i></i>)
262
263 <p>
264 Private slot called by the context menu to show the difference of a
265 file to the repository.
266 </p>
267 <p>
268 This gives the chance to enter the revisions to compare.
269 </p>
270 <a NAME="SvnProjectBrowserHelper.__SVNListProps" ID="SvnProjectBrowserHelper.__SVNListProps"></a>
271 <h4>SvnProjectBrowserHelper.__SVNListProps</h4>
272 <b>__SVNListProps</b>(<i></i>)
273
274 <p>
275 Private slot called by the context menu to list the subversion
276 properties of a file.
277 </p>
278 <a NAME="SvnProjectBrowserHelper.__SVNLock" ID="SvnProjectBrowserHelper.__SVNLock"></a>
279 <h4>SvnProjectBrowserHelper.__SVNLock</h4>
280 <b>__SVNLock</b>(<i></i>)
281
282 <p>
283 Private slot called by the context menu to lock files in the
284 repository.
285 </p>
286 <a NAME="SvnProjectBrowserHelper.__SVNMove" ID="SvnProjectBrowserHelper.__SVNMove"></a>
287 <h4>SvnProjectBrowserHelper.__SVNMove</h4>
288 <b>__SVNMove</b>(<i></i>)
289
290 <p>
291 Private slot called by the context menu to move the selected file.
292 </p>
293 <a NAME="SvnProjectBrowserHelper.__SVNRemoveFromChangelist" ID="SvnProjectBrowserHelper.__SVNRemoveFromChangelist"></a>
294 <h4>SvnProjectBrowserHelper.__SVNRemoveFromChangelist</h4>
295 <b>__SVNRemoveFromChangelist</b>(<i></i>)
296
297 <p>
298 Private slot called by the context menu to remove files from their
299 changelist.
300 </p>
301 <a NAME="SvnProjectBrowserHelper.__SVNResolve" ID="SvnProjectBrowserHelper.__SVNResolve"></a>
302 <h4>SvnProjectBrowserHelper.__SVNResolve</h4>
303 <b>__SVNResolve</b>(<i></i>)
304
305 <p>
306 Private slot called by the context menu to resolve conflicts of a file.
307 </p>
308 <a NAME="SvnProjectBrowserHelper.__SVNSbsDiff" ID="SvnProjectBrowserHelper.__SVNSbsDiff"></a>
309 <h4>SvnProjectBrowserHelper.__SVNSbsDiff</h4>
310 <b>__SVNSbsDiff</b>(<i></i>)
311
312 <p>
313 Private slot called by the context menu to show the difference of a
314 file to the repository side-by-side.
315 </p>
316 <a NAME="SvnProjectBrowserHelper.__SVNSbsExtendedDiff" ID="SvnProjectBrowserHelper.__SVNSbsExtendedDiff"></a>
317 <h4>SvnProjectBrowserHelper.__SVNSbsExtendedDiff</h4>
318 <b>__SVNSbsExtendedDiff</b>(<i></i>)
319
320 <p>
321 Private slot called by the context menu to show the difference of a
322 file to the repository side-by-side.
323 </p>
324 <p>
325 It allows the selection of revisions to compare.
326 </p>
327 <a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a>
328 <h4>SvnProjectBrowserHelper.__SVNSetProp</h4>
329 <b>__SVNSetProp</b>(<i></i>)
330
331 <p>
332 Private slot called by the context menu to set a subversion property
333 of a file.
334 </p>
335 <a NAME="SvnProjectBrowserHelper.__SVNStealLock" ID="SvnProjectBrowserHelper.__SVNStealLock"></a>
336 <h4>SvnProjectBrowserHelper.__SVNStealLock</h4>
337 <b>__SVNStealLock</b>(<i></i>)
338
339 <p>
340 Private slot called by the context menu to steal lock files in the
341 repository.
342 </p>
343 <a NAME="SvnProjectBrowserHelper.__SVNUnlock" ID="SvnProjectBrowserHelper.__SVNUnlock"></a>
344 <h4>SvnProjectBrowserHelper.__SVNUnlock</h4>
345 <b>__SVNUnlock</b>(<i></i>)
346
347 <p>
348 Private slot called by the context menu to unlock files in the
349 repository.
350 </p>
351 <a NAME="SvnProjectBrowserHelper.__SVNUrlDiff" ID="SvnProjectBrowserHelper.__SVNUrlDiff"></a>
352 <h4>SvnProjectBrowserHelper.__SVNUrlDiff</h4>
353 <b>__SVNUrlDiff</b>(<i></i>)
354
355 <p>
356 Private slot called by the context menu to show the difference of a
357 file of two repository URLs.
358 </p>
359 <p>
360 This gives the chance to enter the repository URLs to compare.
361 </p>
362 <a NAME="SvnProjectBrowserHelper.__itemsHaveFiles" ID="SvnProjectBrowserHelper.__itemsHaveFiles"></a>
363 <h4>SvnProjectBrowserHelper.__itemsHaveFiles</h4>
364 <b>__itemsHaveFiles</b>(<i>items</i>)
365
366 <p>
367 Private method to check, if items contain file type items.
368 </p>
369 <dl>
370
371 <dt><i>items</i></dt>
372 <dd>
373 items to check (list of QTreeWidgetItems)
374 </dd>
375 </dl>
376 <dl>
377 <dt>Return:</dt>
378 <dd>
379 flag indicating items contain file type items (boolean)
380 </dd>
381 </dl>
382 <a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a>
383 <h4>SvnProjectBrowserHelper._addVCSMenu</h4>
384 <b>_addVCSMenu</b>(<i>mainMenu</i>)
385
386 <p>
387 Protected method used to add the VCS menu to all project browsers.
388 </p>
389 <dl>
390
391 <dt><i>mainMenu</i></dt>
392 <dd>
393 reference to the menu to be amended
394 </dd>
395 </dl>
396 <a NAME="SvnProjectBrowserHelper._addVCSMenuBack" ID="SvnProjectBrowserHelper._addVCSMenuBack"></a>
397 <h4>SvnProjectBrowserHelper._addVCSMenuBack</h4>
398 <b>_addVCSMenuBack</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._addVCSMenuDir" ID="SvnProjectBrowserHelper._addVCSMenuDir"></a>
411 <h4>SvnProjectBrowserHelper._addVCSMenuDir</h4>
412 <b>_addVCSMenuDir</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._addVCSMenuDirMulti" ID="SvnProjectBrowserHelper._addVCSMenuDirMulti"></a>
425 <h4>SvnProjectBrowserHelper._addVCSMenuDirMulti</h4>
426 <b>_addVCSMenuDirMulti</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._addVCSMenuMulti" ID="SvnProjectBrowserHelper._addVCSMenuMulti"></a>
439 <h4>SvnProjectBrowserHelper._addVCSMenuMulti</h4>
440 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
441
442 <p>
443 Protected method used to add the VCS menu for multi selection to all
444 project browsers.
445 </p>
446 <dl>
447
448 <dt><i>mainMenu</i></dt>
449 <dd>
450 reference to the menu to be amended
451 </dd>
452 </dl>
453 <a NAME="SvnProjectBrowserHelper.showContextMenu" ID="SvnProjectBrowserHelper.showContextMenu"></a>
454 <h4>SvnProjectBrowserHelper.showContextMenu</h4>
455 <b>showContextMenu</b>(<i>menu, standardItems</i>)
456
457 <p>
458 Public slot called before the context menu is shown.
459 </p>
460 <p>
461 It enables/disables the VCS menu entries depending on the overall
462 VCS status and the file status.
463 </p>
464 <dl>
465
466 <dt><i>menu</i></dt>
467 <dd>
468 reference to the menu to be shown
469 </dd>
470 <dt><i>standardItems</i></dt>
471 <dd>
472 array of standard items that need
473 activation/deactivation depending on the overall VCS status
474 </dd>
475 </dl>
476 <a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a>
477 <h4>SvnProjectBrowserHelper.showContextMenuDir</h4>
478 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
479
480 <p>
481 Public slot called before the context menu is shown.
482 </p>
483 <p>
484 It enables/disables the VCS menu entries depending on the overall
485 VCS status and the directory status.
486 </p>
487 <dl>
488
489 <dt><i>menu</i></dt>
490 <dd>
491 reference to the menu to be shown
492 </dd>
493 <dt><i>standardItems</i></dt>
494 <dd>
495 array of standard items that need
496 activation/deactivation depending on the overall VCS status
497 </dd>
498 </dl>
499 <a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a>
500 <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4>
501 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
502
503 <p>
504 Public slot called before the context menu is shown.
505 </p>
506 <p>
507 It enables/disables the VCS menu entries depending on the overall
508 VCS status and the directory status.
509 </p>
510 <dl>
511
512 <dt><i>menu</i></dt>
513 <dd>
514 reference to the menu to be shown
515 </dd>
516 <dt><i>standardItems</i></dt>
517 <dd>
518 array of standard items that need
519 activation/deactivation depending on the overall VCS status
520 </dd>
521 </dl>
522 <a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a>
523 <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4>
524 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
525
526 <p>
527 Public slot called before the context menu (multiple selections) is
528 shown.
529 </p>
530 <p>
531 It enables/disables the VCS menu entries depending on the overall
532 VCS status and the files status.
533 </p>
534 <dl>
535
536 <dt><i>menu</i></dt>
537 <dd>
538 reference to the menu to be shown
539 </dd>
540 <dt><i>standardItems</i></dt>
541 <dd>
542 array of standard items that need
543 activation/deactivation depending on the overall VCS status
544 </dd>
545 </dl>
546 <div align="right"><a href="#top">Up</a></div>
547 <hr />
548 </body></html>

eric ide

mercurial