QFileSystemModel 类为本地文件系统提供数据模型。 更多...
| 头： | #include <QFileSystemModel> |
| CMake: |
find_package(Qt6 COMPONENTS Gui REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| 继承： | QAbstractItemModel |
| enum | Option { DontWatchForChanges, DontResolveSymlinks, DontUseCustomDirectoryIcons } |
| flags | Options |
| enum | Roles { FileIconRole, FilePathRole, FileNameRole, FilePermissions } |
| 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 |
| QAbstractFileIconProvider * | 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 (QAbstractFileIconProvider * 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 QHash<int, QByteArray> | roleNames () 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.
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 .
另请参阅 模型类 .
[since 5.14]
enum QFileSystemModel::
Option
| 常量 | 值 | 描述 |
|---|---|---|
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 .
| 常量 | 值 |
|---|---|
QFileSystemModel::FileIconRole
|
Qt::DecorationRole
|
QFileSystemModel::FilePathRole
|
Qt::UserRole + 1
|
QFileSystemModel::FileNameRole
|
Qt::UserRole + 2
|
QFileSystemModel::FilePermissions
|
Qt::UserRole + 3
|
This property holds whether files that don't pass the name filter are hidden or disabled
此特性是
true
默认情况下
访问函数：
| bool | nameFilterDisables () const |
| void | setNameFilterDisables (bool enable ) |
[since 5.14]
options
:
Options
此特性保持影响模型的各种选项
默认情况下，所有选项是被禁用的。
选项应被设置，在更改特性之前。
该特性在 Qt 5.14 引入。
访问函数：
| QFileSystemModel::Options | options () const |
| void | setOptions (QFileSystemModel::Options options ) |
另请参阅 setOption () 和 testOption ().
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 ) |
此特性保持目录模型是否应解析符号链接
这仅与 Windows 相关。
默认情况下，此特性为
true
.
访问函数：
| bool | resolveSymlinks () const |
| void | setResolveSymlinks (bool enable ) |
另请参阅 QFileSystemModel::Options .
构造文件系统模型采用给定 parent .
[signal]
void
QFileSystemModel::
directoryLoaded
(const
QString
&
path
)
This signal is emitted when the gatherer thread has finished to load the path .
[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).
Returns the icon for the item stored in the model under the given index .
返回 QFileInfo for the item stored in the model under the given index .
Returns the file name for the item stored in the model under the given index .
Returns the path of the item stored in the model under the index 给定。
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.
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.
这是重载函数。
Returns the model item index for the given path and column .
返回
true
若模型项
index
represents a directory; otherwise returns
false
.
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.
Create a directory with the name 在 parent model index.
Returns the data stored under the given role for the item "My Computer".
另请参阅 Qt::ItemDataRole .
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.
Returns the complete OR-ed together combination of QFile::Permission for the 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 ().
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 ().
[override virtual]
QHash
<
int
,
QByteArray
> QFileSystemModel::
roleNames
() const
重实现： QAbstractItemModel::roleNames () const.
The currently set directory
另请参阅 rootPath ().
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 ().
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 .
设置 provider of file icons for the directory model.
另请参阅 iconProvider ().
Sets the name filters to apply against the existing files.
另请参阅 nameFilters ().
[since 5.14]
void
QFileSystemModel::
setOption
(
QFileSystemModel::Option
option
,
bool
on
= true)
设置给定 option 为被启用若 on 为 true；否则，清零给定 option .
选项应被设置，在更改特性之前。
该函数在 Qt 5.14 引入。
另请参阅 options and testOption ().
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.
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.
[since 5.14]
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).
Returns the type of file index such as "Directory" or "JPEG file".