Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.VCS.ProjectBrowserHelper.html

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

Mercurial Repository: eric

eric ide

mercurial