QFileSystemModel ¶

QFileSystemModel class provides a data model for the local filesystem. 更多 …

概要 ¶

函数 ¶

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 options ()
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 setOption (option[, on=true])
def setOptions (options)
def setReadOnly (enable)
def setResolveSymlinks (enable)
def setRootPath (path)
def size (index)
def testOption (option)
def type (index)

信号 ¶

def directoryLoaded (path)
def fileRenamed (path, oldName, newName)
def rootPathChanged (newPath)

详细描述 ¶

此类提供对本地文件系统的访问，提供用于重命名移除文件目录及创建新目录的函数。在最简单情况下，它可以被用于适合的显示 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() and 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:
model = QFileSystemModel()
model.setRootPath(QDir.currentPath())
												
树视图可用于显示模型的内容
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.

缓存和性能 ¶

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.

不像 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 .

另请参阅

模型类

class QFileSystemModel ( [ parent=None ] ) ¶

param parent

QObject

构造文件系统模型采用给定 parent .

PySide2.QtWidgets.QFileSystemModel. Roles ¶

常量	描述
QFileSystemModel.FileIconRole
QFileSystemModel.FilePathRole
QFileSystemModel.FileNameRole
QFileSystemModel.FilePermissions

PySide2.QtWidgets.QFileSystemModel. Option ¶

常量	描述
QFileSystemModel.DontWatchForChanges	Do not add file watchers to the paths. This reduces overhead when using the model for simple tasks like line edit completion.
QFileSystemModel.DontResolveSymlinks	Don’t resolve symlinks in the file system model. By default, symlinks are resolved.
QFileSystemModel.DontUseCustomDirectoryIcons	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 `DontUseCustomDirectoryIcons` option in the icon provider accordingly.

另请参阅

resolveSymlinks

New in version 5.14.

PySide2.QtWidgets.QFileSystemModel. directoryLoaded ( path ) ¶

参数: path – unicode

PySide2.QtWidgets.QFileSystemModel. fileIcon ( index ) ¶

参数: index – QModelIndex
返回类型: QIcon

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

PySide2.QtWidgets.QFileSystemModel. fileInfo ( index ) ¶

参数: index – QModelIndex
返回类型: QFileInfo

返回 QFileInfo for the item stored in the model under the given index .

PySide2.QtWidgets.QFileSystemModel. fileName ( index ) ¶

参数: index – QModelIndex
返回类型: unicode

Returns the file name for the item stored in the model under the given index .

PySide2.QtWidgets.QFileSystemModel. filePath ( index ) ¶

参数: index – QModelIndex
返回类型: unicode

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

PySide2.QtWidgets.QFileSystemModel. fileRenamed ( path , oldName , newName ) ¶

参数

path – unicode
oldName – unicode
newName – unicode

PySide2.QtWidgets.QFileSystemModel. filter ( ) ¶

返回类型: 过滤器

Returns the filter specified for the directory model.

If a filter has not been set, the default filter is AllEntries | NoDotAndDotDot | AllDirs .

另请参阅

setFilter() 过滤器

PySide2.QtWidgets.QFileSystemModel. iconProvider ( ) ¶

返回类型: QFileIconProvider

Returns the file icon provider for this directory model.

另请参阅

setIconProvider()

PySide2.QtWidgets.QFileSystemModel. index ( path [ , column=0 ] ) ¶

参数

path – unicode
column – int

返回类型

QModelIndex

这是重载函数。

Returns the model item index for the given path and column .

PySide2.QtWidgets.QFileSystemModel. isDir ( index ) ¶

参数: index – QModelIndex
返回类型: bool

返回 true 若模型项 index represents a directory; otherwise returns false .

PySide2.QtWidgets.QFileSystemModel. isReadOnly ( ) ¶

返回类型: bool

PySide2.QtWidgets.QFileSystemModel. lastModified ( index ) ¶

参数: index – QModelIndex
返回类型: QDateTime

Returns the date and time when index was last modified.

PySide2.QtWidgets.QFileSystemModel. mkdir ( parent , name ) ¶

参数

parent – QModelIndex
name – unicode

返回类型

QModelIndex

Create a directory with the name 在 parent model index.

PySide2.QtWidgets.QFileSystemModel. myComputer ( [ role=Qt.DisplayRole ] ) ¶

参数: role – int
返回类型: object

Returns the data stored under the given role for the item “My Computer”.

另请参阅

ItemDataRole

PySide2.QtWidgets.QFileSystemModel. nameFilterDisables ( ) ¶

返回类型: bool

另请参阅

setNameFilterDisables()

PySide2.QtWidgets.QFileSystemModel. nameFilters ( ) ¶

返回类型: 字符串列表

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

另请参阅

setNameFilters()

PySide2.QtWidgets.QFileSystemModel. options ( ) ¶

返回类型: Options

另请参阅

setOptions()

PySide2.QtWidgets.QFileSystemModel. remove ( index ) ¶

参数: index – QModelIndex
返回类型: 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.

警告

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

另请参阅

rmdir()

PySide2.QtWidgets.QFileSystemModel. resolveSymlinks ( ) ¶

返回类型: bool

另请参阅

setResolveSymlinks()

PySide2.QtWidgets.QFileSystemModel. rmdir ( index ) ¶

参数: index – QModelIndex
返回类型: 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.

警告

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

另请参阅

remove()

PySide2.QtWidgets.QFileSystemModel. rootDirectory ( ) ¶

返回类型: QDir

The currently set directory

另请参阅

rootPath()

PySide2.QtWidgets.QFileSystemModel. rootPath ( ) ¶

返回类型: unicode

The currently set root path

另请参阅

setRootPath() rootDirectory()

PySide2.QtWidgets.QFileSystemModel. rootPathChanged ( newPath ) ¶

参数: newPath – unicode

PySide2.QtWidgets.QFileSystemModel. setFilter ( 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, otherwise QFileSystemModel won’t be able to read the directory structure.

另请参阅

filter() 过滤器

PySide2.QtWidgets.QFileSystemModel. setIconProvider ( provider ) ¶

参数: provider – QFileIconProvider

设置 provider of file icons for the directory model.

另请参阅

iconProvider()

PySide2.QtWidgets.QFileSystemModel. setNameFilterDisables ( enable ) ¶

参数: enable – bool

另请参阅

nameFilterDisables()

PySide2.QtWidgets.QFileSystemModel. setNameFilters ( filters ) ¶

参数: filters – 字符串列表

Sets the name filters to apply against the existing files.

另请参阅

nameFilters()

PySide2.QtWidgets.QFileSystemModel. setOption ( option [ , on=true ] ) ¶

参数

option – Option
on – bool

设置给定 option to be enabled if on is true; otherwise, clears the given option .

选项应被设置，在更改特性之前。

另请参阅

options testOption()

PySide2.QtWidgets.QFileSystemModel. setOptions ( options ) ¶

参数: options – Options

另请参阅

options()

PySide2.QtWidgets.QFileSystemModel. setReadOnly ( enable ) ¶

参数: enable – bool

另请参阅

isReadOnly()

PySide2.QtWidgets.QFileSystemModel. setResolveSymlinks ( enable ) ¶

参数: enable – bool

另请参阅

resolveSymlinks()

PySide2.QtWidgets.QFileSystemModel. setRootPath ( path ) ¶

参数: path – unicode
返回类型: QModelIndex

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() signal will be emitted.

注意

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

PySide2.QtWidgets.QFileSystemModel. size ( index ) ¶

参数: index – QModelIndex
返回类型: qint64

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

PySide2.QtWidgets.QFileSystemModel. testOption ( option ) ¶

参数: option – Option
返回类型: bool

返回 true 若给定 option 被启用；否则，返回 false。

另请参阅

options setOption()

PySide2.QtWidgets.QFileSystemModel. type ( index ) ¶

参数: index – QModelIndex
返回类型: unicode

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

内容表

上一话题

下一话题

快速搜索

QFileSystemModel ¶

概要 ¶

函数 ¶

信号 ¶

详细描述 ¶

用法范例 ¶

缓存和性能 ¶