Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.VCS.ProjectBrowserHelper.html

Documentation/Source/eric6.VCS.ProjectBrowserHelper.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.VCS.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.VCS.ProjectBrowserHelper</h1>
23 <p>
24 Module implementing the base class of the VCS project browser helper.
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="#VcsProjectBrowserHelper">VcsProjectBrowserHelper</a></td>
34 <td>Class implementing the base class of the VCS project browser helper.</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="VcsProjectBrowserHelper" ID="VcsProjectBrowserHelper"></a>
43 <h2>VcsProjectBrowserHelper</h2>
44 <p>
45 Class implementing the base class of the VCS project browser helper.
46 </p>
47 <h3>Derived from</h3>
48 QObject
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="#VcsProjectBrowserHelper.__init__">VcsProjectBrowserHelper</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#VcsProjectBrowserHelper._VCSAdd">_VCSAdd</a></td>
64 <td>Protected slot called by the context menu to add the selected file to the VCS repository.</td>
65 </tr><tr>
66 <td><a href="#VcsProjectBrowserHelper._VCSAddTree">_VCSAddTree</a></td>
67 <td>Protected slot called by the context menu.</td>
68 </tr><tr>
69 <td><a href="#VcsProjectBrowserHelper._VCSCommit">_VCSCommit</a></td>
70 <td>Protected slot called by the context menu to commit the changes to the VCS repository.</td>
71 </tr><tr>
72 <td><a href="#VcsProjectBrowserHelper._VCSDiff">_VCSDiff</a></td>
73 <td>Protected slot called by the context menu to show the difference of a file/directory to the repository.</td>
74 </tr><tr>
75 <td><a href="#VcsProjectBrowserHelper._VCSInfoDisplay">_VCSInfoDisplay</a></td>
76 <td>Protected slot called to show some vcs information.</td>
77 </tr><tr>
78 <td><a href="#VcsProjectBrowserHelper._VCSLog">_VCSLog</a></td>
79 <td>Protected slot called by the context menu to show the VCS log of a file/directory.</td>
80 </tr><tr>
81 <td><a href="#VcsProjectBrowserHelper._VCSLogBrowser">_VCSLogBrowser</a></td>
82 <td>Protected slot called by the context menu to show the log browser for a file.</td>
83 </tr><tr>
84 <td><a href="#VcsProjectBrowserHelper._VCSMerge">_VCSMerge</a></td>
85 <td>Protected slot called by the context menu to merge changes into to a file.</td>
86 </tr><tr>
87 <td><a href="#VcsProjectBrowserHelper._VCSRemove">_VCSRemove</a></td>
88 <td>Protected slot called by the context menu to remove the selected file from the VCS repository.</td>
89 </tr><tr>
90 <td><a href="#VcsProjectBrowserHelper._VCSRevert">_VCSRevert</a></td>
91 <td>Protected slot called by the context menu to revert changes made to a file.</td>
92 </tr><tr>
93 <td><a href="#VcsProjectBrowserHelper._VCSStatus">_VCSStatus</a></td>
94 <td>Protected slot called by the context menu to show the status of a file.</td>
95 </tr><tr>
96 <td><a href="#VcsProjectBrowserHelper._VCSUpdate">_VCSUpdate</a></td>
97 <td>Protected slot called by the context menu to update a file from the VCS repository.</td>
98 </tr><tr>
99 <td><a href="#VcsProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td>
100 <td>Protected method to update the VCS status of an item.</td>
101 </tr><tr>
102 <td><a href="#VcsProjectBrowserHelper.addVCSMenus">addVCSMenus</a></td>
103 <td>Public method to add the VCS entries to the various project browser menus.</td>
104 </tr><tr>
105 <td><a href="#VcsProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
106 <td>Public slot called before the context menu is shown.</td>
107 </tr><tr>
108 <td><a href="#VcsProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
109 <td>Public slot called before the context menu is shown.</td>
110 </tr><tr>
111 <td><a href="#VcsProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
112 <td>Public slot called before the context menu is shown.</td>
113 </tr><tr>
114 <td><a href="#VcsProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
115 <td>Public slot called before the context menu (multiple selections) is shown.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="VcsProjectBrowserHelper.__init__" ID="VcsProjectBrowserHelper.__init__"></a>
123 <h4>VcsProjectBrowserHelper (Constructor)</h4>
124 <b>VcsProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>vcsObject</i></dt>
129 <dd>
130 reference to the vcs object
131 </dd><dt><i>browserObject</i></dt>
132 <dd>
133 reference to the project browser object
134 </dd><dt><i>projectObject</i></dt>
135 <dd>
136 reference to the project object
137 </dd><dt><i>isTranslationsBrowser</i></dt>
138 <dd>
139 flag indicating, the helper is requested
140 for the translations browser (this needs some special treatment)
141 </dd><dt><i>parent</i></dt>
142 <dd>
143 parent widget (QWidget)
144 </dd><dt><i>name</i></dt>
145 <dd>
146 name of this object (string)
147 </dd>
148 </dl><a NAME="VcsProjectBrowserHelper._VCSAdd" ID="VcsProjectBrowserHelper._VCSAdd"></a>
149 <h4>VcsProjectBrowserHelper._VCSAdd</h4>
150 <b>_VCSAdd</b>(<i></i>)
151 <p>
152 Protected slot called by the context menu to add the selected file to
153 the VCS repository.
154 </p><a NAME="VcsProjectBrowserHelper._VCSAddTree" ID="VcsProjectBrowserHelper._VCSAddTree"></a>
155 <h4>VcsProjectBrowserHelper._VCSAddTree</h4>
156 <b>_VCSAddTree</b>(<i></i>)
157 <p>
158 Protected slot called by the context menu.
159 </p><p>
160 It is used to add the selected
161 directory tree to the VCS repository.
162 </p><a NAME="VcsProjectBrowserHelper._VCSCommit" ID="VcsProjectBrowserHelper._VCSCommit"></a>
163 <h4>VcsProjectBrowserHelper._VCSCommit</h4>
164 <b>_VCSCommit</b>(<i></i>)
165 <p>
166 Protected slot called by the context menu to commit the changes to the
167 VCS repository.
168 </p><a NAME="VcsProjectBrowserHelper._VCSDiff" ID="VcsProjectBrowserHelper._VCSDiff"></a>
169 <h4>VcsProjectBrowserHelper._VCSDiff</h4>
170 <b>_VCSDiff</b>(<i></i>)
171 <p>
172 Protected slot called by the context menu to show the difference of a
173 file/directory to the repository.
174 </p><a NAME="VcsProjectBrowserHelper._VCSInfoDisplay" ID="VcsProjectBrowserHelper._VCSInfoDisplay"></a>
175 <h4>VcsProjectBrowserHelper._VCSInfoDisplay</h4>
176 <b>_VCSInfoDisplay</b>(<i></i>)
177 <p>
178 Protected slot called to show some vcs information.
179 </p><a NAME="VcsProjectBrowserHelper._VCSLog" ID="VcsProjectBrowserHelper._VCSLog"></a>
180 <h4>VcsProjectBrowserHelper._VCSLog</h4>
181 <b>_VCSLog</b>(<i></i>)
182 <p>
183 Protected slot called by the context menu to show the VCS log of a
184 file/directory.
185 </p><a NAME="VcsProjectBrowserHelper._VCSLogBrowser" ID="VcsProjectBrowserHelper._VCSLogBrowser"></a>
186 <h4>VcsProjectBrowserHelper._VCSLogBrowser</h4>
187 <b>_VCSLogBrowser</b>(<i></i>)
188 <p>
189 Protected slot called by the context menu to show the log browser for a
190 file.
191 </p><a NAME="VcsProjectBrowserHelper._VCSMerge" ID="VcsProjectBrowserHelper._VCSMerge"></a>
192 <h4>VcsProjectBrowserHelper._VCSMerge</h4>
193 <b>_VCSMerge</b>(<i></i>)
194 <p>
195 Protected slot called by the context menu to merge changes into to a
196 file.
197 </p><a NAME="VcsProjectBrowserHelper._VCSRemove" ID="VcsProjectBrowserHelper._VCSRemove"></a>
198 <h4>VcsProjectBrowserHelper._VCSRemove</h4>
199 <b>_VCSRemove</b>(<i></i>)
200 <p>
201 Protected slot called by the context menu to remove the selected file
202 from the VCS repository.
203 </p><a NAME="VcsProjectBrowserHelper._VCSRevert" ID="VcsProjectBrowserHelper._VCSRevert"></a>
204 <h4>VcsProjectBrowserHelper._VCSRevert</h4>
205 <b>_VCSRevert</b>(<i></i>)
206 <p>
207 Protected slot called by the context menu to revert changes made to a
208 file.
209 </p><a NAME="VcsProjectBrowserHelper._VCSStatus" ID="VcsProjectBrowserHelper._VCSStatus"></a>
210 <h4>VcsProjectBrowserHelper._VCSStatus</h4>
211 <b>_VCSStatus</b>(<i></i>)
212 <p>
213 Protected slot called by the context menu to show the status of a file.
214 </p><a NAME="VcsProjectBrowserHelper._VCSUpdate" ID="VcsProjectBrowserHelper._VCSUpdate"></a>
215 <h4>VcsProjectBrowserHelper._VCSUpdate</h4>
216 <b>_VCSUpdate</b>(<i></i>)
217 <p>
218 Protected slot called by the context menu to update a file from the
219 VCS repository.
220 </p><a NAME="VcsProjectBrowserHelper._updateVCSStatus" ID="VcsProjectBrowserHelper._updateVCSStatus"></a>
221 <h4>VcsProjectBrowserHelper._updateVCSStatus</h4>
222 <b>_updateVCSStatus</b>(<i>name</i>)
223 <p>
224 Protected method to update the VCS status of an item.
225 </p><dl>
226 <dt><i>name</i></dt>
227 <dd>
228 filename or directoryname of the item to be updated
229 (string)
230 </dd>
231 </dl><a NAME="VcsProjectBrowserHelper.addVCSMenus" ID="VcsProjectBrowserHelper.addVCSMenus"></a>
232 <h4>VcsProjectBrowserHelper.addVCSMenus</h4>
233 <b>addVCSMenus</b>(<i>mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu</i>)
234 <p>
235 Public method to add the VCS entries to the various project browser
236 menus.
237 </p><dl>
238 <dt><i>mainMenu</i></dt>
239 <dd>
240 reference to the main menu (QPopupMenu)
241 </dd><dt><i>multiMenu</i></dt>
242 <dd>
243 reference to the multiple selection menu (QPopupMenu)
244 </dd><dt><i>backMenu</i></dt>
245 <dd>
246 reference to the background menu (QPopupMenu)
247 </dd><dt><i>dirMenu</i></dt>
248 <dd>
249 reference to the directory menu (QPopupMenu)
250 </dd><dt><i>dirMultiMenu</i></dt>
251 <dd>
252 reference to the multiple selection directory
253 menu (QPopupMenu)
254 </dd>
255 </dl><a NAME="VcsProjectBrowserHelper.showContextMenu" ID="VcsProjectBrowserHelper.showContextMenu"></a>
256 <h4>VcsProjectBrowserHelper.showContextMenu</h4>
257 <b>showContextMenu</b>(<i>menu, standardItems</i>)
258 <p>
259 Public slot called before the context menu is shown.
260 </p><p>
261 It enables/disables the VCS menu entries depending on the overall
262 VCS status and the file status.
263 </p><dl>
264 <dt><i>menu</i></dt>
265 <dd>
266 reference to the menu to be shown
267 </dd><dt><i>standardItems</i></dt>
268 <dd>
269 array of standard items that need
270 activation/deactivation depending on the overall VCS status
271 </dd>
272 </dl><dl>
273 <dt>Raises <b>RuntimeError</b>:</dt>
274 <dd>
275 to indicate that this method must be
276 implemented by a subclass
277 </dd>
278 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDir" ID="VcsProjectBrowserHelper.showContextMenuDir"></a>
279 <h4>VcsProjectBrowserHelper.showContextMenuDir</h4>
280 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
281 <p>
282 Public slot called before the context menu is shown.
283 </p><p>
284 It enables/disables the VCS menu entries depending on the overall
285 VCS status and the directory status.
286 </p><dl>
287 <dt><i>menu</i></dt>
288 <dd>
289 reference to the menu to be shown
290 </dd><dt><i>standardItems</i></dt>
291 <dd>
292 array of standard items that
293 need activation/deactivation depending on the overall VCS status
294 </dd>
295 </dl><dl>
296 <dt>Raises <b>RuntimeError</b>:</dt>
297 <dd>
298 to indicate that this method must be
299 implemented by a subclass
300 </dd>
301 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDirMulti" ID="VcsProjectBrowserHelper.showContextMenuDirMulti"></a>
302 <h4>VcsProjectBrowserHelper.showContextMenuDirMulti</h4>
303 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
304 <p>
305 Public slot called before the context menu is shown.
306 </p><p>
307 It enables/disables the VCS menu entries depending on the overall
308 VCS status and the directory status.
309 </p><dl>
310 <dt><i>menu</i></dt>
311 <dd>
312 reference to the menu to be shown
313 </dd><dt><i>standardItems</i></dt>
314 <dd>
315 array of standard items that need
316 activation/deactivation depending on the overall VCS status
317 </dd>
318 </dl><dl>
319 <dt>Raises <b>RuntimeError</b>:</dt>
320 <dd>
321 to indicate that this method must be
322 implemented by a subclass
323 </dd>
324 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuMulti" ID="VcsProjectBrowserHelper.showContextMenuMulti"></a>
325 <h4>VcsProjectBrowserHelper.showContextMenuMulti</h4>
326 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
327 <p>
328 Public slot called before the context menu (multiple selections) is
329 shown.
330 </p><p>
331 It enables/disables the VCS menu entries depending on the overall
332 VCS status and the files status.
333 </p><dl>
334 <dt><i>menu</i></dt>
335 <dd>
336 reference to the menu to be shown
337 </dd><dt><i>standardItems</i></dt>
338 <dd>
339 array of standard items that need
340 activation/deactivation depending on the overall VCS status
341 </dd>
342 </dl><dl>
343 <dt>Raises <b>RuntimeError</b>:</dt>
344 <dd>
345 to indicate that this method must be
346 implemented by a subclass
347 </dd>
348 </dl>
349 <div align="right"><a href="#top">Up</a></div>
350 <hr />
351 </body></html>

Mercurial Repository: eric

eric ide

mercurial