Класс QFileSystemModel

Класс QFileSystemModel предоставляет модель данных для локальной файловой системы. Подробнее...

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

Открытые типы

Свойства

• nameFilterDisables : bool
• readOnly : bool
• resolveSymlinks : bool

• 1 свойство унаследовано от QObject

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

Переопределённые открытые функции

• 43 public functions inherited from QAbstractItemModel
• 34 public functions inherited from QObject

Сигналы

• 18 signals inherited from QAbstractItemModel
• 2 signals inherited from QObject

Реализованные защищенные функции

• 19 protected functions inherited from QAbstractItemModel
• 9 protected functions inherited from QObject

Дополнительные унаследованные члены

• 2 public slots inherited from QAbstractItemModel
• 1 public slot inherited from QObject
• 1 public variable inherited from QAbstractItemModel
• 1 public variable inherited from QObject
• 2 static public members inherited from QAbstractItemModel
• 10 static public members inherited from QObject
• 19 protected functions inherited from QAbstractItemModel
• 9 protected functions inherited from QObject
• 1 protected slot inherited from QAbstractItemModel
• 2 protected variables inherited from QObject

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

Класс QFileSystemModel предоставляет модель данных для локальной файловой системы.

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

QFileSystemModel может быть использован с помощью стандартного интерфейса, предоставляемого QAbstractItemModel, но также предоставляет некоторые удобные функции, специфичные для модели каталогов. Функции fileInfo(), isDir(), fileName() и filePath() предоставляют информацию об основных файлах и каталогах, связанных с элементами в модели. Каталоги можно создавать и удалять с помощью mkdir() и rmdir().

Примечание: QFileSystemModel требует экземпляра QApplication.

Пример использования

Модель каталога, которая отображает содержимое каталога по умолчанию, обычно создается с родительским объектом:

    QFileSystemModel *model = new QFileSystemModel;
    model->setRootPath(QDir::currentPath());

Для отображения содержимого модели можно использовать виджет дерева

    QTreeView *tree = new QTreeView(splitter);
    tree->setModel(model);

и содержимое конкретного каталога можно отобразить, установив индекс корня виджета дерева:

    tree->setRootIndex(model->index(QDir::currentPath()));

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

Кэширование и производительность

QFileSystemModel не будет извлекать файлы или каталоги, пока не будет вызван setRootPath(). Это предотвратит ненужное обращение к файловой системе, например, перечисление дисков в Windows, до этого момента.

В отличие от QDirModel, QFileSystemModel использует отдельный поток для заполнения, поэтому он не приведет к зависанию основного потока при запросе файловой системы. Вызовы rowCount() вернут 0, пока модель не заполнит каталог.

QFileSystemModel сохраняет кэш с информацией о файлах. Кэш автоматически обновляется с помощью QFileSystemWatcher.

См. также Классы моделей.

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

enum QFileSystemModel::Roles

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

QFileSystemModel::QFileSystemModel(QObject *parent = nullptr)

Создает модель файловой системы с заданным parent.

[virtual] QFileSystemModel::~QFileSystemModel()

Удаляет эту модель файловой системы.

[override virtual] bool QFileSystemModel::canFetchMore(const QModelIndex &parent) const

Переопределено из QAbstractItemModel::canFetchMore().

[override virtual] int QFileSystemModel::columnCount(const QModelIndex &parent = QModelIndex()) const

Переопределено из QAbstractItemModel::columnCount().

[override virtual] QVariant QFileSystemModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

Переопределено из QAbstractItemModel::data().

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

[signal] void QFileSystemModel::directoryLoaded(const QString &path)

Этот сигнал испускается, когда поток сбора данных завершает загрузку path.

Эта функция была добавлена в Qt 4.7.

[override virtual] bool QFileSystemModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

Переопределено из QAbstractItemModel::dropMimeData().

Обрабатывает data, предоставленные операцией перетаскивания, которая закончилась заданным action над строкой в модели, указанной row и column, и parent-индексом.

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

[override virtual protected] bool QFileSystemModel::event(QEvent *event)

Переопределено из QObject::event().

[override virtual] void QFileSystemModel::fetchMore(const QModelIndex &parent)

Переопределено из QAbstractItemModel::fetchMore().

QIcon QFileSystemModel::fileIcon(const QModelIndex &index) const

Возвращает значок для элемента, хранящегося в модели по указанному index.

QFileInfo QFileSystemModel::fileInfo(const QModelIndex &index) const

Возвращает QFileInfo для элемента, хранящегося в модели по указанному index.

QString QFileSystemModel::fileName(const QModelIndex &index) const

Возвращает имя файла для элемента, хранящегося в модели по указанному index.

QString QFileSystemModel::filePath(const QModelIndex &index) const

Возвращает путь к элементу, хранящемуся в модели по указанному index.

[signal] void QFileSystemModel::fileRenamed(const QString &path, const QString &oldName, const QString &newName)

Этот сигнал испускается, когда файл с oldName успешно переименован в newName. Файл находится в каталоге path.

QDir::Filters QFileSystemModel::filter() const

Возвращает фильтр, указанный для модели каталога.

Если фильтр не установлен, по умолчанию используется QDir::AllEntries | QDir::NoDotAndDotDot | QDir::AllDirs.

См. также setFilter() и QDir::Filters.

[override virtual] Qt::ItemFlags QFileSystemModel::flags(const QModelIndex &index) const

Переопределено из QAbstractItemModel::flags().

