The QFileSystemModel class provides a data model for the local filesystem. 更多...
| 頭： | #include <QFileSystemModel> |
| qmake: | QT += widgets |
| Since: | Qt 4.4 |
| 繼承： | QAbstractItemModel |
| enum | Roles { FileIconRole, FilePathRole, FileNameRole, FilePermissions } |
| QFileSystemModel (QObject * parent = Q_NULLPTR) | |
| ~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 |
| 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 | setReadOnly (bool enable ) |
| void | setResolveSymlinks (bool enable ) |
| QModelIndex | setRootPath (const QString & newPath ) |
| qint64 | size (const QModelIndex & index ) const |
| QString | type (const QModelIndex & index ) const |
| virtual bool | canFetchMore (const QModelIndex & parent ) const |
| virtual int | columnCount (const QModelIndex & parent = QModelIndex()) const |
| virtual QVariant | data (const QModelIndex & index , int role = Qt::DisplayRole) const |
| virtual bool | dropMimeData (const QMimeData * data , Qt::DropAction action , int row , int column , const QModelIndex & parent ) |
| virtual void | fetchMore (const QModelIndex & parent ) |
| virtual Qt::ItemFlags | flags (const QModelIndex & index ) const |
| virtual bool | hasChildren (const QModelIndex & parent = QModelIndex()) const |
| virtual QVariant | headerData (int section , Qt::Orientation orientation , int role = Qt::DisplayRole) const |
| virtual QModelIndex | index (int row , int column , const QModelIndex & parent = QModelIndex()) const |
| virtual QMimeData * | mimeData (const QModelIndexList & indexes ) const |
| virtual QStringList | mimeTypes () const |
| virtual QModelIndex | parent (const QModelIndex & index ) const |
| virtual int | rowCount (const QModelIndex & parent = QModelIndex()) const |
| virtual bool | setData (const QModelIndex & idx , const QVariant & value , int role = Qt::EditRole) |
| virtual QModelIndex | sibling (int row , int column , const QModelIndex & idx ) const |
| virtual void | sort (int column , Qt::SortOrder order = Qt::AscendingOrder) |
| virtual Qt::DropActions | supportedDropActions () const |
| 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 ) |
| virtual void | timerEvent (QTimerEvent * event ) |
The QFileSystemModel class provides a data model for the local filesystem.
此類提供對本地文件係統的訪問，提供用於重命名 移除文件 目錄及創建新目錄的函數。在最簡單情況下，它可以被用於適閤的顯示 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 requires an instance of 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 will not fetch any files or directories until 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 .
另請參閱 模型類 .
| 常量 | 值 |
|---|---|
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 ) |
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 ) |
構造文件係統模型采用給定 parent .
銷毀此文件係統模型。
[虛擬]
bool
QFileSystemModel::
canFetchMore
(const
QModelIndex
&
parent
) const
重實現自 QAbstractItemModel::canFetchMore ().
[虛擬]
int
QFileSystemModel::
columnCount
(const
QModelIndex
&
parent
= QModelIndex()) const
重實現自 QAbstractItemModel::columnCount ().
[虛擬]
QVariant
QFileSystemModel::
data
(const
QModelIndex
&
index
,
int
role
= Qt::DisplayRole) const
重實現自 QAbstractItemModel::data ().
另請參閱 setData ().
[signal]
void
QFileSystemModel::
directoryLoaded
(const
QString
&
path
)
This signal is emitted when the gatherer thread has finished to load the path .
該函數在 Qt 4.7 引入。
[虛擬]
bool
QFileSystemModel::
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 索引。
另請參閱 supportedDropActions ().
[virtual protected]
bool
QFileSystemModel::
event
(
QEvent
*
event
)
重實現自 QObject::event ().
[虛擬]
void
QFileSystemModel::
fetchMore
(const
QModelIndex
&
parent
)
重實現自 QAbstractItemModel::fetchMore ().
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 給定。
[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 .
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 .
[虛擬]
Qt::ItemFlags
QFileSystemModel::
flags
(const
QModelIndex
&
index
) const
重實現自 QAbstractItemModel::flags ().
[虛擬]
bool
QFileSystemModel::
hasChildren
(const
QModelIndex
&
parent
= QModelIndex()) const
重實現自 QAbstractItemModel::hasChildren ().
[虛擬]
QVariant
QFileSystemModel::
headerData
(
int
section
,
Qt::Orientation
orientation
,
int
role
= Qt::DisplayRole) const
重實現自 QAbstractItemModel::headerData ().
Returns the file icon provider for this directory model.
另請參閱 setIconProvider ().
[虛擬]
QModelIndex
QFileSystemModel::
index
(
int
row
,
int
column
, const
QModelIndex
&
parent
= QModelIndex()) const
重實現自 QAbstractItemModel::index ().
這是重載函數。
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.
[虛擬]
QMimeData
*QFileSystemModel::
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.
[虛擬]
QStringList
QFileSystemModel::
mimeTypes
() const
重實現自 QAbstractItemModel::mimeTypes ().
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 模型索引。
返迴的數據存儲在給定 role for the item "My Computer".
另請參閱 Qt::ItemDataRole .
Returns a list of filters applied to the names in the model.
另請參閱 setNameFilters ().
[虛擬]
QModelIndex
QFileSystemModel::
parent
(const
QModelIndex
&
index
) const
重實現自 QAbstractItemModel::parent ().
Returns the complete OR-ed together combination of QFile::Permission 為 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 ().
The currently set directory
另請參閱 rootPath ().
The currently set root path
另請參閱 setRootPath () 和 rootDirectory ().
[signal]
void
QFileSystemModel::
rootPathChanged
(const
QString
&
newPath
)
This signal is emitted whenever the root path has been changed to a newPath .
[虛擬]
int
QFileSystemModel::
rowCount
(const
QModelIndex
&
parent
= QModelIndex()) const
重實現自 QAbstractItemModel::rowCount ().
[虛擬]
bool
QFileSystemModel::
setData
(const
QModelIndex
&
idx
, const
QVariant
&
value
,
int
role
= Qt::EditRole)
重實現自 QAbstractItemModel::setData ().
另請參閱 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 ().
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 ().
[虛擬]
QModelIndex
QFileSystemModel::
sibling
(
int
row
,
int
column
, const
QModelIndex
&
idx
) const
重實現自 QAbstractItemModel::sibling ().
Returns the size in bytes of index . If the file does not exist, 0 is returned.
[虛擬]
void
QFileSystemModel::
sort
(
int
column
,
Qt::SortOrder
order
= Qt::AscendingOrder)
重實現自 QAbstractItemModel::sort ().
[虛擬]
Qt::DropActions
QFileSystemModel::
supportedDropActions
() const
重實現自 QAbstractItemModel::supportedDropActions ().
[virtual protected]
void
QFileSystemModel::
timerEvent
(
QTimerEvent
*
event
)
重實現自 QObject::timerEvent ().
Returns the type of file index such as "Directory" or "JPEG file".