Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.ProjectBrowserHelper</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the VCS project browser helper for Git. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#GitProjectBrowserHelper">GitProjectBrowserHelper</a></td> | |
| 25 <td>Class implementing the VCS project browser helper for Git.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="GitProjectBrowserHelper" ID="GitProjectBrowserHelper"></a> | |
| 36 <h2>GitProjectBrowserHelper</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the VCS project browser helper for Git. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 VcsProjectBrowserHelper | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#GitProjectBrowserHelper.__init__">GitProjectBrowserHelper</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitProjectBrowserHelper.__GitBlame">__GitBlame</a></td> | |
| 63 <td>Private slot called by the context menu to show the annotations of a file.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitProjectBrowserHelper.__GitConfigure">__GitConfigure</a></td> | |
| 67 <td>Private method to open the configuration dialog.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitProjectBrowserHelper.__GitCopy">__GitCopy</a></td> | |
| 71 <td>Private slot called by the context menu to copy the selected file.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitProjectBrowserHelper.__GitExtendedDiff">__GitExtendedDiff</a></td> | |
| 75 <td>Private slot called by the context menu to show the difference of a file to the repository.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitProjectBrowserHelper.__GitForget">__GitForget</a></td> | |
| 79 <td>Private slot called by the context menu to remove the selected file from the Git repository leaving a copy in the project directory.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitProjectBrowserHelper.__GitMove">__GitMove</a></td> | |
| 83 <td>Private slot called by the context menu to move the selected file.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitProjectBrowserHelper.__GitRevert">__GitRevert</a></td> | |
| 87 <td>Private slot to revert changes of the working area.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitProjectBrowserHelper.__GitSbsDiff">__GitSbsDiff</a></td> | |
| 91 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitProjectBrowserHelper.__GitSbsExtendedDiff">__GitSbsExtendedDiff</a></td> | |
| 95 <td>Private slot called by the context menu to show the difference of a file to the repository side-by-side.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GitProjectBrowserHelper.__GitUnstage">__GitUnstage</a></td> | |
| 99 <td>Private slot to unstage changes.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GitProjectBrowserHelper._addVCSMenu">_addVCSMenu</a></td> | |
| 103 <td>Protected method used to add the VCS menu to all project browsers.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GitProjectBrowserHelper._addVCSMenuBack">_addVCSMenuBack</a></td> | |
| 107 <td>Protected method used to add the VCS menu to all project browsers.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#GitProjectBrowserHelper._addVCSMenuDir">_addVCSMenuDir</a></td> | |
| 111 <td>Protected method used to add the VCS menu to all project browsers.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#GitProjectBrowserHelper._addVCSMenuDirMulti">_addVCSMenuDirMulti</a></td> | |
| 115 <td>Protected method used to add the VCS menu to all project browsers.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#GitProjectBrowserHelper._addVCSMenuMulti">_addVCSMenuMulti</a></td> | |
| 119 <td>Protected method used to add the VCS menu for multi selection to all project browsers.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#GitProjectBrowserHelper.showContextMenu">showContextMenu</a></td> | |
| 123 <td>Public slot called before the context menu is shown.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#GitProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> | |
| 127 <td>Public slot called before the context menu is shown.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#GitProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> | |
| 131 <td>Public slot called before the context menu is shown.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#GitProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> | |
| 135 <td>Public slot called before the context menu (multiple selections) is shown.</td> | |
| 136 </tr> | |
| 137 </table> | |
| 138 <h3>Static Methods</h3> | |
| 139 | |
| 140 <table> | |
| 141 <tr><td>None</td></tr> | |
| 142 </table> | |
| 143 | |
| 144 <a NAME="GitProjectBrowserHelper.__init__" ID="GitProjectBrowserHelper.__init__"></a> | |
| 145 <h4>GitProjectBrowserHelper (Constructor)</h4> | |
| 146 <b>GitProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None</i>) | |
| 147 | |
| 148 <p> | |
| 149 Constructor | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>vcsObject</i></dt> | |
| 154 <dd> | |
| 155 reference to the vcs object | |
| 156 </dd> | |
| 157 <dt><i>browserObject</i></dt> | |
| 158 <dd> | |
| 159 reference to the project browser object | |
| 160 </dd> | |
| 161 <dt><i>projectObject</i></dt> | |
| 162 <dd> | |
| 163 reference to the project object | |
| 164 </dd> | |
| 165 <dt><i>isTranslationsBrowser</i></dt> | |
| 166 <dd> | |
| 167 flag indicating, the helper is requested | |
| 168 for the translations browser (this needs some special treatment) | |
| 169 </dd> | |
| 170 <dt><i>parent</i></dt> | |
| 171 <dd> | |
| 172 parent widget (QWidget) | |
| 173 </dd> | |
| 174 <dt><i>name</i></dt> | |
| 175 <dd> | |
| 176 name of this object (string) | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <a NAME="GitProjectBrowserHelper.__GitBlame" ID="GitProjectBrowserHelper.__GitBlame"></a> | |
| 180 <h4>GitProjectBrowserHelper.__GitBlame</h4> | |
| 181 <b>__GitBlame</b>(<i></i>) | |
| 182 | |
| 183 <p> | |
| 184 Private slot called by the context menu to show the annotations of a | |
| 185 file. | |
| 186 </p> | |
| 187 <a NAME="GitProjectBrowserHelper.__GitConfigure" ID="GitProjectBrowserHelper.__GitConfigure"></a> | |
| 188 <h4>GitProjectBrowserHelper.__GitConfigure</h4> | |
| 189 <b>__GitConfigure</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Private method to open the configuration dialog. | |
| 193 </p> | |
| 194 <a NAME="GitProjectBrowserHelper.__GitCopy" ID="GitProjectBrowserHelper.__GitCopy"></a> | |
| 195 <h4>GitProjectBrowserHelper.__GitCopy</h4> | |
| 196 <b>__GitCopy</b>(<i></i>) | |
| 197 | |
| 198 <p> | |
| 199 Private slot called by the context menu to copy the selected file. | |
| 200 </p> | |
| 201 <a NAME="GitProjectBrowserHelper.__GitExtendedDiff" ID="GitProjectBrowserHelper.__GitExtendedDiff"></a> | |
| 202 <h4>GitProjectBrowserHelper.__GitExtendedDiff</h4> | |
| 203 <b>__GitExtendedDiff</b>(<i></i>) | |
| 204 | |
| 205 <p> | |
| 206 Private slot called by the context menu to show the difference of a | |
| 207 file to the repository. | |
| 208 </p> | |
| 209 <p> | |
| 210 This gives the chance to enter the revisions to compare. | |
| 211 </p> | |
| 212 <a NAME="GitProjectBrowserHelper.__GitForget" ID="GitProjectBrowserHelper.__GitForget"></a> | |
| 213 <h4>GitProjectBrowserHelper.__GitForget</h4> | |
| 214 <b>__GitForget</b>(<i></i>) | |
| 215 | |
| 216 <p> | |
| 217 Private slot called by the context menu to remove the selected file | |
| 218 from the Git repository leaving a copy in the project directory. | |
| 219 </p> | |
| 220 <a NAME="GitProjectBrowserHelper.__GitMove" ID="GitProjectBrowserHelper.__GitMove"></a> | |
| 221 <h4>GitProjectBrowserHelper.__GitMove</h4> | |
| 222 <b>__GitMove</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Private slot called by the context menu to move the selected file. | |
| 226 </p> | |
| 227 <a NAME="GitProjectBrowserHelper.__GitRevert" ID="GitProjectBrowserHelper.__GitRevert"></a> | |
| 228 <h4>GitProjectBrowserHelper.__GitRevert</h4> | |
| 229 <b>__GitRevert</b>(<i></i>) | |
| 230 | |
| 231 <p> | |
| 232 Private slot to revert changes of the working area. | |
| 233 </p> | |
| 234 <a NAME="GitProjectBrowserHelper.__GitSbsDiff" ID="GitProjectBrowserHelper.__GitSbsDiff"></a> | |
| 235 <h4>GitProjectBrowserHelper.__GitSbsDiff</h4> | |
| 236 <b>__GitSbsDiff</b>(<i></i>) | |
| 237 | |
| 238 <p> | |
| 239 Private slot called by the context menu to show the difference of a | |
| 240 file to the repository side-by-side. | |
| 241 </p> | |
| 242 <a NAME="GitProjectBrowserHelper.__GitSbsExtendedDiff" ID="GitProjectBrowserHelper.__GitSbsExtendedDiff"></a> | |
| 243 <h4>GitProjectBrowserHelper.__GitSbsExtendedDiff</h4> | |
| 244 <b>__GitSbsExtendedDiff</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Private slot called by the context menu to show the difference of a | |
| 248 file to the repository side-by-side. | |
| 249 </p> | |
| 250 <p> | |
| 251 It allows the selection of revisions to compare. | |
| 252 </p> | |
| 253 <a NAME="GitProjectBrowserHelper.__GitUnstage" ID="GitProjectBrowserHelper.__GitUnstage"></a> | |
| 254 <h4>GitProjectBrowserHelper.__GitUnstage</h4> | |
| 255 <b>__GitUnstage</b>(<i></i>) | |
| 256 | |
| 257 <p> | |
| 258 Private slot to unstage changes. | |
| 259 </p> | |
| 260 <a NAME="GitProjectBrowserHelper._addVCSMenu" ID="GitProjectBrowserHelper._addVCSMenu"></a> | |
| 261 <h4>GitProjectBrowserHelper._addVCSMenu</h4> | |
| 262 <b>_addVCSMenu</b>(<i>mainMenu</i>) | |
| 263 | |
| 264 <p> | |
| 265 Protected method used to add the VCS menu to all project browsers. | |
| 266 </p> | |
| 267 <dl> | |
| 268 | |
| 269 <dt><i>mainMenu</i></dt> | |
| 270 <dd> | |
| 271 reference to the menu to be amended | |
| 272 </dd> | |
| 273 </dl> | |
| 274 <a NAME="GitProjectBrowserHelper._addVCSMenuBack" ID="GitProjectBrowserHelper._addVCSMenuBack"></a> | |
| 275 <h4>GitProjectBrowserHelper._addVCSMenuBack</h4> | |
| 276 <b>_addVCSMenuBack</b>(<i>mainMenu</i>) | |
| 277 | |
| 278 <p> | |
| 279 Protected method used to add the VCS menu to all project browsers. | |
| 280 </p> | |
| 281 <dl> | |
| 282 | |
| 283 <dt><i>mainMenu</i></dt> | |
| 284 <dd> | |
| 285 reference to the menu to be amended | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="GitProjectBrowserHelper._addVCSMenuDir" ID="GitProjectBrowserHelper._addVCSMenuDir"></a> | |
| 289 <h4>GitProjectBrowserHelper._addVCSMenuDir</h4> | |
| 290 <b>_addVCSMenuDir</b>(<i>mainMenu</i>) | |
| 291 | |
| 292 <p> | |
| 293 Protected method used to add the VCS menu to all project browsers. | |
| 294 </p> | |
| 295 <dl> | |
| 296 | |
| 297 <dt><i>mainMenu</i></dt> | |
| 298 <dd> | |
| 299 reference to the menu to be amended | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <a NAME="GitProjectBrowserHelper._addVCSMenuDirMulti" ID="GitProjectBrowserHelper._addVCSMenuDirMulti"></a> | |
| 303 <h4>GitProjectBrowserHelper._addVCSMenuDirMulti</h4> | |
| 304 <b>_addVCSMenuDirMulti</b>(<i>mainMenu</i>) | |
| 305 | |
| 306 <p> | |
| 307 Protected method used to add the VCS menu to all project browsers. | |
| 308 </p> | |
| 309 <dl> | |
| 310 | |
| 311 <dt><i>mainMenu</i></dt> | |
| 312 <dd> | |
| 313 reference to the menu to be amended | |
| 314 </dd> | |
| 315 </dl> | |
| 316 <a NAME="GitProjectBrowserHelper._addVCSMenuMulti" ID="GitProjectBrowserHelper._addVCSMenuMulti"></a> | |
| 317 <h4>GitProjectBrowserHelper._addVCSMenuMulti</h4> | |
| 318 <b>_addVCSMenuMulti</b>(<i>mainMenu</i>) | |
| 319 | |
| 320 <p> | |
| 321 Protected method used to add the VCS menu for multi selection to all | |
| 322 project browsers. | |
| 323 </p> | |
| 324 <dl> | |
| 325 | |
| 326 <dt><i>mainMenu</i></dt> | |
| 327 <dd> | |
| 328 reference to the menu to be amended | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <a NAME="GitProjectBrowserHelper.showContextMenu" ID="GitProjectBrowserHelper.showContextMenu"></a> | |
| 332 <h4>GitProjectBrowserHelper.showContextMenu</h4> | |
| 333 <b>showContextMenu</b>(<i>menu, standardItems</i>) | |
| 334 | |
| 335 <p> | |
| 336 Public slot called before the context menu is shown. | |
| 337 </p> | |
| 338 <p> | |
| 339 It enables/disables the VCS menu entries depending on the overall | |
| 340 VCS status and the file status. | |
| 341 </p> | |
| 342 <dl> | |
| 343 | |
| 344 <dt><i>menu</i></dt> | |
| 345 <dd> | |
| 346 reference to the menu to be shown | |
| 347 </dd> | |
| 348 <dt><i>standardItems</i></dt> | |
| 349 <dd> | |
| 350 array of standard items that need | |
| 351 activation/deactivation depending on the overall VCS status | |
| 352 </dd> | |
| 353 </dl> | |
| 354 <a NAME="GitProjectBrowserHelper.showContextMenuDir" ID="GitProjectBrowserHelper.showContextMenuDir"></a> | |
| 355 <h4>GitProjectBrowserHelper.showContextMenuDir</h4> | |
| 356 <b>showContextMenuDir</b>(<i>menu, standardItems</i>) | |
| 357 | |
| 358 <p> | |
| 359 Public slot called before the context menu is shown. | |
| 360 </p> | |
| 361 <p> | |
| 362 It enables/disables the VCS menu entries depending on the overall | |
| 363 VCS status and the directory status. | |
| 364 </p> | |
| 365 <dl> | |
| 366 | |
| 367 <dt><i>menu</i></dt> | |
| 368 <dd> | |
| 369 reference to the menu to be shown | |
| 370 </dd> | |
| 371 <dt><i>standardItems</i></dt> | |
| 372 <dd> | |
| 373 array of standard items that need | |
| 374 activation/deactivation depending on the overall VCS status | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <a NAME="GitProjectBrowserHelper.showContextMenuDirMulti" ID="GitProjectBrowserHelper.showContextMenuDirMulti"></a> | |
| 378 <h4>GitProjectBrowserHelper.showContextMenuDirMulti</h4> | |
| 379 <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) | |
| 380 | |
| 381 <p> | |
| 382 Public slot called before the context menu is shown. | |
| 383 </p> | |
| 384 <p> | |
| 385 It enables/disables the VCS menu entries depending on the overall | |
| 386 VCS status and the directory status. | |
| 387 </p> | |
| 388 <dl> | |
| 389 | |
| 390 <dt><i>menu</i></dt> | |
| 391 <dd> | |
| 392 reference to the menu to be shown | |
| 393 </dd> | |
| 394 <dt><i>standardItems</i></dt> | |
| 395 <dd> | |
| 396 array of standard items that need | |
| 397 activation/deactivation depending on the overall VCS status | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <a NAME="GitProjectBrowserHelper.showContextMenuMulti" ID="GitProjectBrowserHelper.showContextMenuMulti"></a> | |
| 401 <h4>GitProjectBrowserHelper.showContextMenuMulti</h4> | |
| 402 <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) | |
| 403 | |
| 404 <p> | |
| 405 Public slot called before the context menu (multiple selections) is | |
| 406 shown. | |
| 407 </p> | |
| 408 <p> | |
| 409 It enables/disables the VCS menu entries depending on the overall | |
| 410 VCS status and the files status. | |
| 411 </p> | |
| 412 <dl> | |
| 413 | |
| 414 <dt><i>menu</i></dt> | |
| 415 <dd> | |
| 416 reference to the menu to be shown | |
| 417 </dd> | |
| 418 <dt><i>standardItems</i></dt> | |
| 419 <dd> | |
| 420 array of standard items that need | |
| 421 activation/deactivation depending on the overall VCS status | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <div align="right"><a href="#top">Up</a></div> | |
| 425 <hr /> | |
| 426 </body></html> |
