QFileSystemModel

概要

函数

信号

详细描述

PySide.QtGui.QFileSystemModel class provides a data model for the local filesystem.

此类提供对本地文件系统的访问,提供用于重命名 移除文件 目录及创建新目录的函数。在最简单情况下,它可以被用于适合的显示 Widget 作为浏览器 (或过滤器) 的一部分。

PySide.QtGui.QFileSystemModel can be accessed using the standard interface provided by PySide.QtCore.QAbstractItemModel , but it also provides some convenience functions that are specific to a directory model. The PySide.QtGui.QFileSystemModel.fileInfo() , PySide.QtGui.QFileSystemModel.isDir() , name() , and path() functions provide information about the underlying files and directories related to items in the model. Directories can be created and removed using PySide.QtGui.QFileSystemModel.mkdir() , PySide.QtGui.QFileSystemModel.rmdir() .

注意

PySide.QtGui.QFileSystemModel requires an instance of a GUI application.

用法范例

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. PySide.QtGui.QDirModel provides a convenience function that returns a suitable model index for a path to a directory within the model.

缓存和性能

PySide.QtGui.QFileSystemModel will not fetch any files or directories until PySide.QtGui.QFileSystemModel.setRootPath() is called. This will prevent any unnecessary querying on the file system until that point such as listing the drives on Windows.

不像 PySide.QtGui.QDirModel , PySide.QtGui.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 PySide.QtGui.QFileSystemModel.rowCount() will return 0 until the model populates a directory.

PySide.QtGui.QFileSystemModel keeps a cache with file information. The cache is automatically kept up to date using the PySide.QtCore.QFileSystemWatcher .

另请参阅

模型类

class PySide.QtGui. QFileSystemModel ( [ parent=None ] )
参数: parent PySide.QtCore.QObject

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

PySide.QtGui.QFileSystemModel. Roles
常量 描述
QFileSystemModel.FileIconRole  
QFileSystemModel.FilePathRole  
QFileSystemModel.FileNameRole  
QFileSystemModel.FilePermissions  
PySide.QtGui.QFileSystemModel. directoryLoaded ( path )
参数: path – unicode
PySide.QtGui.QFileSystemModel. fileIcon ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtGui.QIcon

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

PySide.QtGui.QFileSystemModel. fileInfo ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.QFileInfo

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

PySide.QtGui.QFileSystemModel. fileName ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: unicode

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

PySide.QtGui.QFileSystemModel. filePath ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: unicode

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

PySide.QtGui.QFileSystemModel. fileRenamed ( path , oldName , newName )
参数:
  • path – unicode
  • oldName – unicode
  • newName – unicode
PySide.QtGui.QFileSystemModel. filter ( )
返回类型: PySide.QtCore.QDir.Filters

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 .

PySide.QtGui.QFileSystemModel. iconProvider ( )
返回类型: PySide.QtGui.QFileIconProvider

Returns the file icon provider for this directory model.

PySide.QtGui.QFileSystemModel. index ( path [ , column=0 ] )
参数:
  • path – unicode
  • column PySide.QtCore.int
返回类型:

PySide.QtCore.QModelIndex

这是重载函数。

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

PySide.QtGui.QFileSystemModel. isDir ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.bool

Returns true if the model item index represents a directory; otherwise returns false.

PySide.QtGui.QFileSystemModel. isReadOnly ( )
返回类型: PySide.QtCore.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.

This property is true by default

PySide.QtGui.QFileSystemModel. lastModified ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.QDateTime

Returns the date and time when index was last modified.

PySide.QtGui.QFileSystemModel. mkdir ( parent , name )
参数:
返回类型:

PySide.QtCore.QModelIndex

Create a directory with the name parent model index.

PySide.QtGui.QFileSystemModel. myComputer ( [ role=Qt.DisplayRole ] )
参数: role PySide.QtCore.int
返回类型: object

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

另请参阅

Qt.ItemDataRole

PySide.QtGui.QFileSystemModel. nameFilterDisables ( )
返回类型: PySide.QtCore.bool

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

This property is true by default

PySide.QtGui.QFileSystemModel. nameFilters ( )
返回类型: 字符串列表

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

PySide.QtGui.QFileSystemModel. permissions ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.QFile.Permissions

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

PySide.QtGui.QFileSystemModel. remove ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.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.

返回类型: PySide.QtCore.bool

This property holds Whether the directory model should resolve symbolic links.

This is only relevant on operating systems that support symbolic links.

默认情况下,此特性为 false。

PySide.QtGui.QFileSystemModel. rmdir ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.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.

PySide.QtGui.QFileSystemModel. rootDirectory ( )
返回类型: PySide.QtCore.QDir

The currently set directory

PySide.QtGui.QFileSystemModel. rootPath ( )
返回类型: unicode

The currently set root path

PySide.QtGui.QFileSystemModel. rootPathChanged ( newPath )
参数: newPath – unicode
PySide.QtGui.QFileSystemModel. setFilter ( filters )
参数: filters PySide.QtCore.QDir.Filters
PySide.QtGui.QFileSystemModel. setIconProvider ( provider )
参数: provider PySide.QtGui.QFileIconProvider

设置 provider of file icons for the directory model.

PySide.QtGui.QFileSystemModel. setNameFilterDisables ( enable )
参数: enable PySide.QtCore.bool

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

This property is true by default

PySide.QtGui.QFileSystemModel. setNameFilters ( filters )
参数: filters – list of strings

Sets the name filters to apply against the existing files.

PySide.QtGui.QFileSystemModel. setReadOnly ( enable )
参数: enable PySide.QtCore.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.

This property is true by default

参数: enable PySide.QtCore.bool

This property holds Whether the directory model should resolve symbolic links.

This is only relevant on operating systems that support symbolic links.

默认情况下,此特性为 false。

PySide.QtGui.QFileSystemModel. setRootPath ( path )
参数: path – unicode
返回类型: PySide.QtCore.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 PySide.QtGui.QFileSystemModel.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.

PySide.QtGui.QFileSystemModel. size ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: PySide.QtCore.qint64

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

PySide.QtGui.QFileSystemModel. type ( index )
参数: index PySide.QtCore.QModelIndex
返回类型: unicode

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