# eric3.VCS.ProjectHelper

Module implementing the base class of the VCS project helper.

### Classes

VcsProjectHelper | Class implementing the base class of the VCS project helper.

### Functions

None

## VcsProjectHelper

Class implementing the base class of the VCS project helper.

### Derived from

QObject

### Methods

VcsProjectHelper | Constructor
cvsLogin | Private slot used to login to a remote repository.
cvsLogout | Private slot used to logout from a remote repository.
handleShowMenu | Private slot called before the vcs menu is shown.
initActions | Private method to generate the action objects.
initMenu | Private method to generate the VCS menu.
vcsCheckout | Private slot used to create a local project from the repository.
vcsCleanup | Private slot used to cleanup the local project.
vcsCommand | Private slot used to execute an arbitrary vcs command.
vcsCommandOptions | Private slot to edit the VCS command options.
vcsCommit | Private slot used to commit changes to the local project to the repository.
vcsDiff | Private slot used to show the difference of the local project to the repository.
vcsExport | Private slot used to export a project from the repository.
vcsImport | Private slot used to import the local project into the repository.
vcsLog | Private slot used to show the log of the local project.
vcsMerge | Private slot used to merge changes of a tag/revision into the local project.
vcsRemove | Private slot used to remove the local project from the repository.
vcsRevert | Private slot used to revert changes made to the local project.
vcsStatus | Private slot used to show the status of the local project.
vcsSwitch | Private slot used to switch the local project to another tag/branch.
vcsTag | Private slot used to tag the local project in the repository.
vcsUpdate | Private slot used to update the local project from the repository.

### VcsProjectHelper (Constructor)

VcsProjectHelper(vcsObject, projectObject, parent=None, name=None)

Constructor

vcsObject
  reference to the vcs object
projectObject
  reference to the project object
parent
  parent widget (QWidget)
name
  name of this object (string or QString)

### VcsProjectHelper.cvsLogin

cvsLogin()

Private slot used to login to a remote repository.

### VcsProjectHelper.cvsLogout

cvsLogout()

Private slot used to logout from a remote repository.

### VcsProjectHelper.handleShowMenu

handleShowMenu()

Private slot called before the vcs menu is shown.

### VcsProjectHelper.initActions

initActions()

Private method to generate the action objects.

### VcsProjectHelper.initMenu

initMenu()

Private method to generate the VCS menu.

### VcsProjectHelper.vcsCheckout

vcsCheckout(export=0)

Private slot used to create a local project from the repository.

export
  flag indicating whether an export or a checkout should be performed

### VcsProjectHelper.vcsCleanup

vcsCleanup()

Private slot used to cleanup the local project.

### VcsProjectHelper.vcsCommand

vcsCommand()

Private slot used to execute an arbitrary vcs command.

### VcsProjectHelper.vcsCommandOptions

vcsCommandOptions()

Private slot to edit the VCS command options.

### VcsProjectHelper.vcsCommit

vcsCommit()

Private slot used to commit changes to the local project to the repository.

### VcsProjectHelper.vcsDiff

vcsDiff()

Private slot used to show the difference of the local project to the repository.

### VcsProjectHelper.vcsExport

vcsExport()

Private slot used to export a project from the repository.

### VcsProjectHelper.vcsImport

vcsImport()

Private slot used to import the local project into the repository.

NOTE: This does not necvessarily make the local project a vcs controlled project. You may have to checkout the project from the repository in order to accomplish that.

### VcsProjectHelper.vcsLog

vcsLog()

Private slot used to show the log of the local project.

### VcsProjectHelper.vcsMerge

vcsMerge()

Private slot used to merge changes of a tag/revision into the local project.

### VcsProjectHelper.vcsRemove

vcsRemove()

Private slot used to remove the local project from the repository.

Depending on the parameters set in the vcs object the project may be removed from the local disk as well.

### VcsProjectHelper.vcsRevert

vcsRevert()

Private slot used to revert changes made to the local project.

### VcsProjectHelper.vcsStatus

vcsStatus()

Private slot used to show the status of the local project.

### VcsProjectHelper.vcsSwitch

vcsSwitch()

Private slot used to switch the local project to another tag/branch.

### VcsProjectHelper.vcsTag

vcsTag()

Private slot used to tag the local project in the repository.

### VcsProjectHelper.vcsUpdate

vcsUpdate()

Private slot used to update the local project from the repository.

Up