QFileSystemModel Class Reference [QtGui module]The QFileSystemModel class provides a data model for the local filesystem. More...
Inherits QAbstractItemModel. Types- enum Roles { FileIconRole, FilePathRole, FileNameRole, FilePermissions }
Methods- __init__ (self, QObject parent = None)
- bool canFetchMore (self, QModelIndex parent)
- int columnCount (self, QModelIndex parent = QModelIndex())
- QVariant data (self, QModelIndex index, int role = Qt.DisplayRole)
- bool dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, QModelIndex parent)
- fetchMore (self, QModelIndex parent)
- QIcon fileIcon (self, QModelIndex aindex)
- QFileInfo fileInfo (self, QModelIndex aindex)
- QString fileName (self, QModelIndex aindex)
- QString filePath (self, QModelIndex index)
- QDir.Filters filter (self)
- Qt.ItemFlags flags (self, QModelIndex index)
- bool hasChildren (self, QModelIndex parent = QModelIndex())
- QVariant headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)
- QFileIconProvider iconProvider (self)
- QModelIndex index (self, int row, int column, QModelIndex parent = QModelIndex())
- QModelIndex index (self, QString path, int column = 0)
- bool isDir (self, QModelIndex index)
- bool isReadOnly (self)
- QDateTime lastModified (self, QModelIndex index)
- QMimeData mimeData (self, QModelIndex-list indexes)
- QStringList mimeTypes (self)
- QModelIndex mkdir (self, QModelIndex parent, QString name)
- QVariant myComputer (self, int role = Qt.DisplayRole)
- bool nameFilterDisables (self)
- QStringList nameFilters (self)
- QModelIndex parent (self, QModelIndex child)
- QFile.Permissions permissions (self, QModelIndex index)
- bool remove (self, QModelIndex aindex)
- bool resolveSymlinks (self)
- bool rmdir (self, QModelIndex aindex)
- QDir rootDirectory (self)
- QString rootPath (self)
- int rowCount (self, QModelIndex parent = QModelIndex())
- bool setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)
- setFilter (self, QDir.Filters filters)
- setIconProvider (self, QFileIconProvider provider)
- setNameFilterDisables (self, bool enable)
- setNameFilters (self, QStringList filters)
- setReadOnly (self, bool enable)
- setResolveSymlinks (self, bool enable)
- QModelIndex setRootPath (self, QString path)
- long size (self, QModelIndex index)
- sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)
- Qt.DropActions supportedDropActions (self)
- timerEvent (self, QTimerEvent event)
- QString type (self, QModelIndex index)
Qt Signals
Detailed DescriptionThe 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.
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 the 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 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(), 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 mkdir(), rmdir().
Note: QFileSystemModel requires an instance of a GUI application.
See also Model Classes.
Type DocumentationQFileSystemModel.Roles
Constant | Value |
QFileSystemModel.FileIconRole | Qt.DecorationRole |
QFileSystemModel.FilePathRole | Qt.UserRole + 1 |
QFileSystemModel.FileNameRole | Qt.UserRole + 2 |
QFileSystemModel.FilePermissions | Qt.UserRole + 3 |
Method DocumentationQFileSystemModel.__init__ (self, QObject parent = None)The parent argument, if not None, causes self to be owned by Qt instead of PyQt. Constructs a file system model with the given parent.
bool QFileSystemModel.canFetchMore (self, QModelIndex parent)int QFileSystemModel.columnCount (self, QModelIndex parent = QModelIndex())QVariant QFileSystemModel.data (self, QModelIndex index, int role = Qt.DisplayRole)bool QFileSystemModel.dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, QModelIndex parent)Handles the data supplied by a drag and drop operation that ended with the given action over the row in the model specified by the row and column and by the parent index.
Reimplemented from QAbstractItemModel.
See also supportedDropActions().
QFileSystemModel.fetchMore (self, QModelIndex parent)QIcon QFileSystemModel.fileIcon (self, QModelIndex aindex)Returns the icon for the item stored in the model under the given index.
QFileInfo QFileSystemModel.fileInfo (self, QModelIndex aindex)Returns the QFileInfo for the item stored in the model under the given index.
QString QFileSystemModel.fileName (self, QModelIndex aindex)Returns the file name for the item stored in the model under the given index.
QString QFileSystemModel.filePath (self, QModelIndex index)Returns the path of the item stored in the model under the index given.
QDir.Filters QFileSystemModel.filter (self)Returns the filter specification for the directory model.
See also setFilter() and QDir.Filters.
bool QFileSystemModel.hasChildren (self, QModelIndex parent = QModelIndex())QVariant QFileSystemModel.headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)QFileIconProvider QFileSystemModel.iconProvider (self)Returns the file icon provider for this directory model.
See also setIconProvider().
QModelIndex QFileSystemModel.index (self, int row, int column, QModelIndex parent = QModelIndex())Returns the model item index for the given path and column.
QModelIndex QFileSystemModel.index (self, QString path, int column = 0)bool QFileSystemModel.isDir (self, QModelIndex index)Returns true if the model item index represents a directory; otherwise returns false.
bool QFileSystemModel.isReadOnly (self)QDateTime QFileSystemModel.lastModified (self, QModelIndex index)Returns the date and time when index was last modified.
QMimeData QFileSystemModel.mimeData (self, QModelIndex-list indexes)Returns an object that contains a serialized description of the specified indexes. The format used to describe the items corresponding to the indexes is obtained from the mimeTypes() function.
If the list of indexes is empty, 0 is returned rather than a serialized empty list.
Reimplemented from QAbstractItemModel.
QStringList QFileSystemModel.mimeTypes (self)Returns a list of MIME types that can be used to describe a list of items in the model.
Reimplemented from QAbstractItemModel.
Create a directory with the name in the parent model index.
QVariant QFileSystemModel.myComputer (self, int role = Qt.DisplayRole)Returns the data stored under the given role for the item "My Computer".
See also Qt.ItemDataRole.
bool QFileSystemModel.nameFilterDisables (self)QStringList QFileSystemModel.nameFilters (self)Returns a list of filters applied to the names in the model.
See also setNameFilters().
Returns the complete OR-ed together combination of QFile.Permission for the index.
bool QFileSystemModel.remove (self, QModelIndex aindex)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 rmdir().
bool QFileSystemModel.resolveSymlinks (self)bool QFileSystemModel.rmdir (self, QModelIndex aindex)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 remove().
QDir QFileSystemModel.rootDirectory (self)The currently set directory
See also rootPath().
QString QFileSystemModel.rootPath (self)The currently set root path
See also setRootPath() and rootDirectory().
int QFileSystemModel.rowCount (self, QModelIndex parent = QModelIndex())bool QFileSystemModel.setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)QFileSystemModel.setFilter (self, QDir.Filters filters)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.
See also filter() and QDir.Filters.
QFileSystemModel.setIconProvider (self, QFileIconProvider provider)Sets the provider of file icons for the directory model.
See also iconProvider().
QFileSystemModel.setNameFilterDisables (self, bool enable)QFileSystemModel.setNameFilters (self, QStringList filters)Sets the name filters to apply against the existing files.
See also nameFilters().
QFileSystemModel.setReadOnly (self, bool enable)QFileSystemModel.setResolveSymlinks (self, bool enable)QModelIndex QFileSystemModel.setRootPath (self, QString path)Sets the directory that is being watched by the model to newPath. If the path is changed the model will be reset.
See also rootPath().
long QFileSystemModel.size (self, QModelIndex index)Returns the size in bytes of index. If the file does not exist, 0 is returned.
QFileSystemModel.sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)Qt.DropActions QFileSystemModel.supportedDropActions (self)QFileSystemModel.timerEvent (self, QTimerEvent event)QString QFileSystemModel.type (self, QModelIndex index)Returns the type of file index such as "Directory" or "JPEG file".
Qt Signal Documentationvoid fileRenamed (const QString&,const QString&,const QString&)This signal is emitted whenever a file with the oldName is successfully renamed to newName. The file is located in in the directory path.
void rootPathChanged (const QString&)This signal is emitted whenever the root path has been changed to a newPath.
|