Qt 4.4: QFileSystemModel Class Reference

|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QFileSystemModel Class Reference
[QtGui module]

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

     #include <QFileSystemModel>

Inherits QAbstractItemModel.

This class was introduced in Qt 4.4.

- List of all members, including inherited members

### Public Types

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

### Properties

- nameFilterDisables : bool
- readOnly : bool
- resolveSymlinks : bool

- 1 property inherited from QObject

### Public Functions

- QFileSystemModel ( QObject * parent = 0 )
- ~QFileSystemModel ()
- virtual bool dropMimeData ( const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent )
- 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
- QDateTime lastModified ( const QModelIndex & index ) const
- virtual QMimeData * mimeData ( const QModelIndexList & indexes ) const
- virtual QStringList mimeTypes () const
- QModelIndex mkdir ( const QModelIndex & parent, const QString & name )
- QVariant myComputer ( int role = Qt::DisplayRole ) const
- bool nameFilterDisables () const
- QStringList nameFilters () const
- QFile::Permissions permissions ( const QModelIndex & index ) const
- bool remove ( const QModelIndex & index ) const
- bool resolveSymlinks () const
- bool rmdir ( const QModelIndex & index ) const
- QDir rootDirectory () const
- QString rootPath () const
- void setFilter ( QDir::Filters filters )
- void setIconProvider ( QFileIconProvider * provider )
- void setNameFilterDisables ( bool enable )
- void setNameFilters ( const QStringList & filters )
- void setReadOnly ( bool enable )
- void setResolveSymlinks ( bool enable )
- QModelIndex setRootPath ( const QString & newPath )
- qint64 size ( const QModelIndex & index ) const
- QString type ( const QModelIndex & index ) const

- 34 public functions inherited from QAbstractItemModel
- 29 public functions inherited from QObject

### Signals

- void fileRenamed ( const QString & path, const QString & oldName, const QString & newName )
- void rootPathChanged ( const QString & newPath )

- 14 signals inherited from QAbstractItemModel
- 1 signal inherited from QObject

### Additional Inherited Members

- 2 public slots inherited from QAbstractItemModel
- 1 public slot inherited from QObject
- 5 static public members inherited from QObject
- 14 protected functions inherited from QAbstractItemModel
- 7 protected functions inherited from QObject

## 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 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 the QDirModel, 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.

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

See also Model Classes.

## Member Type Documentation

### enum QFileSystemModel::Roles

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

## Property Documentation

### nameFilterDisables : bool

This property holds whether files that don't pass the name filter are hidden or disabled.

This property is true by default

Access functions:

- bool nameFilterDisables () const
- void setNameFilterDisables ( 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

### QFileSystemModel::QFileSystemModel ( QObject * parent = 0 )

Constructs a file system model with the given parent.

### QFileSystemModel::~QFileSystemModel ()

Destroys this file system model.

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

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.

Reimplemented from QAbstractItemModel.

See also supportedDropActions().

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

### void QFileSystemModel::fileRenamed ( const QString & path, const QString & oldName, const QString & newName ) `[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.

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

Returns the filter specification for the directory model.

See also setFilter() and QDir::Filters.

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

Returns the file icon provider for this directory model.

See also setIconProvider().

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

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.

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

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.

Reimplemented from QAbstractItemModel.

### QStringList QFileSystemModel::mimeTypes () const `[virtual]`

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

Reimplemented from QAbstractItemModel.

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

### 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 ) const

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::rmdir ( const QModelIndex & index ) const

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

The currently set directory

See also rootPath().

### QString QFileSystemModel::rootPath () const

The currently set root path

See also setRootPath() and rootDirectory().

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

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

### 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 ( QFileIconProvider * 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().

### QModelIndex QFileSystemModel::setRootPath ( const QString & newPath )

Sets the directory that is being watched by the model to newPath. If the path is changed the model will be reset.

See also rootPath().

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

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

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

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