#include <kdevversioncontrol.h>
Inherits TQObject.
Signals | |
void | statusReady (const VCSFileInfoMap &fileInfoMap, void *callerData) |
Public Member Functions | |
KDevVCSFileInfoProvider (KDevVersionControl *parent, const char *name) | |
virtual const VCSFileInfoMap * | status (const TQString &dirPath)=0 |
virtual bool | requestStatus (const TQString &dirPath, void *callerData, bool recursive=true, bool checkRepos=true)=0 |
Protected Member Functions | |
KDevVersionControl * | owner () const |
Detailed Description
Basic interface for providing info on file registered in a version control repository repository.
Definition at line 185 of file kdevversioncontrol.h.
Constructor & Destructor Documentation
◆ KDevVCSFileInfoProvider()
|
inline |
Constructor.
- Parameters
-
parent The parent VCS plugin. name The name of a provider object.
Definition at line 193 of file kdevversioncontrol.h.
Member Function Documentation
◆ owner()
|
inlineprotected |
- Returns
- The version control which owns this provider.
Definition at line 229 of file kdevversioncontrol.h.
◆ requestStatus()
|
pure virtual |
Starts a request for directory status to the remote repository.
Requests and answers are asynchronous.
This is an asynchronous operation for requesting data, so 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 The pointer to some data you want the provider will return to you when it has done. recursive If false, retrieve information only for dirPath's immediate children. checkRepos If true, contact remote repository and augment repository's status. If false, retrieve only for local modification information.
- Returns
- true if the request has been successfully started, false otherwise.
◆ status()
|
pure virtual |
Gets the status for local files in the specified directory: the info are collected locally so they are necessarily in sync with the repository.
This is a synchronous operation (blocking).
- Parameters
-
dirPath The relative (to project dir) directory path to stat.
- Returns
- Status for all registered files.
◆ statusReady
|
signal |
Emitted when the status request to remote repository has finished.
- Parameters
-
fileInfoMap The status for registered in repository files. callerData The pointer to some data you want the provider will return to you when it has done
- See also
- requestStatus for to find out when this signal should be used.
The documentation for this class was generated from the following file: