QFileSystemModel¶
The
QFileSystemModel
class provides a data model for the local filesystem. More…
Synopsis¶
Functions¶
def
fileIcon
(index)def
fileInfo
(index)def
fileName
(index)def
filePath
(index)def
filter
()def
iconProvider
()def
index
(path[, column=0])def
isDir
(index)def
isReadOnly
()def
lastModified
(index)def
mkdir
(parent, name)def
myComputer
([role=Qt.DisplayRole])def
nameFilterDisables
()def
nameFilters
()def
remove
(index)def
resolveSymlinks
()def
rmdir
(index)def
rootDirectory
()def
rootPath
()def
setFilter
(filters)def
setIconProvider
(provider)def
setNameFilterDisables
(enable)def
setNameFilters
(filters)def
setReadOnly
(enable)def
setResolveSymlinks
(enable)def
setRootPath
(path)def
size
(index)def
type
(index)
Signals¶
def
directoryLoaded
(path)def
fileRenamed
(path, oldName, newName)def
rootPathChanged
(newPath)
Detailed Description¶
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 filter.
QFileSystemModel
can be accessed using the standard interface provided byQAbstractItemModel
, but it also provides some convenience functions that are specific to a directory model. ThefileInfo()
,isDir()
,fileName()
andfilePath()
functions provide information about the underlying files and directories related to items in the model. Directories can be created and removed usingmkdir()
,rmdir()
.Note
QFileSystemModel
requires an instance ofQApplication
.
Example Usage¶
A directory model that displays the contents of a default directory is usually constructed with a parent object:
model = QFileSystemModel() model.setRootPath(QDir.currentPath())A tree view can be used to display the contents of the model
tree = QTreeView() 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.
Caching and Performance¶
QFileSystemModel
will not fetch any files or directories untilsetRootPath()
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 torowCount()
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 theQFileSystemWatcher
.See also
-
class
QFileSystemModel
([parent=None])¶ - param parent
QObject
Constructs a file system model with the given
parent
.
-
PySide2.QtWidgets.QFileSystemModel.
Roles
¶ Constant
Description
QFileSystemModel.FileIconRole
QFileSystemModel.FilePathRole
QFileSystemModel.FileNameRole
QFileSystemModel.FilePermissions
-
PySide2.QtWidgets.QFileSystemModel.
directoryLoaded
(path)¶ - Parameters
path – unicode
-
PySide2.QtWidgets.QFileSystemModel.
fileIcon
(index)¶ - Parameters
index –
QModelIndex
- Return type
QIcon
Returns the icon for the item stored in the model under the given
index
.
-
PySide2.QtWidgets.QFileSystemModel.
fileInfo
(index)¶ - Parameters
index –
QModelIndex
- Return type
QFileInfo
Returns the
QFileInfo
for the item stored in the model under the givenindex
.
-
PySide2.QtWidgets.QFileSystemModel.
fileName
(index)¶ - Parameters
index –
QModelIndex
- Return type
unicode
Returns the file name for the item stored in the model under the given
index
.
-
PySide2.QtWidgets.QFileSystemModel.
filePath
(index)¶ - Parameters
index –
QModelIndex
- Return type
unicode
Returns the path of the item stored in the model under the
index
given.
-
PySide2.QtWidgets.QFileSystemModel.
fileRenamed
(path, oldName, newName)¶ - Parameters
path – unicode
oldName – unicode
newName – unicode
-
PySide2.QtWidgets.QFileSystemModel.
filter
()¶ - Return type
Filters
Returns the filter specified for the directory model.
If a filter has not been set, the default filter is
AllEntries
|NoDotAndDotDot
|AllDirs
.See also
setFilter()
Filters
-
PySide2.QtWidgets.QFileSystemModel.
iconProvider
()¶ - Return type
Returns the file icon provider for this directory model.
See also
-
PySide2.QtWidgets.QFileSystemModel.
index
(path[, column=0])¶ - Parameters
path – unicode
column –
int
- Return type
QModelIndex
This is an overloaded function.
Returns the model item index for the given
path
andcolumn
.
-
PySide2.QtWidgets.QFileSystemModel.
isDir
(index)¶ - Parameters
index –
QModelIndex
- Return type
bool
Returns
true
if the model itemindex
represents a directory; otherwise returnsfalse
.
-
PySide2.QtWidgets.QFileSystemModel.
isReadOnly
()¶ - Return type
bool
-
PySide2.QtWidgets.QFileSystemModel.
lastModified
(index)¶ - Parameters
index –
QModelIndex
- Return type
QDateTime
Returns the date and time when
index
was last modified.
-
PySide2.QtWidgets.QFileSystemModel.
mkdir
(parent, name)¶ - Parameters
parent –
QModelIndex
name – unicode
- Return type
QModelIndex
Create a directory with the
name
in theparent
model index.
-
PySide2.QtWidgets.QFileSystemModel.
myComputer
([role=Qt.DisplayRole])¶ - Parameters
role –
int
- Return type
object
Returns the data stored under the given
role
for the item “My Computer”.See also
ItemDataRole
-
PySide2.QtWidgets.QFileSystemModel.
nameFilterDisables
()¶ - Return type
bool
See also
-
PySide2.QtWidgets.QFileSystemModel.
nameFilters
()¶ - Return type
list of strings
Returns a list of filters applied to the names in the model.
See also
-
PySide2.QtWidgets.QFileSystemModel.
remove
(index)¶ - Parameters
index –
QModelIndex
- Return type
bool
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.Warning
This function deletes files from the file system; it does not move them to a location where they can be recovered.
See also
-
PySide2.QtWidgets.QFileSystemModel.
resolveSymlinks
()¶ - Return type
bool
See also
-
PySide2.QtWidgets.QFileSystemModel.
rmdir
(index)¶ - Parameters
index –
QModelIndex
- Return type
bool
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.Warning
This function deletes directories from the file system; it does not move them to a location where they can be recovered.
See also
-
PySide2.QtWidgets.QFileSystemModel.
rootDirectory
()¶ - Return type
QDir
The currently set directory
See also
-
PySide2.QtWidgets.QFileSystemModel.
rootPath
()¶ - Return type
unicode
The currently set root path
See also
-
PySide2.QtWidgets.QFileSystemModel.
rootPathChanged
(newPath)¶ - Parameters
newPath – unicode
-
PySide2.QtWidgets.QFileSystemModel.
setFilter
(filters)¶ - Parameters
filters –
Filters
Sets the directory model’s filter to that specified by
filters
.Note that the filter you set should always include the
AllDirs
enum value, otherwiseQFileSystemModel
won’t be able to read the directory structure.See also
filter()
Filters
-
PySide2.QtWidgets.QFileSystemModel.
setIconProvider
(provider)¶ - Parameters
provider –
QFileIconProvider
Sets the
provider
of file icons for the directory model.See also
-
PySide2.QtWidgets.QFileSystemModel.
setNameFilterDisables
(enable)¶ - Parameters
enable –
bool
See also
-
PySide2.QtWidgets.QFileSystemModel.
setNameFilters
(filters)¶ - Parameters
filters – list of strings
Sets the name
filters
to apply against the existing files.See also
-
PySide2.QtWidgets.QFileSystemModel.
setReadOnly
(enable)¶ - Parameters
enable –
bool
See also
-
PySide2.QtWidgets.QFileSystemModel.
setResolveSymlinks
(enable)¶ - Parameters
enable –
bool
See also
-
PySide2.QtWidgets.QFileSystemModel.
setRootPath
(path)¶ - Parameters
path – unicode
- Return type
QModelIndex
Sets the directory that is being watched by the model to
newPath
by installing afile 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()
signal will be emitted.Note
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.See also
-
PySide2.QtWidgets.QFileSystemModel.
size
(index)¶ - Parameters
index –
QModelIndex
- Return type
qint64
Returns the size in bytes of
index
. If the file does not exist, 0 is returned.
-
PySide2.QtWidgets.QFileSystemModel.
type
(index)¶ - Parameters
index –
QModelIndex
- Return type
unicode
Returns the type of file
index
such as “Directory” or “JPEG file”.
© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.