QFileSystemModel

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 permissions (index)
• 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

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

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.

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

Note

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

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

Caching and Performance

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.

Unlike 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 .

See also

Model Classes

class PySide.QtGui.QFileSystemModel([parent=None])

Parameters:parent – PySide.QtCore.QObject

Constructs a file system model with the given parent .

PySide.QtGui.QFileSystemModel.Roles

Constant	Description
QFileSystemModel.FileIconRole
QFileSystemModel.FilePathRole
QFileSystemModel.FileNameRole
QFileSystemModel.FilePermissions

PySide.QtGui.QFileSystemModel.directoryLoaded(path)

Parameters:path – unicode

PySide.QtGui.QFileSystemModel.fileIcon(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtGui.QIcon

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

PySide.QtGui.QFileSystemModel.fileInfo(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtCore.QFileInfo

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

PySide.QtGui.QFileSystemModel.fileName(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:unicode

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

PySide.QtGui.QFileSystemModel.filePath(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:unicode

Returns the path of the item stored in the model under the index given.

PySide.QtGui.QFileSystemModel.fileRenamed(path, oldName, newName)

Parameters:

• path – unicode
• oldName – unicode
• newName – unicode

PySide.QtGui.QFileSystemModel.filter()

Return type: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 .

See also

PySide.QtGui.QFileSystemModel.setFilter() QDir.Filters

PySide.QtGui.QFileSystemModel.iconProvider()

Return type:PySide.QtGui.QFileIconProvider

Returns the file icon provider for this directory model.

See also

PySide.QtGui.QFileSystemModel.setIconProvider()

PySide.QtGui.QFileSystemModel.index(path[, column=0])

Parameters:

• path – unicode
• column – PySide.QtCore.int

Return type:

PySide.QtCore.QModelIndex

This is an overloaded function.

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

PySide.QtGui.QFileSystemModel.isDir(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtCore.bool

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

PySide.QtGui.QFileSystemModel.isReadOnly()

Return type: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)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtCore.QDateTime

Returns the date and time when index was last modified.

PySide.QtGui.QFileSystemModel.mkdir(parent, name)

Parameters:

• parent – PySide.QtCore.QModelIndex
• name – unicode

Return type:

PySide.QtCore.QModelIndex

Create a directory with the name in the parent model index.

PySide.QtGui.QFileSystemModel.myComputer([role=Qt.DisplayRole])

Parameters:role – PySide.QtCore.int Return type:object

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

See also

Qt.ItemDataRole

PySide.QtGui.QFileSystemModel.nameFilterDisables()

Return type: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()

Return type:list of strings

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

See also

PySide.QtGui.QFileSystemModel.setNameFilters()

PySide.QtGui.QFileSystemModel.permissions(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtCore.QFile.Permissions

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

PySide.QtGui.QFileSystemModel.remove(index)

Parameters:index – PySide.QtCore.QModelIndex Return type: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.

Warning

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

See also

PySide.QtGui.QFileSystemModel.rmdir()

PySide.QtGui.QFileSystemModel.resolveSymlinks()

Return type: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.

By default, this property is false.

PySide.QtGui.QFileSystemModel.rmdir(index)

Parameters:index – PySide.QtCore.QModelIndex Return type: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.

Warning

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

See also

PySide.QtGui.QFileSystemModel.remove()

PySide.QtGui.QFileSystemModel.rootDirectory()

Return type:PySide.QtCore.QDir

The currently set directory

See also

PySide.QtGui.QFileSystemModel.rootPath()

PySide.QtGui.QFileSystemModel.rootPath()

Return type:unicode

The currently set root path

See also

PySide.QtGui.QFileSystemModel.setRootPath() PySide.QtGui.QFileSystemModel.rootDirectory()

PySide.QtGui.QFileSystemModel.rootPathChanged(newPath)

Parameters:newPath – unicode

PySide.QtGui.QFileSystemModel.setFilter(filters)

Parameters:filters – PySide.QtCore.QDir.Filters

PySide.QtGui.QFileSystemModel.setIconProvider(provider)

Parameters:provider – PySide.QtGui.QFileIconProvider

Sets the provider of file icons for the directory model.

See also

PySide.QtGui.QFileSystemModel.iconProvider()

PySide.QtGui.QFileSystemModel.setNameFilterDisables(enable)

Parameters: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)

Parameters:filters – list of strings

Sets the name filters to apply against the existing files.

See also

PySide.QtGui.QFileSystemModel.nameFilters()

PySide.QtGui.QFileSystemModel.setReadOnly(enable)

Parameters: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

PySide.QtGui.QFileSystemModel.setResolveSymlinks(enable)

Parameters: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.

By default, this property is false.

PySide.QtGui.QFileSystemModel.setRootPath(path)

Parameters:path – unicode Return type: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.

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

PySide.QtGui.QFileSystemModel.rootPath()

PySide.QtGui.QFileSystemModel.size(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:PySide.QtCore.qint64

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

PySide.QtGui.QFileSystemModel.type(index)

Parameters:index – PySide.QtCore.QModelIndex Return type:unicode

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