Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper</h1>
24
25 <p>
26 Module implementing the VCS project browser helper for Mercurial.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HgProjectBrowserHelper">HgProjectBrowserHelper</a></td>
39 <td>Class implementing the VCS project browser helper for Mercurial.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HgProjectBrowserHelper" ID="HgProjectBrowserHelper"></a>
50 <h2>HgProjectBrowserHelper</h2>
51
52 <p>
53 Class implementing the VCS project browser helper for Mercurial.
54 </p>
55 <h3>Derived from</h3>
56 VcsProjectBrowserHelper
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#HgProjectBrowserHelper.__init__">HgProjectBrowserHelper</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgProjectBrowserHelper.__HgAnnotate">__HgAnnotate</a></td>
77 <td>Private slot called by the context menu to show the annotations of a file.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgProjectBrowserHelper.__HgConfigure">__HgConfigure</a></td>
81 <td>Private method to open the configuration dialog.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgProjectBrowserHelper.__HgCopy">__HgCopy</a></td>
85 <td>Private slot called by the context menu to copy the selected file.</td>
86 </tr>
87 <tr>
88 <td><a href="#HgProjectBrowserHelper.__HgExtendedDiff">__HgExtendedDiff</a></td>
89 <td>Private slot called by the context menu to show the difference of a file to the repository.</td>
90 </tr>
91 <tr>
92 <td><a href="#HgProjectBrowserHelper.__HgForget">__HgForget</a></td>
93 <td>Private slot called by the context menu to remove the selected file from the Mercurial repository leaving a copy in the project directory.</td>
94 </tr>
95 <tr>
96 <td><a href="#HgProjectBrowserHelper.__HgMove">__HgMove</a></td>
97 <td>Private slot called by the context menu to move the selected file.</td>
98 </tr>
99 <tr>
100 <td><a href="#HgProjectBrowserHelper.__HgReMerge">__HgReMerge</a></td>
101 <td>Private slot called by the context menu to re-merge a file.</td>
102 </tr>
103 <tr>
104 <td><a href="#HgProjectBrowserHelper.__HgResolved">__HgResolved</a></td>
105 <td>Private slot called by the context menu to mark conflicts of a file as being resolved.</td>
106 </tr>
107 <tr>
108 <td><a href="#HgProjectBrowserHelper.__HgRevert">__HgRevert</a></td>
109 <td>Private slot called by the context menu to revert changes made.</td>
110 </tr>
111 <tr>
112 <td><a href="#HgProjectBrowserHelper.__HgSbsDiff">__HgSbsDiff</a></td>
113 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
114 </tr>
115 <tr>
116 <td><a href="#HgProjectBrowserHelper.__HgSbsExtendedDiff">__HgSbsExtendedDiff</a></td>
117 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td>
118 </tr>
119 <tr>
120 <td><a href="#HgProjectBrowserHelper.__HgUnresolved">__HgUnresolved</a></td>
121 <td>Private slot called by the context menu to mark conflicts of a file as being unresolved.</td>
122 </tr>
123 <tr>
124 <td><a href="#HgProjectBrowserHelper.__addExtensionsMenu">__addExtensionsMenu</a></td>
125 <td>Private method to add an extension menu entry.</td>
126 </tr>
127 <tr>
128 <td><a href="#HgProjectBrowserHelper.__showExtensionMenu">__showExtensionMenu</a></td>
129 <td>Private slot showing the extensions menu.</td>
130 </tr>
131 <tr>
132 <td><a href="#HgProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td>
133 <td>Protected method used to add the VCS menu to all project browsers.</td>
134 </tr>
135 <tr>
136 <td><a href="#HgProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td>
137 <td>Protected method used to add the VCS menu to all project browsers.</td>
138 </tr>
139 <tr>
140 <td><a href="#HgProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td>
141 <td>Protected method used to add the VCS menu to all project browsers.</td>
142 </tr>
143 <tr>
144 <td><a href="#HgProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td>
145 <td>Protected method used to add the VCS menu to all project browsers.</td>
146 </tr>
147 <tr>
148 <td><a href="#HgProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td>
149 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td>
150 </tr>
151 <tr>
152 <td><a href="#HgProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
153 <td>Public slot called before the context menu is shown.</td>
154 </tr>
155 <tr>
156 <td><a href="#HgProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
157 <td>Public slot called before the context menu is shown.</td>
158 </tr>
159 <tr>
160 <td><a href="#HgProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
161 <td>Public slot called before the context menu is shown.</td>
162 </tr>
163 <tr>
164 <td><a href="#HgProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
165 <td>Public slot called before the context menu (multiple selections) is shown.</td>
166 </tr>
167 </table>
168 <h3>Static Methods</h3>
169
170 <table>
171 <tr><td>None</td></tr>
172 </table>
173
174 <a NAME="HgProjectBrowserHelper.__init__" ID="HgProjectBrowserHelper.__init__"></a>
175 <h4>HgProjectBrowserHelper (Constructor)</h4>
176 <b>HgProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
177
178 <p>
179 Constructor
180 </p>
181 <dl>
182
183 <dt><i>vcsObject</i></dt>
184 <dd>
185 reference to the vcs object
186 </dd>
187 <dt><i>browserObject</i></dt>
188 <dd>
189 reference to the project browser object
190 </dd>
191 <dt><i>projectObject</i></dt>
192 <dd>
193 reference to the project object
194 </dd>
195 <dt><i>isTranslationsBrowser</i></dt>
196 <dd>
197 flag indicating, the helper is requested
198 for the translations browser (this needs some special treatment)
199 </dd>
200 <dt><i>parent</i></dt>
201 <dd>
202 parent widget (QWidget)
203 </dd>
204 <dt><i>name</i></dt>
205 <dd>
206 name of this object (string)
207 </dd>
208 </dl>
209 <a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a>
210 <h4>HgProjectBrowserHelper.__HgAnnotate</h4>
211 <b>__HgAnnotate</b>(<i></i>)
212
213 <p>
214 Private slot called by the context menu to show the annotations of a
215 file.
216 </p>
217 <a NAME="HgProjectBrowserHelper.__HgConfigure" ID="HgProjectBrowserHelper.__HgConfigure"></a>
218 <h4>HgProjectBrowserHelper.__HgConfigure</h4>
219 <b>__HgConfigure</b>(<i></i>)
220
221 <p>
222 Private method to open the configuration dialog.
223 </p>
224 <a NAME="HgProjectBrowserHelper.__HgCopy" ID="HgProjectBrowserHelper.__HgCopy"></a>
225 <h4>HgProjectBrowserHelper.__HgCopy</h4>
226 <b>__HgCopy</b>(<i></i>)
227
228 <p>
229 Private slot called by the context menu to copy the selected file.
230 </p>
231 <a NAME="HgProjectBrowserHelper.__HgExtendedDiff" ID="HgProjectBrowserHelper.__HgExtendedDiff"></a>
232 <h4>HgProjectBrowserHelper.__HgExtendedDiff</h4>
233 <b>__HgExtendedDiff</b>(<i></i>)
234
235 <p>
236 Private slot called by the context menu to show the difference of a
237 file to the repository.
238 </p>
239 <p>
240 This gives the chance to enter the revisions to compare.
241 </p>
242 <a NAME="HgProjectBrowserHelper.__HgForget" ID="HgProjectBrowserHelper.__HgForget"></a>
243 <h4>HgProjectBrowserHelper.__HgForget</h4>
244 <b>__HgForget</b>(<i></i>)
245
246 <p>
247 Private slot called by the context menu to remove the selected file
248 from the Mercurial repository leaving a copy in the project directory.
249 </p>
250 <a NAME="HgProjectBrowserHelper.__HgMove" ID="HgProjectBrowserHelper.__HgMove"></a>
251 <h4>HgProjectBrowserHelper.__HgMove</h4>
252 <b>__HgMove</b>(<i></i>)
253
254 <p>
255 Private slot called by the context menu to move the selected file.
256 </p>
257 <a NAME="HgProjectBrowserHelper.__HgReMerge" ID="HgProjectBrowserHelper.__HgReMerge"></a>
258 <h4>HgProjectBrowserHelper.__HgReMerge</h4>
259 <b>__HgReMerge</b>(<i></i>)
260
261 <p>
262 Private slot called by the context menu to re-merge a file.
263 </p>
264 <a NAME="HgProjectBrowserHelper.__HgResolved" ID="HgProjectBrowserHelper.__HgResolved"></a>
265 <h4>HgProjectBrowserHelper.__HgResolved</h4>
266 <b>__HgResolved</b>(<i></i>)
267
268 <p>
269 Private slot called by the context menu to mark conflicts of a file
270 as being resolved.
271 </p>
272 <a NAME="HgProjectBrowserHelper.__HgRevert" ID="HgProjectBrowserHelper.__HgRevert"></a>
273 <h4>HgProjectBrowserHelper.__HgRevert</h4>
274 <b>__HgRevert</b>(<i></i>)
275
276 <p>
277 Private slot called by the context menu to revert changes made.
278 </p>
279 <a NAME="HgProjectBrowserHelper.__HgSbsDiff" ID="HgProjectBrowserHelper.__HgSbsDiff"></a>
280 <h4>HgProjectBrowserHelper.__HgSbsDiff</h4>
281 <b>__HgSbsDiff</b>(<i></i>)
282
283 <p>
284 Private slot called by the context menu to show the difference of a
285 file to the repository side-by-side.
286 </p>
287 <a NAME="HgProjectBrowserHelper.__HgSbsExtendedDiff" ID="HgProjectBrowserHelper.__HgSbsExtendedDiff"></a>
288 <h4>HgProjectBrowserHelper.__HgSbsExtendedDiff</h4>
289 <b>__HgSbsExtendedDiff</b>(<i></i>)
290
291 <p>
292 Private slot called by the context menu to show the difference of a
293 file to the repository side-by-side.
294 </p>
295 <p>
296 It allows the selection of revisions to compare.
297 </p>
298 <a NAME="HgProjectBrowserHelper.__HgUnresolved" ID="HgProjectBrowserHelper.__HgUnresolved"></a>
299 <h4>HgProjectBrowserHelper.__HgUnresolved</h4>
300 <b>__HgUnresolved</b>(<i></i>)
301
302 <p>
303 Private slot called by the context menu to mark conflicts of a file
304 as being unresolved.
305 </p>
306 <a NAME="HgProjectBrowserHelper.__addExtensionsMenu" ID="HgProjectBrowserHelper.__addExtensionsMenu"></a>
307 <h4>HgProjectBrowserHelper.__addExtensionsMenu</h4>
308 <b>__addExtensionsMenu</b>(<i>menu, key</i>)
309
310 <p>
311 Private method to add an extension menu entry.
312 </p>
313 <dl>
314
315 <dt><i>menu</i></dt>
316 <dd>
317 menu to add it to (QMenu)
318 </dd>
319 <dt><i>key</i></dt>
320 <dd>
321 menu key (string, one of 'mainMenu', 'multiMenu',
322 'backMenu', 'dirMenu' or 'dirMultiMenu')
323 </dd>
324 </dl>
325 <dl>
326 <dt>Return:</dt>
327 <dd>
328 reference to the menu action (QAction)
329 </dd>
330 </dl>
331 <a NAME="HgProjectBrowserHelper.__showExtensionMenu" ID="HgProjectBrowserHelper.__showExtensionMenu"></a>
332 <h4>HgProjectBrowserHelper.__showExtensionMenu</h4>
333 <b>__showExtensionMenu</b>(<i>key, controlled</i>)
334
335 <p>
336 Private slot showing the extensions menu.
337 </p>
338 <dl>
339
340 <dt><i>key</i></dt>
341 <dd>
342 menu key (string, one of 'mainMenu', 'multiMenu',
343 'backMenu', 'dirMenu' or 'dirMultiMenu')
344 </dd>
345 <dt><i>controlled</i></dt>
346 <dd>
347 flag indicating to show the menu for a
348 version controlled entry or a non-version controlled entry
349 (boolean)
350 </dd>
351 </dl>
352 <a NAME="HgProjectBrowserHelper._addVCSMenu" ID="HgProjectBrowserHelper._addVCSMenu"></a>
353 <h4>HgProjectBrowserHelper._addVCSMenu</h4>
354 <b>_addVCSMenu</b>(<i>mainMenu</i>)
355
356 <p>
357 Protected method used to add the VCS menu to all project browsers.
358 </p>
359 <dl>
360
361 <dt><i>mainMenu</i></dt>
362 <dd>
363 reference to the menu to be amended
364 </dd>
365 </dl>
366 <a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a>
367 <h4>HgProjectBrowserHelper._addVCSMenuBack</h4>
368 <b>_addVCSMenuBack</b>(<i>mainMenu</i>)
369
370 <p>
371 Protected method used to add the VCS menu to all project browsers.
372 </p>
373 <dl>
374
375 <dt><i>mainMenu</i></dt>
376 <dd>
377 reference to the menu to be amended
378 </dd>
379 </dl>
380 <a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a>
381 <h4>HgProjectBrowserHelper._addVCSMenuDir</h4>
382 <b>_addVCSMenuDir</b>(<i>mainMenu</i>)
383
384 <p>
385 Protected method used to add the VCS menu to all project browsers.
386 </p>
387 <dl>
388
389 <dt><i>mainMenu</i></dt>
390 <dd>
391 reference to the menu to be amended
392 </dd>
393 </dl>
394 <a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a>
395 <h4>HgProjectBrowserHelper._addVCSMenuDirMulti</h4>
396 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>)
397
398 <p>
399 Protected method used to add the VCS menu to all project browsers.
400 </p>
401 <dl>
402
403 <dt><i>mainMenu</i></dt>
404 <dd>
405 reference to the menu to be amended
406 </dd>
407 </dl>
408 <a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a>
409 <h4>HgProjectBrowserHelper._addVCSMenuMulti</h4>
410 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>)
411
412 <p>
413 Protected method used to add the VCS menu for multi selection to all
414 project browsers.
415 </p>
416 <dl>
417
418 <dt><i>mainMenu</i></dt>
419 <dd>
420 reference to the menu to be amended
421 </dd>
422 </dl>
423 <a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a>
424 <h4>HgProjectBrowserHelper.showContextMenu</h4>
425 <b>showContextMenu</b>(<i>menu, standardItems</i>)
426
427 <p>
428 Public slot called before the context menu is shown.
429 </p>
430 <p>
431 It enables/disables the VCS menu entries depending on the overall
432 VCS status and the file status.
433 </p>
434 <dl>
435
436 <dt><i>menu</i></dt>
437 <dd>
438 reference to the menu to be shown
439 </dd>
440 <dt><i>standardItems</i></dt>
441 <dd>
442 array of standard items that need
443 activation/deactivation depending on the overall VCS status
444 </dd>
445 </dl>
446 <a NAME="HgProjectBrowserHelper.showContextMenuDir" ID="HgProjectBrowserHelper.showContextMenuDir"></a>
447 <h4>HgProjectBrowserHelper.showContextMenuDir</h4>
448 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
449
450 <p>
451 Public slot called before the context menu is shown.
452 </p>
453 <p>
454 It enables/disables the VCS menu entries depending on the overall
455 VCS status and the directory status.
456 </p>
457 <dl>
458
459 <dt><i>menu</i></dt>
460 <dd>
461 reference to the menu to be shown
462 </dd>
463 <dt><i>standardItems</i></dt>
464 <dd>
465 array of standard items that need
466 activation/deactivation depending on the overall VCS status
467 </dd>
468 </dl>
469 <a NAME="HgProjectBrowserHelper.showContextMenuDirMulti" ID="HgProjectBrowserHelper.showContextMenuDirMulti"></a>
470 <h4>HgProjectBrowserHelper.showContextMenuDirMulti</h4>
471 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
472
473 <p>
474 Public slot called before the context menu is shown.
475 </p>
476 <p>
477 It enables/disables the VCS menu entries depending on the overall
478 VCS status and the directory status.
479 </p>
480 <dl>
481
482 <dt><i>menu</i></dt>
483 <dd>
484 reference to the menu to be shown
485 </dd>
486 <dt><i>standardItems</i></dt>
487 <dd>
488 array of standard items that need
489 activation/deactivation depending on the overall VCS status
490 </dd>
491 </dl>
492 <a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a>
493 <h4>HgProjectBrowserHelper.showContextMenuMulti</h4>
494 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
495
496 <p>
497 Public slot called before the context menu (multiple selections) is
498 shown.
499 </p>
500 <p>
501 It enables/disables the VCS menu entries depending on the overall
502 VCS status and the files status.
503 </p>
504 <dl>
505
506 <dt><i>menu</i></dt>
507 <dd>
508 reference to the menu to be shown
509 </dd>
510 <dt><i>standardItems</i></dt>
511 <dd>
512 array of standard items that need
513 activation/deactivation depending on the overall VCS status
514 </dd>
515 </dl>
516 <div align="right"><a href="#top">Up</a></div>
517 <hr />
518 </body></html>

Mercurial Repository: eric

eric ide

mercurial