Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial