KDevelop API Documentation

KDevVCSFileInfoProvider Class Reference

A basic interface for providing info on file registered in a version control repository repository. More...

#include <kdevvcsfileinfoprovider.h>

Inheritance diagram for KDevVCSFileInfoProvider:

Inheritance graph
[legend]
Collaboration diagram for KDevVCSFileInfoProvider:

Collaboration graph
[legend]
List of all members.

Signals

void statusReady (const VCSFileInfoMap &fileInfoMap, void *callerData)
 Emitted when the status request to remote repository has finished.

Public Member Functions

 KDevVCSFileInfoProvider (KDevVersionControl *parent, const char *name)
 Constructor.
virtual ~KDevVCSFileInfoProvider ()
 Destructor.
virtual const VCSFileInfoMapstatus (const QString &dirPath) const =0
 Sync interface Status for the local files in the specified directory: the info are collected locally so they are necessarly in sync with the repository
virtual bool requestStatus (const QString &dirPath, void *callerData)=0
 Async interface for requesting data Start a request for directory status to the remote repository.

Protected Member Functions

KDevVersionControlowner () const

Private Member Functions

 KDevVCSFileInfoProvider (const KDevVCSFileInfoProvider &)
 Verboten!
KDevVCSFileInfoProvideroperator= (const KDevVCSFileInfoProvider &)

Private Attributes

Privated

Detailed Description

A basic interface for providing info on file registered in a version control repository repository.

Definition at line 57 of file kdevvcsfileinfoprovider.h.


Constructor & Destructor Documentation

KDevVCSFileInfoProvider::KDevVCSFileInfoProvider KDevVersionControl parent,
const char *  name
 

Constructor.

Definition at line 67 of file kdevvcsfileinfoprovider.cpp.

KDevVCSFileInfoProvider::~KDevVCSFileInfoProvider  )  [virtual]
 

Destructor.

Definition at line 74 of file kdevvcsfileinfoprovider.cpp.

KDevVCSFileInfoProvider::KDevVCSFileInfoProvider const KDevVCSFileInfoProvider  )  [private]
 

Verboten!


Member Function Documentation

KDevVCSFileInfoProvider& KDevVCSFileInfoProvider::operator= const KDevVCSFileInfoProvider  )  [private]
 

KDevVersionControl * KDevVCSFileInfoProvider::owner  )  const [protected]
 

Returns:
the version control which owns this version control

Definition at line 81 of file kdevvcsfileinfoprovider.cpp.

Referenced by CVSFileInfoProvider::projectDirectory().

virtual bool KDevVCSFileInfoProvider::requestStatus const QString dirPath,
void *  callerData
[pure virtual]
 

Async interface for requesting data Start a request for directory status to the remote repository.

Requests and answers are asynchronous for obvious reasons: the caller must connect the statusReady() signal and check for the return value of this method.

Parameters:
dirPath the (relative to project directory) directory which status you are asking for
callerData a pointer to some data you want the provider will return to you when it has done
Returns:
true if the request has been successfully started, false otherwise

Implemented in CVSFileInfoProvider.

Referenced by VCSFileTreeWidgetImpl::slotSyncWithRepository().

virtual const VCSFileInfoMap* KDevVCSFileInfoProvider::status const QString dirPath  )  const [pure virtual]
 

Sync interface Status for the local files in the specified directory: the info are collected locally so they are necessarly in sync with the repository

Parameters:
dirPath relative (to project dir) directory path to stat
Returns:
status for all registered files

Implemented in CVSFileInfoProvider.

Referenced by VCSFileTreeBranchItem::createTreeViewItem().

void KDevVCSFileInfoProvider::statusReady const VCSFileInfoMap fileInfoMap,
void *  callerData
[signal]
 

Emitted when the status request to remote repository has finished.

Parameters:
fileInfoMap status for registered in repository files
callerData 
See also:
requestStatus.

Referenced by CVSFileInfoProvider::slotJobExited().


Member Data Documentation

Private* KDevVCSFileInfoProvider::d [private]
 

Definition at line 105 of file kdevvcsfileinfoprovider.h.


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 Wed Mar 23 00:22:59 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003