|  | Home · All Classes · Modules

# QFileSystemModel Class Reference
[QtGui module]

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

Inherits QAbstractItemModel.

### Types

- enum Roles { FileIconRole, FilePathRole, FileNameRole, FilePermissions }

### Methods

- __init__ (self, QObject parent = None)
- bool canFetchMore (self, QModelIndex parent)
- int columnCount (self, QModelIndex parent = QModelIndex())
- QVariant data (self, QModelIndex index, int role = Qt.DisplayRole)
- bool dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, QModelIndex parent)
- bool event (self, QEvent event)
- fetchMore (self, QModelIndex parent)
- QIcon fileIcon (self, QModelIndex aindex)
- QFileInfo fileInfo (self, QModelIndex aindex)
- QString fileName (self, QModelIndex aindex)
- QString filePath (self, QModelIndex index)
- QDir.Filters filter (self)
- Qt.ItemFlags flags (self, QModelIndex index)
- bool hasChildren (self, QModelIndex parent = QModelIndex())
- QVariant headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)
- QFileIconProvider iconProvider (self)
- QModelIndex index (self, int row, int column, QModelIndex parent = QModelIndex())
- QModelIndex index (self, QString path, int column = 0)
- bool isDir (self, QModelIndex index)
- bool isReadOnly (self)
- QDateTime lastModified (self, QModelIndex index)
- QMimeData mimeData (self, unknown-type indexes)
- QStringList mimeTypes (self)
- QModelIndex mkdir (self, QModelIndex parent, QString name)
- QVariant myComputer (self, int role = Qt.DisplayRole)
- bool nameFilterDisables (self)
- QStringList nameFilters (self)
- QModelIndex parent (self, QModelIndex child)
- QFile.Permissions permissions (self, QModelIndex index)
- bool remove (self, QModelIndex aindex)
- bool resolveSymlinks (self)
- bool rmdir (self, QModelIndex aindex)
- QDir rootDirectory (self)
- QString rootPath (self)
- int rowCount (self, QModelIndex parent = QModelIndex())
- bool setData (self, QModelIndex idx, QVariant value, int role = Qt.EditRole)
- setFilter (self, QDir.Filters filters)
- setIconProvider (self, QFileIconProvider provider)
- setNameFilterDisables (self, bool enable)
- setNameFilters (self, QStringList filters)
- setReadOnly (self, bool enable)
- setResolveSymlinks (self, bool enable)
- QModelIndex setRootPath (self, QString path)
- int size (self, QModelIndex index)
- sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)
- Qt.DropActions supportedDropActions (self)
- timerEvent (self, QTimerEvent event)
- QString type (self, QModelIndex index)

### Qt Signals

- void directoryLoaded (const QString&)
- void fileRenamed (const QString&,const QString&,const QString&)
- void rootPathChanged (const QString&)

## Detailed Description

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

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 filter.

QFileSystemModel 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(), isDir(), name(), and path() functions provide information about the underlying files and directories related to items in the model. Directories can be created and removed using mkdir(), rmdir().

Note: QFileSystemModel requires an instance of a GUI application.

### Example Usage

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(obsolete) provides a convenience function that returns a suitable model index for a path to a directory within the model.

### Caching and Performance

QFileSystemModel will not fetch any files or directories until setRootPath() is called. This will prevent any unnecessary querying on the file system until that point such as listing the drives on Windows.

Unlike QDirModel(obsolete), QFileSystemModel uses a separate thread to populate itself so it will not cause the main thread to hang as the file system is being queried. Calls to rowCount() will return 0 until the model populates a directory.

QFileSystemModel keeps a cache with file information. The cache is automatically kept up to date using the QFileSystemWatcher.

## Type Documentation

### QFileSystemModel.Roles

Constant | Value
--- | ---
`QFileSystemModel.FileIconRole` | `Qt.DecorationRole`
`QFileSystemModel.FilePathRole` | `Qt.UserRole + 1`
`QFileSystemModel.FileNameRole` | `Qt.UserRole + 2`
`QFileSystemModel.FilePermissions` | `Qt.UserRole + 3`

## Method Documentation

### QFileSystemModel.__init__ (self, QObject parent = None)

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

Constructs a file system model with the given parent.

### bool QFileSystemModel.canFetchMore (self, QModelIndex parent)

