libkonq
#include <kversioncontrolplugin.h>
Public Types | |
enum | VersionState { UnversionedVersion, NormalVersion, UpdateRequiredVersion, LocallyModifiedVersion, AddedVersion, RemovedVersion, ConflictingVersion, LocallyModifiedUnstagedVersion } |
Signals | |
void | errorMessage (const QString &msg) |
void | infoMessage (const QString &msg) |
void | operationCompletedMessage (const QString &msg) |
void | versionStatesChanged () |
Public Member Functions | |
KVersionControlPlugin (QObject *parent=0) | |
virtual | ~KVersionControlPlugin () |
virtual bool | beginRetrieval (const QString &directory)=0 |
virtual QList< QAction * > | contextMenuActions (const KFileItemList &items)=0 |
virtual QList< QAction * > | contextMenuActions (const QString &directory)=0 |
virtual void | endRetrieval ()=0 |
virtual QString | fileName () const =0 |
virtual VersionState | versionState (const KFileItem &item)=0 |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Detailed Description
Base class for version control plugins.
It is recommended to use the KVersionControlPlugin2 interface. KVersionControlPlugin2 allows having context menu actions also for non-versioned directories and provides some interface cleanups. It replaces:
- contextMenuActions() by KVersionControlPlugin2::actions()
- versionState() by KVersionControlPlugin2::itemVersion()
- versionStatesChanged() by KVersionControlPlugin2::itemVersionsChanged()
- VersionState by ItemState
- Since
- 4.4
Definition at line 43 of file kversioncontrolplugin.h.
Member Enumeration Documentation
Definition at line 48 of file kversioncontrolplugin.h.
Constructor & Destructor Documentation
KVersionControlPlugin::KVersionControlPlugin | ( | QObject * | parent = 0 | ) |
Definition at line 21 of file kversioncontrolplugin.cpp.
|
virtual |
Definition at line 26 of file kversioncontrolplugin.cpp.
Member Function Documentation
|
pure virtual |
Is invoked whenever the version control information will get retrieved for the directory directory
.
It is assured that the directory contains a trailing slash.
Implemented in KVersionControlPlugin2.
|
pure virtual |
Returns the list of actions that should be shown in the context menu for the files items
.
It is assured that the passed list is not empty. If an action triggers a change of the versions, the signal KVersionControlPlugin::versionStatesChanged() must be emitted.
- Deprecated:
- Use KVersionControlPlugin2::actions() instead.
Implemented in KVersionControlPlugin2.
|
pure virtual |
Returns the list of actions that should be shown in the context menu for the directory directory
.
If an action triggers a change of the versions, the signal KVersionControlPlugin::versionStatesChanged() must be emitted.
- Deprecated:
- Use KVersionControlPlugin2::actions() instead.
Implemented in KVersionControlPlugin2.
|
pure virtual |
Is invoked after the version control information has been received.
It is assured that KVersionControlPlugin::beginInfoRetrieval() has been invoked before.
Implemented in KVersionControlPlugin2.
|
signal |
Is emitted if an error message with the content msg should be shown.
|
pure virtual |
Returns the name of the file which stores the version controls information.
(e. g. .svn, .cvs, .git).
Implemented in KVersionControlPlugin2.
|
signal |
Is emitted if an information message with the content msg should be shown.
|
signal |
Is emitted if an "operation completed" message with the content msg should be shown.
|
pure virtual |
Returns the version state for the file item
.
It is assured that KVersionControlPlugin::beginInfoRetrieval() has been invoked before and that the file is part of the directory specified in beginInfoRetrieval().
- Deprecated:
- Use KVersionControlPlugin2::itemVersion() instead.
Implemented in KVersionControlPlugin2.
|
signal |
Should be emitted when the version state of files might have been changed after the last retrieval (e.
g. by executing a context menu action of the version control plugin). The file manager will be triggered to update the version states of the directory directory
by invoking KVersionControlPlugin::beginRetrieval(), KVersionControlPlugin::versionState() and KVersionControlPlugin::endRetrieval().
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:07:48 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.