src/views/versioncontrol/versioncontrolobserver.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef VERSIONCONTROLOBSERVER_H
  21 #define VERSIONCONTROLOBSERVER_H
  22
  23 #include <libdolphin_export.h>
  24
  25 #include <KFileItem>
  26 #include <kversioncontrolplugin.h>
  27 #include <QList>
  28 #include <QMutex>
  29 #include <QObject>
  30 #include <QPersistentModelIndex>
  31 #include <QString>
  32
  33 class DolphinModel;
  34 class KDirLister;
  35 class KFileItemList;
  36 class QAbstractItemView;
  37 class QAction;
  38 class QTimer;
  39 class UpdateItemStatesThread;
  40
  41 /**
  42  * @brief Observes all version control plugins.
  43  *
  44  * The item view gets updated automatically if the currently shown
  45  * directory is under version control.
  46  *
  47  * @see VersionControlPlugin
  48  */
  49 class LIBDOLPHINPRIVATE_EXPORT VersionControlObserver : public QObject
  50 {
  51     Q_OBJECT
  52
  53 public:
  54     VersionControlObserver(QAbstractItemView* view);
  55     virtual ~VersionControlObserver();
  56
  57     QList<QAction*> contextMenuActions(const KFileItemList& items) const;
  58     QList<QAction*> contextMenuActions(const QString& directory) const;
  59
  60 signals:
  61     /**
  62      * Is emitted if an information message with the content \a msg
  63      * should be shown.
  64      */
  65     void infoMessage(const QString& msg);
  66
  67     /**
  68      * Is emitted if an error message with the content \a msg
  69      * should be shown.
  70      */
  71     void errorMessage(const QString& msg);
  72
  73     /**
  74      * Is emitted if an "operation completed" message with the content \a msg
  75      * should be shown.
  76      */
  77     void operationCompletedMessage(const QString& msg);
  78
  79 private slots:
  80     /**
  81      * Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification()
  82      * is invoked before the delay has been exceeded, the delay will be reset. This
  83      * assures that a lot of short requests for directory verification only result
  84      * in one (expensive) call.
  85      */
  86     void delayedDirectoryVerification();
  87
  88     /**
  89      * Invokes verifyDirectory() with a small delay. In opposite to
  90      * delayedDirectoryVerification() it and assures that the verification of
  91      * the directory is done silently without information messages.
  92      */
  93     void silentDirectoryVerification();
  94
  95     void verifyDirectory();
  96
  97     /**
  98      * Is invoked if the thread m_updateItemStatesThread has been finished
  99      * and applys the item states.
 100      */
 101     void slotThreadFinished();
 102
 103 private:
 104     struct ItemState
 105     {
 106         QPersistentModelIndex index;
 107         KFileItem item;
 108         KVersionControlPlugin::VersionState version;
 109     };
 110
 111     void updateItemStates();
 112
 113     /**
 114      * Adds recursively all items from the directory \p parentIndex into
 115      * the list \p itemStates.
 116      */
 117     void addDirectory(const QModelIndex& parentIndex, QList<ItemState>& itemStates);
 118
 119     /**
 120      * Returns a matching plugin for the given directory.
 121      * 0 is returned, if no matching plugin has been found.
 122      */
 123     KVersionControlPlugin* searchPlugin(const KUrl& directory) const;
 124
 125     /**
 126      * Returns true, if the directory contains a version control information.
 127      */
 128     bool isVersioned() const;
 129
 130 private:
 131     bool m_pendingItemStatesUpdate;
 132     bool m_versionedDirectory;
 133     bool m_silentUpdate; // if true, no messages will be send during the update
 134                          // of version states
 135
 136     QAbstractItemView* m_view;
 137     KDirLister* m_dirLister;
 138     DolphinModel* m_dolphinModel;
 139
 140     QTimer* m_dirVerificationTimer;
 141
 142     KVersionControlPlugin* m_plugin;
 143     UpdateItemStatesThread* m_updateItemStatesThread;
 144
 145     friend class UpdateItemStatesThread;
 146 };
 147
 148 #endif // REVISIONCONTROLOBSERVER_H
 149