KInotify
#include <kinotify.h>

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< WatchEvent > | WatchEvents |
enum | WatchFlag { FlagOnlyDir = 0x01000000, FlagDoNotFollow = 0x02000000, FlagOneShot = 0x80000000, FlagExclUnlink = 0x04000000 } |
typedef QFlags< WatchFlag > | WatchFlags |
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) | |
bool | available () const |
void | resetUserLimit () |
bool | watchingPath (const QString &path) const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | 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 | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | QObjectList |
![]() | |
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 |
QObject * | sender () 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 Enumeration Documentation
◆ WatchEvent
enum KInotify::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.
Definition at line 38 of file kinotify.h.
◆ WatchFlag
enum KInotify::WatchFlag |
Watch flags.
These flags correspond to the native Linux inotify flags.
Definition at line 75 of file kinotify.h.
Member Function Documentation
◆ accessed
|
signal |
Emitted if a file is accessed (KInotify::EventAccess)
◆ attributeChanged
|
signal |
Emitted if file attributes are changed (KInotify::EventAttributeChange)
◆ available()
bool KInotify::available | ( | ) | const |
- Returns
true
if inotify is available and usable.
Definition at line 218 of file kinotify.cpp.
◆ closedRead
|
signal |
Emitted if FIXME (KInotify::EventCloseRead)
◆ closedWrite
|
signal |
Emitted if FIXME (KInotify::EventCloseWrite)
◆ created
|
signal |
Emitted if a new file has been created in one of the watched folders (KInotify::EventCreate)
◆ deleted
|
signal |
Emitted if a watched file or folder has been deleted.
This includes files in watched folders (KInotify::EventDelete and KInotify::EventDeleteSelf)
◆ installedWatches
|
signal |
This is emitted once watches have been installed in all the directories indicated by addWatch.
◆ modified
|
signal |
Emitted if a watched file is modified (KInotify::EventModify)
◆ moved
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
|
signal |
Emitted if a file is opened (KInotify::EventOpen)
◆ resetUserLimit()
void KInotify::resetUserLimit | ( | ) |
Call this when the inotify limit has been increased.
Definition at line 251 of file kinotify.cpp.
◆ unmounted
|
signal |
Emitted if a watched path has been unmounted (KInotify::EventUnmount)
◆ watchUserLimitReached
|
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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:10:36 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.