#include <kdirwatch.h>
Inherits TQObject.
Public Types | |
enum | Method { FAM , DNotify , Stat , INotify } |
Signals | |
void | dirty (const TQString &path) |
void | dirty (const KURL &url) |
void | created (const TQString &path) |
void | deleted (const TQString &path) |
Public Member Functions | |
KDirWatch (TQObject *parent=0, const char *name=0) | |
~KDirWatch () | |
void | addDir (const TQString &path, bool watchFiles=false, bool recursive=false) |
void | addDir (const KURL &url, bool watchFiles=false, bool recursive=false) |
void | addFile (const TQString &file) |
TQDateTime | ctime (const TQString &path) |
void | removeDir (const TQString &path) |
void | removeDir (const KURL &path) |
void | removeFile (const TQString &file) |
bool | stopDirScan (const TQString &path) |
bool | restartDirScan (const TQString &path) |
void | startScan (bool notify=false, bool skippedToo=false) |
void | stopScan () |
bool | isStopped () |
bool | contains (const TQString &path) const |
void | setCreated (const TQString &path) |
void | setDirty (const TQString &path) |
void | setDirty (const KURL &url) |
void | setDeleted (const TQString &path) |
Method | internalMethod () |
Static Public Member Functions | |
static void | statistics () |
static KDirWatch * | self () |
static bool | exists () |
Detailed Description
Watch directories and files for changes.
The watched directories or files don't have to exist yet.
When a watched directory is changed, i.e. when files therein are created or deleted, KDirWatch will emit the signal dirty().
When a watched, but previously not existing directory gets created, KDirWatch will emit the signal created().
When a watched directory gets deleted, KDirWatch will emit the signal deleted(). The directory is still watched for new creation.
When a watched file is changed, i.e. attributes changed or written to, KDirWatch will emit the signal dirty().
Scanning of particular directories or files can be stopped temporarily and restarted. The whole class can be stopped and restarted. Directories and files can be added/removed from the list in any state.
The implementation uses the FAM service when available; if FAM is not available, the DNOTIFY functionality is used on LINUX. As a last resort, a regular polling for change of modification times is done; the polling interval is a global config option: DirWatch/PollInterval and DirWatch/NFSPollInterval for NFS mounted directories.
- See also
- self()
Class for watching directory and file changes.
Definition at line 65 of file kdirwatch.h.
Constructor & Destructor Documentation
◆ KDirWatch()
KDirWatch::KDirWatch | ( | TQObject * | parent = 0 , |
const char * | name = 0 |
||
) |
Constructor.
Scanning begins immediately when a dir/file watch is added.
- Parameters
-
parent the parent of the TQObject (or 0 for parent-less KDataTools) name the name of the TQObject, can be 0
Definition at line 1648 of file kdirwatch.cpp.
◆ ~KDirWatch()
KDirWatch::~KDirWatch | ( | ) |
Member Function Documentation
◆ addDir()
void KDirWatch::addDir | ( | const TQString & | path, |
bool | watchFiles = false , |
||
bool | recursive = false |
||
) |
Adds a directory to be watched.
The directory does not have to exist. When watchFiles
is false (the default), the signals dirty(), created(), deleted() can be emitted, all for the watched directory. When watchFiles
is true, all files in the watched directory are watched for changes, too. Thus, the signals dirty(), created(), deleted() can be emitted.
- Parameters
-
path the path to watch watchFiles if true, the KDirWatch will also watch files - NOT IMPLEMENTED YET recursive if true, all sub directories are also watched - NOT IMPLEMENTED YET
Definition at line 1679 of file kdirwatch.cpp.
◆ addFile()
void KDirWatch::addFile | ( | const TQString & | file | ) |
Adds a file to be watched.
- Parameters
-
file the file to watch
Definition at line 1696 of file kdirwatch.cpp.
◆ contains()
bool KDirWatch::contains | ( | const TQString & | path | ) | const |
Check if a directory is being watched by this KDirWatch instance.
- Parameters
-
path the directory to check
- Returns
- true if the directory is being watched
Definition at line 1761 of file kdirwatch.cpp.
◆ created
|
signal |
Emitted when a file or directory is created.
- Parameters
-
path the path of the file or directory
◆ ctime()
TQDateTime KDirWatch::ctime | ( | const TQString & | path | ) |
Returns the time the directory/file was last changed.
- Parameters
-
path the file to check
- Returns
- the date of the last modification
Definition at line 1701 of file kdirwatch.cpp.
◆ deleted
|
signal |
Emitted when a file or directory is deleted.
The object is still watched for new creation.
- Parameters
-
path the path of the file or directory
◆ dirty
|
signal |
Emitted when a watched object is changed.
For a directory this signal is emitted when files therein are created or deleted. For a file this signal is emitted when its size or attributes change.
When you watch a directory, changes in the size or attributes of contained files may or may not trigger this signal to be emitted depending on which backend is used by KDirWatch.
The new ctime is set before the signal is emitted.
- Parameters
-
path the path of the file or directory
◆ exists()
|
static |
Returns true if there is an instance of KDirWatch.
- Returns
- true if there is an instance of KDirWatch.
- See also
- KDirWatch::self()
- Since
- 3.1
Definition at line 1643 of file kdirwatch.cpp.
◆ internalMethod()
KDirWatch::Method KDirWatch::internalMethod | ( | ) |
Returns the preferred internal method to watch for changes.
- Since
- 3.2
Definition at line 1808 of file kdirwatch.cpp.
◆ isStopped()
|
inline |
Is scanning stopped? After creation of a KDirWatch instance, this is false.
- Returns
- true when scanning stopped
Definition at line 195 of file kdirwatch.h.
◆ removeDir()
void KDirWatch::removeDir | ( | const TQString & | path | ) |
Removes a directory from the list of scanned directories.
If specified path is not in the list this does nothing.
- Parameters
-
path the path of the dir to be removed from the list
Definition at line 1713 of file kdirwatch.cpp.
◆ removeFile()
void KDirWatch::removeFile | ( | const TQString & | file | ) |
Removes a file from the list of watched files.
If specified path is not in the list this does nothing.
- Parameters
-
file the file to be removed from the list
Definition at line 1723 of file kdirwatch.cpp.
◆ restartDirScan()
bool KDirWatch::restartDirScan | ( | const TQString & | path | ) |
Restarts scanning for specified path.
Resets ctime. It doesn't notify the change (by emitted a signal), since the ctime value is reset.
Call it when you are finished with big operations on that path, and when you have refreshed that path.
- Parameters
-
path the path to restart scanning
- Returns
- true if the
path
is being watched, otherwise false
- See also
- stopDirScanning()
Definition at line 1737 of file kdirwatch.cpp.
◆ self()
|
static |
The KDirWatch instance usually globally used in an application.
It is automatically deleted when the application exits.
However, you can create an arbitrary number of KDirWatch instances aside from this one - for those you have to take care of memory management.
This function returns an instance of KDirWatch. If there is none, it will be created.
- Returns
- a KDirWatch instance
Definition at line 1634 of file kdirwatch.cpp.
◆ setCreated()
void KDirWatch::setCreated | ( | const TQString & | path | ) |
Emits created().
- Parameters
-
path the path of the file or directory
Definition at line 1784 of file kdirwatch.cpp.
◆ setDeleted()
void KDirWatch::setDeleted | ( | const TQString & | path | ) |
Emits deleted().
- Parameters
-
path the path of the file or directory
Definition at line 1802 of file kdirwatch.cpp.
◆ setDirty()
void KDirWatch::setDirty | ( | const TQString & | path | ) |
Emits dirty().
- Parameters
-
path the path of the file or directory
Definition at line 1790 of file kdirwatch.cpp.
◆ startScan()
void KDirWatch::startScan | ( | bool | notify = false , |
bool | skippedToo = false |
||
) |
Starts scanning of all dirs in list.
- Parameters
-
notify If true, all changed directories (since stopScan() call) will be notified for refresh. If notify is false, all ctimes will be reset (except those who are stopped, but only if skippedToo
is false) and changed dirs won't be notified. You can start scanning even if the list is empty. First call should be called withfalse
or else all directories in list will be notified.
skippedToo if true, the skipped directoris (scanning of which was stopped with stopDirScan() ) will be reset and notified for change. Otherwise, stopped directories will continue to be unnotified.
Definition at line 1754 of file kdirwatch.cpp.
◆ statistics()
|
static |
Dump statistic information about all KDirWatch instances.
This checks for consistency, too.
Definition at line 1774 of file kdirwatch.cpp.
◆ stopDirScan()
bool KDirWatch::stopDirScan | ( | const TQString & | path | ) |
Stops scanning the specified path.
The path
is not deleted from the interal just, it is just skipped. Call this function when you perform an huge operation on this directory (copy/move big files or many files). When finished, call restartDirScan(path).
- Parameters
-
path the path to skip
- Returns
- true if the
path
is being watched, otherwise false
- See also
- restartDirScanning()
Definition at line 1728 of file kdirwatch.cpp.
◆ stopScan()
void KDirWatch::stopScan | ( | ) |
Stops scanning of all directories in internal list.
The timer is stopped, but the list is not cleared.
Definition at line 1748 of file kdirwatch.cpp.
The documentation for this class was generated from the following files: