Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Detailed Description

Detailed Description

TheQDirModel class provides a data model for the local filesystem.

The usage ofQDirModel is not recommended anymore. TheQFileSystemModel 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 withrefresh().

QDirModel can be accessed using the standard interface provided byQAbstractItemModel, but it also provides some convenience functions that are specific to a directory model. ThefileInfo() andisDir() functions provide information about the underlying files and directories related to items in the model.

Directories can be created and removed usingmkdir(),rmdir(), and the model will be automatically updated to take the changes into account.

Note:QDirModel requires an instance of a GUI application.

Member Type Documentation

enum QDirModel::Roles

Property Documentation

lazyChildCount :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:

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:

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:

Member Function Documentation

QDirModel::QDirModel(constQStringList & nameFilters,QDir::Filters filters,QDir::SortFlags sort,QObject * parent = 0)

Constructs a new directory model with the givenparent. Only those files matching thenameFilters and thefilters are included in the model. The sort order is given by thesort flags.

QDirModel::QDirModel(QObject * parent = 0)

Constructs a directory model with the givenparent.

QDirModel::~QDirModel()

Destroys this directory model.

[virtual]int QDirModel::columnCount(constQModelIndex & parent = QModelIndex()) const

Reimplemented fromQAbstractItemModel::columnCount().

Returns the number of columns in theparent model item.

[virtual]QVariant QDirModel::data(constQModelIndex & index,int role = Qt::DisplayRole) const

Reimplemented fromQAbstractItemModel::data().

Returns the data for the model itemindex with the givenrole.

See alsosetData().

[virtual]bool QDirModel::dropMimeData(constQMimeData * data,Qt::DropAction action,int row,int column, constQModelIndex & parent)

Reimplemented fromQAbstractItemModel::dropMimeData().

Handles thedata supplied by a drag and drop operation that ended with the givenaction over the row in the model specified by therow andcolumn and by theparent index.

See alsosupportedDropActions().

QIcon QDirModel::fileIcon(constQModelIndex & index) const

Returns the icons for the item stored in the model under the givenindex.

QFileInfo QDirModel::fileInfo(constQModelIndex & index) const

Returns the file information for the specified modelindex.

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 whetherresolveSymlinks is enabled or not.

See alsoQFileInfo::symLinkTarget().

QString QDirModel::fileName(constQModelIndex & index) const

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

QString QDirModel::filePath(constQModelIndex & index) const

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

QDir::Filters QDirModel::filter() const

Returns the filter specification for the directory model.

See alsosetFilter() andQDir::Filters.

[virtual]Qt::ItemFlags QDirModel::flags(constQModelIndex & index) const

Reimplemented fromQAbstractItemModel::flags().

Returns the item flags for the givenindex in the model.

See alsoQt::ItemFlags.

[virtual]bool QDirModel::hasChildren(constQModelIndex & parent = QModelIndex()) const

Reimplemented fromQAbstractItemModel::hasChildren().

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

[virtual]QVariant QDirModel::headerData(int section,Qt::Orientation orientation,int role = Qt::DisplayRole) const

Reimplemented fromQAbstractItemModel::headerData().

Returns the data stored under the givenrole for the specifiedsection of the header with the givenorientation.

QFileIconProvider * QDirModel::iconProvider() const

Returns the file icon provider for this directory model.

See alsosetIconProvider().

[virtual]QModelIndex QDirModel::index(int row,int column, constQModelIndex & parent = QModelIndex()) const

Reimplemented fromQAbstractItemModel::index().

Returns the model item index for the item in theparent with the givenrow andcolumn.

QModelIndex QDirModel::index(constQString & path,int column = 0) const

This is an overloaded function.

Returns the model item index for the givenpath.

bool QDirModel::isDir(constQModelIndex & index) const

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

[virtual]QMimeData * QDirModel::mimeData(constQModelIndexList & indexes) const

Reimplemented fromQAbstractItemModel::mimeData().

Returns an object that contains a serialized description of the specifiedindexes. The format used to describe the items corresponding to the indexes is obtained from themimeTypes() function.

If the list of indexes is empty, 0 is returned rather than a serialized empty list.

[virtual]QStringList QDirModel::mimeTypes() const

Reimplemented fromQAbstractItemModel::mimeTypes().

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

QModelIndex QDirModel::mkdir(constQModelIndex & parent, constQString & name)

Create a directory with thename in theparent model item.

QStringList QDirModel::nameFilters() const

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

See alsosetNameFilters().

[virtual]QModelIndex QDirModel::parent(constQModelIndex & child) const

Reimplemented fromQAbstractItemModel::parent().

Return the parent of the givenchild model item.

[slot]void QDirModel::refresh(constQModelIndex & parent = QModelIndex())

QDirModel caches file information. This function updates the cache. Theparent 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(constQModelIndex & index)

Removes the model itemindex from the directory model anddeletes 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 doesnot move them to a location where they can be recovered.

See alsormdir().

bool QDirModel::rmdir(constQModelIndex & index)

Removes the directory corresponding to the model itemindex in the directory model anddeletes 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 doesnot move them to a location where they can be recovered.

See alsoremove().

[virtual]int QDirModel::rowCount(constQModelIndex & parent = QModelIndex()) const

Reimplemented fromQAbstractItemModel::rowCount().

Returns the number of rows in theparent model item.

[virtual]bool QDirModel::setData(constQModelIndex & index, constQVariant & value,int role = Qt::EditRole)

Reimplemented fromQAbstractItemModel::setData().

Sets the data for the model itemindex with the givenrole to the data referenced by thevalue. Returns true if successful; otherwise returns false.

See alsodata() andQt::ItemDataRole.

void QDirModel::setFilter(QDir::Filters filters)

Sets the directory model's filter to that specified byfilters.

Note that the filter you set should always include theQDir::AllDirs enum value, otherwiseQDirModel won't be able to read the directory structure.

See alsofilter() andQDir::Filters.

void QDirModel::setIconProvider(QFileIconProvider * provider)

Sets theprovider of file icons for the directory model.

See alsoiconProvider().

void QDirModel::setNameFilters(constQStringList & filters)

Sets the namefilters for the directory model.

See alsonameFilters().

void QDirModel::setSorting(QDir::SortFlags sort)

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

See alsosorting() andQDir::SortFlags.

[virtual]void QDirModel::sort(int column,Qt::SortOrder order = Qt::AscendingOrder)

Reimplemented fromQAbstractItemModel::sort().

Sort the model items in thecolumn using theorder given. The order is a value defined inQt::SortOrder.

QDir::SortFlags QDirModel::sorting() const

Returns the sorting method used for the directory model.

See alsosetSorting() andQDir::SortFlags.

[virtual]Qt::DropActions QDirModel::supportedDropActions() const

Reimplemented fromQAbstractItemModel::supportedDropActions().

Returns the drop actions supported by this model.

See alsoQt::DropActions.