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.vcsMercurial.ProjectBrowserHelper</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the VCS project browser helper for Mercurial. |
11 Module implementing the VCS project browser helper for Mercurial. |
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="#HgProjectBrowserHelper">HgProjectBrowserHelper</a></td> |
22 <td><a href="#HgProjectBrowserHelper">HgProjectBrowserHelper</a></td> |
25 <td>Class implementing the VCS project browser helper for Mercurial.</td> |
23 <td>Class implementing the VCS project browser helper for Mercurial.</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="HgProjectBrowserHelper" ID="HgProjectBrowserHelper"></a> |
34 <a NAME="HgProjectBrowserHelper" ID="HgProjectBrowserHelper"></a> |
36 <h2>HgProjectBrowserHelper</h2> |
35 <h2>HgProjectBrowserHelper</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the VCS project browser helper for Mercurial. |
37 Class implementing the VCS project browser helper for Mercurial. |
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="#HgProjectBrowserHelper.__init__">HgProjectBrowserHelper</a></td> |
55 <td><a href="#HgProjectBrowserHelper.__init__">HgProjectBrowserHelper</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
205 </dd> |
203 </dd> |
206 </dl> |
204 </dl> |
207 <a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a> |
205 <a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a> |
208 <h4>HgProjectBrowserHelper.__HgAnnotate</h4> |
206 <h4>HgProjectBrowserHelper.__HgAnnotate</h4> |
209 <b>__HgAnnotate</b>(<i></i>) |
207 <b>__HgAnnotate</b>(<i></i>) |
210 |
|
211 <p> |
208 <p> |
212 Private slot called by the context menu to show the annotations of a |
209 Private slot called by the context menu to show the annotations of a |
213 file. |
210 file. |
214 </p> |
211 </p> |
|
212 |
215 <a NAME="HgProjectBrowserHelper.__HgAnnotateSkip" ID="HgProjectBrowserHelper.__HgAnnotateSkip"></a> |
213 <a NAME="HgProjectBrowserHelper.__HgAnnotateSkip" ID="HgProjectBrowserHelper.__HgAnnotateSkip"></a> |
216 <h4>HgProjectBrowserHelper.__HgAnnotateSkip</h4> |
214 <h4>HgProjectBrowserHelper.__HgAnnotateSkip</h4> |
217 <b>__HgAnnotateSkip</b>(<i></i>) |
215 <b>__HgAnnotateSkip</b>(<i></i>) |
218 |
|
219 <p> |
216 <p> |
220 Private slot called by the context menu to show the annotations of a |
217 Private slot called by the context menu to show the annotations of a |
221 file with a project specific skip list. |
218 file with a project specific skip list. |
222 </p> |
219 </p> |
|
220 |
223 <a NAME="HgProjectBrowserHelper.__HgAnnotateSkipListFile" ID="HgProjectBrowserHelper.__HgAnnotateSkipListFile"></a> |
221 <a NAME="HgProjectBrowserHelper.__HgAnnotateSkipListFile" ID="HgProjectBrowserHelper.__HgAnnotateSkipListFile"></a> |
224 <h4>HgProjectBrowserHelper.__HgAnnotateSkipListFile</h4> |
222 <h4>HgProjectBrowserHelper.__HgAnnotateSkipListFile</h4> |
225 <b>__HgAnnotateSkipListFile</b>(<i></i>) |
223 <b>__HgAnnotateSkipListFile</b>(<i></i>) |
226 |
|
227 <p> |
224 <p> |
228 Private method to create an empty 'hg annotate' skip list file. |
225 Private method to create an empty 'hg annotate' skip list file. |
229 </p> |
226 </p> |
|
227 |
230 <a NAME="HgProjectBrowserHelper.__HgConfigure" ID="HgProjectBrowserHelper.__HgConfigure"></a> |
228 <a NAME="HgProjectBrowserHelper.__HgConfigure" ID="HgProjectBrowserHelper.__HgConfigure"></a> |
231 <h4>HgProjectBrowserHelper.__HgConfigure</h4> |
229 <h4>HgProjectBrowserHelper.__HgConfigure</h4> |
232 <b>__HgConfigure</b>(<i></i>) |
230 <b>__HgConfigure</b>(<i></i>) |
233 |
|
234 <p> |
231 <p> |
235 Private method to open the configuration dialog. |
232 Private method to open the configuration dialog. |
236 </p> |
233 </p> |
|
234 |
237 <a NAME="HgProjectBrowserHelper.__HgCopy" ID="HgProjectBrowserHelper.__HgCopy"></a> |
235 <a NAME="HgProjectBrowserHelper.__HgCopy" ID="HgProjectBrowserHelper.__HgCopy"></a> |
238 <h4>HgProjectBrowserHelper.__HgCopy</h4> |
236 <h4>HgProjectBrowserHelper.__HgCopy</h4> |
239 <b>__HgCopy</b>(<i></i>) |
237 <b>__HgCopy</b>(<i></i>) |
240 |
|
241 <p> |
238 <p> |
242 Private slot called by the context menu to copy the selected file. |
239 Private slot called by the context menu to copy the selected file. |
243 </p> |
240 </p> |
|
241 |
244 <a NAME="HgProjectBrowserHelper.__HgExtendedDiff" ID="HgProjectBrowserHelper.__HgExtendedDiff"></a> |
242 <a NAME="HgProjectBrowserHelper.__HgExtendedDiff" ID="HgProjectBrowserHelper.__HgExtendedDiff"></a> |
245 <h4>HgProjectBrowserHelper.__HgExtendedDiff</h4> |
243 <h4>HgProjectBrowserHelper.__HgExtendedDiff</h4> |
246 <b>__HgExtendedDiff</b>(<i></i>) |
244 <b>__HgExtendedDiff</b>(<i></i>) |
247 |
|
248 <p> |
245 <p> |
249 Private slot called by the context menu to show the difference of a |
246 Private slot called by the context menu to show the difference of a |
250 file to the repository. |
247 file to the repository. |
251 </p> |
248 </p> |
252 <p> |
249 <p> |
253 This gives the chance to enter the revisions to compare. |
250 This gives the chance to enter the revisions to compare. |
254 </p> |
251 </p> |
|
252 |
255 <a NAME="HgProjectBrowserHelper.__HgForget" ID="HgProjectBrowserHelper.__HgForget"></a> |
253 <a NAME="HgProjectBrowserHelper.__HgForget" ID="HgProjectBrowserHelper.__HgForget"></a> |
256 <h4>HgProjectBrowserHelper.__HgForget</h4> |
254 <h4>HgProjectBrowserHelper.__HgForget</h4> |
257 <b>__HgForget</b>(<i></i>) |
255 <b>__HgForget</b>(<i></i>) |
258 |
|
259 <p> |
256 <p> |
260 Private slot called by the context menu to remove the selected file |
257 Private slot called by the context menu to remove the selected file |
261 from the Mercurial repository leaving a copy in the project directory. |
258 from the Mercurial repository leaving a copy in the project directory. |
262 </p> |
259 </p> |
|
260 |
263 <a NAME="HgProjectBrowserHelper.__HgMove" ID="HgProjectBrowserHelper.__HgMove"></a> |
261 <a NAME="HgProjectBrowserHelper.__HgMove" ID="HgProjectBrowserHelper.__HgMove"></a> |
264 <h4>HgProjectBrowserHelper.__HgMove</h4> |
262 <h4>HgProjectBrowserHelper.__HgMove</h4> |
265 <b>__HgMove</b>(<i></i>) |
263 <b>__HgMove</b>(<i></i>) |
266 |
|
267 <p> |
264 <p> |
268 Private slot called by the context menu to move the selected file. |
265 Private slot called by the context menu to move the selected file. |
269 </p> |
266 </p> |
|
267 |
270 <a NAME="HgProjectBrowserHelper.__HgReMerge" ID="HgProjectBrowserHelper.__HgReMerge"></a> |
268 <a NAME="HgProjectBrowserHelper.__HgReMerge" ID="HgProjectBrowserHelper.__HgReMerge"></a> |
271 <h4>HgProjectBrowserHelper.__HgReMerge</h4> |
269 <h4>HgProjectBrowserHelper.__HgReMerge</h4> |
272 <b>__HgReMerge</b>(<i></i>) |
270 <b>__HgReMerge</b>(<i></i>) |
273 |
|
274 <p> |
271 <p> |
275 Private slot called by the context menu to re-merge a file. |
272 Private slot called by the context menu to re-merge a file. |
276 </p> |
273 </p> |
|
274 |
277 <a NAME="HgProjectBrowserHelper.__HgResolved" ID="HgProjectBrowserHelper.__HgResolved"></a> |
275 <a NAME="HgProjectBrowserHelper.__HgResolved" ID="HgProjectBrowserHelper.__HgResolved"></a> |
278 <h4>HgProjectBrowserHelper.__HgResolved</h4> |
276 <h4>HgProjectBrowserHelper.__HgResolved</h4> |
279 <b>__HgResolved</b>(<i></i>) |
277 <b>__HgResolved</b>(<i></i>) |
280 |
|
281 <p> |
278 <p> |
282 Private slot called by the context menu to mark conflicts of a file |
279 Private slot called by the context menu to mark conflicts of a file |
283 as being resolved. |
280 as being resolved. |
284 </p> |
281 </p> |
|
282 |
285 <a NAME="HgProjectBrowserHelper.__HgRevert" ID="HgProjectBrowserHelper.__HgRevert"></a> |
283 <a NAME="HgProjectBrowserHelper.__HgRevert" ID="HgProjectBrowserHelper.__HgRevert"></a> |
286 <h4>HgProjectBrowserHelper.__HgRevert</h4> |
284 <h4>HgProjectBrowserHelper.__HgRevert</h4> |
287 <b>__HgRevert</b>(<i></i>) |
285 <b>__HgRevert</b>(<i></i>) |
288 |
|
289 <p> |
286 <p> |
290 Private slot called by the context menu to revert changes made. |
287 Private slot called by the context menu to revert changes made. |
291 </p> |
288 </p> |
|
289 |
292 <a NAME="HgProjectBrowserHelper.__HgSbsDiff" ID="HgProjectBrowserHelper.__HgSbsDiff"></a> |
290 <a NAME="HgProjectBrowserHelper.__HgSbsDiff" ID="HgProjectBrowserHelper.__HgSbsDiff"></a> |
293 <h4>HgProjectBrowserHelper.__HgSbsDiff</h4> |
291 <h4>HgProjectBrowserHelper.__HgSbsDiff</h4> |
294 <b>__HgSbsDiff</b>(<i></i>) |
292 <b>__HgSbsDiff</b>(<i></i>) |
295 |
|
296 <p> |
293 <p> |
297 Private slot called by the context menu to show the difference of a |
294 Private slot called by the context menu to show the difference of a |
298 file to the repository side-by-side. |
295 file to the repository side-by-side. |
299 </p> |
296 </p> |
|
297 |
300 <a NAME="HgProjectBrowserHelper.__HgSbsExtendedDiff" ID="HgProjectBrowserHelper.__HgSbsExtendedDiff"></a> |
298 <a NAME="HgProjectBrowserHelper.__HgSbsExtendedDiff" ID="HgProjectBrowserHelper.__HgSbsExtendedDiff"></a> |
301 <h4>HgProjectBrowserHelper.__HgSbsExtendedDiff</h4> |
299 <h4>HgProjectBrowserHelper.__HgSbsExtendedDiff</h4> |
302 <b>__HgSbsExtendedDiff</b>(<i></i>) |
300 <b>__HgSbsExtendedDiff</b>(<i></i>) |
303 |
|
304 <p> |
301 <p> |
305 Private slot called by the context menu to show the difference of a |
302 Private slot called by the context menu to show the difference of a |
306 file to the repository side-by-side. |
303 file to the repository side-by-side. |
307 </p> |
304 </p> |
308 <p> |
305 <p> |
309 It allows the selection of revisions to compare. |
306 It allows the selection of revisions to compare. |
310 </p> |
307 </p> |
|
308 |
311 <a NAME="HgProjectBrowserHelper.__HgUnresolved" ID="HgProjectBrowserHelper.__HgUnresolved"></a> |
309 <a NAME="HgProjectBrowserHelper.__HgUnresolved" ID="HgProjectBrowserHelper.__HgUnresolved"></a> |
312 <h4>HgProjectBrowserHelper.__HgUnresolved</h4> |
310 <h4>HgProjectBrowserHelper.__HgUnresolved</h4> |
313 <b>__HgUnresolved</b>(<i></i>) |
311 <b>__HgUnresolved</b>(<i></i>) |
314 |
|
315 <p> |
312 <p> |
316 Private slot called by the context menu to mark conflicts of a file |
313 Private slot called by the context menu to mark conflicts of a file |
317 as being unresolved. |
314 as being unresolved. |
318 </p> |
315 </p> |
|
316 |
319 <a NAME="HgProjectBrowserHelper.__addExtensionsMenu" ID="HgProjectBrowserHelper.__addExtensionsMenu"></a> |
317 <a NAME="HgProjectBrowserHelper.__addExtensionsMenu" ID="HgProjectBrowserHelper.__addExtensionsMenu"></a> |
320 <h4>HgProjectBrowserHelper.__addExtensionsMenu</h4> |
318 <h4>HgProjectBrowserHelper.__addExtensionsMenu</h4> |
321 <b>__addExtensionsMenu</b>(<i>menu, key</i>) |
319 <b>__addExtensionsMenu</b>(<i>menu, key</i>) |
322 |
|
323 <p> |
320 <p> |
324 Private method to add an extension menu entry. |
321 Private method to add an extension menu entry. |
325 </p> |
322 </p> |
|
323 |
326 <dl> |
324 <dl> |
327 |
325 |
328 <dt><i>menu</i> (QMenu)</dt> |
326 <dt><i>menu</i> (QMenu)</dt> |
329 <dd> |
327 <dd> |
330 menu to add it to |
328 menu to add it to |
387 </dd> |
385 </dd> |
388 </dl> |
386 </dl> |
389 <a NAME="HgProjectBrowserHelper._addVCSMenu" ID="HgProjectBrowserHelper._addVCSMenu"></a> |
387 <a NAME="HgProjectBrowserHelper._addVCSMenu" ID="HgProjectBrowserHelper._addVCSMenu"></a> |
390 <h4>HgProjectBrowserHelper._addVCSMenu</h4> |
388 <h4>HgProjectBrowserHelper._addVCSMenu</h4> |
391 <b>_addVCSMenu</b>(<i>mainMenu</i>) |
389 <b>_addVCSMenu</b>(<i>mainMenu</i>) |
392 |
|
393 <p> |
390 <p> |
394 Protected method used to add the VCS menu to all project browsers. |
391 Protected method used to add the VCS menu to all project browsers. |
395 </p> |
392 </p> |
|
393 |
396 <dl> |
394 <dl> |
397 |
395 |
398 <dt><i>mainMenu</i> (QMenu)</dt> |
396 <dt><i>mainMenu</i> (QMenu)</dt> |
399 <dd> |
397 <dd> |
400 reference to the menu to be amended |
398 reference to the menu to be amended |
401 </dd> |
399 </dd> |
402 </dl> |
400 </dl> |
403 <a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a> |
401 <a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a> |
404 <h4>HgProjectBrowserHelper._addVCSMenuBack</h4> |
402 <h4>HgProjectBrowserHelper._addVCSMenuBack</h4> |
405 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) |
403 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) |
406 |
|
407 <p> |
404 <p> |
408 Protected method used to add the VCS menu to all project browsers. |
405 Protected method used to add the VCS menu to all project browsers. |
409 </p> |
406 </p> |
|
407 |
410 <dl> |
408 <dl> |
411 |
409 |
412 <dt><i>mainMenu</i> (QMenu)</dt> |
410 <dt><i>mainMenu</i> (QMenu)</dt> |
413 <dd> |
411 <dd> |
414 reference to the menu to be amended |
412 reference to the menu to be amended |
415 </dd> |
413 </dd> |
416 </dl> |
414 </dl> |
417 <a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a> |
415 <a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a> |
418 <h4>HgProjectBrowserHelper._addVCSMenuDir</h4> |
416 <h4>HgProjectBrowserHelper._addVCSMenuDir</h4> |
419 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) |
417 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) |
420 |
|
421 <p> |
418 <p> |
422 Protected method used to add the VCS menu to all project browsers. |
419 Protected method used to add the VCS menu to all project browsers. |
423 </p> |
420 </p> |
|
421 |
424 <dl> |
422 <dl> |
425 |
423 |
426 <dt><i>mainMenu</i> (QMenu)</dt> |
424 <dt><i>mainMenu</i> (QMenu)</dt> |
427 <dd> |
425 <dd> |
428 reference to the menu to be amended |
426 reference to the menu to be amended |
429 </dd> |
427 </dd> |
430 </dl> |
428 </dl> |
431 <a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a> |
429 <a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a> |
432 <h4>HgProjectBrowserHelper._addVCSMenuDirMulti</h4> |
430 <h4>HgProjectBrowserHelper._addVCSMenuDirMulti</h4> |
433 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) |
431 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) |
434 |
|
435 <p> |
432 <p> |
436 Protected method used to add the VCS menu to all project browsers. |
433 Protected method used to add the VCS menu to all project browsers. |
437 </p> |
434 </p> |
|
435 |
438 <dl> |
436 <dl> |
439 |
437 |
440 <dt><i>mainMenu</i> (QMenu)</dt> |
438 <dt><i>mainMenu</i> (QMenu)</dt> |
441 <dd> |
439 <dd> |
442 reference to the menu to be amended |
440 reference to the menu to be amended |
443 </dd> |
441 </dd> |
444 </dl> |
442 </dl> |
445 <a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a> |
443 <a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a> |
446 <h4>HgProjectBrowserHelper._addVCSMenuMulti</h4> |
444 <h4>HgProjectBrowserHelper._addVCSMenuMulti</h4> |
447 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) |
445 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) |
448 |
|
449 <p> |
446 <p> |
450 Protected method used to add the VCS menu for multi selection to all |
447 Protected method used to add the VCS menu for multi selection to all |
451 project browsers. |
448 project browsers. |
452 </p> |
449 </p> |
|
450 |
453 <dl> |
451 <dl> |
454 |
452 |
455 <dt><i>mainMenu</i> (QMenu)</dt> |
453 <dt><i>mainMenu</i> (QMenu)</dt> |
456 <dd> |
454 <dd> |
457 reference to the menu to be amended |
455 reference to the menu to be amended |
458 </dd> |
456 </dd> |
459 </dl> |
457 </dl> |
460 <a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a> |
458 <a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a> |
461 <h4>HgProjectBrowserHelper.showContextMenu</h4> |
459 <h4>HgProjectBrowserHelper.showContextMenu</h4> |
462 <b>showContextMenu</b>(<i>menu, standardItems</i>) |
460 <b>showContextMenu</b>(<i>menu, standardItems</i>) |
463 |
|
464 <p> |
461 <p> |
465 Public slot called before the context menu is shown. |
462 Public slot called before the context menu is shown. |
466 </p> |
463 </p> |
467 <p> |
464 <p> |
468 It enables/disables the VCS menu entries depending on the overall |
465 It enables/disables the VCS menu entries depending on the overall |
469 VCS status and the file status. |
466 VCS status and the file status. |
470 </p> |
467 </p> |
|
468 |
471 <dl> |
469 <dl> |
472 |
470 |
473 <dt><i>menu</i> (QMenu)</dt> |
471 <dt><i>menu</i> (QMenu)</dt> |
474 <dd> |
472 <dd> |
475 reference to the menu to be shown |
473 reference to the menu to be shown |