QDirModel Class

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

頭: #include <QDirModel>
qmake: QT += widgets
繼承: QAbstractItemModel

該類已過時。 提供它是為使舊源代碼能繼續工作。強烈建議不要在新代碼中使用它。

公共類型

enum Roles { FileIconRole, FilePathRole, FileNameRole }

特性

公共函數

QDirModel (const QStringList & nameFilters , QDir::Filters filters , QDir::SortFlags sort , QObject * parent = nullptr)
QDirModel (QObject * parent = nullptr)
virtual ~QDirModel ()
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
bool lazyChildCount () const
QModelIndex mkdir (const QModelIndex & parent , const QString & name )
QStringList nameFilters () const
bool remove (const QModelIndex & index )
bool resolveSymlinks () const
bool rmdir (const QModelIndex & index )
void setFilter (QDir::Filters filters )
void setIconProvider (QFileIconProvider * provider )
void setLazyChildCount (bool enable )
void setNameFilters (const QStringList & filters )
void setReadOnly (bool enable )
void setResolveSymlinks (bool enable )
void setSorting (QDir::SortFlags sort )
QDir::SortFlags sorting () const

重實現公共函數

virtual int columnCount (const QModelIndex & parent = QModelIndex()) const override
virtual QVariant data (const QModelIndex & index , int role = Qt::DisplayRole) const override
virtual bool dropMimeData (const QMimeData * data , Qt::DropAction action , int row , int column , const QModelIndex & parent ) override
virtual Qt::ItemFlags flags (const QModelIndex & index ) const override
virtual bool hasChildren (const QModelIndex & parent = QModelIndex()) const override
virtual QVariant headerData (int section , Qt::Orientation orientation , int role = Qt::DisplayRole) const override
virtual QModelIndex index (int row , int column , const QModelIndex & parent = QModelIndex()) const override
virtual QMimeData * mimeData (const QModelIndexList & indexes ) const override
virtual QStringList mimeTypes () const override
virtual QModelIndex parent (const QModelIndex & child ) const override
virtual int rowCount (const QModelIndex & parent = QModelIndex()) const override
virtual bool setData (const QModelIndex & index , const QVariant & value , int role = Qt::EditRole) override
virtual void sort (int column , Qt::SortOrder order = Qt::AscendingOrder) override
virtual Qt::DropActions supportedDropActions () const override

公共槽

void refresh (const QModelIndex & parent = QModelIndex())

靜態公共成員

const QMetaObject staticMetaObject

額外繼承成員

詳細描述

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

注意: QDirModel requires an instance of QApplication .

另請參閱 nameFilters (), setFilter (), filter (), QListView , QTreeView , QFileSystemModel , 目錄視圖範例 ,和 模型類 .

成員類型文檔編製

enum QDirModel:: Roles

常量
QDirModel::FileIconRole Qt::DecorationRole
QDirModel::FilePathRole Qt::UserRole + 1
QDirModel::FileNameRole 258

特性文檔編製

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.

此特性是 false 默認情況下

訪問函數:

bool lazyChildCount () const
void setLazyChildCount (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.

此特性是 true 默認情況下

訪問函數:

bool isReadOnly () const
void setReadOnly (bool enable )

此特性保持目錄模型是否應解析符號鏈接

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

訪問函數:

bool resolveSymlinks () const
void setResolveSymlinks (bool enable )

成員函數文檔編製

QDirModel:: QDirModel (const QStringList & nameFilters , QDir::Filters filters , QDir::SortFlags sort , QObject * parent = nullptr)

Constructs a new directory model with the given parent . Only those files matching the nameFilters filters are included in the model. The sort order is given by the sort flags.

QDirModel:: QDirModel ( QObject * parent = nullptr)

Constructs a directory model with the given parent .

[虛擬] QDirModel:: ~QDirModel ()

Destroys this directory model.

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

重實現自 QAbstractItemModel::columnCount ().

Returns the number of columns in the parent 模型項。

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

重實現自 QAbstractItemModel::data ().

Returns the data for the model item index 采用給定 role .

另請參閱 setData ().

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

重實現自 QAbstractItemModel::dropMimeData ().

處理 data 的提供是通過結束拖放操作,按給定 action over the row in the model specified by the row and column and by the parent 索引。

返迴 true if the drop was successful, and false otherwise.

另請參閱 supportedDropActions ().

QIcon QDirModel:: fileIcon (const QModelIndex & index ) const

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

QFileInfo QDirModel:: fileInfo (const QModelIndex & index ) const

Returns the file information for the specified model index .

注意: 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.

另請參閱 QFileInfo::symLinkTarget ().

QString QDirModel:: fileName (const QModelIndex & index ) const

Returns the name of the item stored in the model under the index 給定。

QString QDirModel:: filePath (const QModelIndex & index ) const

Returns the path of the item stored in the model under the index 給定。

QDir::Filters QDirModel:: filter () const

Returns the filter specification for the directory model.

另請參閱 setFilter () 和 QDir::Filters .

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

重實現自 QAbstractItemModel::flags ().

返迴項標誌為給定 index in the model.

另請參閱 Qt::ItemFlags .

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

重實現自 QAbstractItemModel::hasChildren ().

返迴 true parent model item has children; otherwise returns false .

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

重實現自 QAbstractItemModel::headerData ().

返迴的數據存儲在給定 role 為指定 section of the header with the given orientation .

QFileIconProvider *QDirModel:: iconProvider () const

Returns the file icon provider for this directory model.

另請參閱 setIconProvider ().

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

重實現自 QAbstractItemModel::index ().

Returns the model item index for the item in the parent 采用給定 row and column .

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

這是重載函數。

Returns the model item index for the given path .

bool QDirModel:: isDir (const QModelIndex & index ) const

返迴 true 若模型項 index represents a directory; otherwise returns false .

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

重實現自 QAbstractItemModel::mimeData ().

返迴的對象包含序列化描述為指定 indexes . The format used to describe the items corresponding to the indexes is obtained from the mimeTypes () 函數。

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

[override virtual] QStringList QDirModel:: mimeTypes () const

重實現自 QAbstractItemModel::mimeTypes ().

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

QModelIndex QDirModel:: mkdir (const QModelIndex & parent , const QString & name )

Create a directory with the name parent 模型項。

QStringList QDirModel:: nameFilters () const

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

另請參閱 setNameFilters ().

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

重實現自 QAbstractItemModel::parent ().

Return the parent of the given child 模型項。

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

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

bool QDirModel:: remove (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.

警告: This function deletes files from the file system; it does not move them to a location where they can be recovered.

另請參閱 rmdir ().

bool QDirModel:: rmdir (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.

警告: This function deletes directories from the file system; it does not move them to a location where they can be recovered.

另請參閱 remove ().

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

重實現自 QAbstractItemModel::rowCount ().

Returns the number of rows in the parent 模型項。

[override virtual] bool QDirModel:: setData (const QModelIndex & index , const QVariant & value , int role = Qt::EditRole)

重實現自 QAbstractItemModel::setData ().

Sets the data for the model item index 采用給定 role to the data referenced by the value 。返迴 true 若成功;否則返迴 false .

另請參閱 data () 和 Qt::ItemDataRole .

void QDirModel:: 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 QDirModel won't be able to read the directory structure.

另請參閱 filter () 和 QDir::Filters .

void QDirModel:: setIconProvider ( QFileIconProvider * provider )

設置 provider of file icons for the directory model.

另請參閱 iconProvider ().

void QDirModel:: setNameFilters (const QStringList & filters )

Sets the name filters for the directory model.

另請參閱 nameFilters ().

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

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

另請參閱 sorting () 和 QDir::SortFlags .

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

重實現自 QAbstractItemModel::sort ().

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

QDir::SortFlags QDirModel:: sorting () const

Returns the sorting method used for the directory model.

另請參閱 setSorting () 和 QDir::SortFlags .

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

重實現自 QAbstractItemModel::supportedDropActions ().

返迴由此模型支持的掉落動作。

另請參閱 Qt::DropActions .