|  | Home · All Classes · Modules

# QDirModel Class Reference
[QtGui module]

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

Inherits QAbstractItemModel.

### Types

- enum Roles { FileIconRole, FilePathRole, FileNameRole }

### Methods

- __init__ (self, QStringList, QDir.Filters, QDir.SortFlags, QObject parent = None)
- __init__ (self, QObject parent = None)
- int columnCount (self, QModelIndex parent = QModelIndex())
- QVariant data (self, QModelIndex, int role = Qt.DisplayRole)
- bool dropMimeData (self, QMimeData, Qt.DropAction, int, int, QModelIndex)
- QIcon fileIcon (self, QModelIndex)
- QFileInfo fileInfo (self, QModelIndex)
- QString fileName (self, QModelIndex)
- QString filePath (self, QModelIndex)
- QDir.Filters filter (self)
- Qt.ItemFlags flags (self, QModelIndex)
- bool hasChildren (self, QModelIndex parent = QModelIndex())
- QVariant headerData (self, int, Qt.Orientation, int role = Qt.DisplayRole)
- QFileIconProvider iconProvider (self)
- QModelIndex index (self, int, int, QModelIndex parent = QModelIndex())
- QModelIndex index (self, QString, int column = 0)
- bool isDir (self, QModelIndex)
- bool isReadOnly (self)
- bool lazyChildCount (self)
- QMimeData mimeData (self, list-of-QModelIndex)
- QStringList mimeTypes (self)
- QModelIndex mkdir (self, QModelIndex, QString)
- QStringList nameFilters (self)
- QModelIndex parent (self, QModelIndex)
- QObject parent (self)
- refresh (self, QModelIndex parent = QModelIndex())
- bool remove (self, QModelIndex)
- bool resolveSymlinks (self)
- bool rmdir (self, QModelIndex)
- int rowCount (self, QModelIndex parent = QModelIndex())
- bool setData (self, QModelIndex, QVariant, int role = Qt.EditRole)
- setFilter (self, QDir.Filters)
- setIconProvider (self, QFileIconProvider)
- setLazyChildCount (self, bool)
- setNameFilters (self, QStringList)
- setReadOnly (self, bool)
- setResolveSymlinks (self, bool)
- setSorting (self, QDir.SortFlags)
- sort (self, int, Qt.SortOrder order = Qt.AscendingOrder)
- QDir.SortFlags sorting (self)
- Qt.DropActions supportedDropActions (self)

## Detailed Description

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

Note: 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().

A directory model that displays the contents of a default directory is usually constructed with a parent object:

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

A tree view can be used to display the contents of the model

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

and the contents of a particular directory can be displayed by setting the tree view's root index:

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

The view's root index can be used to control how much of a hierarchical model is displayed. QDirModel provides a convenience function that returns a suitable model index for a path to a directory within the model.

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 a GUI application.

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

## Type Documentation

### QDirModel.Roles

Constant | Value
--- | ---
`QDirModel.FileIconRole` | `Qt.DecorationRole`
`QDirModel.FilePathRole` | `Qt.UserRole + 1`
`QDirModel.FileNameRole` | ?

## Method Documentation

### QDirModel.__init__ (self, QStringList, QDir.Filters, QDir.SortFlags, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a directory model with the given parent.

### int QDirModel.columnCount (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.columnCount().

Returns the number of columns in the parent model item.

### QVariant QDirModel.data (self, QModelIndex, int role = Qt.DisplayRole)

Reimplemented from QAbstractItemModel.data().

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

See also setData().

### bool QDirModel.dropMimeData (self, QMimeData, Qt.DropAction, int, int, QModelIndex)

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.

See also supportedDropActions().

### QIcon QDirModel.fileIcon (self, QModelIndex)

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

### QFileInfo QDirModel.fileInfo (self, QModelIndex)

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 (self, QModelIndex)

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

### QString QDirModel.filePath (self, QModelIndex)

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

### QDir.Filters QDirModel.filter (self)

Returns the filter specification for the directory model.

See also setFilter() and QDir.Filters.

### Qt.ItemFlags QDirModel.flags (self, QModelIndex)

Reimplemented from QAbstractItemModel.flags().

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

See also Qt.ItemFlags.

### bool QDirModel.hasChildren (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.hasChildren().

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

### QVariant QDirModel.headerData (self, int, Qt.Orientation, int role = Qt.DisplayRole)

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 (self)

Returns the file icon provider for this directory model.

See also setIconProvider().

### QModelIndex QDirModel.index (self, int, int, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.index().

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

### QModelIndex QDirModel.index (self, QString, int column = 0)

This is an overloaded function.

Returns the model item index for the given path.

### bool QDirModel.isDir (self, QModelIndex)

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

### bool QDirModel.isReadOnly (self)

### bool QDirModel.lazyChildCount (self)

### QMimeData QDirModel.mimeData (self, list-of-QModelIndex)

The QMimeData result

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.

### QStringList QDirModel.mimeTypes (self)

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 (self, QModelIndex, QString)

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

### QStringList QDirModel.nameFilters (self)

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

See also setNameFilters().

### QModelIndex QDirModel.parent (self, QModelIndex)

Reimplemented from QAbstractItemModel.parent().

Return the parent of the given child model item.

### QObject QDirModel.parent (self)

### QDirModel.refresh (self, 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 (self, QModelIndex)

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.resolveSymlinks (self)

### bool QDirModel.rmdir (self, QModelIndex)

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().

### int QDirModel.rowCount (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.rowCount().

Returns the number of rows in the parent model item.

### bool QDirModel.setData (self, QModelIndex, QVariant, 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.

### QDirModel.setFilter (self, QDir.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.

### QDirModel.setIconProvider (self, QFileIconProvider)

Sets the provider of file icons for the directory model.

See also iconProvider().

### QDirModel.setLazyChildCount (self, bool)

### QDirModel.setNameFilters (self, QStringList)

Sets the name filters for the directory model.

See also nameFilters().

### QDirModel.setReadOnly (self, bool)

### QDirModel.setResolveSymlinks (self, bool)

### QDirModel.setSorting (self, QDir.SortFlags)

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

See also sorting() and QDir.SortFlags.

### QDirModel.sort (self, int, 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 (self)

Returns the sorting method used for the directory model.

See also setSorting() and QDir.SortFlags.

### Qt.DropActions QDirModel.supportedDropActions (self)

Reimplemented from QAbstractItemModel.supportedDropActions().

Returns the drop actions supported by this model.

See also Qt.DropActions.