KDevVersionControl Class Reference

#include <kdevversioncontrol.h>

Signals
void	finishedFetching (TQString destinationDir)

Public Member Functions
	KDevVersionControl (const KDevPluginInfo *info, TQObject *parent, const char *name)
virtual void	createNewProject (const TQString &dir)=0
virtual bool	fetchFromRepository ()=0
virtual KDevVCSFileInfoProvider *	fileInfoProvider () const =0
virtual bool	isValidDirectory (const TQString &dirPath) const =0

Detailed Description

KDevelop version control system interface.

This is the abstract base class which encapsulates everything necessary for communicating with version control systems. VCS support plugins should implement this interface.

Instances that implement this interface are available through extension architecture:

KDevVersionControl *vcs = extension<KDevVersionControl>("TDevelop/VersionControl");
if (vcs) {
    // do something
} else {
    // fail
}

See also

KDevPlugin::extension method documentation.

Definition at line 135 of file kdevversioncontrol.h.

Constructor & Destructor Documentation

KDevVersionControl()

KDevVersionControl::KDevVersionControl ( const KDevPluginInfo * info, TQObject * parent, const char * name )

inline

Constructs a VCS plugin.

Parameters

info	Important information about the plugin - plugin internal and generic (GUI) name, description, a list of authors, etc. That information is used to show plugin information in various places like "about application" dialog, plugin selector dialog, etc. Plugin does not take ownership on info object, also its lifetime should be equal to the lifetime of the plugin.
parent	The parent object for the plugin. Parent object must implement KDevApi interface. Otherwise the plugin will not be constructed.
name	The internal name which identifies the plugin.

Definition at line 150 of file kdevversioncontrol.h.

Member Function Documentation

createNewProject()

virtual void KDevVersionControl::createNewProject ( const TQString & dir )

pure virtual

Creates a new project in the passed path dir.

This should instantiate VCS infrastructure and import a project into the VCS in that directory.

Parameters

dir	The absolute path to the directory where VCS infrastructure should be created.

fetchFromRepository()

virtual bool KDevVersionControl::fetchFromRepository ( )

pure virtual

Fetches a module from remote repository, so it can be used for importing.

Returns

true in case of success.

fileInfoProvider()

virtual KDevVCSFileInfoProvider * KDevVersionControl::fileInfoProvider ( ) const

pure virtual

Returns

The file info provider for this version control (0 if none is available).

finishedFetching

void KDevVersionControl::finishedFetching ( TQString destinationDir )

signal

Emitted when the Version Control has finished importing a module from remote repository.

Parameters

destinationDir

The directory where the module has been fetched.

isValidDirectory()

virtual bool KDevVersionControl::isValidDirectory ( const TQString & dirPath ) const

pure virtual

Checks if the directory is valid for this version control (for example CVS may check for the presence of "<dirPath>/CVS/" subdir and something else).

Parameters

dirPath

The absolute path of the directory.

Returns

true if the directory is valid for this version control warning: this returns false by default.

---

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

• kdevversioncontrol.h