Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial