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:

Inheritance graph
[legend]
Collaboration diagram for KDevVersionControl:

Collaboration graph
[legend]
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
void registerVersionControl (KDevVersionControl *vcs)
 Add vcs to the list of the registered VCS.
void setVersionControl (KDevVersionControl *vcsToUse)
 Use the specified version control object as default vcs.
KDevVersionControlversionControlByName (const QString &uid) const
 Returns the Version Control System having the specified uinque identifier uid.
QStringList registeredVersionControls () const
 Returns a list with unique identifiers among the version control systems.
void unregisterVersionControl (KDevVersionControl *vcs)
 Remove (not delete) vcs from the list of the registered VCS.

Private Attributes

KDevApim_api

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 33 of file kdevversioncontrol.cpp.

References kdDebug(), m_api, registerVersionControl(), and uid().

KDevVersionControl::~KDevVersionControl  )  [virtual]
 

Destructor.

Removes current VCS from the list of available ones.

Definition at line 46 of file kdevversioncontrol.cpp.

References unregisterVersionControl().


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 70 of file kdevversioncontrol.cpp.

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

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 79 of file kdevversioncontrol.cpp.

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

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 95 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

Referenced by CvsServicePart::init().

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 88 of file kdevversioncontrol.cpp.

Referenced by FileTreeWidget::FileTreeWidget().

QWidget * KDevVersionControl::newProjectWidget QWidget  )  [virtual]
 

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

Reimplemented in CvsServicePart, and subversionPart.

Definition at line 61 of file kdevversioncontrol.cpp.

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

QStringList KDevVersionControl::registeredVersionControls  )  const
 

Returns a list with unique identifiers among the version control systems.

Definition at line 123 of file kdevversioncontrol.cpp.

References m_api, and KDevApi::registeredVersionControls().

void KDevVersionControl::registerVersionControl KDevVersionControl vcs  ) 
 

Add vcs to the list of the registered VCS.

Definition at line 109 of file kdevversioncontrol.cpp.

References m_api, and KDevApi::registerVersionControl().

Referenced by KDevVersionControl().

void KDevVersionControl::setVersionControl KDevVersionControl vcsToUse  ) 
 

Use the specified version control object as default vcs.

Parameters:
vcsToUse 

Definition at line 102 of file kdevversioncontrol.cpp.

References m_api, and KDevApi::setVersionControl().

QString KDevVersionControl::uid  )  const
 

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

Definition at line 53 of file kdevversioncontrol.cpp.

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

void KDevVersionControl::unregisterVersionControl KDevVersionControl vcs  ) 
 

Remove (not delete) vcs from the list of the registered VCS.

Definition at line 116 of file kdevversioncontrol.cpp.

References m_api, and KDevApi::unregisterVersionControl().

Referenced by ~KDevVersionControl().

KDevVersionControl * KDevVersionControl::versionControlByName const QString uid  )  const
 

Returns the Version Control System having the specified uinque identifier uid.

Definition at line 130 of file kdevversioncontrol.cpp.

References m_api, and KDevApi::versionControlByName().


Member Data Documentation

class KDevApi* KDevVersionControl::m_api [private]
 

Reimplemented from KDevPlugin.

Definition at line 131 of file kdevversioncontrol.h.

Referenced by KDevVersionControl(), registeredVersionControls(), registerVersionControl(), setVersionControl(), unregisterVersionControl(), and versionControlByName().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:40:34 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003