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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.VcsPlugins.vcsSubversion.ProjectBrowserHelper</h1>
24 <p>
25 Module implementing the VCS project browser helper for subversion.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#SvnProjectBrowserHelper">SvnProjectBrowserHelper</a></td>
35 <td>Class implementing the VCS project browser helper for subversion.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="SvnProjectBrowserHelper" ID="SvnProjectBrowserHelper"></a>
44 <h2>SvnProjectBrowserHelper</h2>
45 <p>
46 Class implementing the VCS project browser helper for subversion.
47 </p>
48 <h3>Derived from</h3>
49 VcsProjectBrowserHelper
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#SvnProjectBrowserHelper.__init__">SvnProjectBrowserHelper</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#SvnProjectBrowserHelper.__SVNAddToChangelist">__SVNAddToChangelist</a></td>
61 <td>Private slot called by the context menu to add files to a changelist.</td>
62 </tr><tr>
63 <td><a href="#SvnProjectBrowserHelper.__SVNBlame">__SVNBlame</a></td>
64 <td>Private slot called by the context menu to show the blame of a file.</td>
65 </tr><tr>
66 <td><a href="#SvnProjectBrowserHelper.__SVNBreakLock">__SVNBreakLock</a></td>
67 <td>Private slot called by the context menu to break lock files in the repository.</td>
68 </tr><tr>
69 <td><a href="#SvnProjectBrowserHelper.__SVNConfigure">__SVNConfigure</a></td>
70 <td>Private method to open the configuration dialog.</td>
71 </tr><tr>
72 <td><a href="#SvnProjectBrowserHelper.__SVNCopy">__SVNCopy</a></td>
73 <td>Private slot called by the context menu to copy the selected file.</td>
74 </tr><tr>
75 <td><a href="#SvnProjectBrowserHelper.__SVNDelProp">__SVNDelProp</a></td>
76 <td>Private slot called by the context menu to delete a subversion property of a file.</td>
77 </tr><tr>
78 <td><a href="#SvnProjectBrowserHelper.__SVNExtendedDiff">__SVNExtendedDiff</a></td>
79 <td>Private slot called by the context menu to show the difference of a file to the repository.</td>
80 </tr><tr>
81 <td><a href="#SvnProjectBrowserHelper.__SVNListProps">__SVNListProps</a></td>
82 <td>Private slot called by the context menu to list the subversion properties of a file.</td>
83 </tr><tr>
84 <td><a href="#SvnProjectBrowserHelper.__SVNLock">__SVNLock</a></td>
85 <td>Private slot called by the context menu to lock files in the repository.</td>
86 </tr><tr>
87 <td><a href="#SvnProjectBrowserHelper.__SVNLogBrowser">__SVNLogBrowser</a></td>
88 <td>Private slot called by the context menu to show the log browser for a file.</td>
89 </tr><tr>
90 <td><a href="#SvnProjectBrowserHelper.__SVNLogLimited">__SVNLogLimited</a></td>
91 <td>Private slot called by the context menu to show the limited log of a file.</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.__SVNSetProp">__SVNSetProp</a></td>
103 <td>Private slot called by the context menu to set a subversion property of a file.</td>
104 </tr><tr>
105 <td><a href="#SvnProjectBrowserHelper.__SVNStealLock">__SVNStealLock</a></td>
106 <td>Private slot called by the context menu to steal lock files in the repository.</td>
107 </tr><tr>
108 <td><a href="#SvnProjectBrowserHelper.__SVNUnlock">__SVNUnlock</a></td>
109 <td>Private slot called by the context menu to unlock files in the repository.</td>
110 </tr><tr>
111 <td><a href="#SvnProjectBrowserHelper.__SVNUrlDiff">__SVNUrlDiff</a></td>
112 <td>Private slot called by the context menu to show the difference of a file of two repository URLs.</td>
113 </tr><tr>
114 <td><a href="#SvnProjectBrowserHelper.__itemsHaveFiles">__itemsHaveFiles</a></td>
115 <td>Private method to check, if items contain file type items.</td>
116 </tr><tr>
117 <td><a href="#SvnProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
118 <td>Protected method used to add the VCS menu to all project browsers.</td>
119 </tr><tr>
120 <td><a href="#SvnProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td>
121 <td>Protected method used to add the VCS menu to all project browsers.</td>
122 </tr><tr>
123 <td><a href="#SvnProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</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._addVCSMenuDirMulti">_addVCSMenuDirMulti</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._addVCSMenuMulti">_addVCSMenuMulti</a></td>
130 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
131 </tr><tr>
132 <td><a href="#SvnProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
133 <td>Slot called before the context menu is shown.</td>
134 </tr><tr>
135 <td><a href="#SvnProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
136 <td>Slot called before the context menu is shown.</td>
137 </tr><tr>
138 <td><a href="#SvnProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
139 <td>Slot called before the context menu is shown.</td>
140 </tr><tr>
141 <td><a href="#SvnProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
142 <td>Slot called before the context menu (multiple selections) is shown.</td>
143 </tr>
144 </table>
145 <a NAME="SvnProjectBrowserHelper.__init__" ID="SvnProjectBrowserHelper.__init__"></a>
146 <h4>SvnProjectBrowserHelper (Constructor)</h4>
147 <b>SvnProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent = None, name = None</i>)
148 <p>
149 Constructor
150 </p><dl>
151 <dt><i>vcsObject</i></dt>
152 <dd>
153 reference to the vcs object
154 </dd><dt><i>browserObject</i></dt>
155 <dd>
156 reference to the project browser object
157 </dd><dt><i>projectObject</i></dt>
158 <dd>
159 reference to the project object
160 </dd><dt><i>isTranslationsBrowser</i></dt>
161 <dd>
162 flag indicating, the helper is requested for the
163 translations browser (this needs some special treatment)
164 </dd><dt><i>parent</i></dt>
165 <dd>
166 parent widget (QWidget)
167 </dd><dt><i>name</i></dt>
168 <dd>
169 name of this object (string)
170 </dd>
171 </dl><a NAME="SvnProjectBrowserHelper.__SVNAddToChangelist" ID="SvnProjectBrowserHelper.__SVNAddToChangelist"></a>
172 <h4>SvnProjectBrowserHelper.__SVNAddToChangelist</h4>
173 <b>__SVNAddToChangelist</b>(<i></i>)
174 <p>
175 Private slot called by the context menu to add files to a changelist.
176 </p><a NAME="SvnProjectBrowserHelper.__SVNBlame" ID="SvnProjectBrowserHelper.__SVNBlame"></a>
177 <h4>SvnProjectBrowserHelper.__SVNBlame</h4>
178 <b>__SVNBlame</b>(<i></i>)
179 <p>
180 Private slot called by the context menu to show the blame of a file.
181 </p><a NAME="SvnProjectBrowserHelper.__SVNBreakLock" ID="SvnProjectBrowserHelper.__SVNBreakLock"></a>
182 <h4>SvnProjectBrowserHelper.__SVNBreakLock</h4>
183 <b>__SVNBreakLock</b>(<i></i>)
184 <p>
185 Private slot called by the context menu to break lock files in the repository.
186 </p><a NAME="SvnProjectBrowserHelper.__SVNConfigure" ID="SvnProjectBrowserHelper.__SVNConfigure"></a>
187 <h4>SvnProjectBrowserHelper.__SVNConfigure</h4>
188 <b>__SVNConfigure</b>(<i></i>)
189 <p>
190 Private method to open the configuration dialog.
191 </p><a NAME="SvnProjectBrowserHelper.__SVNCopy" ID="SvnProjectBrowserHelper.__SVNCopy"></a>
192 <h4>SvnProjectBrowserHelper.__SVNCopy</h4>
193 <b>__SVNCopy</b>(<i></i>)
194 <p>
195 Private slot called by the context menu to copy the selected file.
196 </p><a NAME="SvnProjectBrowserHelper.__SVNDelProp" ID="SvnProjectBrowserHelper.__SVNDelProp"></a>
197 <h4>SvnProjectBrowserHelper.__SVNDelProp</h4>
198 <b>__SVNDelProp</b>(<i></i>)
199 <p>
200 Private slot called by the context menu to delete a subversion property of a file.
201 </p><a NAME="SvnProjectBrowserHelper.__SVNExtendedDiff" ID="SvnProjectBrowserHelper.__SVNExtendedDiff"></a>
202 <h4>SvnProjectBrowserHelper.__SVNExtendedDiff</h4>
203 <b>__SVNExtendedDiff</b>(<i></i>)
204 <p>
205 Private slot called by the context menu to show the difference of a file to
206 the repository.
207 </p><p>
208 This gives the chance to enter the revisions to compare.
209 </p><a NAME="SvnProjectBrowserHelper.__SVNListProps" ID="SvnProjectBrowserHelper.__SVNListProps"></a>
210 <h4>SvnProjectBrowserHelper.__SVNListProps</h4>
211 <b>__SVNListProps</b>(<i></i>)
212 <p>
213 Private slot called by the context menu to list the subversion properties of
214 a file.
215 </p><a NAME="SvnProjectBrowserHelper.__SVNLock" ID="SvnProjectBrowserHelper.__SVNLock"></a>
216 <h4>SvnProjectBrowserHelper.__SVNLock</h4>
217 <b>__SVNLock</b>(<i></i>)
218 <p>
219 Private slot called by the context menu to lock files in the repository.
220 </p><a NAME="SvnProjectBrowserHelper.__SVNLogBrowser" ID="SvnProjectBrowserHelper.__SVNLogBrowser"></a>
221 <h4>SvnProjectBrowserHelper.__SVNLogBrowser</h4>
222 <b>__SVNLogBrowser</b>(<i></i>)
223 <p>
224 Private slot called by the context menu to show the log browser for a file.
225 </p><a NAME="SvnProjectBrowserHelper.__SVNLogLimited" ID="SvnProjectBrowserHelper.__SVNLogLimited"></a>
226 <h4>SvnProjectBrowserHelper.__SVNLogLimited</h4>
227 <b>__SVNLogLimited</b>(<i></i>)
228 <p>
229 Private slot called by the context menu to show the limited log of a file.
230 </p><a NAME="SvnProjectBrowserHelper.__SVNMove" ID="SvnProjectBrowserHelper.__SVNMove"></a>
231 <h4>SvnProjectBrowserHelper.__SVNMove</h4>
232 <b>__SVNMove</b>(<i></i>)
233 <p>
234 Private slot called by the context menu to move the selected file.
235 </p><a NAME="SvnProjectBrowserHelper.__SVNRemoveFromChangelist" ID="SvnProjectBrowserHelper.__SVNRemoveFromChangelist"></a>
236 <h4>SvnProjectBrowserHelper.__SVNRemoveFromChangelist</h4>
237 <b>__SVNRemoveFromChangelist</b>(<i></i>)
238 <p>
239 Private slot called by the context menu to remove files from their changelist.
240 </p><a NAME="SvnProjectBrowserHelper.__SVNResolve" ID="SvnProjectBrowserHelper.__SVNResolve"></a>
241 <h4>SvnProjectBrowserHelper.__SVNResolve</h4>
242 <b>__SVNResolve</b>(<i></i>)
243 <p>
244 Private slot called by the context menu to resolve conflicts of a file.
245 </p><a NAME="SvnProjectBrowserHelper.__SVNSetProp" ID="SvnProjectBrowserHelper.__SVNSetProp"></a>
246 <h4>SvnProjectBrowserHelper.__SVNSetProp</h4>
247 <b>__SVNSetProp</b>(<i></i>)
248 <p>
249 Private slot called by the context menu to set a subversion property of a file.
250 </p><a NAME="SvnProjectBrowserHelper.__SVNStealLock" ID="SvnProjectBrowserHelper.__SVNStealLock"></a>
251 <h4>SvnProjectBrowserHelper.__SVNStealLock</h4>
252 <b>__SVNStealLock</b>(<i></i>)
253 <p>
254 Private slot called by the context menu to steal lock files in the repository.
255 </p><a NAME="SvnProjectBrowserHelper.__SVNUnlock" ID="SvnProjectBrowserHelper.__SVNUnlock"></a>
256 <h4>SvnProjectBrowserHelper.__SVNUnlock</h4>
257 <b>__SVNUnlock</b>(<i></i>)
258 <p>
259 Private slot called by the context menu to unlock files in the repository.
260 </p><a NAME="SvnProjectBrowserHelper.__SVNUrlDiff" ID="SvnProjectBrowserHelper.__SVNUrlDiff"></a>
261 <h4>SvnProjectBrowserHelper.__SVNUrlDiff</h4>
262 <b>__SVNUrlDiff</b>(<i></i>)
263 <p>
264 Private slot called by the context menu to show the difference of a file of
265 two repository URLs.
266 </p><p>
267 This gives the chance to enter the repository URLs to compare.
268 </p><a NAME="SvnProjectBrowserHelper.__itemsHaveFiles" ID="SvnProjectBrowserHelper.__itemsHaveFiles"></a>
269 <h4>SvnProjectBrowserHelper.__itemsHaveFiles</h4>
270 <b>__itemsHaveFiles</b>(<i>items</i>)
271 <p>
272 Private method to check, if items contain file type items.
273 </p><dl>
274 <dt><i>items</i></dt>
275 <dd>
276 items to check (list of QTreeWidgetItems)
277 </dd>
278 </dl><dl>
279 <dt>Returns:</dt>
280 <dd>
281 flag indicating items contain file type items (boolean)
282 </dd>
283 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenu" ID="SvnProjectBrowserHelper._addVCSMenu"></a>
284 <h4>SvnProjectBrowserHelper._addVCSMenu</h4>
285 <b>_addVCSMenu</b>(<i>mainMenu</i>)
286 <p>
287 Protected method used to add the VCS menu to all project browsers.
288 </p><dl>
289 <dt><i>mainMenu</i></dt>
290 <dd>
291 reference to the menu to be amended
292 </dd>
293 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuBack" ID="SvnProjectBrowserHelper._addVCSMenuBack"></a>
294 <h4>SvnProjectBrowserHelper._addVCSMenuBack</h4>
295 <b>_addVCSMenuBack</b>(<i>mainMenu</i>)
296 <p>
297 Protected method used to add the VCS menu to all project browsers.
298 </p><dl>
299 <dt><i>mainMenu</i></dt>
300 <dd>
301 reference to the menu to be amended
302 </dd>
303 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDir" ID="SvnProjectBrowserHelper._addVCSMenuDir"></a>
304 <h4>SvnProjectBrowserHelper._addVCSMenuDir</h4>
305 <b>_addVCSMenuDir</b>(<i>mainMenu</i>)
306 <p>
307 Protected method used to add the VCS menu to all project browsers.
308 </p><dl>
309 <dt><i>mainMenu</i></dt>
310 <dd>
311 reference to the menu to be amended
312 </dd>
313 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuDirMulti" ID="SvnProjectBrowserHelper._addVCSMenuDirMulti"></a>
314 <h4>SvnProjectBrowserHelper._addVCSMenuDirMulti</h4>
315 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
316 <p>
317 Protected method used to add the VCS menu to all project browsers.
318 </p><dl>
319 <dt><i>mainMenu</i></dt>
320 <dd>
321 reference to the menu to be amended
322 </dd>
323 </dl><a NAME="SvnProjectBrowserHelper._addVCSMenuMulti" ID="SvnProjectBrowserHelper._addVCSMenuMulti"></a>
324 <h4>SvnProjectBrowserHelper._addVCSMenuMulti</h4>
325 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
326 <p>
327 Protected method used to add the VCS menu for multi selection to all
328 project browsers.
329 </p><dl>
330 <dt><i>mainMenu</i></dt>
331 <dd>
332 reference to the menu to be amended
333 </dd>
334 </dl><a NAME="SvnProjectBrowserHelper.showContextMenu" ID="SvnProjectBrowserHelper.showContextMenu"></a>
335 <h4>SvnProjectBrowserHelper.showContextMenu</h4>
336 <b>showContextMenu</b>(<i>menu, standardItems</i>)
337 <p>
338 Slot called before the context menu is shown.
339 </p><p>
340 It enables/disables the VCS menu entries depending on the overall
341 VCS status and the file status.
342 </p><dl>
343 <dt><i>menu</i></dt>
344 <dd>
345 reference to the menu to be shown
346 </dd><dt><i>standardItems</i></dt>
347 <dd>
348 array of standard items that need activation/deactivation
349 depending on the overall VCS status
350 </dd>
351 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDir" ID="SvnProjectBrowserHelper.showContextMenuDir"></a>
352 <h4>SvnProjectBrowserHelper.showContextMenuDir</h4>
353 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
354 <p>
355 Slot called before the context menu is shown.
356 </p><p>
357 It enables/disables the VCS menu entries depending on the overall
358 VCS status and the directory status.
359 </p><dl>
360 <dt><i>menu</i></dt>
361 <dd>
362 reference to the menu to be shown
363 </dd><dt><i>standardItems</i></dt>
364 <dd>
365 array of standard items that need activation/deactivation
366 depending on the overall VCS status
367 </dd>
368 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuDirMulti" ID="SvnProjectBrowserHelper.showContextMenuDirMulti"></a>
369 <h4>SvnProjectBrowserHelper.showContextMenuDirMulti</h4>
370 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
371 <p>
372 Slot called before the context menu is shown.
373 </p><p>
374 It enables/disables the VCS menu entries depending on the overall
375 VCS status and the directory status.
376 </p><dl>
377 <dt><i>menu</i></dt>
378 <dd>
379 reference to the menu to be shown
380 </dd><dt><i>standardItems</i></dt>
381 <dd>
382 array of standard items that need activation/deactivation
383 depending on the overall VCS status
384 </dd>
385 </dl><a NAME="SvnProjectBrowserHelper.showContextMenuMulti" ID="SvnProjectBrowserHelper.showContextMenuMulti"></a>
386 <h4>SvnProjectBrowserHelper.showContextMenuMulti</h4>
387 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
388 <p>
389 Slot called before the context menu (multiple selections) is shown.
390 </p><p>
391 It enables/disables the VCS menu entries depending on the overall
392 VCS status and the files status.
393 </p><dl>
394 <dt><i>menu</i></dt>
395 <dd>
396 reference to the menu to be shown
397 </dd><dt><i>standardItems</i></dt>
398 <dd>
399 array of standard items that need activation/deactivation
400 depending on the overall VCS status
401 </dd>
402 </dl>
403 <div align="right"><a href="#top">Up</a></div>
404 <hr />
405 </body></html>

eric ide

mercurial