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:

[legend]Collaboration diagram for KDevVCSFileInfoProvider:


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 VCSFileInfoMap *	status (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
KDevVersionControl *	owner () const
Private Member Functions
	KDevVCSFileInfoProvider (const KDevVCSFileInfoProvider &)
	Verboten!
KDevVCSFileInfoProvider &	operator= (const KDevVCSFileInfoProvider &)
Private Attributes
Private *	d

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:

lib/interfaces/kdevvcsfileinfoprovider.h
lib/interfaces/kdevvcsfileinfoprovider.cpp

KDevelop API Documentation

KDevVCSFileInfoProvider Class Reference

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation