KDevelop::IBranchingVersionControl Class Reference

#include <ibranchingversioncontrol.h>

Inheritance diagram for KDevelop::IBranchingVersionControl:

Signals
void	repositoryBranchChanged (const QUrl &repository)

Public Member Functions
virtual	~IBranchingVersionControl ()
virtual VcsJob *	branch (const QUrl &repository, const VcsRevision &rev, const QString &branchName)=0
virtual VcsJob *	branches (const QUrl &repository)=0
virtual VcsJob *	currentBranch (const QUrl &repository)=0
virtual VcsJob *	deleteBranch (const QUrl &repository, const QString &branchName)=0
virtual VcsJob *	mergeBranch (const QUrl &repository, const QString &branchName)=0
virtual void	registerRepositoryForCurrentBranchChanges (const QUrl &repository)=0
virtual VcsJob *	renameBranch (const QUrl &repository, const QString &oldBranchName, const QString &newBranchName)=0
virtual VcsJob *	switchBranch (const QUrl &repository, const QString &branchName)=0
virtual VcsJob *	tag (const QUrl &repository, const QString &commitMessage, const VcsRevision &rev, const QString &tagName)=0

Detailed Description

Definition at line 35 of file ibranchingversioncontrol.h.

Constructor & Destructor Documentation

~IBranchingVersionControl()

virtual KDevelop::IBranchingVersionControl::~IBranchingVersionControl ( )

inlinevirtual

Definition at line 38 of file ibranchingversioncontrol.h.

Member Function Documentation

branch()

virtual VcsJob* KDevelop::IBranchingVersionControl::branch ( const QUrl &  repository, const VcsRevision &  rev, const QString &  branchName  )

pure virtual

Creates a branch from the given mapping information.

Parameters

repository	repository directory on which we're going to branch
rev	What revision of the requested items should be branched.
branchName	Short, descriptive name for the branch used for VCS's that take branch names instead of destination paths, or store metadata about the branch. Not all VCS's will use this parameter.

branches()

virtual VcsJob* KDevelop::IBranchingVersionControl::branches ( const QUrl &  repository )

pure virtual

Returns the branches inside the specified repository in a QStringList.

Parameters

repository

The repository path where the branches will be returned from

currentBranch()

virtual VcsJob* KDevelop::IBranchingVersionControl::currentBranch ( const QUrl &  repository )

pure virtual

Returns the current branch name inside the specified repository in a QString.

Note

If we are not on a branch currently, the string will be empty

Parameters

repository

The repository path where the current branch will be returned from

deleteBranch()

virtual VcsJob* KDevelop::IBranchingVersionControl::deleteBranch ( const QUrl &  repository, const QString &  branchName  )

pure virtual

Deletes the desired branch inside the specified repository.

Parameters

repository	The repository path where the current branch will be deleted from
branchName	The branch name that will be deleted inside the specified repository

mergeBranch()

virtual VcsJob* KDevelop::IBranchingVersionControl::mergeBranch ( const QUrl &  repository, const QString &  branchName  )

pure virtual

Merges the selected branch into the current one.

Parameters

repository	The repository path where the current branch will be merged into.
branchName	The name of the selected branch to be merged into the current one.

registerRepositoryForCurrentBranchChanges()

virtual void KDevelop::IBranchingVersionControl::registerRepositoryForCurrentBranchChanges ( const QUrl &  repository )

pure virtual

Tells the implementation to report about changes in the current branch of a given repository.

renameBranch()

virtual VcsJob* KDevelop::IBranchingVersionControl::renameBranch ( const QUrl &  repository, const QString &  oldBranchName, const QString &  newBranchName  )

pure virtual

Deletes the desired branch inside the specified repository.

Parameters

repository	The repository path where the current branch will be deleted from
oldBranchName	The branch name that will be renamed
newBranchName	The new branch name

repositoryBranchChanged

void KDevelop::IBranchingVersionControl::repositoryBranchChanged ( const QUrl &  repository )

signal

switchBranch()

virtual VcsJob* KDevelop::IBranchingVersionControl::switchBranch ( const QUrl &  repository, const QString &  branchName  )

pure virtual

Switches to the desired branch inside the specified repository.

Parameters

repository	The repository path where the branch will be switched
branchName	The branch name that will be switched to inside the specified repository

tag()

virtual VcsJob* KDevelop::IBranchingVersionControl::tag ( const QUrl &  repository, const QString &  commitMessage, const VcsRevision &  rev, const QString &  tagName  )

pure virtual

Creates a new tag from the given mapping information.

Parameters

rev	What revision of the requested items should be tagged.
tagName	Short, descriptive name for the tag used for VCS's that take tag names instead of destination paths, or store metadata about the tag. Not all VCS's will use this parameter.

---

The documentation for this class was generated from the following file:

• ibranchingversioncontrol.h