QDirModel Class Reference

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

  1. #include <QDirModel>

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

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

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

Public Types

Toggle detailsenum QDirModel::

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

ConstantValue
QDirModel::FileIconRole Qt::DecorationRole
QDirModel::FilePathRole Qt::UserRole + 1
QDirModel::FileNameRole ?

Look up this member in the source code.

    Properties

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

    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.

    Access functions:

    Look up this member in the source code.

      Public Functions

      Toggle details QDirModel

      QDirModelQDirModel ( const QStringList &nameFilters , QDir::Filters filters , QDir::SortFlags sort , QObject *parent=0 ...) ( const QStringList &nameFilters , QDir::Filters filters , QDir::SortFlags sort , QObject *parent=0 )

      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.

      Look up this member in the source code.

      Toggle details QDirModel

      QDirModelQDirModel ( QObject *parent=0 ) ( QObject *parent=0 )

      Constructs a directory model with the given parent.

      Look up this member in the source code.

      Toggle details QDirModel

      ~QDirModel~QDirModel () ()

      Destroys this directory model.

      Look up this member in the source code.

      Toggle details int QDirModel

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

      Reimplemented from QAbstractItemModel::columnCount().

      Returns the number of columns in the parent model item.

      Look up this member in the source code.

      Toggle details QVariant QDirModel

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

      Reimplemented from QAbstractItemModel::data().

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

      See also setData().

      Look up this member in the source code.

      Toggle details bool QDirModel

      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 QIcon QDirModel

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

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

      Look up this member in the source code.

      Toggle details QFileInfo QDirModel

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

      Look up this member in the source code.

      Toggle details QString QDirModel

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

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

      Look up this member in the source code.

      Toggle details QString QDirModel

      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 QDirModel

      filterfilter () ()const

      Returns the filter specification for the directory model.

      See also setFilter() and QDir::Filters.

      Look up this member in the source code.

      Toggle details Qt::ItemFlags QDirModel

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

      Reimplemented from QAbstractItemModel::flags().

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

      See also Qt::ItemFlags.

      Look up this member in the source code.

      Toggle details bool QDirModel

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

      Reimplemented from QAbstractItemModel::hasChildren().

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

      Look up this member in the source code.

      Toggle details QVariant QDirModel

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

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

      Look up this member in the source code.

      Toggle details QFileIconProvider * QDirModel

      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 QDirModel

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

      Reimplemented from QAbstractItemModel::index().

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

      Look up this member in the source code.

      Toggle details QModelIndex QDirModel

      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.

      Look up this member in the source code.

      Toggle details bool QDirModel

      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 QMimeData * QDirModel

      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 QDirModel

      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 QDirModel

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

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

      Look up this member in the source code.

      Toggle details QStringList QDirModel

      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 QDirModel

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

      Reimplemented from QAbstractItemModel::parent().

      Return the parent of the given child model item.

      Look up this member in the source code.

      Toggle details bool QDirModel

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

      Look up this member in the source code.

      Toggle details bool QDirModel

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

      Look up this member in the source code.

      Toggle details int QDirModel

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

      Reimplemented from QAbstractItemModel::rowCount().

      Returns the number of rows in the parent model item.

      Look up this member in the source code.

      Toggle details bool QDirModel

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

      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.

      Look up this member in the source code.

      Toggle details void QDirModel

      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 QDirModel 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 QDirModel

      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 QDirModel

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

      Sets the name filters for the directory model.

      See also nameFilters().

      Look up this member in the source code.

      Toggle details void QDirModel

      setSortingsetSorting ( QDir::SortFlags sort ) ( QDir::SortFlags sort )

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

      See also sorting() and QDir::SortFlags.

      Look up this member in the source code.

      Toggle details void QDirModel

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

      Reimplemented from QAbstractItemModel::sort().

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

      Look up this member in the source code.

      Toggle details QDir::SortFlags QDirModel

      sortingsorting () ()const

      Returns the sorting method used for the directory model.

      See also setSorting() and QDir::SortFlags.

      Look up this member in the source code.

      Toggle details Qt::DropActions QDirModel

      supportedDropActionssupportedDropActions () ()const [virtual]

      Reimplemented from QAbstractItemModel::supportedDropActions().

      Returns the drop actions supported by this model.

      See also Qt::DropActions.

      Look up this member in the source code.

        Public Slots

        Toggle details void QDirModel

        refreshrefresh ( const QModelIndex &parent=QModelIndex() ...) ( const QModelIndex &parent=QModelIndex() ) [slot]

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

        Look up this member in the source code.

          Notes provided by the Qt Community

          No notes