Skip to content

PythonQt.QtGui.QFileSystemModel · declarations 002

Back to PythonQt.QtGui.QFileSystemModel

nameFilterDisables instance-attribute

nameFilterDisables: bool

Qt 5 reference:

nameFilterDisables : bool

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

This property is true by default

Access functions:

bool nameFilterDisables() const
void setNameFilterDisables(bool enable)

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#nameFilterDisables

nameFilters

nameFilters() -> tuple

X.nameFilters() -> tuple

Supplemental documentation: Qt 5 reference:

QStringList QFileSystemModel::nameFilters() const

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

See also setNameFilters().

Upstream PySide2 reference signatures (binding differences may apply):

nameFilters(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#nameFilters

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.objectNameChanged; argument details are not documented.

options instance-attribute

options: Any

Qt 5 reference:

options : Options

This property holds the various options that affect the model

By default, all options are disabled.

Options should be set before changing properties.

This property was introduced in Qt 5.14.

Access functions:

QFileSystemModel::Options options() const
void setOptions(QFileSystemModel::Options options)

See also setOption() and testOption().

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#options

parent

parent(child: Any) -> Any

X.parent(child) -> PythonQt.QtCore.QModelIndex

Supplemental documentation: Qt 5 reference:

[override virtual] QModelIndex QFileSystemModel::parent(const QModelIndex \&index) const

Reimplements: QAbstractItemModel::parent(const QModelIndex \&index) const.

Upstream PySide2 reference signatures (binding differences may apply):

parent(self) -> PySide2.QtCore.QObject
parent(self, child: PySide2.QtCore.QModelIndex) -> PySide2.QtCore.QModelIndex

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#parent

permissions

permissions(index: Any) -> Any

X.permissions(index)

Supplemental documentation: Qt 5 reference:

QFile::Permissions QFileSystemModel::permissions(const QModelIndex \&index) const

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

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#permissions

readOnly instance-attribute

readOnly: Any

Qt 5 reference:

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

Access functions:

bool isReadOnly() const
void setReadOnly(bool enable)

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#readOnly

remove

remove(index: Any) -> bool

X.remove(index) -> bool

Supplemental documentation: Qt 5 reference:

bool QFileSystemModel::remove(const QModelIndex \&index)

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

Upstream PySide2 reference signatures (binding differences may apply):

remove(self, index: PySide2.QtCore.QModelIndex) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#remove

resolveSymlinks: bool

Qt 5 reference:

This property holds whether the directory model should resolve symbolic links

This is only relevant on Windows.

By default, this property is true.

Access functions:

bool resolveSymlinks() const
void setResolveSymlinks(bool enable)

See also QFileSystemModel::Options.

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#resolveSymlinks

rmdir

rmdir(index: Any) -> bool

X.rmdir(index) -> bool

Supplemental documentation: Qt 5 reference:

bool QFileSystemModel::rmdir(const QModelIndex \&index)

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

Upstream PySide2 reference signatures (binding differences may apply):

rmdir(self, index: PySide2.QtCore.QModelIndex) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#rmdir

rootDirectory

rootDirectory() -> Any

X.rootDirectory() -> PythonQt.QtCore.QDir

Supplemental documentation: Qt 5 reference:

QDir QFileSystemModel::rootDirectory() const

The currently set directory

See also rootPath().

Upstream PySide2 reference signatures (binding differences may apply):

rootDirectory(self) -> PySide2.QtCore.QDir

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#rootDirectory

rootPath

rootPath() -> str

X.rootPath() -> str

Supplemental documentation: Qt 5 reference:

QString QFileSystemModel::rootPath() const

The currently set root path

See also setRootPath() and rootDirectory().

Upstream PySide2 reference signatures (binding differences may apply):

rootPath(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#rootPath

rootPathChanged

rootPathChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rootPathChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QFileSystemModel::rootPathChanged(const QString \&newPath)

This signal is emitted whenever the root path has been changed to a newPath.

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#rootPathChanged

rowCount

rowCount(parent: Any) -> int

X.rowCount(parent) -> int

Supplemental documentation: Qt 5 reference:

[override virtual] int QFileSystemModel::rowCount(const QModelIndex \&parent \= QModelIndex()) const

Reimplements: QAbstractItemModel::rowCount(const QModelIndex \&parent) const.

Upstream PySide2 reference signatures (binding differences may apply):

rowCount(self, parent: PySide2.QtCore.QModelIndex=...) -> int

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#rowCount

rowsAboutToBeInserted

rowsAboutToBeInserted(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsAboutToBeInserted; argument details are not documented.

rowsAboutToBeMoved

rowsAboutToBeMoved(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsAboutToBeMoved; argument details are not documented.

rowsAboutToBeRemoved

rowsAboutToBeRemoved(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsAboutToBeRemoved; argument details are not documented.

rowsInserted

rowsInserted(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsInserted; argument details are not documented.

rowsMoved

rowsMoved(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsMoved; argument details are not documented.

rowsRemoved

rowsRemoved(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QFileSystemModel.rowsRemoved; argument details are not documented.

setData

setData(index: Any, value: Any, role: int) -> bool

X.setData(index, value, role) -> bool

Supplemental documentation: Qt 5 reference:

[override virtual] bool QFileSystemModel::setData(const QModelIndex \&idx, const QVariant \&value, int role \= Qt::EditRole)

Reimplements: QAbstractItemModel::setData(const QModelIndex \&index, const QVariant \&value, int role).

See also data().

Upstream PySide2 reference signatures (binding differences may apply):

setData(self, index: PySide2.QtCore.QModelIndex, value: typing.Any, role: int=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setData

setFilter

setFilter(filters: Any) -> None

X.setFilter(filters)

Supplemental documentation: Qt 5 reference:

void QFileSystemModel::setFilter(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.

Upstream PySide2 reference signatures (binding differences may apply):

setFilter(self, filters: PySide2.QtCore.QDir.Filters) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setFilter

setIconProvider

setIconProvider(provider: Any) -> None

X.setIconProvider(provider)

Supplemental documentation: Qt 5 reference:

void QFileSystemModel::setIconProvider(QFileIconProvider *provider)

Sets the provider of file icons for the directory model.

See also iconProvider().

Upstream PySide2 reference signatures (binding differences may apply):

setIconProvider(self, provider: PySide2.QtWidgets.QFileIconProvider) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setIconProvider

setNameFilterDisables

setNameFilterDisables(enable: bool) -> None

X.setNameFilterDisables(enable)

Upstream PySide2 reference signatures (binding differences may apply):

setNameFilterDisables(self, enable: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setNameFilterDisables

setNameFilters

setNameFilters(filters: Any) -> None

X.setNameFilters(filters)

Supplemental documentation: Qt 5 reference:

void QFileSystemModel::setNameFilters(const QStringList \&filters)

Sets the name filters to apply against the existing files.

See also nameFilters().

Upstream PySide2 reference signatures (binding differences may apply):

setNameFilters(self, filters: typing.Sequence[str]) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setNameFilters

setReadOnly

setReadOnly(enable: bool) -> None

X.setReadOnly(enable)

Upstream PySide2 reference signatures (binding differences may apply):

setReadOnly(self, enable: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setReadOnly

setResolveSymlinks(enable: bool) -> None

X.setResolveSymlinks(enable)

Upstream PySide2 reference signatures (binding differences may apply):

setResolveSymlinks(self, enable: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setResolveSymlinks

setRootPath

setRootPath(path: str) -> Any

X.setRootPath(path) -> PythonQt.QtCore.QModelIndex

Supplemental documentation: Qt 5 reference:

QModelIndex QFileSystemModel::setRootPath(const QString \&newPath)

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.

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

Upstream PySide2 reference signatures (binding differences may apply):

setRootPath(self, path: str) -> PySide2.QtCore.QModelIndex

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#setRootPath

sibling

sibling(row: int, column: int, idx: Any) -> Any

X.sibling(row, column, idx) -> PythonQt.QtCore.QModelIndex

Supplemental documentation: Qt 5 reference:

[override virtual] QModelIndex QFileSystemModel::sibling(int row, int column, const QModelIndex \&idx) const

Reimplements: QAbstractItemModel::sibling(int row, int column, const QModelIndex \&index) const.

Upstream PySide2 reference signatures (binding differences may apply):

sibling(self, row: int, column: int, idx: PySide2.QtCore.QModelIndex) -> PySide2.QtCore.QModelIndex

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#sibling

size

size(index: Any) -> int

X.size(index) -> int

Supplemental documentation: Qt 5 reference:

qint64 QFileSystemModel::size(const QModelIndex \&index) const

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

Upstream PySide2 reference signatures (binding differences may apply):

size(self, index: PySide2.QtCore.QModelIndex) -> int

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#size

sort

sort(column: int, order: Any) -> None

X.sort(column, order)

Supplemental documentation: Qt 5 reference:

[override virtual] void QFileSystemModel::sort(int column, Qt::SortOrder order \= Qt::AscendingOrder)

Reimplements: QAbstractItemModel::sort(int column, Qt::SortOrder order).

Upstream PySide2 reference signatures (binding differences may apply):

sort(self, column: int, order: PySide2.QtCore.Qt.SortOrder=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#sort

supportedDropActions

supportedDropActions() -> Any

X.supportedDropActions()

Supplemental documentation: Qt 5 reference:

[override virtual] Qt::DropActions QFileSystemModel::supportedDropActions() const

Reimplements: QAbstractItemModel::supportedDropActions() const.

Upstream PySide2 reference signatures (binding differences may apply):

supportedDropActions(self) -> PySide2.QtCore.Qt.DropActions

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#supportedDropActions

timerEvent

timerEvent(event: Any) -> None

X.timerEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QFileSystemModel::timerEvent(QTimerEvent *event)

Reimplements: QObject::timerEvent(QTimerEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

timerEvent(self, event: PySide2.QtCore.QTimerEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#timerEvent

type

type(index: Any) -> str

X.type(index) -> str

Supplemental documentation: Qt 5 reference:

QString QFileSystemModel::type(const QModelIndex \&index) const

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

Upstream PySide2 reference signatures (binding differences may apply):

type(self, index: PySide2.QtCore.QModelIndex) -> str

Source: https://doc.qt.io/archives/qt-5.15/qfilesystemmodel.html#type