|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper</h1> |
|
24 <p> |
|
25 Module implementing the VCS project browser helper for Mercurial. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#HgProjectBrowserHelper">HgProjectBrowserHelper</a></td> |
|
35 <td>Class implementing the VCS project browser helper for Mercurial.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="HgProjectBrowserHelper" ID="HgProjectBrowserHelper"></a> |
|
44 <h2>HgProjectBrowserHelper</h2> |
|
45 <p> |
|
46 Class implementing the VCS project browser helper for Mercurial. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 VcsProjectBrowserHelper |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#HgProjectBrowserHelper.__init__">HgProjectBrowserHelper</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#HgProjectBrowserHelper.__HgAnnotate">__HgAnnotate</a></td> |
|
61 <td>Private slot called by the context menu to show the annotations of a file.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#HgProjectBrowserHelper.__HgCopy">__HgCopy</a></td> |
|
64 <td>Private slot called by the context menu to copy the selected file.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#HgProjectBrowserHelper.__HgExtendedDiff">__HgExtendedDiff</a></td> |
|
67 <td>Private slot called by the context menu to show the difference of a file to the repository.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#HgProjectBrowserHelper.__HgLogBrowser">__HgLogBrowser</a></td> |
|
70 <td>Private slot called by the context menu to show the log browser for a file.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HgProjectBrowserHelper.__HgLogLimited">__HgLogLimited</a></td> |
|
73 <td>Private slot called by the context menu to show the limited log of a file.</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.__HgResolve">__HgResolve</a></td> |
|
79 <td>Private slot called by the context menu to resolve conflicts of a file.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#HgProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td> |
|
82 <td>Protected method used to add the VCS menu to all project browsers.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#HgProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td> |
|
85 <td>Protected method used to add the VCS menu to all project browsers.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#HgProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td> |
|
88 <td>Protected method used to add the VCS menu to all project browsers.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#HgProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td> |
|
91 <td>Protected method used to add the VCS menu to all project browsers.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#HgProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td> |
|
94 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#HgProjectBrowserHelper.showContextMenu">showContextMenu</a></td> |
|
97 <td>Slot called before the context menu is shown.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#HgProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> |
|
100 <td>Slot called before the context menu is shown.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#HgProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> |
|
103 <td>Slot called before the context menu is shown.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#HgProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> |
|
106 <td>Slot called before the context menu (multiple selections) is shown.</td> |
|
107 </tr> |
|
108 </table> |
|
109 <a NAME="HgProjectBrowserHelper.__init__" ID="HgProjectBrowserHelper.__init__"></a> |
|
110 <h4>HgProjectBrowserHelper (Constructor)</h4> |
|
111 <b>HgProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent = None, name = None</i>) |
|
112 <p> |
|
113 Constructor |
|
114 </p><dl> |
|
115 <dt><i>vcsObject</i></dt> |
|
116 <dd> |
|
117 reference to the vcs object |
|
118 </dd><dt><i>browserObject</i></dt> |
|
119 <dd> |
|
120 reference to the project browser object |
|
121 </dd><dt><i>projectObject</i></dt> |
|
122 <dd> |
|
123 reference to the project object |
|
124 </dd><dt><i>isTranslationsBrowser</i></dt> |
|
125 <dd> |
|
126 flag indicating, the helper is requested for the |
|
127 translations browser (this needs some special treatment) |
|
128 </dd><dt><i>parent</i></dt> |
|
129 <dd> |
|
130 parent widget (QWidget) |
|
131 </dd><dt><i>name</i></dt> |
|
132 <dd> |
|
133 name of this object (string) |
|
134 </dd> |
|
135 </dl><a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a> |
|
136 <h4>HgProjectBrowserHelper.__HgAnnotate</h4> |
|
137 <b>__HgAnnotate</b>(<i></i>) |
|
138 <p> |
|
139 Private slot called by the context menu to show the annotations of a file. |
|
140 </p><a NAME="HgProjectBrowserHelper.__HgCopy" ID="HgProjectBrowserHelper.__HgCopy"></a> |
|
141 <h4>HgProjectBrowserHelper.__HgCopy</h4> |
|
142 <b>__HgCopy</b>(<i></i>) |
|
143 <p> |
|
144 Private slot called by the context menu to copy the selected file. |
|
145 </p><a NAME="HgProjectBrowserHelper.__HgExtendedDiff" ID="HgProjectBrowserHelper.__HgExtendedDiff"></a> |
|
146 <h4>HgProjectBrowserHelper.__HgExtendedDiff</h4> |
|
147 <b>__HgExtendedDiff</b>(<i></i>) |
|
148 <p> |
|
149 Private slot called by the context menu to show the difference of a file to |
|
150 the repository. |
|
151 </p><p> |
|
152 This gives the chance to enter the revisions to compare. |
|
153 </p><a NAME="HgProjectBrowserHelper.__HgLogBrowser" ID="HgProjectBrowserHelper.__HgLogBrowser"></a> |
|
154 <h4>HgProjectBrowserHelper.__HgLogBrowser</h4> |
|
155 <b>__HgLogBrowser</b>(<i></i>) |
|
156 <p> |
|
157 Private slot called by the context menu to show the log browser for a file. |
|
158 </p><a NAME="HgProjectBrowserHelper.__HgLogLimited" ID="HgProjectBrowserHelper.__HgLogLimited"></a> |
|
159 <h4>HgProjectBrowserHelper.__HgLogLimited</h4> |
|
160 <b>__HgLogLimited</b>(<i></i>) |
|
161 <p> |
|
162 Private slot called by the context menu to show the limited log of a file. |
|
163 </p><a NAME="HgProjectBrowserHelper.__HgMove" ID="HgProjectBrowserHelper.__HgMove"></a> |
|
164 <h4>HgProjectBrowserHelper.__HgMove</h4> |
|
165 <b>__HgMove</b>(<i></i>) |
|
166 <p> |
|
167 Private slot called by the context menu to move the selected file. |
|
168 </p><a NAME="HgProjectBrowserHelper.__HgResolve" ID="HgProjectBrowserHelper.__HgResolve"></a> |
|
169 <h4>HgProjectBrowserHelper.__HgResolve</h4> |
|
170 <b>__HgResolve</b>(<i></i>) |
|
171 <p> |
|
172 Private slot called by the context menu to resolve conflicts of a file. |
|
173 </p><a NAME="HgProjectBrowserHelper._addVCSMenu" ID="HgProjectBrowserHelper._addVCSMenu"></a> |
|
174 <h4>HgProjectBrowserHelper._addVCSMenu</h4> |
|
175 <b>_addVCSMenu</b>(<i>mainMenu</i>) |
|
176 <p> |
|
177 Protected method used to add the VCS menu to all project browsers. |
|
178 </p><dl> |
|
179 <dt><i>mainMenu</i></dt> |
|
180 <dd> |
|
181 reference to the menu to be amended |
|
182 </dd> |
|
183 </dl><a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a> |
|
184 <h4>HgProjectBrowserHelper._addVCSMenuBack</h4> |
|
185 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) |
|
186 <p> |
|
187 Protected method used to add the VCS menu to all project browsers. |
|
188 </p><dl> |
|
189 <dt><i>mainMenu</i></dt> |
|
190 <dd> |
|
191 reference to the menu to be amended |
|
192 </dd> |
|
193 </dl><a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a> |
|
194 <h4>HgProjectBrowserHelper._addVCSMenuDir</h4> |
|
195 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) |
|
196 <p> |
|
197 Protected method used to add the VCS menu to all project browsers. |
|
198 </p><dl> |
|
199 <dt><i>mainMenu</i></dt> |
|
200 <dd> |
|
201 reference to the menu to be amended |
|
202 </dd> |
|
203 </dl><a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a> |
|
204 <h4>HgProjectBrowserHelper._addVCSMenuDirMulti</h4> |
|
205 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) |
|
206 <p> |
|
207 Protected method used to add the VCS menu to all project browsers. |
|
208 </p><dl> |
|
209 <dt><i>mainMenu</i></dt> |
|
210 <dd> |
|
211 reference to the menu to be amended |
|
212 </dd> |
|
213 </dl><a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a> |
|
214 <h4>HgProjectBrowserHelper._addVCSMenuMulti</h4> |
|
215 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) |
|
216 <p> |
|
217 Protected method used to add the VCS menu for multi selection to all |
|
218 project browsers. |
|
219 </p><dl> |
|
220 <dt><i>mainMenu</i></dt> |
|
221 <dd> |
|
222 reference to the menu to be amended |
|
223 </dd> |
|
224 </dl><a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a> |
|
225 <h4>HgProjectBrowserHelper.showContextMenu</h4> |
|
226 <b>showContextMenu</b>(<i>menu, standardItems</i>) |
|
227 <p> |
|
228 Slot called before the context menu is shown. |
|
229 </p><p> |
|
230 It enables/disables the VCS menu entries depending on the overall |
|
231 VCS status and the file status. |
|
232 </p><dl> |
|
233 <dt><i>menu</i></dt> |
|
234 <dd> |
|
235 reference to the menu to be shown |
|
236 </dd><dt><i>standardItems</i></dt> |
|
237 <dd> |
|
238 array of standard items that need activation/deactivation |
|
239 depending on the overall VCS status |
|
240 </dd> |
|
241 </dl><a NAME="HgProjectBrowserHelper.showContextMenuDir" ID="HgProjectBrowserHelper.showContextMenuDir"></a> |
|
242 <h4>HgProjectBrowserHelper.showContextMenuDir</h4> |
|
243 <b>showContextMenuDir</b>(<i>menu, standardItems</i>) |
|
244 <p> |
|
245 Slot called before the context menu is shown. |
|
246 </p><p> |
|
247 It enables/disables the VCS menu entries depending on the overall |
|
248 VCS status and the directory status. |
|
249 </p><dl> |
|
250 <dt><i>menu</i></dt> |
|
251 <dd> |
|
252 reference to the menu to be shown |
|
253 </dd><dt><i>standardItems</i></dt> |
|
254 <dd> |
|
255 array of standard items that need activation/deactivation |
|
256 depending on the overall VCS status |
|
257 </dd> |
|
258 </dl><a NAME="HgProjectBrowserHelper.showContextMenuDirMulti" ID="HgProjectBrowserHelper.showContextMenuDirMulti"></a> |
|
259 <h4>HgProjectBrowserHelper.showContextMenuDirMulti</h4> |
|
260 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) |
|
261 <p> |
|
262 Slot called before the context menu is shown. |
|
263 </p><p> |
|
264 It enables/disables the VCS menu entries depending on the overall |
|
265 VCS status and the directory status. |
|
266 </p><dl> |
|
267 <dt><i>menu</i></dt> |
|
268 <dd> |
|
269 reference to the menu to be shown |
|
270 </dd><dt><i>standardItems</i></dt> |
|
271 <dd> |
|
272 array of standard items that need activation/deactivation |
|
273 depending on the overall VCS status |
|
274 </dd> |
|
275 </dl><a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a> |
|
276 <h4>HgProjectBrowserHelper.showContextMenuMulti</h4> |
|
277 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) |
|
278 <p> |
|
279 Slot called before the context menu (multiple selections) is shown. |
|
280 </p><p> |
|
281 It enables/disables the VCS menu entries depending on the overall |
|
282 VCS status and the files status. |
|
283 </p><dl> |
|
284 <dt><i>menu</i></dt> |
|
285 <dd> |
|
286 reference to the menu to be shown |
|
287 </dd><dt><i>standardItems</i></dt> |
|
288 <dd> |
|
289 array of standard items that need activation/deactivation |
|
290 depending on the overall VCS status |
|
291 </dd> |
|
292 </dl> |
|
293 <div align="right"><a href="#top">Up</a></div> |
|
294 <hr /> |
|
295 </body></html> |