KVersionControlPlugin Class Reference

#include <kversioncontrolplugin.h>

Inheritance diagram for KVersionControlPlugin:

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

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

enum KVersionControlPlugin::VersionState

Enumerator
UnversionedVersion	The file is not under version control.
NormalVersion	The file is under version control and represents the latest version.
UpdateRequiredVersion	The file is under version control and a newer version exists on the main branch.
LocallyModifiedVersion	The file is under version control and has been modified locally. All modifications will be part of the next commit.
AddedVersion	The file has not been under version control but has been marked to get added with the next commit.
RemovedVersion	The file is under version control but has been marked for getting removed with the next commit.
ConflictingVersion	The file is under version control and has been locally modified. A modification has also been done on the main branch.
LocallyModifiedUnstagedVersion	The file is under version control and has local modifications, which will not be part of the next commit (or are "unstaged" in git jargon). Since 4.6

Definition at line 48 of file kversioncontrolplugin.h.

Constructor & Destructor Documentation

KVersionControlPlugin::KVersionControlPlugin

(

QObject *

parent = 0

)

Definition at line 21 of file kversioncontrolplugin.cpp.

KVersionControlPlugin::~KVersionControlPlugin ( )

virtual

Definition at line 26 of file kversioncontrolplugin.cpp.

Member Function Documentation

virtual bool KVersionControlPlugin::beginRetrieval ( const QString &  directory )

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.

virtual QList<QAction*> KVersionControlPlugin::contextMenuActions ( const KFileItemList &  items )

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.

virtual QList<QAction*> KVersionControlPlugin::contextMenuActions ( const QString &  directory )

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.

virtual void KVersionControlPlugin::endRetrieval ( )

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.

void KVersionControlPlugin::errorMessage ( const QString &  msg )

signal

Is emitted if an error message with the content msg should be shown.

virtual QString KVersionControlPlugin::fileName ( ) const

pure virtual

Returns the name of the file which stores the version controls information.

(e. g. .svn, .cvs, .git).

Implemented in KVersionControlPlugin2.

void KVersionControlPlugin::infoMessage ( const QString &  msg )

signal

Is emitted if an information message with the content msg should be shown.

void KVersionControlPlugin::operationCompletedMessage ( const QString &  msg )

signal

Is emitted if an "operation completed" message with the content msg should be shown.

virtual VersionState KVersionControlPlugin::versionState ( const KFileItem &  item )

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.

void KVersionControlPlugin::versionStatesChanged ( )

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().

Deprecated:

Use KVersionControlPlugin2::itemVersionsChanged() instead.

---

The documentation for this class was generated from the following files:

• kversioncontrolplugin.h
• kversioncontrolplugin.cpp