QFileSystemModel Class Reference

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

  1. #include <QFileSystemModel>

Inherits: QAbstractItemModel.

This class was introduced in Qt 4.4.

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:

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

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

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

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

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

See also Model Classes.

Public Types

Toggle detailsenum QFileSystemModel::

RolesRoles { FileIconRole , FilePathRole Qt::UserRole + , FileNameRole Qt::UserRole + , FilePermissions Qt::UserRole + 3 ...} { FileIconRole , FilePathRole Qt::UserRole + , FileNameRole Qt::UserRole + , FilePermissions Qt::UserRole + 3 }

ConstantValue
QFileSystemModel::FileIconRole Qt::DecorationRole
QFileSystemModel::FilePathRole Qt::UserRole + 1
QFileSystemModel::FileNameRole Qt::UserRole + 2
QFileSystemModel::FilePermissions Qt::UserRole + 3

Look up this member in the source code.

    Properties

    Toggle detailsnameFilterDisablesnameFilterDisables : 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:

    Look up this member in the source code.

    Toggle detailsreadOnlyreadOnly : 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:

    Look up this member in the source code.

    Toggle detailsresolveSymlinksresolveSymlinks : bool

    This property holds Whether the directory model should resolve symbolic links

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

    By default, this property is false.

    Access functions:

    Look up this member in the source code.

      Public Functions

      Toggle details QFileSystemModel

      QFileSystemModelQFileSystemModel ( QObject *parent=0 ) ( QObject *parent=0 )

      Constructs a file system model with the given parent.

      Look up this member in the source code.

      Toggle details QFileSystemModel

      ~QFileSystemModel~QFileSystemModel () ()

      Destroys this file system model.

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      canFetchMorecanFetchMore ( const QModelIndex &parent ) ( const QModelIndex &parent )const [virtual]

      Reimplemented from QAbstractItemModel::canFetchMore().

      Look up this member in the source code.

      Toggle details int QFileSystemModel

      columnCountcolumnCount ( const QModelIndex &parent=QModelIndex() ...) ( const QModelIndex &parent=QModelIndex() )const [virtual]

      Reimplemented from QAbstractItemModel::columnCount().

      Look up this member in the source code.

      Toggle details QVariant QFileSystemModel

      datadata ( const QModelIndex &index , int role=Qt::DisplayRole ...) ( const QModelIndex &index , int role=Qt::DisplayRole )const [virtual]

      Reimplemented from QAbstractItemModel::data().

      See also setData().

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      dropMimeDatadropMimeData ( const QMimeData *data , Qt::DropAction action , int row , int column , const QModelIndex &parent ...) ( const QMimeData *data , Qt::DropAction action , int row , int column , const QModelIndex &parent ) [virtual]

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

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      eventevent ( QEvent *event ) ( QEvent *event ) [virtual protected]

      Reimplemented from QObject::event().

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      fetchMorefetchMore ( const QModelIndex &parent ) ( const QModelIndex &parent ) [virtual]

      Reimplemented from QAbstractItemModel::fetchMore().

      Look up this member in the source code.

      Toggle details QIcon QFileSystemModel

      fileIconfileIcon ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details QFileInfo QFileSystemModel

      fileInfofileInfo ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details QString QFileSystemModel

      fileNamefileName ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details QString QFileSystemModel

      filePathfilePath ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details QDir::Filters QFileSystemModel

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

      Look up this member in the source code.

      Toggle details Qt::ItemFlags QFileSystemModel

      flagsflags ( const QModelIndex &index ) ( const QModelIndex &index )const [virtual]

      Reimplemented from QAbstractItemModel::flags().

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      hasChildrenhasChildren ( const QModelIndex &parent=QModelIndex() ...) ( const QModelIndex &parent=QModelIndex() )const [virtual]

      Reimplemented from QAbstractItemModel::hasChildren().

      Look up this member in the source code.

      Toggle details QVariant QFileSystemModel

      headerDataheaderData ( int section , Qt::Orientation orientation , int role=Qt::DisplayRole ...) ( int section , Qt::Orientation orientation , int role=Qt::DisplayRole )const [virtual]

      Reimplemented from QAbstractItemModel::headerData().

      Look up this member in the source code.

      Toggle details QFileIconProvider * QFileSystemModel

      iconProvidericonProvider () ()const

      Returns the file icon provider for this directory model.

      See also setIconProvider().

      Look up this member in the source code.

      Toggle details QModelIndex QFileSystemModel

      indexindex ( int row , int column , const QModelIndex &parent=QModelIndex() ...) ( int row , int column , const QModelIndex &parent=QModelIndex() )const [virtual]

      Reimplemented from QAbstractItemModel::index().

      Look up this member in the source code.

      Toggle details QModelIndex QFileSystemModel

      indexindex ( const QString &path , int column=0 ...) ( const QString &path , int column=0 )const

      This is an overloaded function.

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

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      isDirisDir ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details QDateTime QFileSystemModel

      lastModifiedlastModified ( const QModelIndex &index ) ( const QModelIndex &index )const

      Returns the date and time when index was last modified.

      Look up this member in the source code.

      Toggle details QMimeData * QFileSystemModel

      mimeDatamimeData ( const QModelIndexList &indexes ...) ( const QModelIndexList &indexes )const [virtual]

      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.

      Look up this member in the source code.

      Toggle details QStringList QFileSystemModel

      mimeTypesmimeTypes () ()const [virtual]

      Reimplemented from QAbstractItemModel::mimeTypes().

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

      Look up this member in the source code.

      Toggle details QModelIndex QFileSystemModel

      mkdirmkdir ( const QModelIndex &parent , const QString &name ...) ( const QModelIndex &parent , const QString &name )

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

      Look up this member in the source code.

      Toggle details QVariant QFileSystemModel

      myComputermyComputer ( int role=Qt::DisplayRole ) ( int role=Qt::DisplayRole )const

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

      See also Qt::ItemDataRole.

      Look up this member in the source code.

      Toggle details QStringList QFileSystemModel

      nameFiltersnameFilters () ()const

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

      See also setNameFilters().

      Look up this member in the source code.

      Toggle details QModelIndex QFileSystemModel

      parentparent ( const QModelIndex &index ) ( const QModelIndex &index )const [virtual]

      Reimplemented from QAbstractItemModel::parent().

      Look up this member in the source code.

      Toggle details QFile::Permissions QFileSystemModel

      permissionspermissions ( const QModelIndex &index ...) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      removeremove ( const QModelIndex &index ) ( 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().

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      rmdirrmdir ( const QModelIndex &index ) ( 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().

      Look up this member in the source code.

      Toggle details QDir QFileSystemModel

      rootDirectoryrootDirectory () ()const

      The currently set directory

      See also rootPath().

      Look up this member in the source code.

      Toggle details QString QFileSystemModel

      rootPathrootPath () ()const

      The currently set root path

      See also setRootPath() and rootDirectory().

      Look up this member in the source code.

      Toggle details int QFileSystemModel

      rowCountrowCount ( const QModelIndex &parent=QModelIndex() ...) ( const QModelIndex &parent=QModelIndex() )const [virtual]

      Reimplemented from QAbstractItemModel::rowCount().

      Look up this member in the source code.

      Toggle details bool QFileSystemModel

      setDatasetData ( const QModelIndex &idx , const QVariant &value , int role=Qt::EditRole ...) ( const QModelIndex &idx , const QVariant &value , int role=Qt::EditRole ) [virtual]

      Reimplemented from QAbstractItemModel::setData().

      See also data().

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      setFiltersetFilter ( QDir::Filters filters ) ( 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.

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      setIconProvidersetIconProvider ( QFileIconProvider *provider ) ( QFileIconProvider *provider )

      Sets the provider of file icons for the directory model.

      See also iconProvider().

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      setNameFilterssetNameFilters ( const QStringList &filters ) ( const QStringList &filters )

      Sets the name filters to apply against the existing files.

      See also nameFilters().

      Look up this member in the source code.

      Toggle details QModelIndex QFileSystemModel

      setRootPathsetRootPath ( const QString &newPath ) ( 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.

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

      Look up this member in the source code.

      Toggle details qint64 QFileSystemModel

      sizesize ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      sortsort ( int column , Qt::SortOrder order=Qt::AscendingOrder ...) ( int column , Qt::SortOrder order=Qt::AscendingOrder ) [virtual]

      Reimplemented from QAbstractItemModel::sort().

      Look up this member in the source code.

      Toggle details Qt::DropActions QFileSystemModel

      supportedDropActionssupportedDropActions () ()const [virtual]

      Look up this member in the source code.

      Toggle details void QFileSystemModel

      timerEventtimerEvent ( QTimerEvent *event ) ( QTimerEvent *event ) [virtual protected]

      Reimplemented from QObject::timerEvent().

      Look up this member in the source code.

      Toggle details QString QFileSystemModel

      typetype ( const QModelIndex &index ) ( const QModelIndex &index )const

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

      Look up this member in the source code.

        Signals

        Toggle details void QFileSystemModel

        directoryLoadeddirectoryLoaded ( const QString &path ) ( const QString &path ) [signal]

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

        Look up this member in the source code.

        Toggle details void QFileSystemModel

        fileRenamedfileRenamed ( const QString &path , const QString &oldName , const QString &newName ...) ( 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.

        Look up this member in the source code.

        Toggle details void QFileSystemModel

        rootPathChangedrootPathChanged ( const QString &newPath ) ( const QString &newPath ) [signal]

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

        Look up this member in the source code.

          Notes provided by the Qt Community

          No notes