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

#include <qfilesystemmodel.h>

Inheritance diagram for QFileSystemModel:

Collaboration diagram for QFileSystemModel:

Public Types
enum	Roles { FileIconRole = Qt::DecorationRole , FilePathRole = Qt::UserRole + 1 , FileNameRole = Qt::UserRole + 2 , FilePermissions = Qt::UserRole + 3 }

enum	Option { DontWatchForChanges = 0x00000001 , DontResolveSymlinks = 0x00000002 , DontUseCustomDirectoryIcons = 0x00000004 }

Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }

enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Signals
void	rootPathChanged (const QString &newPath)

void	fileRenamed (const QString &path, const QString &oldName, const QString &newName)

void	directoryLoaded (const QString &path)

Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

void	layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)

void	modelAboutToBeReset (QPrivateSignal)

void	modelReset (QPrivateSignal)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)

void	rowsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row, QPrivateSignal)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)

void	columnsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int column, QPrivateSignal)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QFileSystemModel (QObject *parent=nullptr)

	~QFileSystemModel ()

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

QModelIndex	index (const QString &path, int column=0) const

QModelIndex	parent (const QModelIndex &child) const override

QModelIndex	sibling (int row, int column, const QModelIndex &idx) const override

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override

bool	canFetchMore (const QModelIndex &parent) const override

void	fetchMore (const QModelIndex &parent) override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QVariant	myComputer (int role=Qt::DisplayRole) const

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

Qt::ItemFlags	flags (const QModelIndex &index) const override

void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override

QStringList	mimeTypes () const override

QMimeData *	mimeData (const QModelIndexList &indexes) const override

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

Qt::DropActions	supportedDropActions () const override

QHash< int, QByteArray >	roleNames () const override

QModelIndex	setRootPath (const QString &path)

QString	rootPath () const

QDir	rootDirectory () const

void	setIconProvider (QAbstractFileIconProvider *provider)

QAbstractFileIconProvider *	iconProvider () const

void	setFilter (QDir::Filters filters)

QDir::Filters	filter () const

void	setResolveSymlinks (bool enable)

bool	resolveSymlinks () const

void	setReadOnly (bool enable)

bool	isReadOnly () const

void	setNameFilterDisables (bool enable)

bool	nameFilterDisables () const

void	setNameFilters (const QStringList &filters)

QStringList	nameFilters () const

void	setOption (Option option, bool on=true)

bool	testOption (Option option) const

void	setOptions (Options options)

Options	options () const

QString	filePath (const QModelIndex &index) const

bool	isDir (const QModelIndex &index) const

qint64	size (const QModelIndex &index) const

QString	type (const QModelIndex &index) const

QDateTime	lastModified (const QModelIndex &index) const

QModelIndex	mkdir (const QModelIndex &parent, const QString &name)

bool	rmdir (const QModelIndex &index)

QString	fileName (const QModelIndex &index) const

QIcon	fileIcon (const QModelIndex &index) const

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

QFileInfo	fileInfo (const QModelIndex &index) const

bool	remove (const QModelIndex &index)

QObject *	parent () const

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)

virtual	~QAbstractItemModel ()

Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual bool	clearItemData (const QModelIndex &index)

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const

virtual Qt::DropActions	supportedDragActions () const

virtual bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex())

virtual bool	insertColumns (int column, int count, const QModelIndex &parent=QModelIndex())

virtual bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex())

virtual bool	removeColumns (int column, int count, const QModelIndex &parent=QModelIndex())

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	insertRow (int row, const QModelIndex &parent=QModelIndex())

bool	insertColumn (int column, const QModelIndex &parent=QModelIndex())

bool	removeRow (int row, const QModelIndex &parent=QModelIndex())

bool	removeColumn (int column, const QModelIndex &parent=QModelIndex())

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual QModelIndex	buddy (const QModelIndex &index) const

virtual Q_INVOKABLE QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith\|Qt::MatchWrap)) const

virtual QSize	span (const QModelIndex &index) const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const

QObject *	parent () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
	QFileSystemModel (QFileSystemModelPrivate &, QObject *parent=nullptr)

void	timerEvent (QTimerEvent *event) override

bool	event (QEvent *event) override

Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)

QModelIndex	createIndex (int row, int column, const void *data=nullptr) const

QModelIndex	createIndex (int row, int column, quintptr id) const

void	encodeData (const QModelIndexList &indexes, QDataStream &stream) const

bool	decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

