• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdevelop API Reference
  • KDE Home
  • Contact Us
 

kdevplatform/vcs

  • KDevelop
  • IBranchingVersionControl
Signals | Public Member Functions | List of all members
KDevelop::IBranchingVersionControl Class Referenceabstract

#include <ibranchingversioncontrol.h>

Inheritance diagram for KDevelop::IBranchingVersionControl:
Inheritance graph
[legend]

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
repositoryrepository directory on which we're going to branch
revWhat revision of the requested items should be branched.
branchNameShort, 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
repositoryThe 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
repositoryThe 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
repositoryThe repository path where the current branch will be deleted from
branchNameThe 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
repositoryThe repository path where the current branch will be merged into.
branchNameThe 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
repositoryThe repository path where the current branch will be deleted from
oldBranchNameThe branch name that will be renamed
newBranchNameThe 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
repositoryThe repository path where the branch will be switched
branchNameThe 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
revWhat revision of the requested items should be tagged.
tagNameShort, 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Apr 10 2021 23:31:23 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/vcs

Skip menu "kdevplatform/vcs"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal