KDE 4.2 API Reference vcs
KDevelop::ICentralizedVersionControl Class Reference
#include <icentralizedversioncontrol.h>
Detailed Description
This is the interface that all Centralized Version Control plugins need to implement.None of the methods in this interface are optional.
This only works on a local checkout from the repository, if your plugin should offer functionality that works solely on the server see the IRepositoryVersionControl interface
Definition at line 40 of file icentralizedversioncontrol.h.
Public Types | |
| enum | RecursionMode { Recursive, NonRecursive } |
Public Member Functions | |
| virtual VcsJob * | edit (const KUrl &localLocation)=0 |
| virtual VcsJob * | import (const VcsMapping &localLocation, const QString &commitMessage)=0 |
| virtual VcsJob * | localRevision (const KUrl &localLocation, VcsRevision::RevisionType)=0 |
| virtual VcsJob * | unedit (const KUrl &localLocation)=0 |
Member Enumeration Documentation
- Enumerator:
-
Recursive run recursively through subdirectories NonRecursive don't run recursively through subdirectories
Reimplemented from KDevelop::IBasicVersionControl.
Definition at line 43 of file icentralizedversioncontrol.h.
Member Function Documentation
| virtual VcsJob* KDevelop::ICentralizedVersionControl::edit | ( | const KUrl & | localLocation | ) | [pure virtual] |
this is for files only, it makes a file editable, this may be a no-op
| virtual VcsJob* KDevelop::ICentralizedVersionControl::import | ( | const VcsMapping & | localLocation, | |
| const QString & | commitMessage | |||
| ) | [pure virtual] |
The following two methods are part of the basic interface so other plugins can depend on them, for example the appwizard.
These two don't need a valid VCS-dir, in fact they should be invoked with a local directory that is either empty or contains a non-VCed project take a mapping of local to repository locations and import that into the repository
| virtual VcsJob* KDevelop::ICentralizedVersionControl::localRevision | ( | const KUrl & | localLocation, | |
| VcsRevision::RevisionType | ||||
| ) | [pure virtual] |
retrieves status information for a file or dir recursive is only active for directories
gives the revision of file/dir, that is the revision to which this files was updated when update() was run the last time
| virtual VcsJob* KDevelop::ICentralizedVersionControl::unedit | ( | const KUrl & | localLocation | ) | [pure virtual] |
this is for files only, it makes a file un-editable, this may be a no-op This is different from revert because it doesn't change the content of the file (it may fail if the file has changed).
The documentation for this class was generated from the following file:
