QDirModel Class | Qt Widgets 5.12.8

Qt 5.12 | Qt Widgets | C++ Classes | QDirModel

Qt 5.12.8 Reference Documentation

# QDirModel Class

The QDirModel class provides a data model for the local filesystem. More...

Header: | #include <QDirModel>
qmake: | QT += widgets
Inherits: | QAbstractItemModel

This class is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

- List of all members, including inherited members
- Obsolete members

## Public Types

enum | Roles { FileIconRole, FilePathRole, FileNameRole }

## Properties

- lazyChildCount : bool
- readOnly : bool
- resolveSymlinks : bool

- 1 property inherited from QObject

## Public Functions

| QDirModel(const QStringList &nameFilters, QDir::Filters filters, QDir::SortFlags sort, QObject *parent = nullptr)
| QDirModel(QObject *parent = nullptr)
virtual | ~QDirModel()
QIcon | fileIcon(const QModelIndex &index) const
QFileInfo | fileInfo(const QModelIndex &index) const
QString | fileName(const QModelIndex &index) const
QString | filePath(const QModelIndex &index) const
QDir::Filters | filter() const
QFileIconProvider * | iconProvider() const
QModelIndex | index(const QString &path, int column = 0) const
bool | isDir(const QModelIndex &index) const
bool | isReadOnly() const
bool | lazyChildCount() const
QModelIndex | mkdir(const QModelIndex &parent, const QString &name)
QStringList | nameFilters() const
bool | remove(const QModelIndex &index)
bool | resolveSymlinks() const
bool | rmdir(const QModelIndex &index)
void | setFilter(QDir::Filters filters)
void | setIconProvider(QFileIconProvider *provider)
void | setLazyChildCount(bool enable)
void | setNameFilters(const QStringList &filters)
void | setReadOnly(bool enable)
void | setResolveSymlinks(bool enable)
void | setSorting(QDir::SortFlags sort)
QDir::SortFlags | sorting() const

## Reimplemented Public Functions

virtual int | columnCount(const QModelIndex &parent = QModelIndex()) const override
virtual QVariant | data(const QModelIndex &index, int role = Qt::DisplayRole) const override
virtual bool | dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
virtual Qt::ItemFlags | flags(const QModelIndex &index) const override
virtual bool | hasChildren(const QModelIndex &parent = QModelIndex()) const override
virtual QVariant | headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override
virtual QModelIndex | index(int row, int column, const QModelIndex &parent = QModelIndex()) const override
virtual QMimeData * | mimeData(const QModelIndexList &indexes) const override
virtual QStringList | mimeTypes() const override
virtual QModelIndex | parent(const QModelIndex &child) const override
virtual int | rowCount(const QModelIndex &parent = QModelIndex()) const override
virtual bool | setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override
virtual void | sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override
virtual Qt::DropActions | supportedDropActions() const override

- 40 public functions inherited from QAbstractItemModel
- 31 public functions inherited from QObject

## Public Slots

void | refresh(const QModelIndex &parent = QModelIndex())

- 2 public slots inherited from QAbstractItemModel
- 1 public slot inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 18 signals inherited from QAbstractItemModel
- 2 signals inherited from QObject
- 19 protected functions inherited from QAbstractItemModel
- 9 protected functions inherited from QObject
- 1 protected slot inherited from QAbstractItemModel

## Detailed Description

The QDirModel class provides a data model for the local filesystem.

The usage of QDirModel is not recommended anymore. The QFileSystemModel class is a more performant alternative.

This class provides access to the local filesystem, providing functions for renaming and removing files and directories, and for creating new directories. In the simplest case, it can be used with a suitable display widget as part of a browser or filer.

QDirModel keeps a cache with file information. The cache needs to be updated with refresh().

QDirModel can be accessed using the standard interface provided by QAbstractItemModel, but it also provides some convenience functions that are specific to a directory model. The fileInfo() and isDir() functions provide information about the underlying files and directories related to items in the model.

Directories can be created and removed using mkdir(), rmdir(), and the model will be automatically updated to take the changes into account.

Note: QDirModel requires an instance of QApplication.

See also nameFilters(), setFilter(), filter(), QListView, QTreeView, QFileSystemModel, Dir View Example, and Model Classes.

## Member Type Documentation

### enum QDirModel::Roles

Constant | Value
--- | ---
`QDirModel::FileIconRole` | `Qt::DecorationRole`
`QDirModel::FilePathRole` | `Qt::UserRole + 1`
`QDirModel::FileNameRole` | `258`

## Property Documentation

### lazyChildCount : bool

This property holds whether the directory model optimizes the hasChildren function to only check if the item is a directory.

If this property is set to false, the directory model will make sure that a directory actually containes any files before reporting that it has children. Otherwise the directory model will report that an item has children if the item is a directory.

This property is `false` by default

Access functions:

bool | lazyChildCount() const
void | setLazyChildCount(bool enable)

### readOnly : bool

This property holds whether the directory model allows writing to the file system

If this property is set to false, the directory model will allow renaming, copying and deleting of files and directories.

This property is `true` by default

Access functions:

bool | isReadOnly() const
void | setReadOnly(bool enable)

### resolveSymlinks : bool

This property holds whether the directory model should resolve symbolic links

This is only relevant on operating systems that support symbolic links.

Access functions:

bool | resolveSymlinks() const
void | setResolveSymlinks(bool enable)