void	endInsertRows ()

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	endRemoveRows ()

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

void	endMoveRows ()

void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	endInsertColumns ()

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	endRemoveColumns ()

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)

void	endMoveColumns ()

void	beginResetModel ()

void	endResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndexList	persistentIndexList () const

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
bool	resolveSymlinks
	Whether the directory model should resolve symbolic links. More...

bool	readOnly
	Whether the directory model allows writing to the file system. More...

bool	nameFilterDisables
	Whether files that don't pass the name filter are hidden or disabled. More...

Options	options
	the various options that affect the model More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Slots inherited from QAbstractItemModel
virtual bool	submit ()

virtual void	revert ()

Public Slots inherited from QObject
void	deleteLater ()

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

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

Since: 4.4

\inmodule QtGui

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 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(), fileName() and filePath() 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 \l QApplication.

Definition at line 58 of file qfilesystemmodel.h.

Member Enumeration Documentation

◆ Option

enum QFileSystemModel::Option

Since: 5.14

\value DontWatchForChanges Do not add file watchers to the paths. This reduces overhead when using the model for simple tasks like line edit completion.

\value DontResolveSymlinks Don't resolve symlinks in the file system model. By default, symlinks are resolved.

\value DontUseCustomDirectoryIcons Always use the default directory icon. Some platforms allow the user to set a different icon. Custom icon lookup causes a big performance impact over network or removable drives. This sets the QFileIconProvider::DontUseCustomDirectoryIcons option in the icon provider accordingly.

See also: resolveSymlinks

Enumerator
DontWatchForChanges
DontResolveSymlinks
DontUseCustomDirectoryIcons

Definition at line 79 of file qfilesystemmodel.h.

◆ Roles

enum QFileSystemModel::Roles

\value FileIconRole \value FilePathRole \value FileNameRole \value FilePermissions

Enumerator
FileIconRole
FilePathRole
FileNameRole
FilePermissions

Definition at line 72 of file qfilesystemmodel.h.

Constructor & Destructor Documentation

◆ QFileSystemModel() [1/2]

QFileSystemModel::QFileSystemModel ( QObject * parent = nullptr )

explicit

Constructs a file system model with the given parent.

Definition at line 227 of file qfilesystemmodel.cpp.

◆ ~QFileSystemModel()

QFileSystemModel::~QFileSystemModel ( )

default

Destroys this file system model.

◆ QFileSystemModel() [2/2]

QFileSystemModel::QFileSystemModel	(	QFileSystemModelPrivate &	dd,
		QObject *	parent = `nullptr`
	)

protected

Definition at line 235 of file qfilesystemmodel.cpp.

Member Function Documentation

◆ canFetchMore()

