kdirwatch.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1998 Sven Radej <sven@lisa.exp.univie.ac.at>

   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 _KDIRWATCH_H
#define _KDIRWATCH_H

#include <QtCore/QDateTime>
#include <QtCore/QObject>
#include <QtCore/QString>

#include <kdecore_export.h>

class KDirWatchPrivate;

class KDECORE_EXPORT KDirWatch : public QObject
{
  Q_OBJECT

  public:

    enum WatchMode {
      WatchDirOnly = 0,  
      WatchFiles = 0x01, 
      WatchSubDirs = 0x02 
    };
    Q_DECLARE_FLAGS(WatchModes, WatchMode)

   
   KDirWatch(QObject* parent = 0);

   ~KDirWatch();

   void addDir(const QString& path, WatchModes watchModes = WatchDirOnly);

   void addFile(const QString& file);

   QDateTime ctime(const QString& path) const;

   void removeDir(const QString& path);

   void removeFile(const QString& file);

   bool stopDirScan(const QString& path);

   bool restartDirScan(const QString& path);

   void startScan( bool notify=false, bool skippedToo=false );

   void stopScan();

   bool isStopped();

   bool contains( const QString& path ) const;

   static void statistics(); // TODO implement a QDebug operator for KDirWatch instead.

   enum Method { FAM, INotify, DNotify /*now unused*/, Stat, QFSWatch };
   Method internalMethod(); // TODO KDE5: make const

   static KDirWatch* self();
   static bool exists();

public Q_SLOTS:

   void setCreated( const QString &path );

   void setDirty( const QString &path );

   void setDeleted( const QString &path );

 Q_SIGNALS:

   void dirty(const QString &path);

   void created(const QString &path);

   void deleted(const QString &path);

 private:
   KDirWatchPrivate *const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDirWatch::WatchModes)

#endif

// vim: sw=3 et