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