bool QFileSystemModel::canFetchMore ( const QModelIndex & parent ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 641 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ columnCount()

int QFileSystemModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

\reimp

Implements QAbstractItemModel.

Definition at line 686 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

QVariant QFileSystemModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

overridevirtual

\reimp

Implements QAbstractItemModel.

Definition at line 715 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ directoryLoaded

void QFileSystemModel::directoryLoaded ( const QString & path )

signal

Since: 4.7

This signal is emitted when the gatherer thread has finished to load the path.

Here is the caller graph for this function:

◆ dropMimeData()

bool QFileSystemModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

overridevirtual

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. Returns true if the operation was successful.

See also: supportedDropActions()

Reimplemented from QAbstractItemModel.

Definition at line 1206 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ event()

bool QFileSystemModel::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1744 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ fetchMore()

void QFileSystemModel::fetchMore ( const QModelIndex & parent )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 653 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileIcon()

QIcon QFileSystemModel::fileIcon ( const QModelIndex & index ) const

inline

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

Definition at line 183 of file qfilesystemmodel.h.

Here is the call graph for this function:

◆ fileInfo()

QFileInfo QFileSystemModel::fileInfo ( const QModelIndex & index ) const

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

Definition at line 164 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ fileName()

QString QFileSystemModel::fileName ( const QModelIndex & index ) const

inline

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

Definition at line 181 of file qfilesystemmodel.h.

◆ filePath()

QString QFileSystemModel::filePath ( const QModelIndex & index ) const

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

Definition at line 1373 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileRenamed

void QFileSystemModel::fileRenamed	(	const QString &	path,
		const QString &	oldName,
		const QString &	newName
	)

signal

This signal is emitted whenever a file with the oldName is successfully renamed to newName. The file is located in in the directory path.

Here is the caller graph for this function:

◆ filter()

QDir::Filters QFileSystemModel::filter ( ) const

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: QDir::Filters

Definition at line 1614 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ flags()

Qt::ItemFlags QFileSystemModel::flags ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 975 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ hasChildren()

bool QFileSystemModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 624 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ headerData()

QVariant QFileSystemModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 929 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ iconProvider()

QAbstractFileIconProvider * QFileSystemModel::iconProvider ( ) const

Returns the file icon provider for this directory model.

Definition at line 1574 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ index() [1/2]

QModelIndex QFileSystemModel::index	(	const QString &	path,
		int	column = `0`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

Definition at line 292 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ index() [2/2]

QModelIndex QFileSystemModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

overridevirtual

\reimp

Implements QAbstractItemModel.

Definition at line 250 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDir()

bool QFileSystemModel::isDir ( const QModelIndex & index ) const

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

Definition at line 531 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReadOnly()

bool QFileSystemModel::isReadOnly ( ) const

Definition at line 1665 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ lastModified()

QDateTime QFileSystemModel::lastModified ( const QModelIndex & index ) const

Returns the date and time when index was last modified.

Definition at line 568 of file qfilesystemmodel.cpp.

◆ mimeData()

QMimeData * QFileSystemModel::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

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, \nullptr is returned rather than a serialized empty list.

Reimplemented from QAbstractItemModel.

Definition at line 1186 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ mimeTypes()

QStringList QFileSystemModel::mimeTypes ( ) const

overridevirtual

Returns a list of MIME types that can be used to describe a list of items in the model.

Reimplemented from QAbstractItemModel.

Definition at line 1173 of file qfilesystemmodel.cpp.

◆ mkdir()

QModelIndex QFileSystemModel::mkdir	(	const QModelIndex &	parent,
		const QString &	name
	)

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

Definition at line 1428 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ myComputer()

QVariant QFileSystemModel::myComputer ( int role = Qt::DisplayRole ) const

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

See also: Qt::ItemDataRole

Definition at line 696 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nameFilterDisables()

bool QFileSystemModel::nameFilterDisables ( ) const

Definition at line 1687 of file qfilesystemmodel.cpp.

◆ nameFilters()

QStringList QFileSystemModel::nameFilters ( ) const

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

Definition at line 1731 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ options()

QFileSystemModel::Options QFileSystemModel::options ( ) const

Definition at line 1352 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parent() [1/2]

QObject * QObject::parent

inline

Returns a pointer to the parent object.

See also: children()

Definition at line 409 of file qobject.h.

Here is the caller graph for this function:

◆ parent() [2/2]

QModelIndex QFileSystemModel::parent ( const QModelIndex & index ) const

overridevirtual

\reimp

Implements QAbstractItemModel.

Definition at line 579 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ permissions()

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

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

Definition at line 1451 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ remove()

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

Definition at line 204 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveSymlinks()

bool QFileSystemModel::resolveSymlinks ( ) const

Definition at line 1640 of file qfilesystemmodel.cpp.

◆ rmdir()

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

Definition at line 1756 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ roleNames()

QHash< int, QByteArray > QFileSystemModel::roleNames ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 1257 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ rootDirectory()

QDir QFileSystemModel::rootDirectory ( ) const

The currently set directory

See also: rootPath()

Definition at line 1550 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rootPath()

QString QFileSystemModel::rootPath ( ) const

The currently set root path

See also: rootDirectory()

Definition at line 1539 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ rootPathChanged

void QFileSystemModel::rootPathChanged ( const QString & newPath )

signal

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

Here is the caller graph for this function:

◆ rowCount()

int QFileSystemModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

\reimp

Implements QAbstractItemModel.

Definition at line 670 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setData()

bool QFileSystemModel::setData	(	const QModelIndex &	idx,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 864 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ setFilter()

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: QDir::Filters

Definition at line 1592 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ setIconProvider()

void QFileSystemModel::setIconProvider ( QAbstractFileIconProvider * provider )

Sets the provider of file icons for the directory model.

Definition at line 1562 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ setNameFilterDisables()

void QFileSystemModel::setNameFilterDisables ( bool enable )

Definition at line 1677 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ setNameFilters()

void QFileSystemModel::setNameFilters ( const QStringList & filters )

Sets the name filters to apply against the existing files.

Definition at line 1696 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOption()

void QFileSystemModel::setOption	(	Option	option,
		bool	on = `true`
	)

Since: 5.14 Sets the given option to be enabled if on is true; otherwise, clears the given option.

Options should be set before changing properties.

See also: options, testOption()

Definition at line 1297 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ setOptions()

void QFileSystemModel::setOptions ( Options options )

Definition at line 1327 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ setReadOnly()

void QFileSystemModel::setReadOnly ( bool enable )

Definition at line 1659 of file qfilesystemmodel.cpp.

Here is the caller graph for this function:

◆ setResolveSymlinks()

void QFileSystemModel::setResolveSymlinks ( bool enable )

Definition at line 1630 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ setRootPath()

QModelIndex QFileSystemModel::setRootPath ( const QString & newPath )

Sets the directory that is being watched by the model to newPath by installing a \l{QFileSystemWatcher}{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.

Definition at line 1470 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ sibling()

QModelIndex QFileSystemModel::sibling	(	int	row,
		int	column,
		const QModelIndex &	idx
	)		const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 275 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ size()

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

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

Definition at line 546 of file qfilesystemmodel.cpp.

◆ sort()

void QFileSystemModel::sort	(	int	column,
		Qt::SortOrder	order = `Qt::AscendingOrder`
	)

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 1133 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ supportedDropActions()

Qt::DropActions QFileSystemModel::supportedDropActions ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 1249 of file qfilesystemmodel.cpp.

◆ testOption()

bool QFileSystemModel::testOption ( Option option ) const

Since: 5.14

Returns true if the given option is enabled; otherwise, returns false.

See also: options, setOption()

Definition at line 1311 of file qfilesystemmodel.cpp.

◆ timerEvent()

void QFileSystemModel::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 507 of file qfilesystemmodel.cpp.

Here is the call graph for this function:

◆ type()

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

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

Definition at line 557 of file qfilesystemmodel.cpp.

Property Documentation

◆ nameFilterDisables

QFileSystemModel::nameFilterDisables

readwrite

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

This property is true by default

Definition at line 188 of file qfilesystemmodel.h.

◆ options

QFileSystemModel::options

readwrite

the various options that affect the model

Since: 5.14

By default, all options are disabled.

Options should be set before changing properties.

See also: setOption(), testOption()

Definition at line 188 of file qfilesystemmodel.h.

◆ readOnly

QFileSystemModel::readOnly

readwrite

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

Definition at line 188 of file qfilesystemmodel.h.

◆ resolveSymlinks

QFileSystemModel::resolveSymlinks

readwrite

Whether the directory model should resolve symbolic links.

This is only relevant on Windows.

By default, this property is true.

See also: QFileSystemModel::Options

Definition at line 188 of file qfilesystemmodel.h.

The documentation for this class was generated from the following files:

src/gui/itemmodels/qfilesystemmodel.h
src/gui/itemmodels/qfilesystemmodel.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Option

◆ Roles

Constructor & Destructor Documentation

◆ QFileSystemModel() [1/2]

◆ ~QFileSystemModel()

◆ QFileSystemModel() [2/2]

Member Function Documentation

◆ canFetchMore()

◆ columnCount()

◆ data()

◆ directoryLoaded

◆ dropMimeData()

◆ event()

◆ fetchMore()

◆ fileIcon()

◆ fileInfo()

◆ fileName()

◆ filePath()

◆ fileRenamed

◆ filter()

◆ flags()

◆ hasChildren()

◆ headerData()

◆ iconProvider()

◆ index() [1/2]

◆ index() [2/2]

◆ isDir()

◆ isReadOnly()

◆ lastModified()

◆ mimeData()

◆ mimeTypes()

◆ mkdir()

◆ myComputer()

◆ nameFilterDisables()

◆ nameFilters()

◆ options()

◆ parent() [1/2]

◆ parent() [2/2]

◆ permissions()

◆ remove()

◆ resolveSymlinks()

◆ rmdir()

◆ roleNames()

◆ rootDirectory()

◆ rootPath()

◆ rootPathChanged

◆ rowCount()

◆ setData()

◆ setFilter()

◆ setIconProvider()

◆ setNameFilterDisables()

◆ setNameFilters()

◆ setOption()

◆ setOptions()

◆ setReadOnly()

◆ setResolveSymlinks()

◆ setRootPath()

◆ sibling()

◆ size()

◆ sort()

◆ supportedDropActions()

◆ testOption()

◆ timerEvent()

◆ type()

Property Documentation

◆ nameFilterDisables

◆ options

◆ readOnly

◆ resolveSymlinks