QFileSystemModel 類

QFileSystemModel 類為本地文件係統提供數據模型。更多...

頭：	#include <QFileSystemModel>
qmake:	QT += widgets
Since:	Qt 4.4
繼承：	QAbstractItemModel

該類在 Qt 4.4 引入。

所有成員列錶，包括繼承成員

公共類型

enum	Option { DontWatchForChanges, DontResolveSymlinks, DontUseCustomDirectoryIcons }
flags	Options
enum	Roles { FileIconRole, FilePathRole, FileNameRole, FilePermissions }

特性

nameFilterDisables : bool
options : Options
readOnly : bool
resolveSymlinks : bool

公共函數

	QFileSystemModel (QObject * parent = nullptr)
virtual	~QFileSystemModel ()
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
QModelIndex	mkdir (const QModelIndex & parent , const QString & name )
QVariant	myComputer (int role = Qt::DisplayRole) const
bool	nameFilterDisables () const
QStringList	nameFilters () const
QFileSystemModel::Options	options () const
QFile::Permissions	permissions (const QModelIndex & index ) const
bool	remove (const QModelIndex & index )
bool	resolveSymlinks () const
bool	rmdir (const QModelIndex & index )
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	setOption (QFileSystemModel::Option option , bool on = true)
void	setOptions (QFileSystemModel::Options options )
void	setReadOnly (bool enable )
void	setResolveSymlinks (bool enable )
QModelIndex	setRootPath (const QString & newPath )
qint64	size (const QModelIndex & index ) const
bool	testOption (QFileSystemModel::Option option ) const
QString	type (const QModelIndex & index ) const

重實現公共函數

virtual bool	canFetchMore (const QModelIndex & parent ) const override
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 void	fetchMore (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 & index ) const override
virtual int	rowCount (const QModelIndex & parent = QModelIndex()) const override
virtual bool	setData (const QModelIndex & idx , const QVariant & value , int role = Qt::EditRole) override
virtual QModelIndex	sibling (int row , int column , const QModelIndex & idx ) const override
virtual void	sort (int column , Qt::SortOrder order = Qt::AscendingOrder) override
virtual Qt::DropActions	supportedDropActions () const override

信號

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

重實現保護函數

virtual bool	event (QEvent * event ) override
virtual void	timerEvent (QTimerEvent * event ) override

詳細描述

此類提供對本地文件係統的訪問，提供用於重命名移除文件目錄及創建新目錄的函數。在最簡單情況下，它可以被用於適閤的顯示 Widget 作為瀏覽器 (或過濾器) 的一部分。

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 (), fileName () 和 filePath () functions provide information about the underlying files and directories related to items in the model. Directories can be created and removed using mkdir (), rmdir ().

注意： QFileSystemModel 要求實例化 QApplication .

用法範例

A directory model that displays the contents of a default directory is usually constructed with a parent object:

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

樹視圖可用於顯示模型的內容

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

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

    tree->setRootIndex(model->index(QDir::currentPath()));

The view's root index can be used to control how much of a hierarchical model is displayed. QFileSystemModel provides a convenience function that returns a suitable model index for a path to a directory within the model.

緩存和性能

QFileSystemModel 不會取齣任何文件或目錄，直到 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, 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 .

另請參閱 模型類 .

成員類型文檔編製

enum QFileSystemModel:: Option
flags QFileSystemModel:: Options

常量	值	描述
`QFileSystemModel::DontWatchForChanges`	`0x00000001`	Do not add file watchers to the paths. This reduces overhead when using the model for simple tasks like line edit completion.
`QFileSystemModel::DontResolveSymlinks`	`0x00000002`	Don't resolve symlinks in the file system model. By default, symlinks are resolved.
`QFileSystemModel::DontUseCustomDirectoryIcons`	`0x00000004`	Always use the default directory icon. Some platforms allow the user to set a different icon. Custom icon lookup causes a big performance impact over network or removable drives. This sets the QFileIconProvider::DontUseCustomDirectoryIcons option in the icon provider accordingly.

該枚舉在 Qt 5.14 引入或被修改。

Options 類型是 typedef 對於 QFlags <Option>。它存儲 Option 值的 OR (或) 組閤。

另請參閱 resolveSymlinks .

enum QFileSystemModel:: Roles

常量	值
`QFileSystemModel::FileIconRole`	`Qt::DecorationRole`
`QFileSystemModel::FilePathRole`	`Qt::UserRole + 1`
`QFileSystemModel::FileNameRole`	`Qt::UserRole + 2`
`QFileSystemModel::FilePermissions`	`Qt::UserRole + 3`

特性文檔編製

nameFilterDisables : bool

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

此特性是 true 默認情況下

訪問函數：

bool	nameFilterDisables () const
void	setNameFilterDisables (bool enable )

options : Options

此特性保持影響模型的各種選項

默認情況下，所有選項是被禁用的。

選項應被設置，在更改特性之前。

該特性在 Qt 5.14 引入。

訪問函數：

QFileSystemModel::Options	options () const
void	setOptions (QFileSystemModel::Options options )

另請參閱 setOption () 和 testOption ().

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 )

resolveSymlinks : bool

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

這僅與 Windows 相關。

默認情況下，此特性為 true .

訪問函數：

bool	resolveSymlinks () const
void	setResolveSymlinks (bool enable )

另請參閱 QFileSystemModel::Options .

成員函數文檔編製

QFileSystemModel:: QFileSystemModel ( QObject * parent = nullptr)

構造文件係統模型采用給定 parent .

`[signal]` void QFileSystemModel:: directoryLoaded (const QString & path )

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

該函數在 Qt 4.7 引入。

`[signal]` void QFileSystemModel:: fileRenamed (const QString & path , const QString & oldName , const QString & newName )

This signal is emitted whenever a file with the oldName is successfully renamed to newName . The file is located in in the directory path .

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

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

`[虛擬]` QFileSystemModel:: ~QFileSystemModel ()

銷毀此文件係統模型。

`[override virtual]` bool QFileSystemModel:: canFetchMore (const QModelIndex & parent ) const

重實現： QAbstractItemModel::canFetchMore (const QModelIndex &parent) const.

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

重實現： QAbstractItemModel::columnCount (const QModelIndex &parent) const.

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

重實現： QAbstractItemModel::data (const QModelIndex &index, int role) const.

另請參閱 setData ().

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

重實現： QAbstractItemModel::dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent).

處理 data 的提供是通過結束拖放操作，按給定 action over the row in the model specified by the row and column and by the parent index. Returns true if the operation was successful.

另請參閱 supportedDropActions ().

`[override virtual protected]` bool QFileSystemModel:: event ( QEvent * event )

重實現： QObject::event (QEvent *e).

`[override virtual]` void QFileSystemModel:: fetchMore (const QModelIndex & parent )

重實現： QAbstractItemModel::fetchMore (const QModelIndex &parent).

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

返迴 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 給定。

QDir::Filters QFileSystemModel:: filter () 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 .

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

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

重實現： QAbstractItemModel::flags (const QModelIndex &index) const.

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

重實現： QAbstractItemModel::hasChildren (const QModelIndex &parent) const.

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

重實現： QAbstractItemModel::headerData (int section, Qt::Orientation orientation, int role) const.

QFileIconProvider *QFileSystemModel:: iconProvider () const

Returns the file icon provider for this directory model.

另請參閱 setIconProvider ().

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

重實現： QAbstractItemModel::index (int row, int column, const QModelIndex &parent) const.

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

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

QDateTime QFileSystemModel:: lastModified (const QModelIndex & index ) const

Returns the date and time when index was last modified.

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

重實現： QAbstractItemModel::mimeData (const QModelIndexList &indexes) const.

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

If the list of indexes is empty, nullptr 被返迴而不是序列化空列錶。

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

重實現： QAbstractItemModel::mimeTypes () const.

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

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

Create a directory with the name 在 parent 模型索引。

QVariant QFileSystemModel:: myComputer ( int role = Qt::DisplayRole) const

返迴的數據存儲在給定 role for the item "My Computer".

另請參閱 Qt::ItemDataRole .

QStringList QFileSystemModel:: nameFilters () const

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

另請參閱 setNameFilters ().

`[override virtual]` QModelIndex QFileSystemModel:: parent (const QModelIndex & index ) const

重實現： QAbstractItemModel::parent (const QModelIndex &index) const.

QFile::Permissions QFileSystemModel:: permissions (const QModelIndex & index ) const

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

bool QFileSystemModel:: remove (const QModelIndex & index )

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.

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

另請參閱 rmdir ().

bool QFileSystemModel:: rmdir (const QModelIndex & index )

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.

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

另請參閱 remove ().

QDir QFileSystemModel:: rootDirectory () const

The currently set directory

另請參閱 rootPath ().

QString QFileSystemModel:: rootPath () const

The currently set root path

另請參閱 setRootPath () 和 rootDirectory ().

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

重實現： QAbstractItemModel::rowCount (const QModelIndex &parent) const.

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

重實現： QAbstractItemModel::setData (const QModelIndex &index, const QVariant &value, int role).

另請參閱 data ().

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.

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

void QFileSystemModel:: setIconProvider ( QFileIconProvider * provider )

設置 provider of file icons for the directory model.

另請參閱 iconProvider ().

void QFileSystemModel:: setNameFilters (const QStringList & filters )

Sets the name filters to apply against the existing files.

另請參閱 nameFilters ().

void QFileSystemModel:: setOption ( QFileSystemModel::Option option , bool on = true)

