Класс QFileSystemWatcher

Класс QFileSystemWatcher предоставляет интерфейс для отслеживания файлов и каталогов на предмет изменений. Подробнее...

Этот класс был представлен в Qt 4.2.

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Сигналы

Подробное описание

QFileSystemWatcher отслеживает файловую систему на предмет изменений файлов и каталогов, наблюдая за списком указанных путей.

Вызовите addPath(), чтобы следить за определённым файлом или каталогом. Несколько путей можно добавить с помощью функции addPaths(). Существующие пути можно удалить, используя функции removePath() и removePaths().

QFileSystemWatcher проверяет каждый добавленный к нему путь. Файлы, которые были добавлены в QFileSystemWatcher, можно получить с помощью функции files(), а каталоги — с помощью функции directories().

Сигнал fileChanged() генерируется, когда файл был изменён, переименован или удалён с диска. Аналогично, сигнал directoryChanged() генерируется, когда каталог или его содержимое изменяются или удаляются. Обратите внимание, что QFileSystemWatcher прекращает отслеживание файлов после их переименования или удаления с диска, а каталогов — после их удаления с диска.

• Примечания:
  • В системах, работающих на ядре Linux без поддержки inotify, файловые системы, содержащие наблюдаемые пути, не могут быть размонтированы.
  • Действие отслеживания файлов и каталогов на предмет изменений потребляет системные ресурсы. Это подразумевает, что существует ограничение на количество файлов и каталогов, которые ваш процесс может одновременно отслеживать. Например, на всех вариантах BSD для каждого отслеживаемого файла требуется открытый дескриптор файла. Некоторые системы ограничивают количество открытых дескрипторов файлов до 256 по умолчанию. Это означает, что addPath() и addPaths() потерпят неудачу, если ваш процесс попытается добавить более 256 файлов или каталогов в монитор файловой системы. Также обратите внимание, что ваш процесс может иметь открытые дескрипторы файлов помимо тех, которые используются для отслеживаемых файлов, и эти другие открытые дескрипторы также учитываются в общей сумме. macOS использует другой бэкэнд и не страдает от этой проблемы.

См. также QFile и QDir.

Документация по функциям-членам

QFileSystemWatcher::QFileSystemWatcher(const QStringList &paths, QObject *parent = nullptr)

Создаёт новый объект наблюдателя файловой системы с заданным parent, который отслеживает указанный список paths.

QFileSystemWatcher::QFileSystemWatcher(QObject *parent = nullptr)

Создаёт новый объект наблюдателя файловой системы с заданным parent.

[signal] void QFileSystemWatcher::directoryChanged(const QString &path)

Этот сигнал генерируется, когда каталог по указанному path изменяется (например, когда файл добавляется или удаляется) или удаляется с диска. Обратите внимание, что если несколько изменений происходят в течение короткого периода времени, некоторые из изменений могут не сгенерировать этот сигнал. Однако последнее изменение в последовательности изменений всегда сгенерирует этот сигнал.

Примечание: Это закрытый сигнал. Он может использоваться в соединениях сигналов, но не может испускаться пользователем.

См. также fileChanged().

[signal] void QFileSystemWatcher::fileChanged(const QString &path)

Этот сигнал генерируется, когда файл по указанному path изменяется, переименовывается или удаляется с диска.

Примечание: В качестве меры предосторожности многие приложения сохраняют открытый файл, записывая новый файл, а затем удаляя старый. В вашей функции-обработчике вы можете проверить watcher.files().contains(path). Если она возвращает false, проверьте, существует ли файл, и затем вызовите addPath() для продолжения отслеживания его.

Примечание: Это закрытый сигнал. Он может использоваться в соединениях сигналов, но не может испускаться пользователем.

См. также directoryChanged().

[virtual] QFileSystemWatcher::~QFileSystemWatcher()

Уничтожает наблюдатель файловой системы.

bool QFileSystemWatcher::addPath(const QString &path)

Добавляет path к наблюдателю файловой системы, если path существует. Путь не добавляется, если он не существует или уже отслеживается наблюдателем файловой системы.

Если path указывает на каталог, то сигнал directoryChanged() будет генерироваться, когда path изменяется или удаляется с диска; в противном случае генерируется сигнал fileChanged(), когда path изменяется, переименовывается или удаляется.

Если отслеживание прошло успешно, возвращается true.

Причины сбоя отслеживания, как правило, зависят от системы, но могут включать отсутствие ресурса, проблемы с доступом или предельное значение общего количества отслеживаний, если платформа имеет такое ограничение.

Примечание: Может быть системное ограничение на количество файлов и каталогов, которые можно одновременно отслеживать. Если это ограничение достигнуто, path не будет отслеживаться, и возвращается false.

См. также addPaths() и removePath().

QStringList QFileSystemWatcher::addPaths(const QStringList &paths)

Добавляет каждый путь из paths к наблюдателю файловой системы. Пути не добавляются, если они не существуют или уже отслеживаются наблюдателем файловой системы.

Если путь указывает на каталог, сигнал directoryChanged() будет генерироваться, когда путь изменяется или удаляется с диска; в противном случае генерируется сигнал fileChanged(), когда путь изменяется, переименовывается или удаляется.

Возвращаемое значение — список путей, которые не удалось отследить.

Причины сбоя отслеживания, как правило, зависят от системы, но могут включать отсутствие ресурса, проблемы с доступом или предельное значение общего количества отслеживаний, если платформа имеет такое ограничение.

Примечание: Может быть системное ограничение на количество файлов и каталогов, которые можно одновременно отслеживать. Если это ограничение достигнуто, лишние paths не будут отслеживаться, и они будут добавлены в возвращаемый QStringList.

См. также addPath() и removePaths().

QStringList QFileSystemWatcher::directories() const

Возвращает список путей к каталогам, которые отслеживаются.

См. также files().

QStringList QFileSystemWatcher::files() const

Возвращает список путей к файлам, которые отслеживаются.

См. также directories().

bool QFileSystemWatcher::removePath(const QString &path)

Удаляет указанный path из наблюдателя за файловой системой.

Если наблюдение успешно удалено, возвращается true.

Причинами неудачного удаления наблюдения, как правило, являются зависимости от системы, но могут быть связаны, например, с тем, что путь уже был удалён.

См. также removePaths() и addPath().

QStringList QFileSystemWatcher::removePaths(const QStringList &paths)

Удаляет указанные paths из наблюдателя за файловой системой.

Возвращаемое значение — список путей, которые не удалось успешно снять с наблюдения.

Причинами неудачного удаления наблюдения, как правило, являются зависимости от системы, но могут быть связаны, например, с тем, что путь уже был удалён.

См. также removePath() и addPaths().