KInotify

Search for usage in LXR

#include <kinotify.h>

Inheritance diagram for KInotify:

Public Types

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
}
 
typedef QFlags< WatchEventWatchEvents
 
enum  WatchFlag { FlagOnlyDir = 0x01000000 , FlagDoNotFollow = 0x02000000 , FlagOneShot = 0x80000000 , FlagExclUnlink = 0x04000000 }
 
typedef QFlags< WatchFlagWatchFlags
 

Signals

void accessed (const QString &file)
 
void attributeChanged (const QString &file)
 
void closedRead (const QString &file)
 
void closedWrite (const QString &file)
 
void created (const QString &file, bool isDir)
 
void deleted (const QString &file, bool isDir)
 
void installedWatches ()
 
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)
 

Public Slots

bool addWatch (const QString &path, WatchEvents modes, WatchFlags flags=WatchFlags())
 
bool removeWatch (const QString &path)
 

Public Member Functions

 KInotify (Baloo::FileIndexerConfig *config, QObject *parent=nullptr)
 
void resetUserLimit ()
 
bool watchingPath (const QString &path) const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A simple wrapper around inotify which only allows to add folders recursively.

Warning: moving of top-level folders is not supported and results in undefined behaviour.

Definition at line 24 of file kinotify.h.

Member Typedef Documentation

◆ WatchEvents

Definition at line 68 of file kinotify.h.

◆ WatchFlags

Definition at line 81 of file kinotify.h.

Member Enumeration Documentation

◆ WatchEvent

Inotify events that can occur.

Use with addWatch to define the events that should be watched.

These flags correspond to the native Linux inotify flags.

Enumerator
EventAccess 

File was accessed (read, compare inotify's IN_ACCESS)

EventAttributeChange 

Metadata changed (permissions, timestamps, extended attributes, etc., compare inotify's IN_ATTRIB)

EventCloseWrite 

File opened for writing was closed (compare inotify's IN_CLOSE_WRITE)

EventCloseRead 

File not opened for writing was closed (compare inotify's IN_CLOSE_NOWRITE)

EventDelete 

File/directory created in watched directory (compare inotify's IN_CREATE)

File/directory deleted from watched directory (compare inotify's IN_DELETE)

EventDeleteSelf 

Watched file/directory was itself deleted (compare inotify's IN_DELETE_SELF)

EventModify 

File was modified (compare inotify's IN_MODIFY)

EventMoveSelf 

Watched file/directory was itself moved (compare inotify's IN_MOVE_SELF)

EventMoveFrom 

File moved out of watched directory (compare inotify's IN_MOVED_FROM)

EventMoveTo 

File moved into watched directory (compare inotify's IN_MOVED_TO)

EventOpen 

File was opened (compare inotify's IN_OPEN)

EventUnmount 

Backing fs was unmounted (compare inotify's IN_UNMOUNT)

EventQueueOverflow 

Event queued overflowed (compare inotify's IN_Q_OVERFLOW)

EventIgnored 

File was ignored (compare inotify's IN_IGNORED)

Definition at line 38 of file kinotify.h.

◆ WatchFlag

Watch flags.

These flags correspond to the native Linux inotify flags.

Enumerator
FlagOnlyDir 

Only watch the path if it is a directory (IN_ONLYDIR)

FlagDoNotFollow 

Don't follow a sym link (IN_DONT_FOLLOW)

FlagOneShot 

Only send event once (IN_ONESHOT)

FlagExclUnlink 

Do not generate events for unlinked files (IN_EXCL_UNLINK)

Definition at line 75 of file kinotify.h.

Constructor & Destructor Documentation

◆ KInotify()

KInotify::KInotify ( Baloo::FileIndexerConfig * config,
QObject * parent = nullptr )
explicit

Definition at line 200 of file kinotify.cpp.

◆ ~KInotify()

KInotify::~KInotify ( )
override

Definition at line 212 of file kinotify.cpp.

Member Function Documentation

◆ accessed

void KInotify::accessed ( const QString & file)
signal

Emitted if a file is accessed (KInotify::EventAccess)

◆ addWatch

bool KInotify::addWatch ( const QString & path,
WatchEvents modes,
WatchFlags flags = WatchFlags() )
slot

Definition at line 228 of file kinotify.cpp.

◆ attributeChanged

void KInotify::attributeChanged ( const QString & file)
signal

Emitted if file attributes are changed (KInotify::EventAttributeChange)

◆ closedRead

void KInotify::closedRead ( const QString & file)
signal

Emitted if FIXME (KInotify::EventCloseRead)

◆ closedWrite

void KInotify::closedWrite ( const QString & file)
signal

Emitted if FIXME (KInotify::EventCloseWrite)

◆ created

void KInotify::created ( const QString & file,
bool isDir )
signal

Emitted if a new file has been created in one of the watched folders (KInotify::EventCreate)

◆ deleted

void KInotify::deleted ( const QString & file,
bool isDir )
signal

Emitted if a watched file or folder has been deleted.

This includes files in watched folders (KInotify::EventDelete and KInotify::EventDeleteSelf)

◆ installedWatches

void KInotify::installedWatches ( )
signal

This is emitted once watches have been installed in all the directories indicated by addWatch.

◆ modified

void KInotify::modified ( const QString & file)
signal

Emitted if a watched file is modified (KInotify::EventModify)

◆ moved

void KInotify::moved ( const QString & oldName,
const QString & newName )
signal

Emitted if a file or folder has been moved or renamed.

Warning
The moved signal will only be emitted if both the source and target folder are being watched.

◆ opened

void KInotify::opened ( const QString & file)
signal

Emitted if a file is opened (KInotify::EventOpen)

◆ removeWatch

bool KInotify::removeWatch ( const QString & path)
slot

Definition at line 247 of file kinotify.cpp.

◆ resetUserLimit()

void KInotify::resetUserLimit ( )

Call this when the inotify limit has been increased.

Definition at line 223 of file kinotify.cpp.

◆ unmounted

void KInotify::unmounted ( const QString & file)
signal

Emitted if a watched path has been unmounted (KInotify::EventUnmount)

◆ watchingPath()

bool KInotify::watchingPath ( const QString & path) const

Definition at line 217 of file kinotify.cpp.

◆ watchUserLimitReached

void KInotify::watchUserLimitReached ( const QString & path)
signal

Emitted if during updating the internal watch structures (recursive watches) the inotify user watch limit was reached.

This means that not all requested paths can be watched until the user watch limit is increased.

The argument is the path being added when the limit was reached.

This signal will only be emitted once until resetUserLimit is called.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:51:50 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.