設置給定 option 為被啓用若 on 為 true；否則，清零給定 option .

選項應被設置，在更改特性之前。

該函數在 Qt 5.14 引入。

另請參閱 options and testOption ().

QModelIndex QFileSystemModel:: setRootPath (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 () 信號將發射。

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

另請參閱 rootPath ().

`[override virtual]` QModelIndex QFileSystemModel:: sibling ( int row , int column , const QModelIndex & idx ) const

重實現： QAbstractItemModel::sibling (int row, int column, const QModelIndex &index) const.

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

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

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

重實現： QAbstractItemModel::sort (int column, Qt::SortOrder order).

`[override virtual]` Qt::DropActions QFileSystemModel:: supportedDropActions () const

重實現： QAbstractItemModel::supportedDropActions () const.

bool QFileSystemModel:: testOption ( QFileSystemModel::Option option ) const

返迴 true 若給定 option 被啓用；否則，返迴 false。

該函數在 Qt 5.14 引入。

另請參閱 options and setOption ().

`[override virtual protected]` void QFileSystemModel:: timerEvent ( QTimerEvent * event )

重實現： QObject::timerEvent (QTimerEvent *event).

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

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

QFileSystemModel 類

公共類型

特性

公共函數

重實現公共函數

信號

重實現保護函數

詳細描述

用法範例

緩存和性能

成員類型文檔編製

enum QFileSystemModel:: Option flags QFileSystemModel:: Options

enum QFileSystemModel:: Roles

特性文檔編製

nameFilterDisables : bool

options : Options

readOnly : bool

resolveSymlinks : bool

成員函數文檔編製

QFileSystemModel:: QFileSystemModel ( QObject * parent = nullptr)

[signal] void QFileSystemModel:: directoryLoaded (const QString & path )

[signal] void QFileSystemModel:: fileRenamed (const QString & path , const QString & oldName , const QString & newName )

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

[虛擬] QFileSystemModel:: ~QFileSystemModel ()

[override virtual] bool QFileSystemModel:: canFetchMore (const QModelIndex & parent ) const

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

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

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

[override virtual protected] bool QFileSystemModel:: event ( QEvent * event )

[override virtual] void QFileSystemModel:: fetchMore (const QModelIndex & parent )

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

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

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

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

QDir::Filters QFileSystemModel:: filter () const

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

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

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

QFileIconProvider *QFileSystemModel:: iconProvider () const

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

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

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

QDateTime QFileSystemModel:: lastModified (const QModelIndex & index ) const

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

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

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

QVariant QFileSystemModel:: myComputer ( int role = Qt::DisplayRole) const

QStringList QFileSystemModel:: nameFilters () const

[override virtual] QModelIndex QFileSystemModel:: parent (const QModelIndex & index ) const

QFile::Permissions QFileSystemModel:: permissions (const QModelIndex & index ) const

bool QFileSystemModel:: remove (const QModelIndex & index )

bool QFileSystemModel:: rmdir (const QModelIndex & index )

QDir QFileSystemModel:: rootDirectory () const

QString QFileSystemModel:: rootPath () const

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

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

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

void QFileSystemModel:: setIconProvider ( QFileIconProvider * provider )

void QFileSystemModel:: setNameFilters (const QStringList & filters )

void QFileSystemModel:: setOption ( QFileSystemModel::Option option , bool on = true)

QModelIndex QFileSystemModel:: setRootPath (const QString & newPath )

[override virtual] QModelIndex QFileSystemModel:: sibling ( int row , int column , const QModelIndex & idx ) const

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

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

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

bool QFileSystemModel:: testOption ( QFileSystemModel::Option option ) const

[override virtual protected] void QFileSystemModel:: timerEvent ( QTimerEvent * event )

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

內容

enum QFileSystemModel:: Option
flags QFileSystemModel:: Options

`[signal]` void QFileSystemModel:: directoryLoaded (const QString & path )

`[signal]` void QFileSystemModel:: fileRenamed (const QString & path , const QString & oldName , const QString & newName )

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

`[虛擬]` QFileSystemModel:: ~QFileSystemModel ()

`[override virtual]` bool QFileSystemModel:: canFetchMore (const QModelIndex & parent ) const

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

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

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

`[override virtual protected]` bool QFileSystemModel:: event ( QEvent * event )

`[override virtual]` void QFileSystemModel:: fetchMore (const QModelIndex & parent )

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

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

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

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

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

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

`[override virtual]` QModelIndex QFileSystemModel:: parent (const QModelIndex & index ) const

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

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

`[override virtual]` QModelIndex QFileSystemModel:: sibling ( int row , int column , const QModelIndex & idx ) const

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

`[override virtual]` Qt::DropActions QFileSystemModel:: supportedDropActions () const

`[override virtual protected]` void QFileSystemModel:: timerEvent ( QTimerEvent * event )