runtime/nepomuk/services/strigi/filesystemwatcher.h

   1 /* This file is part of the KDE Project
   2    Copyright (c) 2008 Sebastian Trueg <trueg@kde.org>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License version 2 as published by the Free Software Foundation.
   7
   8    This library is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11    Library General Public License for more details.
  12
  13    You should have received a copy of the GNU Library General Public License
  14    along with this library; see the file COPYING.LIB.  If not, write to
  15    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16    Boston, MA 02110-1301, USA.
  17 */
  18
  19 #ifndef _FILE_SYSTEM_WATCHER_H_
  20 #define _FILE_SYSTEM_WATCHER_H_
  21
  22 #include <QtCore/QObject>
  23 #include <QtCore/QDateTime>
  24
  25
  26 /**
  27  * Watches a file system by periodically checking the
  28  * folder modification date.
  29  */
  30 class FileSystemWatcher : public QObject
  31 {
  32     Q_OBJECT
  33
  34 public:
  35     FileSystemWatcher( QObject* parent = 0 );
  36     ~FileSystemWatcher();
  37
  38     QStringList folders() const;
  39     bool watchRecursively() const;
  40     int interval() const;
  41
  42 public Q_SLOTS:
  43     void setFolders( const QStringList& folders );
  44
  45     /**
  46      * Enabled by default.
  47      */
  48     void setWatchRecursively( bool );
  49
  50     void setInterval( int seconds );
  51
  52     /**
  53      * Actually start checking the folders. Once the FileSystemWatcher
  54      * is started it will check the configured folders every \p interval()
  55      * seconds.
  56      *
  57      * Be aware that changing the settings on a started FileSystemWatcher
  58      * will have no effect until it is restarted.
  59      */
  60     void start( const QDateTime& startTime = QDateTime::currentDateTime() );
  61
  62     void stop();
  63
  64 Q_SIGNALS:
  65     /**
  66      * Emitted if a folder is dirty, i.e. its contents
  67      * changed.
  68      */
  69     void dirty( const QString& folder );
  70
  71 private:
  72     class Private;
  73     Private* const d;
  74
  75     Q_PRIVATE_SLOT( d, void checkFolders() )
  76 };
  77
  78 #endif