[override virtual] bool QFileSystemModel::hasChildren(const QModelIndex &parent = QModelIndex()) const

Переопределено из QAbstractItemModel::hasChildren().

[override virtual] QVariant QFileSystemModel::headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const

Переопределено из QAbstractItemModel::headerData().

QFileIconProvider *QFileSystemModel::iconProvider() const

Возвращает поставщик значков файлов для этой модели каталога.

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

[override virtual] QModelIndex QFileSystemModel::index(int row, int column, const QModelIndex &parent = QModelIndex()) const

Переопределено из QAbstractItemModel::index().

QModelIndex QFileSystemModel::index(const QString &path, int column = 0) const

Это перегруженная функция.

Возвращает индекс элемента модели для заданного path и column.

bool QFileSystemModel::isDir(const QModelIndex &index) const

Возвращает true, если элемент модели index представляет каталог; в противном случае возвращает false.

QDateTime QFileSystemModel::lastModified(const QModelIndex &index) const

Возвращает дату и время последнего изменения index.

[override virtual] QMimeData *QFileSystemModel::mimeData(const QModelIndexList &indexes) const

Переопределено из QAbstractItemModel::mimeData().

Возвращает объект, содержащий сериализованное описание указанных indexes. Формат описания элементов, соответствующих индексам, получен из функции mimeTypes().

Если список индексов пуст, возвращается 0, а не сериализованный пустой список.

[override virtual] QStringList QFileSystemModel::mimeTypes() const

Переопределено из QAbstractItemModel::mimeTypes().

Возвращает список типов MIME, которые могут использоваться для описания списка элементов в модели.

QModelIndex QFileSystemModel::mkdir(const QModelIndex &parent, const QString &name)

Создает директорию с именем name в родительском индексе модели parent.

QVariant QFileSystemModel::myComputer(int role = Qt::DisplayRole) const

Возвращает данные, хранящиеся по заданному role для элемента "Мой компьютер".

См. также Qt::ItemDataRole.

QStringList QFileSystemModel::nameFilters() const

Возвращает список фильтров, применённых к именам в модели.

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

[override virtual] QModelIndex QFileSystemModel::parent(const QModelIndex &index) const

Переопределено из QAbstractItemModel::parent().

QFile::Permissions QFileSystemModel::permissions(const QModelIndex &index) const

Возвращает полную комбинацию QFile::Permission, объединённую с помощью побитового ИЛИ, для index.

bool QFileSystemModel::remove(const QModelIndex &index)

Удаляет элемент модели index из модели файловой системы и удаляет соответствующий файл из файловой системы, возвращая true при успехе. Если элемент не может быть удален, возвращается false.

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

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

bool QFileSystemModel::rmdir(const QModelIndex &index)

Удаляет директорию, соответствующую элементу модели index в модели файловой системы и удаляет соответствующую директорию из файловой системы, возвращая true при успехе. Если директория не может быть удалена, возвращается false.

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

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

QDir QFileSystemModel::rootDirectory() const

Текущая установленная директория

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

QString QFileSystemModel::rootPath() const

Текущий установленный путь к корню

См. также setRootPath() и rootDirectory().

[signal] void QFileSystemModel::rootPathChanged(const QString &newPath)

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

[override virtual] int QFileSystemModel::rowCount(const QModelIndex &parent = QModelIndex()) const

Переопределено из QAbstractItemModel::rowCount().

[override virtual] bool QFileSystemModel::setData(const QModelIndex &idx, const QVariant &value, int role = Qt::EditRole)

Переопределено из QAbstractItemModel::setData().

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

void QFileSystemModel::setFilter(QDir::Filters filters)

Устанавливает фильтр модели каталога, указанный filters.

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

См. также filter() и QDir::Filters.

void QFileSystemModel::setIconProvider(QFileIconProvider *provider)

Устанавливает provider для иконок файлов в модели каталога.

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

void QFileSystemModel::setNameFilters(const QStringList &filters)

Устанавливает фильтры имен filters для применения к существующим файлам.

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

QModelIndex QFileSystemModel::setRootPath(const QString &newPath)

Устанавливает наблюдаемую директорию модели на newPath, установив наблюдателя файловой системы на ней. Любые изменения файлов и директорий в этой директории будут отображаться в модели.

Если путь изменён, будет выпущен сигнал rootPathChanged().

Примечание: Эта функция не изменяет структуру модели или не изменяет доступные данные для представлений. Другими словами, "корень" модели не изменяется, чтобы включать только файлы и директории в директории, указанной newPath в файловой системе.

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

[override virtual] QModelIndex QFileSystemModel::sibling(int row, int column, const QModelIndex &idx) const

Переопределено из QAbstractItemModel::sibling().

qint64 QFileSystemModel::size(const QModelIndex &index) const

Возвращает размер index в байтах. Если файл не существует, возвращается 0.

[override virtual] void QFileSystemModel::sort(int column, Qt::SortOrder order = Qt::AscendingOrder)

Переопределено из QAbstractItemModel::sort().

[override virtual] Qt::DropActions QFileSystemModel::supportedDropActions() const

Переопределено из QAbstractItemModel::supportedDropActions().

[override virtual protected] void QFileSystemModel::timerEvent(QTimerEvent *event)

Переопределено из QObject::timerEvent().

QString QFileSystemModel::type(const QModelIndex &index) const

Возвращает тип файла index, например "Директория" или "JPEG-файл".