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

eric ide

mercurial