5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the VCS project browser helper for Git. |
11 Module implementing the VCS project browser helper for Git. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#GitProjectBrowserHelper">GitProjectBrowserHelper</a></td> |
22 <td><a href="#GitProjectBrowserHelper">GitProjectBrowserHelper</a></td> |
25 <td>Class implementing the VCS project browser helper for Git.</td> |
23 <td>Class implementing the VCS project browser helper for Git.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="GitProjectBrowserHelper" ID="GitProjectBrowserHelper"></a> |
34 <a NAME="GitProjectBrowserHelper" ID="GitProjectBrowserHelper"></a> |
36 <h2>GitProjectBrowserHelper</h2> |
35 <h2>GitProjectBrowserHelper</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the VCS project browser helper for Git. |
37 Class implementing the VCS project browser helper for Git. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 VcsProjectBrowserHelper |
41 VcsProjectBrowserHelper |
43 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
44 |
|
45 <table> |
43 <table> |
46 <tr><td>None</td></tr> |
44 <tr><td>None</td></tr> |
47 </table> |
45 </table> |
|
46 |
48 <h3>Class Methods</h3> |
47 <h3>Class Methods</h3> |
49 |
|
50 <table> |
48 <table> |
51 <tr><td>None</td></tr> |
49 <tr><td>None</td></tr> |
52 </table> |
50 </table> |
|
51 |
53 <h3>Methods</h3> |
52 <h3>Methods</h3> |
54 |
53 <table> |
55 <table> |
|
56 |
|
57 <tr> |
54 <tr> |
58 <td><a href="#GitProjectBrowserHelper.__init__">GitProjectBrowserHelper</a></td> |
55 <td><a href="#GitProjectBrowserHelper.__init__">GitProjectBrowserHelper</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
189 </dd> |
187 </dd> |
190 </dl> |
188 </dl> |
191 <a NAME="GitProjectBrowserHelper.__GitBlame" ID="GitProjectBrowserHelper.__GitBlame"></a> |
189 <a NAME="GitProjectBrowserHelper.__GitBlame" ID="GitProjectBrowserHelper.__GitBlame"></a> |
192 <h4>GitProjectBrowserHelper.__GitBlame</h4> |
190 <h4>GitProjectBrowserHelper.__GitBlame</h4> |
193 <b>__GitBlame</b>(<i></i>) |
191 <b>__GitBlame</b>(<i></i>) |
194 |
|
195 <p> |
192 <p> |
196 Private slot called by the context menu to show the annotations of a |
193 Private slot called by the context menu to show the annotations of a |
197 file. |
194 file. |
198 </p> |
195 </p> |
|
196 |
199 <a NAME="GitProjectBrowserHelper.__GitBlameSkip" ID="GitProjectBrowserHelper.__GitBlameSkip"></a> |
197 <a NAME="GitProjectBrowserHelper.__GitBlameSkip" ID="GitProjectBrowserHelper.__GitBlameSkip"></a> |
200 <h4>GitProjectBrowserHelper.__GitBlameSkip</h4> |
198 <h4>GitProjectBrowserHelper.__GitBlameSkip</h4> |
201 <b>__GitBlameSkip</b>(<i></i>) |
199 <b>__GitBlameSkip</b>(<i></i>) |
202 |
|
203 <p> |
200 <p> |
204 Private slot called by the context menu to show the annotations of a |
201 Private slot called by the context menu to show the annotations of a |
205 file with a project specific skip list. |
202 file with a project specific skip list. |
206 </p> |
203 </p> |
|
204 |
207 <a NAME="GitProjectBrowserHelper.__GitBlameSkipListFile" ID="GitProjectBrowserHelper.__GitBlameSkipListFile"></a> |
205 <a NAME="GitProjectBrowserHelper.__GitBlameSkipListFile" ID="GitProjectBrowserHelper.__GitBlameSkipListFile"></a> |
208 <h4>GitProjectBrowserHelper.__GitBlameSkipListFile</h4> |
206 <h4>GitProjectBrowserHelper.__GitBlameSkipListFile</h4> |
209 <b>__GitBlameSkipListFile</b>(<i></i>) |
207 <b>__GitBlameSkipListFile</b>(<i></i>) |
210 |
|
211 <p> |
208 <p> |
212 Private method to create an empty 'git blame' skip list file. |
209 Private method to create an empty 'git blame' skip list file. |
213 </p> |
210 </p> |
|
211 |
214 <a NAME="GitProjectBrowserHelper.__GitConfigure" ID="GitProjectBrowserHelper.__GitConfigure"></a> |
212 <a NAME="GitProjectBrowserHelper.__GitConfigure" ID="GitProjectBrowserHelper.__GitConfigure"></a> |
215 <h4>GitProjectBrowserHelper.__GitConfigure</h4> |
213 <h4>GitProjectBrowserHelper.__GitConfigure</h4> |
216 <b>__GitConfigure</b>(<i></i>) |
214 <b>__GitConfigure</b>(<i></i>) |
217 |
|
218 <p> |
215 <p> |
219 Private method to open the configuration dialog. |
216 Private method to open the configuration dialog. |
220 </p> |
217 </p> |
|
218 |
221 <a NAME="GitProjectBrowserHelper.__GitCopy" ID="GitProjectBrowserHelper.__GitCopy"></a> |
219 <a NAME="GitProjectBrowserHelper.__GitCopy" ID="GitProjectBrowserHelper.__GitCopy"></a> |
222 <h4>GitProjectBrowserHelper.__GitCopy</h4> |
220 <h4>GitProjectBrowserHelper.__GitCopy</h4> |
223 <b>__GitCopy</b>(<i></i>) |
221 <b>__GitCopy</b>(<i></i>) |
224 |
|
225 <p> |
222 <p> |
226 Private slot called by the context menu to copy the selected file. |
223 Private slot called by the context menu to copy the selected file. |
227 </p> |
224 </p> |
|
225 |
228 <a NAME="GitProjectBrowserHelper.__GitExtendedDiff" ID="GitProjectBrowserHelper.__GitExtendedDiff"></a> |
226 <a NAME="GitProjectBrowserHelper.__GitExtendedDiff" ID="GitProjectBrowserHelper.__GitExtendedDiff"></a> |
229 <h4>GitProjectBrowserHelper.__GitExtendedDiff</h4> |
227 <h4>GitProjectBrowserHelper.__GitExtendedDiff</h4> |
230 <b>__GitExtendedDiff</b>(<i></i>) |
228 <b>__GitExtendedDiff</b>(<i></i>) |
231 |
|
232 <p> |
229 <p> |
233 Private slot called by the context menu to show the difference of a |
230 Private slot called by the context menu to show the difference of a |
234 file to the repository. |
231 file to the repository. |
235 </p> |
232 </p> |
236 <p> |
233 <p> |
237 This gives the chance to enter the revisions to compare. |
234 This gives the chance to enter the revisions to compare. |
238 </p> |
235 </p> |
|
236 |
239 <a NAME="GitProjectBrowserHelper.__GitForget" ID="GitProjectBrowserHelper.__GitForget"></a> |
237 <a NAME="GitProjectBrowserHelper.__GitForget" ID="GitProjectBrowserHelper.__GitForget"></a> |
240 <h4>GitProjectBrowserHelper.__GitForget</h4> |
238 <h4>GitProjectBrowserHelper.__GitForget</h4> |
241 <b>__GitForget</b>(<i></i>) |
239 <b>__GitForget</b>(<i></i>) |
242 |
|
243 <p> |
240 <p> |
244 Private slot called by the context menu to remove the selected file |
241 Private slot called by the context menu to remove the selected file |
245 from the Git repository leaving a copy in the project directory. |
242 from the Git repository leaving a copy in the project directory. |
246 </p> |
243 </p> |
|
244 |
247 <a NAME="GitProjectBrowserHelper.__GitMove" ID="GitProjectBrowserHelper.__GitMove"></a> |
245 <a NAME="GitProjectBrowserHelper.__GitMove" ID="GitProjectBrowserHelper.__GitMove"></a> |
248 <h4>GitProjectBrowserHelper.__GitMove</h4> |
246 <h4>GitProjectBrowserHelper.__GitMove</h4> |
249 <b>__GitMove</b>(<i></i>) |
247 <b>__GitMove</b>(<i></i>) |
250 |
|
251 <p> |
248 <p> |
252 Private slot called by the context menu to move the selected file. |
249 Private slot called by the context menu to move the selected file. |
253 </p> |
250 </p> |
|
251 |
254 <a NAME="GitProjectBrowserHelper.__GitRevert" ID="GitProjectBrowserHelper.__GitRevert"></a> |
252 <a NAME="GitProjectBrowserHelper.__GitRevert" ID="GitProjectBrowserHelper.__GitRevert"></a> |
255 <h4>GitProjectBrowserHelper.__GitRevert</h4> |
253 <h4>GitProjectBrowserHelper.__GitRevert</h4> |
256 <b>__GitRevert</b>(<i></i>) |
254 <b>__GitRevert</b>(<i></i>) |
257 |
|
258 <p> |
255 <p> |
259 Private slot to revert changes of the working area. |
256 Private slot to revert changes of the working area. |
260 </p> |
257 </p> |
|
258 |
261 <a NAME="GitProjectBrowserHelper.__GitSbsDiff" ID="GitProjectBrowserHelper.__GitSbsDiff"></a> |
259 <a NAME="GitProjectBrowserHelper.__GitSbsDiff" ID="GitProjectBrowserHelper.__GitSbsDiff"></a> |
262 <h4>GitProjectBrowserHelper.__GitSbsDiff</h4> |
260 <h4>GitProjectBrowserHelper.__GitSbsDiff</h4> |
263 <b>__GitSbsDiff</b>(<i></i>) |
261 <b>__GitSbsDiff</b>(<i></i>) |
264 |
|
265 <p> |
262 <p> |
266 Private slot called by the context menu to show the difference of a |
263 Private slot called by the context menu to show the difference of a |
267 file to the repository side-by-side. |
264 file to the repository side-by-side. |
268 </p> |
265 </p> |
|
266 |
269 <a NAME="GitProjectBrowserHelper.__GitSbsExtendedDiff" ID="GitProjectBrowserHelper.__GitSbsExtendedDiff"></a> |
267 <a NAME="GitProjectBrowserHelper.__GitSbsExtendedDiff" ID="GitProjectBrowserHelper.__GitSbsExtendedDiff"></a> |
270 <h4>GitProjectBrowserHelper.__GitSbsExtendedDiff</h4> |
268 <h4>GitProjectBrowserHelper.__GitSbsExtendedDiff</h4> |
271 <b>__GitSbsExtendedDiff</b>(<i></i>) |
269 <b>__GitSbsExtendedDiff</b>(<i></i>) |
272 |
|
273 <p> |
270 <p> |
274 Private slot called by the context menu to show the difference of a |
271 Private slot called by the context menu to show the difference of a |
275 file to the repository side-by-side. |
272 file to the repository side-by-side. |
276 </p> |
273 </p> |
277 <p> |
274 <p> |
278 It allows the selection of revisions to compare. |
275 It allows the selection of revisions to compare. |
279 </p> |
276 </p> |
|
277 |
280 <a NAME="GitProjectBrowserHelper.__GitUnstage" ID="GitProjectBrowserHelper.__GitUnstage"></a> |
278 <a NAME="GitProjectBrowserHelper.__GitUnstage" ID="GitProjectBrowserHelper.__GitUnstage"></a> |
281 <h4>GitProjectBrowserHelper.__GitUnstage</h4> |
279 <h4>GitProjectBrowserHelper.__GitUnstage</h4> |
282 <b>__GitUnstage</b>(<i></i>) |
280 <b>__GitUnstage</b>(<i></i>) |
283 |
|
284 <p> |
281 <p> |
285 Private slot to unstage changes. |
282 Private slot to unstage changes. |
286 </p> |
283 </p> |
|
284 |
287 <a NAME="GitProjectBrowserHelper.__skipListFileName" ID="GitProjectBrowserHelper.__skipListFileName"></a> |
285 <a NAME="GitProjectBrowserHelper.__skipListFileName" ID="GitProjectBrowserHelper.__skipListFileName"></a> |
288 <h4>GitProjectBrowserHelper.__skipListFileName</h4> |
286 <h4>GitProjectBrowserHelper.__skipListFileName</h4> |
289 <b>__skipListFileName</b>(<i></i>) |
287 <b>__skipListFileName</b>(<i></i>) |
290 |
|
291 <p> |
288 <p> |
292 Private method to generate the file name for a 'git blame' skip list file. |
289 Private method to generate the file name for a 'git blame' skip list file. |
293 </p> |
290 </p> |
|
291 |
294 <dl> |
292 <dl> |
295 <dt>Return:</dt> |
293 <dt>Return:</dt> |
296 <dd> |
294 <dd> |
297 name of the skip list file |
295 name of the skip list file |
298 </dd> |
296 </dd> |
304 </dd> |
302 </dd> |
305 </dl> |
303 </dl> |
306 <a NAME="GitProjectBrowserHelper._addVCSMenu" ID="GitProjectBrowserHelper._addVCSMenu"></a> |
304 <a NAME="GitProjectBrowserHelper._addVCSMenu" ID="GitProjectBrowserHelper._addVCSMenu"></a> |
307 <h4>GitProjectBrowserHelper._addVCSMenu</h4> |
305 <h4>GitProjectBrowserHelper._addVCSMenu</h4> |
308 <b>_addVCSMenu</b>(<i>mainMenu</i>) |
306 <b>_addVCSMenu</b>(<i>mainMenu</i>) |
309 |
|
310 <p> |
307 <p> |
311 Protected method used to add the VCS menu to all project browsers. |
308 Protected method used to add the VCS menu to all project browsers. |
312 </p> |
309 </p> |
|
310 |
313 <dl> |
311 <dl> |
314 |
312 |
315 <dt><i>mainMenu</i> (QMenu)</dt> |
313 <dt><i>mainMenu</i> (QMenu)</dt> |
316 <dd> |
314 <dd> |
317 reference to the menu to be amended |
315 reference to the menu to be amended |
318 </dd> |
316 </dd> |
319 </dl> |
317 </dl> |
320 <a NAME="GitProjectBrowserHelper._addVCSMenuBack" ID="GitProjectBrowserHelper._addVCSMenuBack"></a> |
318 <a NAME="GitProjectBrowserHelper._addVCSMenuBack" ID="GitProjectBrowserHelper._addVCSMenuBack"></a> |
321 <h4>GitProjectBrowserHelper._addVCSMenuBack</h4> |
319 <h4>GitProjectBrowserHelper._addVCSMenuBack</h4> |
322 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) |
320 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) |
323 |
|
324 <p> |
321 <p> |
325 Protected method used to add the VCS menu to all project browsers. |
322 Protected method used to add the VCS menu to all project browsers. |
326 </p> |
323 </p> |
|
324 |
327 <dl> |
325 <dl> |
328 |
326 |
329 <dt><i>mainMenu</i> (QMenu)</dt> |
327 <dt><i>mainMenu</i> (QMenu)</dt> |
330 <dd> |
328 <dd> |
331 reference to the menu to be amended |
329 reference to the menu to be amended |
332 </dd> |
330 </dd> |
333 </dl> |
331 </dl> |
334 <a NAME="GitProjectBrowserHelper._addVCSMenuDir" ID="GitProjectBrowserHelper._addVCSMenuDir"></a> |
332 <a NAME="GitProjectBrowserHelper._addVCSMenuDir" ID="GitProjectBrowserHelper._addVCSMenuDir"></a> |
335 <h4>GitProjectBrowserHelper._addVCSMenuDir</h4> |
333 <h4>GitProjectBrowserHelper._addVCSMenuDir</h4> |
336 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) |
334 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) |
337 |
|
338 <p> |
335 <p> |
339 Protected method used to add the VCS menu to all project browsers. |
336 Protected method used to add the VCS menu to all project browsers. |
340 </p> |
337 </p> |
|
338 |
341 <dl> |
339 <dl> |
342 |
340 |
343 <dt><i>mainMenu</i> (QMenu)</dt> |
341 <dt><i>mainMenu</i> (QMenu)</dt> |
344 <dd> |
342 <dd> |
345 reference to the menu to be amended |
343 reference to the menu to be amended |
346 </dd> |
344 </dd> |
347 </dl> |
345 </dl> |
348 <a NAME="GitProjectBrowserHelper._addVCSMenuDirMulti" ID="GitProjectBrowserHelper._addVCSMenuDirMulti"></a> |
346 <a NAME="GitProjectBrowserHelper._addVCSMenuDirMulti" ID="GitProjectBrowserHelper._addVCSMenuDirMulti"></a> |
349 <h4>GitProjectBrowserHelper._addVCSMenuDirMulti</h4> |
347 <h4>GitProjectBrowserHelper._addVCSMenuDirMulti</h4> |
350 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) |
348 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) |
351 |
|
352 <p> |
349 <p> |
353 Protected method used to add the VCS menu to all project browsers. |
350 Protected method used to add the VCS menu to all project browsers. |
354 </p> |
351 </p> |
|
352 |
355 <dl> |
353 <dl> |
356 |
354 |
357 <dt><i>mainMenu</i> (QMenu)</dt> |
355 <dt><i>mainMenu</i> (QMenu)</dt> |
358 <dd> |
356 <dd> |
359 reference to the menu to be amended |
357 reference to the menu to be amended |
360 </dd> |
358 </dd> |
361 </dl> |
359 </dl> |
362 <a NAME="GitProjectBrowserHelper._addVCSMenuMulti" ID="GitProjectBrowserHelper._addVCSMenuMulti"></a> |
360 <a NAME="GitProjectBrowserHelper._addVCSMenuMulti" ID="GitProjectBrowserHelper._addVCSMenuMulti"></a> |
363 <h4>GitProjectBrowserHelper._addVCSMenuMulti</h4> |
361 <h4>GitProjectBrowserHelper._addVCSMenuMulti</h4> |
364 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) |
362 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) |
365 |
|
366 <p> |
363 <p> |
367 Protected method used to add the VCS menu for multi selection to all |
364 Protected method used to add the VCS menu for multi selection to all |
368 project browsers. |
365 project browsers. |
369 </p> |
366 </p> |
|
367 |
370 <dl> |
368 <dl> |
371 |
369 |
372 <dt><i>mainMenu</i> (QMenu)</dt> |
370 <dt><i>mainMenu</i> (QMenu)</dt> |
373 <dd> |
371 <dd> |
374 reference to the menu to be amended |
372 reference to the menu to be amended |
375 </dd> |
373 </dd> |
376 </dl> |
374 </dl> |
377 <a NAME="GitProjectBrowserHelper.showContextMenu" ID="GitProjectBrowserHelper.showContextMenu"></a> |
375 <a NAME="GitProjectBrowserHelper.showContextMenu" ID="GitProjectBrowserHelper.showContextMenu"></a> |
378 <h4>GitProjectBrowserHelper.showContextMenu</h4> |
376 <h4>GitProjectBrowserHelper.showContextMenu</h4> |
379 <b>showContextMenu</b>(<i>menu, standardItems</i>) |
377 <b>showContextMenu</b>(<i>menu, standardItems</i>) |
380 |
|
381 <p> |
378 <p> |
382 Public slot called before the context menu is shown. |
379 Public slot called before the context menu is shown. |
383 </p> |
380 </p> |
384 <p> |
381 <p> |
385 It enables/disables the VCS menu entries depending on the overall |
382 It enables/disables the VCS menu entries depending on the overall |
386 VCS status and the file status. |
383 VCS status and the file status. |
387 </p> |
384 </p> |
|
385 |
388 <dl> |
386 <dl> |
389 |
387 |
390 <dt><i>menu</i> (QMenu)</dt> |
388 <dt><i>menu</i> (QMenu)</dt> |
391 <dd> |
389 <dd> |
392 reference to the menu to be shown |
390 reference to the menu to be shown |