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

eric ide

mercurial