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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.VCS.ProjectBrowserHelper</h1> 23 <h1>eric6.VCS.ProjectBrowserHelper</h1>
24
23 <p> 25 <p>
24 Module implementing the base class of the VCS project browser helper. 26 Module implementing the base class of the VCS project browser helper.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#VcsProjectBrowserHelper">VcsProjectBrowserHelper</a></td> 38 <td><a href="#VcsProjectBrowserHelper">VcsProjectBrowserHelper</a></td>
34 <td>Class implementing the base class of the VCS project browser helper.</td> 39 <td>Class implementing the base class of the VCS project browser helper.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="VcsProjectBrowserHelper" ID="VcsProjectBrowserHelper"></a> 49 <a NAME="VcsProjectBrowserHelper" ID="VcsProjectBrowserHelper"></a>
43 <h2>VcsProjectBrowserHelper</h2> 50 <h2>VcsProjectBrowserHelper</h2>
51
44 <p> 52 <p>
45 Class implementing the base class of the VCS project browser helper. 53 Class implementing the base class of the VCS project browser helper.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#VcsProjectBrowserHelper.__init__">VcsProjectBrowserHelper</a></td> 72 <td><a href="#VcsProjectBrowserHelper.__init__">VcsProjectBrowserHelper</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#VcsProjectBrowserHelper._VCSAdd">_VCSAdd</a></td> 76 <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> 77 <td>Protected slot called by the context menu to add the selected file to the VCS repository.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#VcsProjectBrowserHelper._VCSAddTree">_VCSAddTree</a></td> 80 <td><a href="#VcsProjectBrowserHelper._VCSAddTree">_VCSAddTree</a></td>
67 <td>Protected slot called by the context menu.</td> 81 <td>Protected slot called by the context menu.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#VcsProjectBrowserHelper._VCSCommit">_VCSCommit</a></td> 84 <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> 85 <td>Protected slot called by the context menu to commit the changes to the VCS repository.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#VcsProjectBrowserHelper._VCSDiff">_VCSDiff</a></td> 88 <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> 89 <td>Protected slot called by the context menu to show the difference of a file/directory to the repository.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#VcsProjectBrowserHelper._VCSInfoDisplay">_VCSInfoDisplay</a></td> 92 <td><a href="#VcsProjectBrowserHelper._VCSInfoDisplay">_VCSInfoDisplay</a></td>
76 <td>Protected slot called to show some vcs information.</td> 93 <td>Protected slot called to show some vcs information.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#VcsProjectBrowserHelper._VCSLog">_VCSLog</a></td> 96 <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> 97 <td>Protected slot called by the context menu to show the VCS log of a file/directory.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#VcsProjectBrowserHelper._VCSLogBrowser">_VCSLogBrowser</a></td> 100 <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> 101 <td>Protected slot called by the context menu to show the log browser for a file.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#VcsProjectBrowserHelper._VCSMerge">_VCSMerge</a></td> 104 <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> 105 <td>Protected slot called by the context menu to merge changes into to a file.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#VcsProjectBrowserHelper._VCSRemove">_VCSRemove</a></td> 108 <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> 109 <td>Protected slot called by the context menu to remove the selected file from the VCS repository.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#VcsProjectBrowserHelper._VCSRevert">_VCSRevert</a></td> 112 <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> 113 <td>Protected slot called by the context menu to revert changes made to a file.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#VcsProjectBrowserHelper._VCSStatus">_VCSStatus</a></td> 116 <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> 117 <td>Protected slot called by the context menu to show the status of a file.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#VcsProjectBrowserHelper._VCSUpdate">_VCSUpdate</a></td> 120 <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> 121 <td>Protected slot called by the context menu to update a file from the VCS repository.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#VcsProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td> 124 <td><a href="#VcsProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td>
100 <td>Protected method to update the VCS status of an item.</td> 125 <td>Protected method to update the VCS status of an item.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#VcsProjectBrowserHelper.addVCSMenus">addVCSMenus</a></td> 128 <td><a href="#VcsProjectBrowserHelper.addVCSMenus">addVCSMenus</a></td>
103 <td>Public method to add the VCS entries to the various project browser menus.</td> 129 <td>Public method to add the VCS entries to the various project browser menus.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#VcsProjectBrowserHelper.showContextMenu">showContextMenu</a></td> 132 <td><a href="#VcsProjectBrowserHelper.showContextMenu">showContextMenu</a></td>
106 <td>Public slot called before the context menu is shown.</td> 133 <td>Public slot called before the context menu is shown.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#VcsProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> 136 <td><a href="#VcsProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td>
109 <td>Public slot called before the context menu is shown.</td> 137 <td>Public slot called before the context menu is shown.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#VcsProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> 140 <td><a href="#VcsProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td>
112 <td>Public slot called before the context menu is shown.</td> 141 <td>Public slot called before the context menu is shown.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#VcsProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> 144 <td><a href="#VcsProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td>
115 <td>Public slot called before the context menu (multiple selections) is shown.</td> 145 <td>Public slot called before the context menu (multiple selections) is shown.</td>
116 </tr> 146 </tr>
117 </table> 147 </table>
118 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
149
119 <table> 150 <table>
120 <tr><td>None</td></tr> 151 <tr><td>None</td></tr>
121 </table> 152 </table>
153
122 <a NAME="VcsProjectBrowserHelper.__init__" ID="VcsProjectBrowserHelper.__init__"></a> 154 <a NAME="VcsProjectBrowserHelper.__init__" ID="VcsProjectBrowserHelper.__init__"></a>
123 <h4>VcsProjectBrowserHelper (Constructor)</h4> 155 <h4>VcsProjectBrowserHelper (Constructor)</h4>
124 <b>VcsProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>) 156 <b>VcsProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>)
157
125 <p> 158 <p>
126 Constructor 159 Constructor
127 </p><dl> 160 </p>
161 <dl>
162
128 <dt><i>vcsObject</i></dt> 163 <dt><i>vcsObject</i></dt>
129 <dd> 164 <dd>
130 reference to the vcs object 165 reference to the vcs object
131 </dd><dt><i>browserObject</i></dt> 166 </dd>
167 <dt><i>browserObject</i></dt>
132 <dd> 168 <dd>
133 reference to the project browser object 169 reference to the project browser object
134 </dd><dt><i>projectObject</i></dt> 170 </dd>
171 <dt><i>projectObject</i></dt>
135 <dd> 172 <dd>
136 reference to the project object 173 reference to the project object
137 </dd><dt><i>isTranslationsBrowser</i></dt> 174 </dd>
175 <dt><i>isTranslationsBrowser</i></dt>
138 <dd> 176 <dd>
139 flag indicating, the helper is requested 177 flag indicating, the helper is requested
140 for the translations browser (this needs some special treatment) 178 for the translations browser (this needs some special treatment)
141 </dd><dt><i>parent</i></dt> 179 </dd>
180 <dt><i>parent</i></dt>
142 <dd> 181 <dd>
143 parent widget (QWidget) 182 parent widget (QWidget)
144 </dd><dt><i>name</i></dt> 183 </dd>
184 <dt><i>name</i></dt>
145 <dd> 185 <dd>
146 name of this object (string) 186 name of this object (string)
147 </dd> 187 </dd>
148 </dl><a NAME="VcsProjectBrowserHelper._VCSAdd" ID="VcsProjectBrowserHelper._VCSAdd"></a> 188 </dl>
189 <a NAME="VcsProjectBrowserHelper._VCSAdd" ID="VcsProjectBrowserHelper._VCSAdd"></a>
149 <h4>VcsProjectBrowserHelper._VCSAdd</h4> 190 <h4>VcsProjectBrowserHelper._VCSAdd</h4>
150 <b>_VCSAdd</b>(<i></i>) 191 <b>_VCSAdd</b>(<i></i>)
192
151 <p> 193 <p>
152 Protected slot called by the context menu to add the selected file to 194 Protected slot called by the context menu to add the selected file to
153 the VCS repository. 195 the VCS repository.
154 </p><a NAME="VcsProjectBrowserHelper._VCSAddTree" ID="VcsProjectBrowserHelper._VCSAddTree"></a> 196 </p>
197 <a NAME="VcsProjectBrowserHelper._VCSAddTree" ID="VcsProjectBrowserHelper._VCSAddTree"></a>
155 <h4>VcsProjectBrowserHelper._VCSAddTree</h4> 198 <h4>VcsProjectBrowserHelper._VCSAddTree</h4>
156 <b>_VCSAddTree</b>(<i></i>) 199 <b>_VCSAddTree</b>(<i></i>)
200
157 <p> 201 <p>
158 Protected slot called by the context menu. 202 Protected slot called by the context menu.
159 </p><p> 203 </p>
204 <p>
160 It is used to add the selected 205 It is used to add the selected
161 directory tree to the VCS repository. 206 directory tree to the VCS repository.
162 </p><a NAME="VcsProjectBrowserHelper._VCSCommit" ID="VcsProjectBrowserHelper._VCSCommit"></a> 207 </p>
208 <a NAME="VcsProjectBrowserHelper._VCSCommit" ID="VcsProjectBrowserHelper._VCSCommit"></a>
163 <h4>VcsProjectBrowserHelper._VCSCommit</h4> 209 <h4>VcsProjectBrowserHelper._VCSCommit</h4>
164 <b>_VCSCommit</b>(<i></i>) 210 <b>_VCSCommit</b>(<i></i>)
211
165 <p> 212 <p>
166 Protected slot called by the context menu to commit the changes to the 213 Protected slot called by the context menu to commit the changes to the
167 VCS repository. 214 VCS repository.
168 </p><a NAME="VcsProjectBrowserHelper._VCSDiff" ID="VcsProjectBrowserHelper._VCSDiff"></a> 215 </p>
216 <a NAME="VcsProjectBrowserHelper._VCSDiff" ID="VcsProjectBrowserHelper._VCSDiff"></a>
169 <h4>VcsProjectBrowserHelper._VCSDiff</h4> 217 <h4>VcsProjectBrowserHelper._VCSDiff</h4>
170 <b>_VCSDiff</b>(<i></i>) 218 <b>_VCSDiff</b>(<i></i>)
219
171 <p> 220 <p>
172 Protected slot called by the context menu to show the difference of a 221 Protected slot called by the context menu to show the difference of a
173 file/directory to the repository. 222 file/directory to the repository.
174 </p><a NAME="VcsProjectBrowserHelper._VCSInfoDisplay" ID="VcsProjectBrowserHelper._VCSInfoDisplay"></a> 223 </p>
224 <a NAME="VcsProjectBrowserHelper._VCSInfoDisplay" ID="VcsProjectBrowserHelper._VCSInfoDisplay"></a>
175 <h4>VcsProjectBrowserHelper._VCSInfoDisplay</h4> 225 <h4>VcsProjectBrowserHelper._VCSInfoDisplay</h4>
176 <b>_VCSInfoDisplay</b>(<i></i>) 226 <b>_VCSInfoDisplay</b>(<i></i>)
227
177 <p> 228 <p>
178 Protected slot called to show some vcs information. 229 Protected slot called to show some vcs information.
179 </p><a NAME="VcsProjectBrowserHelper._VCSLog" ID="VcsProjectBrowserHelper._VCSLog"></a> 230 </p>
231 <a NAME="VcsProjectBrowserHelper._VCSLog" ID="VcsProjectBrowserHelper._VCSLog"></a>
180 <h4>VcsProjectBrowserHelper._VCSLog</h4> 232 <h4>VcsProjectBrowserHelper._VCSLog</h4>
181 <b>_VCSLog</b>(<i></i>) 233 <b>_VCSLog</b>(<i></i>)
234
182 <p> 235 <p>
183 Protected slot called by the context menu to show the VCS log of a 236 Protected slot called by the context menu to show the VCS log of a
184 file/directory. 237 file/directory.
185 </p><a NAME="VcsProjectBrowserHelper._VCSLogBrowser" ID="VcsProjectBrowserHelper._VCSLogBrowser"></a> 238 </p>
239 <a NAME="VcsProjectBrowserHelper._VCSLogBrowser" ID="VcsProjectBrowserHelper._VCSLogBrowser"></a>
186 <h4>VcsProjectBrowserHelper._VCSLogBrowser</h4> 240 <h4>VcsProjectBrowserHelper._VCSLogBrowser</h4>
187 <b>_VCSLogBrowser</b>(<i></i>) 241 <b>_VCSLogBrowser</b>(<i></i>)
242
188 <p> 243 <p>
189 Protected slot called by the context menu to show the log browser for a 244 Protected slot called by the context menu to show the log browser for a
190 file. 245 file.
191 </p><a NAME="VcsProjectBrowserHelper._VCSMerge" ID="VcsProjectBrowserHelper._VCSMerge"></a> 246 </p>
247 <a NAME="VcsProjectBrowserHelper._VCSMerge" ID="VcsProjectBrowserHelper._VCSMerge"></a>
192 <h4>VcsProjectBrowserHelper._VCSMerge</h4> 248 <h4>VcsProjectBrowserHelper._VCSMerge</h4>
193 <b>_VCSMerge</b>(<i></i>) 249 <b>_VCSMerge</b>(<i></i>)
250
194 <p> 251 <p>
195 Protected slot called by the context menu to merge changes into to a 252 Protected slot called by the context menu to merge changes into to a
196 file. 253 file.
197 </p><a NAME="VcsProjectBrowserHelper._VCSRemove" ID="VcsProjectBrowserHelper._VCSRemove"></a> 254 </p>
255 <a NAME="VcsProjectBrowserHelper._VCSRemove" ID="VcsProjectBrowserHelper._VCSRemove"></a>
198 <h4>VcsProjectBrowserHelper._VCSRemove</h4> 256 <h4>VcsProjectBrowserHelper._VCSRemove</h4>
199 <b>_VCSRemove</b>(<i></i>) 257 <b>_VCSRemove</b>(<i></i>)
258
200 <p> 259 <p>
201 Protected slot called by the context menu to remove the selected file 260 Protected slot called by the context menu to remove the selected file
202 from the VCS repository. 261 from the VCS repository.
203 </p><a NAME="VcsProjectBrowserHelper._VCSRevert" ID="VcsProjectBrowserHelper._VCSRevert"></a> 262 </p>
263 <a NAME="VcsProjectBrowserHelper._VCSRevert" ID="VcsProjectBrowserHelper._VCSRevert"></a>
204 <h4>VcsProjectBrowserHelper._VCSRevert</h4> 264 <h4>VcsProjectBrowserHelper._VCSRevert</h4>
205 <b>_VCSRevert</b>(<i></i>) 265 <b>_VCSRevert</b>(<i></i>)
266
206 <p> 267 <p>
207 Protected slot called by the context menu to revert changes made to a 268 Protected slot called by the context menu to revert changes made to a
208 file. 269 file.
209 </p><a NAME="VcsProjectBrowserHelper._VCSStatus" ID="VcsProjectBrowserHelper._VCSStatus"></a> 270 </p>
271 <a NAME="VcsProjectBrowserHelper._VCSStatus" ID="VcsProjectBrowserHelper._VCSStatus"></a>
210 <h4>VcsProjectBrowserHelper._VCSStatus</h4> 272 <h4>VcsProjectBrowserHelper._VCSStatus</h4>
211 <b>_VCSStatus</b>(<i></i>) 273 <b>_VCSStatus</b>(<i></i>)
274
212 <p> 275 <p>
213 Protected slot called by the context menu to show the status of a file. 276 Protected slot called by the context menu to show the status of a file.
214 </p><a NAME="VcsProjectBrowserHelper._VCSUpdate" ID="VcsProjectBrowserHelper._VCSUpdate"></a> 277 </p>
278 <a NAME="VcsProjectBrowserHelper._VCSUpdate" ID="VcsProjectBrowserHelper._VCSUpdate"></a>
215 <h4>VcsProjectBrowserHelper._VCSUpdate</h4> 279 <h4>VcsProjectBrowserHelper._VCSUpdate</h4>
216 <b>_VCSUpdate</b>(<i></i>) 280 <b>_VCSUpdate</b>(<i></i>)
281
217 <p> 282 <p>
218 Protected slot called by the context menu to update a file from the 283 Protected slot called by the context menu to update a file from the
219 VCS repository. 284 VCS repository.
220 </p><a NAME="VcsProjectBrowserHelper._updateVCSStatus" ID="VcsProjectBrowserHelper._updateVCSStatus"></a> 285 </p>
286 <a NAME="VcsProjectBrowserHelper._updateVCSStatus" ID="VcsProjectBrowserHelper._updateVCSStatus"></a>
221 <h4>VcsProjectBrowserHelper._updateVCSStatus</h4> 287 <h4>VcsProjectBrowserHelper._updateVCSStatus</h4>
222 <b>_updateVCSStatus</b>(<i>name</i>) 288 <b>_updateVCSStatus</b>(<i>name</i>)
289
223 <p> 290 <p>
224 Protected method to update the VCS status of an item. 291 Protected method to update the VCS status of an item.
225 </p><dl> 292 </p>
293 <dl>
294
226 <dt><i>name</i></dt> 295 <dt><i>name</i></dt>
227 <dd> 296 <dd>
228 filename or directoryname of the item to be updated 297 filename or directoryname of the item to be updated
229 (string) 298 (string)
230 </dd> 299 </dd>
231 </dl><a NAME="VcsProjectBrowserHelper.addVCSMenus" ID="VcsProjectBrowserHelper.addVCSMenus"></a> 300 </dl>
301 <a NAME="VcsProjectBrowserHelper.addVCSMenus" ID="VcsProjectBrowserHelper.addVCSMenus"></a>
232 <h4>VcsProjectBrowserHelper.addVCSMenus</h4> 302 <h4>VcsProjectBrowserHelper.addVCSMenus</h4>
233 <b>addVCSMenus</b>(<i>mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu</i>) 303 <b>addVCSMenus</b>(<i>mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu</i>)
304
234 <p> 305 <p>
235 Public method to add the VCS entries to the various project browser 306 Public method to add the VCS entries to the various project browser
236 menus. 307 menus.
237 </p><dl> 308 </p>
309 <dl>
310
238 <dt><i>mainMenu</i></dt> 311 <dt><i>mainMenu</i></dt>
239 <dd> 312 <dd>
240 reference to the main menu (QPopupMenu) 313 reference to the main menu (QPopupMenu)
241 </dd><dt><i>multiMenu</i></dt> 314 </dd>
315 <dt><i>multiMenu</i></dt>
242 <dd> 316 <dd>
243 reference to the multiple selection menu (QPopupMenu) 317 reference to the multiple selection menu (QPopupMenu)
244 </dd><dt><i>backMenu</i></dt> 318 </dd>
319 <dt><i>backMenu</i></dt>
245 <dd> 320 <dd>
246 reference to the background menu (QPopupMenu) 321 reference to the background menu (QPopupMenu)
247 </dd><dt><i>dirMenu</i></dt> 322 </dd>
323 <dt><i>dirMenu</i></dt>
248 <dd> 324 <dd>
249 reference to the directory menu (QPopupMenu) 325 reference to the directory menu (QPopupMenu)
250 </dd><dt><i>dirMultiMenu</i></dt> 326 </dd>
327 <dt><i>dirMultiMenu</i></dt>
251 <dd> 328 <dd>
252 reference to the multiple selection directory 329 reference to the multiple selection directory
253 menu (QPopupMenu) 330 menu (QPopupMenu)
254 </dd> 331 </dd>
255 </dl><a NAME="VcsProjectBrowserHelper.showContextMenu" ID="VcsProjectBrowserHelper.showContextMenu"></a> 332 </dl>
333 <a NAME="VcsProjectBrowserHelper.showContextMenu" ID="VcsProjectBrowserHelper.showContextMenu"></a>
256 <h4>VcsProjectBrowserHelper.showContextMenu</h4> 334 <h4>VcsProjectBrowserHelper.showContextMenu</h4>
257 <b>showContextMenu</b>(<i>menu, standardItems</i>) 335 <b>showContextMenu</b>(<i>menu, standardItems</i>)
336
258 <p> 337 <p>
259 Public slot called before the context menu is shown. 338 Public slot called before the context menu is shown.
260 </p><p> 339 </p>
340 <p>
261 It enables/disables the VCS menu entries depending on the overall 341 It enables/disables the VCS menu entries depending on the overall
262 VCS status and the file status. 342 VCS status and the file status.
263 </p><dl> 343 </p>
344 <dl>
345
264 <dt><i>menu</i></dt> 346 <dt><i>menu</i></dt>
265 <dd> 347 <dd>
266 reference to the menu to be shown 348 reference to the menu to be shown
267 </dd><dt><i>standardItems</i></dt> 349 </dd>
350 <dt><i>standardItems</i></dt>
268 <dd> 351 <dd>
269 array of standard items that need 352 array of standard items that need
270 activation/deactivation depending on the overall VCS status 353 activation/deactivation depending on the overall VCS status
271 </dd> 354 </dd>
272 </dl><dl> 355 </dl>
356 <dl>
357
273 <dt>Raises <b>RuntimeError</b>:</dt> 358 <dt>Raises <b>RuntimeError</b>:</dt>
274 <dd> 359 <dd>
275 to indicate that this method must be 360 to indicate that this method must be
276 implemented by a subclass 361 implemented by a subclass
277 </dd> 362 </dd>
278 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDir" ID="VcsProjectBrowserHelper.showContextMenuDir"></a> 363 </dl>
364 <a NAME="VcsProjectBrowserHelper.showContextMenuDir" ID="VcsProjectBrowserHelper.showContextMenuDir"></a>
279 <h4>VcsProjectBrowserHelper.showContextMenuDir</h4> 365 <h4>VcsProjectBrowserHelper.showContextMenuDir</h4>
280 <b>showContextMenuDir</b>(<i>menu, standardItems</i>) 366 <b>showContextMenuDir</b>(<i>menu, standardItems</i>)
367
281 <p> 368 <p>
282 Public slot called before the context menu is shown. 369 Public slot called before the context menu is shown.
283 </p><p> 370 </p>
371 <p>
284 It enables/disables the VCS menu entries depending on the overall 372 It enables/disables the VCS menu entries depending on the overall
285 VCS status and the directory status. 373 VCS status and the directory status.
286 </p><dl> 374 </p>
375 <dl>
376
287 <dt><i>menu</i></dt> 377 <dt><i>menu</i></dt>
288 <dd> 378 <dd>
289 reference to the menu to be shown 379 reference to the menu to be shown
290 </dd><dt><i>standardItems</i></dt> 380 </dd>
381 <dt><i>standardItems</i></dt>
291 <dd> 382 <dd>
292 array of standard items that 383 array of standard items that
293 need activation/deactivation depending on the overall VCS status 384 need activation/deactivation depending on the overall VCS status
294 </dd> 385 </dd>
295 </dl><dl> 386 </dl>
387 <dl>
388
296 <dt>Raises <b>RuntimeError</b>:</dt> 389 <dt>Raises <b>RuntimeError</b>:</dt>
297 <dd> 390 <dd>
298 to indicate that this method must be 391 to indicate that this method must be
299 implemented by a subclass 392 implemented by a subclass
300 </dd> 393 </dd>
301 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDirMulti" ID="VcsProjectBrowserHelper.showContextMenuDirMulti"></a> 394 </dl>
395 <a NAME="VcsProjectBrowserHelper.showContextMenuDirMulti" ID="VcsProjectBrowserHelper.showContextMenuDirMulti"></a>
302 <h4>VcsProjectBrowserHelper.showContextMenuDirMulti</h4> 396 <h4>VcsProjectBrowserHelper.showContextMenuDirMulti</h4>
303 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) 397 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>)
398
304 <p> 399 <p>
305 Public slot called before the context menu is shown. 400 Public slot called before the context menu is shown.
306 </p><p> 401 </p>
402 <p>
307 It enables/disables the VCS menu entries depending on the overall 403 It enables/disables the VCS menu entries depending on the overall
308 VCS status and the directory status. 404 VCS status and the directory status.
309 </p><dl> 405 </p>
406 <dl>
407
310 <dt><i>menu</i></dt> 408 <dt><i>menu</i></dt>
311 <dd> 409 <dd>
312 reference to the menu to be shown 410 reference to the menu to be shown
313 </dd><dt><i>standardItems</i></dt> 411 </dd>
412 <dt><i>standardItems</i></dt>
314 <dd> 413 <dd>
315 array of standard items that need 414 array of standard items that need
316 activation/deactivation depending on the overall VCS status 415 activation/deactivation depending on the overall VCS status
317 </dd> 416 </dd>
318 </dl><dl> 417 </dl>
418 <dl>
419
319 <dt>Raises <b>RuntimeError</b>:</dt> 420 <dt>Raises <b>RuntimeError</b>:</dt>
320 <dd> 421 <dd>
321 to indicate that this method must be 422 to indicate that this method must be
322 implemented by a subclass 423 implemented by a subclass
323 </dd> 424 </dd>
324 </dl><a NAME="VcsProjectBrowserHelper.showContextMenuMulti" ID="VcsProjectBrowserHelper.showContextMenuMulti"></a> 425 </dl>
426 <a NAME="VcsProjectBrowserHelper.showContextMenuMulti" ID="VcsProjectBrowserHelper.showContextMenuMulti"></a>
325 <h4>VcsProjectBrowserHelper.showContextMenuMulti</h4> 427 <h4>VcsProjectBrowserHelper.showContextMenuMulti</h4>
326 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) 428 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>)
429
327 <p> 430 <p>
328 Public slot called before the context menu (multiple selections) is 431 Public slot called before the context menu (multiple selections) is
329 shown. 432 shown.
330 </p><p> 433 </p>
434 <p>
331 It enables/disables the VCS menu entries depending on the overall 435 It enables/disables the VCS menu entries depending on the overall
332 VCS status and the files status. 436 VCS status and the files status.
333 </p><dl> 437 </p>
438 <dl>
439
334 <dt><i>menu</i></dt> 440 <dt><i>menu</i></dt>
335 <dd> 441 <dd>
336 reference to the menu to be shown 442 reference to the menu to be shown
337 </dd><dt><i>standardItems</i></dt> 443 </dd>
444 <dt><i>standardItems</i></dt>
338 <dd> 445 <dd>
339 array of standard items that need 446 array of standard items that need
340 activation/deactivation depending on the overall VCS status 447 activation/deactivation depending on the overall VCS status
341 </dd> 448 </dd>
342 </dl><dl> 449 </dl>
450 <dl>
451
343 <dt>Raises <b>RuntimeError</b>:</dt> 452 <dt>Raises <b>RuntimeError</b>:</dt>
344 <dd> 453 <dd>
345 to indicate that this method must be 454 to indicate that this method must be
346 implemented by a subclass 455 implemented by a subclass
347 </dd> 456 </dd>

eric ide

mercurial