QFileSystemModel Class

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

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

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

Member Function Documentation

QFileSystemModel::QFileSystemModel(QObject *parent = nullptr)

Constructs a file system model with the given parent.

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

This signal is emitted when the gatherer thread has finished to load the path.

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

This signal is emitted whenever a file with the oldName is successfully renamed to newName. The file is located in in the directory path.

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

This signal is emitted whenever the root path has been changed to a newPath.

[virtual] QFileSystemModel::~QFileSystemModel()

Destroys this file system model.

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

Reimplements: QAbstractItemModel::canFetchMore(const QModelIndex &parent) const.

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

Reimplements: QAbstractItemModel::columnCount(const QModelIndex &parent) const.

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

Reimplements: QAbstractItemModel::data(const QModelIndex &index, int role) const.

See also setData().

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

Reimplements: QAbstractItemModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent).

Handles the data supplied by a drag and drop operation that ended with the given action over the row in the model specified by the row and column and by the parent index. Returns true if the operation was successful.

See also supportedDropActions().

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

Reimplements: QObject::event(QEvent *e).

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

Reimplements: QAbstractItemModel::fetchMore(const QModelIndex &parent).

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

Returns the icon for the item stored in the model under the given index.

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

Returns the QFileInfo for the item stored in the model under the given index.

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

Returns the file name for the item stored in the model under the given index.

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

Returns the path of the item stored in the model under the index given.

QDir::Filters QFileSystemModel::filter() const

Returns the filter specified for the directory model.

If a filter has not been set, the default filter is QDir::AllEntries | QDir::NoDotAndDotDot | QDir::AllDirs.

See also setFilter() and QDir::Filters.

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

Reimplements: QAbstractItemModel::flags(const QModelIndex &index) const.

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

Reimplements: QAbstractItemModel::hasChildren(const QModelIndex &parent) const.

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

Reimplements: QAbstractItemModel::headerData(int section, Qt::Orientation orientation, int role) const.

QAbstractFileIconProvider *QFileSystemModel::iconProvider() const

Returns the file icon provider for this directory model.

See also setIconProvider().

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

Reimplements: QAbstractItemModel::index(int row, int column, const QModelIndex &parent) const.

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

This is an overloaded function.

Returns the model item index for the given path and column.

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

Returns true if the model item index represents a directory; otherwise returns false.

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

Returns the date and time when index was last modified.

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

Reimplements: QAbstractItemModel::mimeData(const QModelIndexList &indexes) const.

Returns an object that contains a serialized description of the specified indexes. The format used to describe the items corresponding to the indexes is obtained from the mimeTypes() function.

If the list of indexes is empty, nullptr is returned rather than a serialized empty list.

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

Reimplements: QAbstractItemModel::mimeTypes() const.

Returns a list of MIME types that can be used to describe a list of items in the model.

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

Create a directory with the name in the parent model index.

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

Returns the data stored under the given role for the item "My Computer".

See also Qt::ItemDataRole.

QStringList QFileSystemModel::nameFilters() const

Returns a list of filters applied to the names in the model.

See also setNameFilters().

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

Reimplements: QAbstractItemModel::parent(const QModelIndex &index) const.

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

Returns the complete OR-ed together combination of QFile::Permission for the index.

bool QFileSystemModel::remove(const QModelIndex &index)

Removes the model item index from the file system model and deletes the corresponding file from the file system, returning true if successful. If the item cannot be removed, false is returned.

See also rmdir().

bool QFileSystemModel::rmdir(const QModelIndex &index)

Removes the directory corresponding to the model item index in the file system model and deletes the corresponding directory from the file system, returning true if successful. If the directory cannot be removed, false is returned.

See also remove().

[override virtual] QHash<int, QByteArray> QFileSystemModel::roleNames() const

Reimplements: QAbstractItemModel::roleNames() const.

QDir QFileSystemModel::rootDirectory() const

The currently set directory

See also rootPath().

QString QFileSystemModel::rootPath() const

The currently set root path

See also setRootPath() and rootDirectory().

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

Reimplements: QAbstractItemModel::rowCount(const QModelIndex &parent) const.

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

Reimplements: QAbstractItemModel::setData(const QModelIndex &index, const QVariant &value, int role).

See also data().

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

Sets the directory model's filter to that specified by filters.

Note that the filter you set should always include the QDir::AllDirs enum value, otherwise QFileSystemModel won't be able to read the directory structure.

See also filter() and QDir::Filters.

void QFileSystemModel::setIconProvider(QAbstractFileIconProvider *provider)

Sets the provider of file icons for the directory model.

See also iconProvider().

void QFileSystemModel::setNameFilters(const QStringList &filters)

Sets the name filters to apply against the existing files.

See also nameFilters().

[since 5.14] void QFileSystemModel::setOption(QFileSystemModel::Option option, bool on = true)

Sets the given option to be enabled if on is true; otherwise, clears the given option.

Options should be set before changing properties.

This function was introduced in Qt 5.14.

See also options and testOption().

QModelIndex QFileSystemModel::setRootPath(const QString &newPath)

Sets the directory that is being watched by the model to newPath by installing a file system watcher on it. Any changes to files and directories within this directory will be reflected in the model.

If the path is changed, the rootPathChanged() signal will be emitted.

See also rootPath().

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

Reimplements: QAbstractItemModel::sibling(int row, int column, const QModelIndex &index) const.

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

Returns the size in bytes of index. If the file does not exist, 0 is returned.

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

Reimplements: QAbstractItemModel::sort(int column, Qt::SortOrder order).

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

Reimplements: QAbstractItemModel::supportedDropActions() const.

[since 5.14] bool QFileSystemModel::testOption(QFileSystemModel::Option option) const

Returns true if the given option is enabled; otherwise, returns false.

This function was introduced in Qt 5.14.

See also options and setOption().

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

Reimplements: QObject::timerEvent(QTimerEvent *event).

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

Returns the type of file index such as "Directory" or "JPEG file".