Skip to content

PythonQt.QtGui.QDirModel

QDirModel

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

The usage of QDirModel is not recommended anymore. The QFileSystemModel class is a more performant alternative.

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

QDirModel keeps a cache with file information. The cache needs to be updated with refresh().

QDirModel 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() and isDir() functions provide information about the underlying files and directories related to items in the model.

Directories can be created and removed using mkdir(), rmdir(), and the model will be automatically updated to take the changes into account.

Note: QDirModel requires an instance of QApplication.

Source: https://doc.qt.io/archives/qt-5.15/qdirmodel.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
CheckIndexOption attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
DoNotUseParent attribute Any (shared captured text)
FileIconRole attribute Any
FileNameRole attribute Any
FilePathRole attribute Any
HorizontalSortHint attribute Any (shared captured text)
IndexIsValid attribute Any (shared captured text)
LayoutChangeHint attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
NoLayoutChangeHint attribute Any (shared captured text)
NoOption attribute Any (shared captured text)
ParentIsInvalid attribute Any (shared captured text)
Roles attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
VerticalSortHint attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
beginInsertColumns function (self, parent: Any, first: Any, last: Any) -> Any X.beginInsertColumns(parent, first, last) (shared captured text)
beginInsertRows function (self, parent: Any, first: Any, last: Any) -> Any X.beginInsertRows(parent, first, last) (shared captured text)
beginMoveColumns function (self, sourceParent: Any, sourceFirst: Any, sourceLast: Any, destinationParent: Any, destinationColumn: Any) … X.beginMoveColumns(sourceParent, sourceFirst, sourceLast, destinationParent, destinationColumn) -> bool (shared captured text)
beginMoveRows function (self, sourceParent: Any, sourceFirst: Any, sourceLast: Any, destinationParent: Any, destinationRow: Any) -> … X.beginMoveRows(sourceParent, sourceFirst, sourceLast, destinationParent, destinationRow) -> bool (shared captured text)
beginRemoveColumns function (self, parent: Any, first: Any, last: Any) -> Any X.beginRemoveColumns(parent, first, last) (shared captured text)
beginRemoveRows function (self, parent: Any, first: Any, last: Any) -> Any X.beginRemoveRows(parent, first, last) (shared captured text)
beginResetModel function (self) -> Any (shared captured text)
blockSignals function (self, b: Any) -> bool X.blockSignals(b) -> bool (shared captured text)
buddy function (self, index: Any) -> Any X.buddy(index) -> PythonQt.QtCore.QModelIndex (shared captured text)
canDropMimeData function (self, data: Any, action: Any, row: Any, column: Any, parent: Any) -> bool X.canDropMimeData(data, action, row, column, parent) -> bool (shared captured text)
canFetchMore function (self, parent: Any) -> bool X.canFetchMore(parent) -> bool (shared captured text)
changePersistentIndex function (self, *args: Any, **kwargs: Any) -> Any X.changePersistentIndex(from, to) (shared captured text)
changePersistentIndexList function (self, *args: Any, **kwargs: Any) -> Any X.changePersistentIndexList(from, to) (shared captured text)
childEvent function (self, event: Any) -> Any (shared captured text)
children function (self) -> tuple X.children() -> tuple (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
columnCount function (self, parent: Any) -> int X.columnCount(parent) -> int
columnsAboutToBeInserted function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsAboutToBeInserted; argument details are not documented.
columnsAboutToBeMoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsAboutToBeMoved; argument details are not documented.
columnsAboutToBeRemoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsAboutToBeRemoved; argument details are not documented.
columnsInserted function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsInserted; argument details are not documented.
columnsMoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsMoved; argument details are not documented.
columnsRemoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.columnsRemoved; argument details are not documented.
connect function (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool X.connect(signal, receiver, slot, type) -> bool (shared captured text)
createIndex function (self, row: Any, column: Any, id: Any) -> Any X.createIndex(row, column, id) -> PythonQt.QtCore.QModelIndex (shared captured text)
customEvent function (self, event: Any) -> Any (shared captured text)
data function (self, index: Any, role: int) -> Any X.data(index, role) -> object
dataChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.dataChanged; argument details are not documented.
decodeData function (self, row: Any, column: Any, parent: Any, stream: Any) -> bool X.decodeData(row, column, parent, stream) -> bool (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
deleteLater function (self) -> Any (shared captured text)
destroyed function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.destroyed; argument details are not documented.
disconnect function (self, signal: Any, receiver: Any, slot: Any) -> bool X.disconnect(signal, receiver, slot) -> bool (shared captured text)
dropMimeData function (self, data: Any, action: Any, row: int, column: int, parent: Any) -> bool X.dropMimeData(data, action, row, column, parent) -> bool
dumpObjectInfo function (self) -> Any (shared captured text)
dumpObjectTree function (self) -> Any (shared captured text)
dynamicPropertyNames function (self) -> Any (shared captured text)
encodeData function (self, indexes: Any, stream: Any) -> Any X.encodeData(indexes, stream) (shared captured text)
endInsertColumns function (self) -> Any (shared captured text)
endInsertRows function (self) -> Any (shared captured text)
endMoveColumns function (self) -> Any (shared captured text)
endMoveRows function (self) -> Any (shared captured text)
endRemoveColumns function (self) -> Any (shared captured text)
endRemoveRows function (self) -> Any (shared captured text)
endResetModel function (self) -> Any (shared captured text)
event function (self, event: Any) -> bool X.event(event) -> bool (shared captured text)
eventFilter function (self, watched: Any, event: Any) -> bool X.eventFilter(watched, event) -> bool (shared captured text)
fetchMore function (self, parent: Any) -> Any (shared captured text)
fileIcon function (self, index: Any) -> Any X.fileIcon(index) -> PythonQt.QtGui.QIcon
fileInfo function (self, index: Any) -> Any X.fileInfo(index) -> PythonQt.QtCore.QFileInfo
fileName function (self, index: Any) -> str X.fileName(index) -> str
filePath function (self, index: Any) -> str X.filePath(index) -> str
filter function (self) -> Any Returns the filter specification for the directory model.
findChild function (self, type: Any, name: Any) -> Any X.findChild(type, name) -> PythonQt.private.QObject (shared captured text)
findChildren function (self, type: Any, name: Any) -> tuple X.findChildren(type, name) -> tuple (shared captured text)
flags function (self, index: Any) -> Any Reimplements: [QAbstractItemModel::flags](https://doc.qt.io/archives/qt-5.15/qabstractitemmodel.html#flags)(const QModelIndex \&index) const.
hasChildren function (self, index: Any) -> bool X.hasChildren(index) -> bool
hasIndex function (self, row: Any, column: Any, parent: Any) -> bool X.hasIndex(row, column, parent) -> bool (shared captured text)
headerData function (self, section: int, orientation: Any, role: int) -> Any X.headerData(section, orientation, role) -> object
headerDataChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.headerDataChanged; argument details are not documented.
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
iconProvider function (self) -> Any X.iconProvider() -> PythonQt.QtGui.QFileIconProvider
index function (self, row: Any, column: int, parent: Any) -> Any X.index(row, column, parent) -> PythonQt.QtCore.QModelIndex
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
insertColumn function (self, column: Any, parent: Any) -> bool X.insertColumn(column, parent) -> bool (shared captured text)
insertColumns function (self, column: Any, count: Any, parent: Any) -> bool X.insertColumns(column, count, parent) -> bool (shared captured text)
insertRow function (self, row: Any, parent: Any) -> bool X.insertRow(row, parent) -> bool (shared captured text)
insertRows function (self, row: Any, count: Any, parent: Any) -> bool X.insertRows(row, count, parent) -> bool (shared captured text)
installEventFilter function (self, filterObj: Any) -> Any (shared captured text)
isDir function (self, index: Any) -> bool X.isDir(index) -> bool
isReadOnly function (self) -> bool X.isReadOnly() -> bool
isSignalConnected function (self, signal: Any) -> bool X.isSignalConnected(signal) -> bool (shared captured text)
isWidgetType function (self) -> bool X.isWidgetType() -> bool (shared captured text)
isWindowType function (self) -> bool X.isWindowType() -> bool (shared captured text)
itemData function (self, index: Any) -> dict X.itemData(index) -> dict (shared captured text)
killTimer function (self, id: Any) -> Any (shared captured text)
layoutAboutToBeChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.layoutAboutToBeChanged; argument details are not documented.
layoutChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.layoutChanged; argument details are not documented.
lazyChildCount attribute bool This property holds whether the directory model optimizes the [hasChildren](https://doc.qt.io/archives/qt-5.15/qdirmodel.html#hasChildren) function to only check if the item is a directory.
match function (self, start: Any, role: Any, value: Any, hits: Any, arg4: flags) -> tuple X.match(start, role, value, hits, flags) -> tuple (shared captured text)
metaObject function (self) -> Any X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text)
mimeData function (self, indexes: Any) -> Any X.mimeData(indexes) -> PythonQt.QtCore.QMimeData
mimeTypes function (self) -> tuple X.mimeTypes() -> tuple
mkdir function (self, parent: Any, name: str) -> Any X.mkdir(parent, name) -> PythonQt.QtCore.QModelIndex
modelAboutToBeReset function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.modelAboutToBeReset; argument details are not documented.
modelReset function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.modelReset; argument details are not documented.
moveColumn function (self, sourceParent: Any, sourceColumn: Any, destinationParent: Any, destinationChild: Any) -> bool X.moveColumn(sourceParent, sourceColumn, destinationParent, destinationChild) -> bool (shared captured text)
moveColumns function (self, sourceParent: Any, sourceColumn: Any, count: Any, destinationParent: Any, destinationChild: Any) -> bo… X.moveColumns(sourceParent, sourceColumn, count, destinationParent, destinationChild) -> bool (shared captured text)
moveRow function (self, sourceParent: Any, sourceRow: Any, destinationParent: Any, destinationChild: Any) -> bool X.moveRow(sourceParent, sourceRow, destinationParent, destinationChild) -> bool (shared captured text)
moveRows function (self, sourceParent: Any, sourceRow: Any, count: Any, destinationParent: Any, destinationChild: Any) -> bool X.moveRows(sourceParent, sourceRow, count, destinationParent, destinationChild) -> bool (shared captured text)
moveToThread function (self, thread: Any) -> Any (shared captured text)
nameFilters function (self) -> tuple X.nameFilters() -> tuple
objectName attribute Any (shared captured text)
objectNameChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.objectNameChanged; argument details are not documented.
parent function (self, child: Any) -> Any X.parent(child) -> PythonQt.QtCore.QModelIndex
persistentIndexList function (self) -> tuple X.persistentIndexList() -> tuple (shared captured text)
property function (self, name: Any) -> Any X.property(name) -> object (shared captured text)
readOnly attribute Any This property holds whether the directory model allows writing to the file system
refresh function (self, parent: Any) -> None [QDirModel](https://doc.qt.io/archives/qt-5.15/qdirmodel.html) caches file information.
remove function (self, index: Any) -> bool X.remove(index) -> bool
removeColumn function (self, column: Any, parent: Any) -> bool X.removeColumn(column, parent) -> bool (shared captured text)
removeColumns function (self, column: Any, count: Any, parent: Any) -> bool X.removeColumns(column, count, parent) -> bool (shared captured text)
removeEventFilter function (self, obj: Any) -> Any (shared captured text)
removeRow function (self, row: Any, parent: Any) -> bool X.removeRow(row, parent) -> bool (shared captured text)
removeRows function (self, row: Any, count: Any, parent: Any) -> bool X.removeRows(row, count, parent) -> bool (shared captured text)
resolveSymlinks attribute bool This property holds whether the directory model should resolve symbolic links
revert function (self) -> Any (shared captured text)
rmdir function (self, index: Any) -> bool X.rmdir(index) -> bool
roleNames function (self) -> dict X.roleNames() -> dict (shared captured text)
rowCount function (self, parent: Any) -> int X.rowCount(parent) -> int
rowsAboutToBeInserted function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsAboutToBeInserted; argument details are not documented.
rowsAboutToBeMoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsAboutToBeMoved; argument details are not documented.
rowsAboutToBeRemoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsAboutToBeRemoved; argument details are not documented.
rowsInserted function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsInserted; argument details are not documented.
rowsMoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsMoved; argument details are not documented.
rowsRemoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QDirModel.rowsRemoved; argument details are not documented.
sender function (self) -> Any X.sender() -> PythonQt.private.QObject (shared captured text)
senderSignalIndex function (self) -> int X.senderSignalIndex() -> int (shared captured text)
setData function (self, index: Any, value: Any, role: int) -> bool X.setData(index, value, role) -> bool
setFilter function (self, filters: Any) -> None Sets the directory model's filter to that specified by filters.
setHeaderData function (self, section: Any, orientation: Any, value: Any, role: Any) -> bool X.setHeaderData(section, orientation, value, role) -> bool (shared captured text)
setIconProvider function (self, provider: Any) -> None Sets the provider of file icons for the directory model.
setItemData function (self, index: Any, roles: Any) -> bool X.setItemData(index, roles) -> bool (shared captured text)
setLazyChildCount function (self, enable: bool) -> None
setNameFilters function (self, filters: Any) -> None Sets the name filters for the directory model.
setObjectName function (self, name: Any) -> Any (shared captured text)
setParent function (self, parent: Any) -> Any (shared captured text)
setProperty function (self, name: Any, value: Any) -> bool X.setProperty(name, value) -> bool (shared captured text)
setReadOnly function (self, enable: bool) -> None
setResolveSymlinks function (self, enable: bool) -> None
setSorting function (self, sort: Any) -> None Sets the directory model's sorting order to that specified by sort.
sibling function (self, row: Any, column: Any, idx: Any) -> Any X.sibling(row, column, idx) -> PythonQt.QtCore.QModelIndex
signalsBlocked function (self) -> bool X.signalsBlocked() -> bool (shared captured text)
sort function (self, column: int, order: Any) -> None X.sort(column, order)
sorting function (self) -> Any Returns the sorting method used for the directory model.
span function (self, index: Any) -> Any X.span(index) -> PythonQt.QtCore.QSize (shared captured text)
startTimer function (self, interval: Any, timerType: Any) -> int X.startTimer(interval, timerType) -> int (shared captured text)
submit function (self) -> bool X.submit() -> bool (shared captured text)
supportedDragActions function (self) -> Any (shared captured text)
supportedDropActions function (self) -> Any Reimplements: [QAbstractItemModel::supportedDropActions](https://doc.qt.io/archives/qt-5.15/qabstractitemmodel.html#supportedDropActions)() const.
thread function (self) -> Any (shared captured text)
timerEvent function (self, event: Any) -> Any (shared captured text)
tr function (self, text: Any, ambig: Any, n: Any) -> str X.tr(text, ambig, n) -> str (shared captured text)