KDevelop API Documentation

KDevVersionControl Class Reference

This is the abstract base class which encapsulates everything necessary for communicating with version control systems. More...

#include <kdevversioncontrol.h>

Inheritance diagram for KDevVersionControl:

KDevPlugin QObject KXMLGUIClient CervisiaPlugin CvsServicePart subversionPart List of all members.

Signals

void finishedFetching (QString destinationDir)
 Emitted when the Version Control has finished importing a module from remote repository.


Public Member Functions

 KDevVersionControl (const QString &pluginName, const QString &icon, QObject *parent, const char *name)
 Builds the object.

virtual ~KDevVersionControl ()
 Destructor.

virtual QWidgetnewProjectWidget (QWidget *)
 Return a pointer to the associated configuration widget for this vcs.

virtual void createNewProject (const QString &)
 Creates a new project in the passed path dir.

virtual bool fetchFromRepository ()
 Fetch a module from remote repository, so it can be used for importing.

virtual KDevVCSFileInfoProviderfileInfoProvider () const
virtual bool isValidDirectory (const QString &dirPath) const
 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).

QString uid () const

Detailed Description

This is the abstract base class which encapsulates everything necessary for communicating with version control systems.

Definition at line 39 of file kdevversioncontrol.h.


Constructor & Destructor Documentation

KDevVersionControl::KDevVersionControl const QString pluginName,
const QString icon,
QObject parent,
const char *  name
 

Builds the object.

pluginName this _is_ *** unique *** identintifier between all available version controls. icon symbolic name for the icon parent the parent QObject for this version control system name a name for this object; it may be null since it is usefull for debugging

Definition at line 32 of file kdevversioncontrol.cpp.

References endl(), kdDebug(), KDevVersionControl(), and uid().

Referenced by KDevVersionControl().

KDevVersionControl::~KDevVersionControl  )  [virtual]
 

Destructor.

Removes current VCS from the list of available ones.

Definition at line 43 of file kdevversioncontrol.cpp.


Member Function Documentation

void KDevVersionControl::createNewProject const QString  )  [virtual]
 

Creates a new project in the passed path dir.

Reimplemented in CvsServicePart, and subversionPart.

Definition at line 67 of file kdevversioncontrol.cpp.

References createNewProject(), main(), and KDevPlugin::mainWindow().

Referenced by AppWizardDialog::accept(), and createNewProject().

bool KDevVersionControl::fetchFromRepository  )  [virtual]
 

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

Reimplemented in CvsServicePart, and subversionPart.

Definition at line 76 of file kdevversioncontrol.cpp.

References main(), and KDevPlugin::mainWindow().

Referenced by ImportDialog::slotFetchModulesFromRepository().

KDevVCSFileInfoProvider * KDevVersionControl::fileInfoProvider  )  const [virtual]
 

Returns:
the file info provider for this version control (0 if none is available)

Reimplemented in CvsServicePart, and subversionPart.

Definition at line 92 of file kdevversioncontrol.cpp.

Referenced by PartWidget::PartWidget().

void KDevVersionControl::finishedFetching QString  destinationDir  )  [signal]
 

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

Parameters:
destinationDir is the directory where the module has been fetched

bool KDevVersionControl::isValidDirectory const QString dirPath  )  const [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 absolute path of the directory
Returns:
true if the directory is valid for this version control warning: this returns false by default

Reimplemented in CvsServicePart.

Definition at line 85 of file kdevversioncontrol.cpp.

References isValidDirectory().

Referenced by FileTreeWidget::FileTreeWidget(), and isValidDirectory().

QWidget * KDevVersionControl::newProjectWidget QWidget  )  [virtual]
 

Return a pointer to the associated configuration widget for this vcs.

Reimplemented in CvsServicePart, and subversionPart.

Definition at line 58 of file kdevversioncontrol.cpp.

References main(), KDevPlugin::mainWindow(), and newProjectWidget().

Referenced by AppWizardDialog::loadVcs(), and newProjectWidget().

QString KDevVersionControl::uid  )  const
 

Returns:
the unique identifier for this plugin (so it can be used for retrieving it from collections).

Definition at line 50 of file kdevversioncontrol.cpp.

Referenced by KDevVersionControl(), AppWizardDialog::loadVcs(), KDevApi::registeredVersionControls(), KDevApi::registerVersionControl(), and KDevApi::unregisterVersionControl().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:23 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003