Reimplemented from QAbstractItemModel.canFetchMore().

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

Reimplemented from QAbstractItemModel.columnCount().

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

Reimplemented from QAbstractItemModel.data().

See also setData().

### bool QFileSystemModel.dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, 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.

See also supportedDropActions().

### bool QFileSystemModel.event (self, QEvent event)

Reimplemented from QObject.event().

### QFileSystemModel.fetchMore (self, QModelIndex parent)

Reimplemented from QAbstractItemModel.fetchMore().

### QIcon QFileSystemModel.fileIcon (self, QModelIndex aindex)

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

### QFileInfo QFileSystemModel.fileInfo (self, QModelIndex aindex)

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

### QString QFileSystemModel.fileName (self, QModelIndex aindex)

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

### QString QFileSystemModel.filePath (self, QModelIndex index)

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

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

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.

### Qt.ItemFlags QFileSystemModel.flags (self, QModelIndex index)

Reimplemented from QAbstractItemModel.flags().

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

Reimplemented from QAbstractItemModel.hasChildren().

### QVariant QFileSystemModel.headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)

Reimplemented from QAbstractItemModel.headerData().

### QFileIconProvider QFileSystemModel.iconProvider (self)

Returns the file icon provider for this directory model.

See also setIconProvider().

### QModelIndex QFileSystemModel.index (self, int row, int column, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.index().

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

This is an overloaded function.

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

### bool QFileSystemModel.isDir (self, QModelIndex index)

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

### bool QFileSystemModel.isReadOnly (self)

### QDateTime QFileSystemModel.lastModified (self, QModelIndex index)

Returns the date and time when index was last modified.

### QMimeData QFileSystemModel.mimeData (self, unknown-type indexes)

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 QFileSystemModel.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 QFileSystemModel.mkdir (self, QModelIndex parent, QString name)

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

### QVariant QFileSystemModel.myComputer (self, int role = Qt.DisplayRole)

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

See also Qt.ItemDataRole.

### bool QFileSystemModel.nameFilterDisables (self)

### QStringList QFileSystemModel.nameFilters (self)

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

See also setNameFilters().

### QModelIndex QFileSystemModel.parent (self, QModelIndex child)

Reimplemented from QAbstractItemModel.parent().

### QFile.Permissions QFileSystemModel.permissions (self, QModelIndex index)

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

### bool QFileSystemModel.remove (self, QModelIndex aindex)

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.

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

### bool QFileSystemModel.rmdir (self, QModelIndex aindex)

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.

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

### QDir QFileSystemModel.rootDirectory (self)

The currently set directory

See also rootPath().

### QString QFileSystemModel.rootPath (self)

The currently set root path

See also setRootPath() and rootDirectory().

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

Reimplemented from QAbstractItemModel.rowCount().

### bool QFileSystemModel.setData (self, QModelIndex idx, QVariant value, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.setData().

See also data().

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

### QFileSystemModel.setIconProvider (self, QFileIconProvider provider)

Sets the provider of file icons for the directory model.

See also iconProvider().

### QFileSystemModel.setNameFilterDisables (self, bool enable)

### QFileSystemModel.setNameFilters (self, QStringList filters)

Sets the name filters to apply against the existing files.

See also nameFilters().

### QFileSystemModel.setReadOnly (self, bool enable)

### QFileSystemModel.setResolveSymlinks (self, bool enable)

### QModelIndex QFileSystemModel.setRootPath (self, QString path)

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.

Note: This function does not change the structure of the model or modify the data available to views. In other words, the "root" of the model is not changed to include only files and directories within the directory specified by newPath in the file system.

See also rootPath().

### int QFileSystemModel.size (self, QModelIndex index)

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

### QFileSystemModel.sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)

Reimplemented from QAbstractItemModel.sort().

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

Reimplemented from QAbstractItemModel.supportedDropActions().

### QFileSystemModel.timerEvent (self, QTimerEvent event)

Reimplemented from QObject.timerEvent().

### QString QFileSystemModel.type (self, QModelIndex index)

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

## Qt Signal Documentation

### void directoryLoaded (const QString&)

This is the default overload of this signal.

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

This function was introduced in Qt 4.7.

### void fileRenamed (const QString&,const QString&,const QString&)

This is the default overload of this signal.

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

### void rootPathChanged (const QString&)

This is the default overload of this signal.

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