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

changeset 6942
2602857055c5
parent 3673
e26d7d0c1088
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsPySvn.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.__SVNInfo">__SVNInfo</a></td>
85 <td>Private slot called by the context menu to show repository information of a file or directory.</td>
86 </tr><tr>
87 <td><a href="#SvnProjectBrowserHelper.__SVNListProps">__SVNListProps</a></td>
88 <td>Private slot called by the context menu to list the subversion properties of a file.</td>
89 </tr><tr>
90 <td><a href="#SvnProjectBrowserHelper.__SVNLock">__SVNLock</a></td>
91 <td>Private slot called by the context menu to lock files in the repository.</td>
92 </tr><tr>
93 <td><a href="#SvnProjectBrowserHelper.__SVNMove">__SVNMove</a></td>
94 <td>Private slot called by the context menu to move the selected file.</td>
95 </tr><tr>
96 <td><a href="#SvnProjectBrowserHelper.__SVNRemoveFromChangelist">__SVNRemoveFromChangelist</a></td>
97 <td>Private slot called by the context menu to remove files from their changelist.</td>
98 </tr><tr>
99 <td><a href="#SvnProjectBrowserHelper.__SVNResolve">__SVNResolve</a></td>
100 <td>Private slot called by the context menu to resolve conflicts of a file.</td>
101 </tr><tr>
102 <td><a href="#SvnProjectBrowserHelper.__SVNSbsDiff">__SVNSbsDiff</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.__SVNSbsExtendedDiff">__SVNSbsExtendedDiff</a></td>
106 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
107 </tr><tr>
108 <td><a href="#SvnProjectBrowserHelper.__SVNSetProp">__SVNSetProp</a></td>
109 <td>Private slot called by the context menu to set a subversion property of a file.</td>
110 </tr><tr>
111 <td><a href="#SvnProjectBrowserHelper.__SVNStealLock">__SVNStealLock</a></td>
112 <td>Private slot called by the context menu to steal lock files in the repository.</td>
113 </tr><tr>
114 <td><a href="#SvnProjectBrowserHelper.__SVNUnlock">__SVNUnlock</a></td>
115 <td>Private slot called by the context menu to unlock files in the repository.</td>
116 </tr><tr>
117 <td><a href="#SvnProjectBrowserHelper.__SVNUrlDiff">__SVNUrlDiff</a></td>
118 <td>Private slot called by the context menu to show the difference of a file of two repository URLs.</td>
119 </tr><tr>
120 <td><a href="#SvnProjectBrowserHelper.__itemsHaveFiles">__itemsHaveFiles</a></td>
121 <td>Private method to check, if items contain file type items.</td>
122 </tr><tr>
123 <td><a href="#SvnProjectBrowserHelper._addVCSMenu">_addVCSMenu</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._addVCSMenuBack">_addVCSMenuBack</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._addVCSMenuDir">_addVCSMenuDir</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._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td>
133 <td>Protected method used to add the VCS menu to all project browsers.</td>
134 </tr><tr>
135 <td><a href="#SvnProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td>
136 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
137 </tr><tr>
138 <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
139 <td>Public slot called before the context menu is shown.</td>
140 </tr><tr>
141 <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
142 <td>Public slot called before the context menu is shown.</td>
143 </tr><tr>
144 <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
145 <td>Public slot called before the context menu is shown.</td>
146 </tr><tr>
147 <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
148 <td>Public slot called before the context menu (multiple selections) is shown.</td>
149 </tr>
150 </table>
151 <h3>Static Methods</h3>
152 <table>
153 <tr><td>None</td></tr>
154 </table>
155 <a NAME="SvnProjectBrowserHelper.__init__" ID="SvnProjectBrowserHelper.__init__"></a>
156 <h4>SvnProjectBrowserHelper (Constructor)</h4>
157 <b>SvnProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
158 <p>
159 Constructor
160 </p><dl>
161 <dt><i>vcsObject</i></dt>
162 <dd>
163 reference to the vcs object
164 </dd><dt><i>browserObject</i></dt>
165 <dd>
166 reference to the project browser object
167 </dd><dt><i>projectObject</i></dt>
168 <dd>
169 reference to the project object
170 </dd><dt><i>isTranslationsBrowser</i></dt>
171 <dd>
172 flag indicating, the helper is requested
173 for the translations browser (this needs some special treatment)
174 </dd><dt><i>parent</i></dt>
175 <dd>
176 parent widget (QWidget)
177 </dd><dt><i>name</i></dt>
178 <dd>
179 name of this object (string)
180 </dd>
181 </dl><a NAME="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a>
182 <h4>SvnProjectBrowserHelper.__SVNAddToChangelist</h4>
183 <b>__SVNAddToChangelist</b>(<i></i>)
184 <p>
185 Private slot called by the context menu to add files to a changelist.
186 </p><a NAME="SvnProjectBrowserHelper.__SVNBlame" ID="SvnProjectBrowserHelper.__SVNBlame"></a>
187 <h4>SvnProjectBrowserHelper.__SVNBlame</h4>
188 <b>__SVNBlame</b>(<i></i>)
189 <p>
190 Private slot called by the context menu to show the blame of a file.
191 </p><a NAME="SvnProjectBrowserHelper.__SVNBreakLock" ID="SvnProjectBrowserHelper.__SVNBreakLock"></a>
192 <h4>SvnProjectBrowserHelper.__SVNBreakLock</h4>
193 <b>__SVNBreakLock</b>(<i></i>)
194 <p>
195 Private slot called by the context menu to break lock files in the
196 repository.
197 </p><a NAME="SvnProjectBrowserHelper.__SVNConfigure" ID="SvnProjectBrowserHelper.__SVNConfigure"></a>
198 <h4>SvnProjectBrowserHelper.__SVNConfigure</h4>
199 <b>__SVNConfigure</b>(<i></i>)
200 <p>
201 Private method to open the configuration dialog.
202 </p><a NAME="SvnProjectBrowserHelper.__SVNCopy" ID="SvnProjectBrowserHelper.__SVNCopy"></a>
203 <h4>SvnProjectBrowserHelper.__SVNCopy</h4>
204 <b>__SVNCopy</b>(<i></i>)
205 <p>
206 Private slot called by the context menu to copy the selected file.
207 </p><a NAME="SvnProjectBrowserHelper.__SVNDelProp" ID="SvnProjectBrowserHelper.__SVNDelProp"></a>
208 <h4>SvnProjectBrowserHelper.__SVNDelProp</h4>
209 <b>__SVNDelProp</b>(<i></i>)
210 <p>
211 Private slot called by the context menu to delete a subversion
212 property of a file.
213 </p><a NAME="SvnProjectBrowserHelper.__SVNExtendedDiff" ID="SvnProjectBrowserHelper.__SVNExtendedDiff"></a>
214 <h4>SvnProjectBrowserHelper.__SVNExtendedDiff</h4>
215 <b>__SVNExtendedDiff</b>(<i></i>)
216 <p>
217 Private slot called by the context menu to show the difference of a
218 file to the repository.
219 </p><p>
220 This gives the chance to enter the revisions to compare.
221 </p><a NAME="SvnProjectBrowserHelper.__SVNInfo" ID="SvnProjectBrowserHelper.__SVNInfo"></a>
222 <h4>SvnProjectBrowserHelper.__SVNInfo</h4>
223 <b>__SVNInfo</b>(<i></i>)
224 <p>
225 Private slot called by the context menu to show repository information
226 of a file or directory.
227 </p><a NAME="SvnProjectBrowserHelper.__SVNListProps" ID="SvnProjectBrowserHelper.__SVNListProps"></a>
228 <h4>SvnProjectBrowserHelper.__SVNListProps</h4>
229 <b>__SVNListProps</b>(<i></i>)
230 <p>
231 Private slot called by the context menu to list the subversion
232 properties of a file.
233 </p><a NAME="SvnProjectBrowserHelper.__SVNLock" ID="SvnProjectBrowserHelper.__SVNLock"></a>
234 <h4>SvnProjectBrowserHelper.__SVNLock</h4>
235 <b>__SVNLock</b>(<i></i>)
236 <p>
237 Private slot called by the context menu to lock files in the
238 repository.
239 </p><a NAME="SvnProjectBrowserHelper.__SVNMove" ID="SvnProjectBrowserHelper.__SVNMove"></a>
240 <h4>SvnProjectBrowserHelper.__SVNMove</h4>
241 <b>__SVNMove</b>(<i></i>)
242 <p>
243 Private slot called by the context menu to move the selected file.
244 </p><a NAME="SvnProjectBrowserHelper.__SVNRemoveFromChangelist" ID="SvnProjectBrowserHelper.__SVNRemoveFromChangelist"></a>
245 <h4>SvnProjectBrowserHelper.__SVNRemoveFromChangelist</h4>
246 <b>__SVNRemoveFromChangelist</b>(<i></i>)
247 <p>
248 Private slot called by the context menu to remove files from their
249 changelist.
250 </p><a NAME="SvnProjectBrowserHelper.__SVNResolve" ID="SvnProjectBrowserHelper.__SVNResolve"></a>
251 <h4>SvnProjectBrowserHelper.__SVNResolve</h4>
252 <b>__SVNResolve</b>(<i></i>)
253 <p>
254 Private slot called by the context menu to resolve conflicts of a file.
255 </p><a NAME="SvnProjectBrowserHelper.__SVNSbsDiff" ID="SvnProjectBrowserHelper.__SVNSbsDiff"></a>
256 <h4>SvnProjectBrowserHelper.__SVNSbsDiff</h4>
257 <b>__SVNSbsDiff</b>(<i></i>)
258 <p>
259 Private slot called by the context menu to show the difference of a
260 file to the repository side-by-side.
261 </p><a NAME="SvnProjectBrowserHelper.__SVNSbsExtendedDiff" ID="SvnProjectBrowserHelper.__SVNSbsExtendedDiff"></a>
262 <h4>SvnProjectBrowserHelper.__SVNSbsExtendedDiff</h4>
263 <b>__SVNSbsExtendedDiff</b>(<i></i>)
264 <p>
265 Private slot called by the context menu to show the difference of a
266 file to the repository side-by-side.
267 </p><p>
268 It allows the selection of revisions to compare.
269 </p><a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a>
270 <h4>SvnProjectBrowserHelper.__SVNSetProp</h4>
271 <b>__SVNSetProp</b>(<i></i>)
272 <p>
273 Private slot called by the context menu to set a subversion
274 property of a file.
275 </p><a NAME="SvnProjectBrowserHelper.__SVNStealLock" ID="SvnProjectBrowserHelper.__SVNStealLock"></a>
276 <h4>SvnProjectBrowserHelper.__SVNStealLock</h4>
277 <b>__SVNStealLock</b>(<i></i>)
278 <p>
279 Private slot called by the context menu to steal lock files in the
280 repository.
281 </p><a NAME="SvnProjectBrowserHelper.__SVNUnlock" ID="SvnProjectBrowserHelper.__SVNUnlock"></a>
282 <h4>SvnProjectBrowserHelper.__SVNUnlock</h4>
283 <b>__SVNUnlock</b>(<i></i>)
284 <p>
285 Private slot called by the context menu to unlock files in the
286 repository.
287 </p><a NAME="SvnProjectBrowserHelper.__SVNUrlDiff" ID="SvnProjectBrowserHelper.__SVNUrlDiff"></a>
288 <h4>SvnProjectBrowserHelper.__SVNUrlDiff</h4>
289 <b>__SVNUrlDiff</b>(<i></i>)
290 <p>
291 Private slot called by the context menu to show the difference of a
292 file of two repository URLs.
293 </p><p>
294 This gives the chance to enter the repository URLs to compare.
295 </p><a NAME="SvnProjectBrowserHelper.__itemsHaveFiles" ID="SvnProjectBrowserHelper.__itemsHaveFiles"></a>
296 <h4>SvnProjectBrowserHelper.__itemsHaveFiles</h4>
297 <b>__itemsHaveFiles</b>(<i>items</i>)
298 <p>
299 Private method to check, if items contain file type items.
300 </p><dl>
301 <dt><i>items</i></dt>
302 <dd>
303 items to check (list of QTreeWidgetItems)
304 </dd>
305 </dl><dl>
306 <dt>Returns:</dt>
307 <dd>
308 flag indicating items contain file type items (boolean)
309 </dd>
310 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a>
311 <h4>SvnProjectBrowserHelper._addVCSMenu</h4>
312 <b>_addVCSMenu</b>(<i>mainMenu</i>)
313 <p>
314 Protected method used to add the VCS menu to all project browsers.
315 </p><dl>
316 <dt><i>mainMenu</i></dt>
317 <dd>
318 reference to the menu to be amended
319 </dd>
320 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuBack" ID="SvnProjectBrowserHelper._addVCSMenuBack"></a>
321 <h4>SvnProjectBrowserHelper._addVCSMenuBack</h4>
322 <b>_addVCSMenuBack</b>(<i>mainMenu</i>)
323 <p>
324 Protected method used to add the VCS menu to all project browsers.
325 </p><dl>
326 <dt><i>mainMenu</i></dt>
327 <dd>
328 reference to the menu to be amended
329 </dd>
330 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDir" ID="SvnProjectBrowserHelper._addVCSMenuDir"></a>
331 <h4>SvnProjectBrowserHelper._addVCSMenuDir</h4>
332 <b>_addVCSMenuDir</b>(<i>mainMenu</i>)
333 <p>
334 Protected method used to add the VCS menu to all project browsers.
335 </p><dl>
336 <dt><i>mainMenu</i></dt>
337 <dd>
338 reference to the menu to be amended
339 </dd>
340 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDirMulti" ID="SvnProjectBrowserHelper._addVCSMenuDirMulti"></a>
341 <h4>SvnProjectBrowserHelper._addVCSMenuDirMulti</h4>
342 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
343 <p>
344 Protected method used to add the VCS menu to all project browsers.
345 </p><dl>
346 <dt><i>mainMenu</i></dt>
347 <dd>
348 reference to the menu to be amended
349 </dd>
350 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuMulti" ID="SvnProjectBrowserHelper._addVCSMenuMulti"></a>
351 <h4>SvnProjectBrowserHelper._addVCSMenuMulti</h4>
352 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
353 <p>
354 Protected method used to add the VCS menu for multi selection to all
355 project browsers.
356 </p><dl>
357 <dt><i>mainMenu</i></dt>
358 <dd>
359 reference to the menu to be amended
360 </dd>
361 </dl><a NAME="SvnProjectBrowserHelper.showContextMenu" ID="SvnProjectBrowserHelper.showContextMenu"></a>
362 <h4>SvnProjectBrowserHelper.showContextMenu</h4>
363 <b>showContextMenu</b>(<i>menu, standardItems</i>)
364 <p>
365 Public slot called before the context menu is shown.
366 </p><p>
367 It enables/disables the VCS menu entries depending on the overall
368 VCS status and the file status.
369 </p><dl>
370 <dt><i>menu</i></dt>
371 <dd>
372 reference to the menu to be shown
373 </dd><dt><i>standardItems</i></dt>
374 <dd>
375 array of standard items that need
376 activation/deactivation depending on the overall VCS status
377 </dd>
378 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a>
379 <h4>SvnProjectBrowserHelper.showContextMenuDir</h4>
380 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
381 <p>
382 Public slot called before the context menu is shown.
383 </p><p>
384 It enables/disables the VCS menu entries depending on the overall
385 VCS status and the directory status.
386 </p><dl>
387 <dt><i>menu</i></dt>
388 <dd>
389 reference to the menu to be shown
390 </dd><dt><i>standardItems</i></dt>
391 <dd>
392 array of standard items that need
393 activation/deactivation depending on the overall VCS status
394 </dd>
395 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a>
396 <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4>
397 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
398 <p>
399 Public slot called before the context menu is shown.
400 </p><p>
401 It enables/disables the VCS menu entries depending on the overall
402 VCS status and the directory status.
403 </p><dl>
404 <dt><i>menu</i></dt>
405 <dd>
406 reference to the menu to be shown
407 </dd><dt><i>standardItems</i></dt>
408 <dd>
409 array of standard items that need
410 activation/deactivation depending on the overall VCS status
411 </dd>
412 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a>
413 <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4>
414 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
415 <p>
416 Public slot called before the context menu (multiple selections) is
417 shown.
418 </p><p>
419 It enables/disables the VCS menu entries depending on the overall
420 VCS status and the files status.
421 </p><dl>
422 <dt><i>menu</i></dt>
423 <dd>
424 reference to the menu to be shown
425 </dd><dt><i>standardItems</i></dt>
426 <dd>
427 array of standard items that need
428 activation/deactivation depending on the overall VCS status
429 </dd>
430 </dl>
431 <div align="right"><a href="#top">Up</a></div>
432 <hr />
433 </body></html>

eric ide

mercurial