kinotify.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2007-2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

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

#include <QtCore/QObject>
#include <QtCore/QFlags>

class KInotify : public QObject
{
    Q_OBJECT

public:
    KInotify( QObject* parent = 0 );
    virtual ~KInotify();

    enum WatchEvent {
        EventAccess = 0x00000001, 
        EventAttributeChange = 0x00000004, 
        EventCloseWrite = 0x00000008, 
        EventCloseRead = 0x00000010, 
        EventCreate = 0x00000100, 
        EventDelete = 0x00000200, 
        EventDeleteSelf = 0x00000400, 
        EventModify = 0x00000002, 
        EventMoveSelf = 0x00000800, 
        EventMoveFrom = 0x00000040, 
        EventMoveTo = 0x00000080, 
        EventOpen = 0x00000020, 
        EventUnmount = 0x00002000, 
        EventQueueOverflow = 0x00004000, 
        EventIgnored = 0x00008000, 
        EventMove = ( EventMoveFrom|EventMoveTo),
        EventAll = ( EventAccess|
                     EventAttributeChange|
                     EventCloseWrite|
                     EventCloseRead|
                     EventCreate|
                     EventDelete|
                     EventDeleteSelf|
                     EventModify|
                     EventMoveSelf|
                     EventMoveFrom|
                     EventMoveTo|
                     EventOpen )
    };
    Q_DECLARE_FLAGS(WatchEvents, WatchEvent)

    
    enum WatchFlag {
        FlagOnlyDir = 0x01000000, 
        FlagDoNotFollow = 0x02000000, 
        FlagOneShot = 0x80000000, 
        FlagExclUnlink = 0x04000000 
    };
    Q_DECLARE_FLAGS(WatchFlags, WatchFlag)

    
    bool available() const;

    bool watchingPath( const QString& path ) const;

    void resetUserLimit();

protected:
    virtual bool filterWatch( const QString & path, WatchEvents & modes, WatchFlags & flags );

public Q_SLOTS:
    virtual bool addWatch( const QString& path, WatchEvents modes, WatchFlags flags = WatchFlags() );
    bool removeWatch( const QString& path );

Q_SIGNALS:
    void accessed( const QString& file );

    void attributeChanged( const QString& file );

    void closedWrite( const QString& file );

    void closedRead( const QString& file );

    void created( const QString& file, bool isDir );

    void deleted( const QString& file, bool isDir );

    void modified( const QString& file );

    void moved( const QString& oldName, const QString& newName );

    void opened( const QString& file );

    void unmounted( const QString& file );

    void watchUserLimitReached( const QString& path );

private Q_SLOTS:
    void slotEvent( int );
    void slotClearCookies();

private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, bool _k_addWatches() )
};

#endif