Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.trolltech.qt.core
Class QFileSystemWatcher

    java.lang.Object
      com.trolltech.qt.QSignalEmitter
          com.trolltech.qt.QtJambiObject
              com.trolltech.qt.core.QObject
                  com.trolltech.qt.core.QFileSystemWatcher

All Implemented Interfaces:
  QtJambiInterface

    public class QFileSystemWatcher

extends QObject

The `QFileSystemWatcher` class provides an interface for monitoring files and directories for modifications. `QFileSystemWatcher` monitors the file system for changes to files and directories by watching a list of specified paths.

Call `addPath()` to watch a particular file or directory. Multiple paths can be added using the `addPaths()` function. Existing paths can be removed by using the `removePath()` and `removePaths()` functions.

`QFileSystemWatcher` examines each path added to it. Files that have been added to the `QFileSystemWatcher` can be accessed using the `files()` function, and directories using the `directories()` function.

The `fileChanged()` signal is emitted when a file has been modified or removed from disk. Similarly, the `directoryChanged()` signal is emitted when a directory or its contents is modified or removed. Note that `QFileSystemWatcher` stops monitoring files and directories once they have been removed from disk.

Note: On systems running a Linux kernel without inotify support, file systems that contain watched paths cannot be unmounted.

Note: Windows CE does not support directory monitoring by default as this depends on the file system driver installed.

See also:
  `QFile`, and `QDir`.

Nested Class Summary

Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
`QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9`

Field Summary
`QSignalEmitter.Signal1` | `directoryChanged` This signal is emitted when the directory at a specified `path`, is modified (e.g., when a file is added, modified or deleted) or removed from disk.
`QSignalEmitter.Signal1` | `fileChanged` This signal is emitted when the file at the specified `path` is modified or removed from disk.

Constructor Summary
`QFileSystemWatcher()` Constructs a new file system watcher object with the given `parent`.
`QFileSystemWatcher(java.util.List paths)` Constructs a new file system watcher object with the given `parent` which monitors the specified `paths` list.
`QFileSystemWatcher(java.util.List paths, QObject parent)` Constructs a new file system watcher object with the given `parent` which monitors the specified `paths` list.
`QFileSystemWatcher(QObject parent)` Constructs a new file system watcher object with the given `parent`.

Method Summary
`void` | `addPath(java.lang.String file)` Adds `path` to the file system watcher if `path` exists.
`void` | `addPaths(java.util.List files)` Adds each path in `paths` to the file system watcher.
`java.util.List` | `directories()` Returns a list of paths to directories that are being watched.
`java.util.List` | `files()` Returns a list of paths to files that are being watched.
`static QFileSystemWatcher` | `fromNativePointer(QNativePointer nativePointer)` This method returns the QFileSystemWatcher instance pointed to by `nativePointer`.
`void` | `removePath(java.lang.String file)` Removes the specified `path` from the file system watcher.
`void` | `removePaths(java.util.List files)` Removes the specified `paths` from the file system watcher.

Methods inherited from class com.trolltech.qt.core.QObject
`childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty`

Methods inherited from class com.trolltech.qt.QtJambiObject
`dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr`

Methods inherited from class com.trolltech.qt.QSignalEmitter
`blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread`

Methods inherited from class java.lang.Object
`clone, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.trolltech.qt.QtJambiInterface
`disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership`

Field Detail

### directoryChanged

    public final QSignalEmitter.Signal1 directoryChanged

  This signal is emitted when the directory at a specified `path`, is modified (e.g., when a file is added, modified or deleted) or removed from disk. Note that if there are several changes during a short period of time, some of the changes might not emit this signal. However, the last change in the sequence of changes will always generate this signal.

See also:
  `fileChanged()` .

### fileChanged

    public final QSignalEmitter.Signal1 fileChanged

  This signal is emitted when the file at the specified `path` is modified or removed from disk.

See also:
  `directoryChanged()` .

Constructor Detail

### QFileSystemWatcher

    public QFileSystemWatcher()

  Constructs a new file system watcher object with the given `parent`.

### QFileSystemWatcher

    public QFileSystemWatcher(QObject parent)

  Constructs a new file system watcher object with the given `parent`.

### QFileSystemWatcher

    public QFileSystemWatcher(java.util.List paths)

  Constructs a new file system watcher object with the given `parent` which monitors the specified `paths` list.

### QFileSystemWatcher

    public QFileSystemWatcher(java.util.List paths,
                              QObject parent)

  Constructs a new file system watcher object with the given `parent` which monitors the specified `paths` list.

Method Detail

### addPath

    public final void addPath(java.lang.String file)

  Adds `path` to the file system watcher if `path` exists. The path is not added if it does not exist, or if it is already being monitored by the file system watcher.

  If `path` specifies a directory, the `directoryChanged()` signal will be emitted when `path` is modified or removed from disk; otherwise the `fileChanged()` signal is emitted when `path` is modified or removed.

See also:
  `addPaths()`, and `removePath()`.

### addPaths

    public final void addPaths(java.util.List files)

  Adds each path in `paths` to the file system watcher. Paths are not added if they not exist, or if they are already being monitored by the file system watcher.

  If a path specifies a directory, the `directoryChanged()` signal will be emitted when the path is modified or removed from disk; otherwise the `fileChanged()` signal is emitted when the path is modified or removed.

See also:
  `addPath()`, and `removePaths()`.

### directories

    public final java.util.List directories()

  Returns a list of paths to directories that are being watched.

See also:
  `files()`.

### files

    public final java.util.List files()

  Returns a list of paths to files that are being watched.

See also:
  `directories()`.

### removePath

    public final void removePath(java.lang.String file)

  Removes the specified `path` from the file system watcher.

See also:
  `removePaths()`, and `addPath()`.

### removePaths

    public final void removePaths(java.util.List files)

  Removes the specified `paths` from the file system watcher.

See also:
  `removePath()`, and `addPaths()`.

### fromNativePointer

    public static QFileSystemWatcher fromNativePointer(QNativePointer nativePointer)

  This method returns the QFileSystemWatcher instance pointed to by `nativePointer`.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD