# eric3.VCS.ProjectBrowserHelper

Module implementing the base class of the VCS project browser helper.

### Classes

VcsProjectBrowserHelper | Class implementing the base class of the VCS project browser helper.

### Functions

None

## VcsProjectBrowserHelper

Class implementing the base class of the VCS project browser helper.

### Derived from

QObject

### Methods

VcsProjectBrowserHelper | Constructor
addVCSMenus | Public method to add the VCS entries to the various project browser menus.
handleShowPopupMenu | Slot called before the context menu is shown.
handleShowPopupMenuDir | Slot called before the context menu is shown.
handleShowPopupMenuDirMulti | Slot called before the context menu is shown.
handleShowPopupMenuMulti | Slot called before the context menu (multiple selections) is shown.
handleVCSAdd | Private slot called by the context menu to add the selected file to the VCS repository.
handleVCSAddTree | Private slot called by the context menu.
handleVCSCommit | Private slot called by the context menu to commit the changes to the VCS repository.
handleVCSDiff | Private slot called by the context menu to show the difference of a file to the repository.
handleVCSLog | Private slot called by the context menu to show the VCS log of a file.
handleVCSMerge | Private slot called by the context menu to merge changes into to a file.
handleVCSRemove | Private slot called by the context menu to remove the selected file from the VCS repository.
handleVCSRevert | Private slot called by the context menu to revert changes made to a file.
handleVCSStatus | Private slot called by the context menu to show the status of a file.
handleVCSUpdate | Private slot called by the context menu to update a file from the VCS repository.

### VcsProjectBrowserHelper (Constructor)

VcsProjectBrowserHelper(vcsObject, browserObject, projectObject, isTranslationsBrowser, parent=None, name=None)

Constructor

vcsObject
  reference to the vcs object
browserObject
  reference to the project browser object
projectObject
  reference to the project object
isTranslationsBrowser
  flag indicating, the helper is requested for the translations browser (this needs some special treatment)
parent
  parent widget (QWidget)
name
  name of this object (string or QString)

### VcsProjectBrowserHelper.addVCSMenus

addVCSMenus(mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu)

Public method to add the VCS entries to the various project browser menus.

mainMenu
  reference to the main menu (QPopupMenu)
multiMenu
  reference to the multiple selection menu (QPopupMenu)
backMenu
  reference to the background menu (QPopupMenu)
dirMenu
  reference to the directory menu (QPopupMenu)
dirMultiMenu
  reference to the multiple selection directory menu (QPopupMenu)

### VcsProjectBrowserHelper.handleShowPopupMenu

handleShowPopupMenu(menu, standardItems)

Slot called before the context menu is shown.

It enables/disables the VCS menu entries depending on the overall VCS status and the file status.

menu
  reference to the menu to be shown
standardItems
  array of standard items that need activation/deactivation depending on the overall VCS status

### VcsProjectBrowserHelper.handleShowPopupMenuDir

handleShowPopupMenuDir(menu, standardItems)

Slot called before the context menu is shown.

It enables/disables the VCS menu entries depending on the overall VCS status and the directory status.

menu
  reference to the menu to be shown
standardItems
  array of standard items that need activation/deactivation depending on the overall VCS status

### VcsProjectBrowserHelper.handleShowPopupMenuDirMulti

handleShowPopupMenuDirMulti(menu, standardItems)

Slot called before the context menu is shown.

It enables/disables the VCS menu entries depending on the overall VCS status and the directory status.

menu
  reference to the menu to be shown
standardItems
  array of standard items that need activation/deactivation depending on the overall VCS status

### VcsProjectBrowserHelper.handleShowPopupMenuMulti

handleShowPopupMenuMulti(menu, standardItems)

Slot called before the context menu (multiple selections) is shown.

It enables/disables the VCS menu entries depending on the overall VCS status and the files status.

menu
  reference to the menu to be shown
standardItems
  array of standard items that need activation/deactivation depending on the overall VCS status

### VcsProjectBrowserHelper.handleVCSAdd

handleVCSAdd()

Private slot called by the context menu to add the selected file to the VCS repository.

### VcsProjectBrowserHelper.handleVCSAddTree

handleVCSAddTree()

Private slot called by the context menu.

It is used to add the selected directory tree to the VCS repository.

### VcsProjectBrowserHelper.handleVCSCommit

handleVCSCommit()

Private slot called by the context menu to commit the changes to the VCS repository.

### VcsProjectBrowserHelper.handleVCSDiff

handleVCSDiff()

Private slot called by the context menu to show the difference of a file to the repository.

### VcsProjectBrowserHelper.handleVCSLog

handleVCSLog()

Private slot called by the context menu to show the VCS log of a file.

### VcsProjectBrowserHelper.handleVCSMerge

handleVCSMerge()

Private slot called by the context menu to merge changes into to a file.

### VcsProjectBrowserHelper.handleVCSRemove

handleVCSRemove()

Private slot called by the context menu to remove the selected file from the VCS repository.

### VcsProjectBrowserHelper.handleVCSRevert

handleVCSRevert()

Private slot called by the context menu to revert changes made to a file.

### VcsProjectBrowserHelper.handleVCSStatus

handleVCSStatus()

Private slot called by the context menu to show the status of a file.

### VcsProjectBrowserHelper.handleVCSUpdate

handleVCSUpdate()

Private slot called by the context menu to update a file from the VCS repository.

Up