## Member Function Documentation

### QDirModel::QDirModel(const QStringList &nameFilters, QDir::Filters filters, QDir::SortFlags sort, QObject *parent = nullptr)

Constructs a new directory model with the given parent. Only those files matching the nameFilters and the filters are included in the model. The sort order is given by the sort flags.

### QDirModel::QDirModel(QObject *parent = nullptr)

Constructs a directory model with the given parent.

### `[virtual]` QDirModel::~QDirModel()

Destroys this directory model.

### `[override virtual]` int QDirModel::columnCount(const QModelIndex &parent = QModelIndex()) const

Reimplemented from QAbstractItemModel::columnCount().

Returns the number of columns in the parent model item.

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

Reimplemented from QAbstractItemModel::data().

Returns the data for the model item index with the given role.

See also setData().

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

Reimplemented from QAbstractItemModel::dropMimeData().

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 drop was successful, and false otherwise.

See also supportedDropActions().

### QIcon QDirModel::fileIcon(const QModelIndex &index) const

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

### QFileInfo QDirModel::fileInfo(const QModelIndex &index) const

Returns the file information for the specified model index.

Note: If the model index represents a symbolic link in the underlying filing system, the file information returned will contain information about the symbolic link itself, regardless of whether resolveSymlinks is enabled or not.

See also QFileInfo::symLinkTarget().

### QString QDirModel::fileName(const QModelIndex &index) const

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

### QString QDirModel::filePath(const QModelIndex &index) const

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

### QDir::Filters QDirModel::filter() const

Returns the filter specification for the directory model.

See also setFilter() and QDir::Filters.

### `[override virtual]` Qt::ItemFlags QDirModel::flags(const QModelIndex &index) const

Reimplemented from QAbstractItemModel::flags().

Returns the item flags for the given index in the model.

See also Qt::ItemFlags.

### `[override virtual]` bool QDirModel::hasChildren(const QModelIndex &parent = QModelIndex()) const

Reimplemented from QAbstractItemModel::hasChildren().

Returns `true` if the parent model item has children; otherwise returns `false`.

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

Reimplemented from QAbstractItemModel::headerData().

Returns the data stored under the given role for the specified section of the header with the given orientation.

### QFileIconProvider *QDirModel::iconProvider() const

Returns the file icon provider for this directory model.

See also setIconProvider().

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

Reimplemented from QAbstractItemModel::index().

Returns the model item index for the item in the parent with the given row and column.

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

This is an overloaded function.

Returns the model item index for the given path.

### bool QDirModel::isDir(const QModelIndex &index) const

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

### `[override virtual]` QMimeData *QDirModel::mimeData(const QModelIndexList &indexes) const

Reimplemented from QAbstractItemModel::mimeData().

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, 0 is returned rather than a serialized empty list.

### `[override virtual]` QStringList QDirModel::mimeTypes() const

Reimplemented from QAbstractItemModel::mimeTypes().

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

### QModelIndex QDirModel::mkdir(const QModelIndex &parent, const QString &name)

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

### QStringList QDirModel::nameFilters() const

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

See also setNameFilters().

### `[override virtual]` QModelIndex QDirModel::parent(const QModelIndex &child) const

Reimplemented from QAbstractItemModel::parent().

Return the parent of the given child model item.

### `[slot]` void QDirModel::refresh(const QModelIndex &parent = QModelIndex())

QDirModel caches file information. This function updates the cache. The parent parameter is the directory from which the model is updated; the default value will update the model from root directory of the file system (the entire model).

### bool QDirModel::remove(const QModelIndex &index)

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

Warning: This function deletes files from the file system; it does not move them to a location where they can be recovered.

See also rmdir().

### bool QDirModel::rmdir(const QModelIndex &index)

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

Warning: This function deletes directories from the file system; it does not move them to a location where they can be recovered.

See also remove().

### `[override virtual]` int QDirModel::rowCount(const QModelIndex &parent = QModelIndex()) const

Reimplemented from QAbstractItemModel::rowCount().

Returns the number of rows in the parent model item.

### `[override virtual]` bool QDirModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)

Reimplemented from QAbstractItemModel::setData().

Sets the data for the model item index with the given role to the data referenced by the value. Returns `true` if successful; otherwise returns `false`.

See also data() and Qt::ItemDataRole.

### void QDirModel::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 QDirModel won't be able to read the directory structure.

See also filter() and QDir::Filters.

### void QDirModel::setIconProvider(QFileIconProvider *provider)

Sets the provider of file icons for the directory model.

See also iconProvider().

### void QDirModel::setNameFilters(const QStringList &filters)

Sets the name filters for the directory model.

See also nameFilters().

### void QDirModel::setSorting(QDir::SortFlags sort)

Sets the directory model's sorting order to that specified by sort.

See also sorting() and QDir::SortFlags.

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

Reimplemented from QAbstractItemModel::sort().

Sort the model items in the column using the order given. The order is a value defined in Qt::SortOrder.

### QDir::SortFlags QDirModel::sorting() const

Returns the sorting method used for the directory model.

See also setSorting() and QDir::SortFlags.

### `[override virtual]` Qt::DropActions QDirModel::supportedDropActions() const

Reimplemented from QAbstractItemModel::supportedDropActions().

Returns the drop actions supported by this model.

See also Qt::DropActions.