kversioncontrolplugin.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com>                 *
 *                                                                           *
 * This library is free software; you can redistribute it and/or             *
 * modify it under the terms of the GNU Library General Public               *
 * License version 2 as published by the Free Software Foundation.           *
 *                                                                           *
 * This library is distributed in the hope that it will be useful,           *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; see the file COPYING.LIB.  If not, write to      *
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
 * Boston, MA 02110-1301, USA.                                               *
 *****************************************************************************/

#ifndef KVERSIONCONTROLPLUGIN_H
#define KVERSIONCONTROLPLUGIN_H

#include <libkonq_export.h>

#include <QObject>

class KFileItem;
class KFileItemList;
class QAction;

class LIBKONQ_EXPORT KVersionControlPlugin : public QObject
{
    Q_OBJECT

public:
    enum VersionState
    {
        UnversionedVersion,
        NormalVersion,
        UpdateRequiredVersion,
        LocallyModifiedVersion,
        AddedVersion,
        RemovedVersion,
        ConflictingVersion,
        LocallyModifiedUnstagedVersion
    };

    KVersionControlPlugin(QObject* parent = 0);
    virtual ~KVersionControlPlugin();

    virtual QString fileName() const = 0;

    virtual bool beginRetrieval(const QString& directory) = 0;

    virtual void endRetrieval() = 0;

    virtual VersionState versionState(const KFileItem& item) = 0;
    
    virtual QList<QAction*> contextMenuActions(const KFileItemList& items) = 0;

    virtual QList<QAction*> contextMenuActions(const QString& directory) = 0;

signals:
    void versionStatesChanged();

    void infoMessage(const QString& msg);

    void errorMessage(const QString& msg);

    void operationCompletedMessage(const QString& msg);
};

#endif // KVERSIONCONTROLPLUGIN_H