QQuickFolderListModel Class Reference

[class begin] More...

#include <qquickfolderlistmodel_p.h>

Inheritance diagram for QQuickFolderListModel:

Collaboration diagram for QQuickFolderListModel:

Public Types
enum	Roles {   FileNameRole = Qt::UserRole + 1 , FilePathRole = Qt::UserRole + 2 , FileBaseNameRole = Qt::UserRole + 3 , FileSuffixRole = Qt::UserRole + 4 ,   FileSizeRole = Qt::UserRole + 5 , FileLastModifiedRole = Qt::UserRole + 6 , FileLastReadRole = Qt::UserRole +7 , FileIsDirRole = Qt::UserRole + 8 ,   FileUrlRole = Qt::UserRole + 9 , FileURLRole = Qt::UserRole + 10 }
enum	SortField {   Unsorted , Name , Time , Size ,   Type }
enum	Status { Null , Ready , Loading }
Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
	This enum describes the way the model changes layout. More...
enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Signals
void	folderChanged ()
	[notifier]
void	rowCountChanged () const
	Q_REVISION (2, 1) void countChanged() const
	Q_REVISION (2, 11) void statusChanged()
Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This signal is emitted whenever the data in an existing item changes.
void	headerDataChanged (Qt::Orientation orientation, int first, int last)
	This signal is emitted whenever a header is changed.
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)
	This signal is emitted just before rows are inserted into the model.
void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been inserted into the model.
void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are removed from the model.
void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been removed from the model.
void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are inserted into the model.
void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been inserted into the model.
void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are removed from the model.
void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been removed from the model.
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 &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickFolderListModel (QObject *parent=nullptr)
	[class props]
	~QQuickFolderListModel ()
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
	\qmlproperty int FolderListModel::count \readonly
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
	Returns the index of the data in row and column with parent.
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
	Returns the data stored under the given role for the item referred to by the index.
QHash< int, QByteArray >	roleNames () const override
int	count () const
	[abslistmodel]
QUrl	folder () const
	[count]
void	setFolder (const QUrl &folder)
QUrl	rootFolder () const
	\qmlproperty url FolderListModel::rootFolder
void	setRootFolder (const QUrl &path)
QUrl	parentFolder () const
	\qmlproperty url FolderListModel::parentFolder \readonly
QStringList	nameFilters () const
	\qmlproperty list<string> FolderListModel::nameFilters
void	setNameFilters (const QStringList &filters)
SortField	sortField () const
	\qmlproperty enumeration FolderListModel::sortField
void	setSortField (SortField field)
bool	sortReversed () const
	\qmlproperty bool FolderListModel::sortReversed
void	setSortReversed (bool rev)
bool	showFiles () const
	\qmlproperty bool FolderListModel::showFiles
void	setShowFiles (bool showFiles)
bool	showDirs () const
	\qmlproperty bool FolderListModel::showDirs
void	setShowDirs (bool showDirs)
bool	showDirsFirst () const
	\qmlproperty bool FolderListModel::showDirsFirst
void	setShowDirsFirst (bool showDirsFirst)
bool	showDotAndDotDot () const
	\qmlproperty bool FolderListModel::showDotAndDotDot
void	setShowDotAndDotDot (bool on)
bool	showHidden () const
	\qmlproperty bool FolderListModel::showHidden
void	setShowHidden (bool on)
bool	showOnlyReadable () const
	\qmlproperty bool FolderListModel::showOnlyReadable
void	setShowOnlyReadable (bool on)
bool	caseSensitive () const
	\qmlproperty bool FolderListModel::caseSensitive
void	setCaseSensitive (bool on)
Status	status () const
	\qmlproperty enumeration FolderListModel::status
bool	sortCaseSensitive () const
	\qmlproperty bool FolderListModel::sortCaseSensitive
void	setSortCaseSensitive (bool on)
Q_INVOKABLE bool	isFolder (int index) const
	[prop funcs]
Q_INVOKABLE QVariant	get (int idx, const QString &property) const
	\qmlmethod var FolderListModel::get(int index, string property)
Q_INVOKABLE int	indexOf (const QUrl &file) const
	\qmlmethod int FolderListModel::indexOf(url file)
void	classBegin () override
	[parserstatus]
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
int	roleFromString (const QString &roleName) const
	[parserstatus]
Public Member Functions inherited from QAbstractListModel
	QAbstractListModel (QObject *parent=nullptr)
	Constructs an abstract list model with the given parent.
	~QAbstractListModel ()
	Destroys the abstract list model.
QModelIndex	sibling (int row, int column, const QModelIndex &idx) const override
	\reimp
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
	\reimp
Qt::ItemFlags	flags (const QModelIndex &index) const override
	\reimp
QObject *	parent () const
	Returns a pointer to the parent object.
Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)
	Constructs an abstract item model with the given parent.
virtual	~QAbstractItemModel ()
	Destroys the abstract item model.
Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
virtual Q_INVOKABLE bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets the role data for the item at index to value.
virtual Q_INVOKABLE QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Returns the data for the given role and section in the header with the specified orientation.
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
	Sets the data for the given role and section in the header with the specified orientation to the value supplied.
virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const
	Returns a map with values for all predefined roles in the model for the item at the given index.
virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
	Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
virtual bool	clearItemData (const QModelIndex &index)
virtual QStringList	mimeTypes () const
	Returns the list of allowed MIME types.
virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
	Returns an object that contains serialized items of data corresponding to the list of indexes specified.
virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	Returns {true} if a model can accept a drop of the data.
virtual Qt::DropActions	supportedDropActions () const
virtual Qt::DropActions	supportedDragActions () const
	Returns the actions supported by the data in this model.
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertRows(int row
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertColumns(int column
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeRows(int row
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeColumns(int column
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertRow(int row
Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertColumn(int column
Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeRow(int row
Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeColumn(int column
Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
virtual Q_INVOKABLE void	fetchMore (const QModelIndex &parent)
	Fetches any available data for the items with the parent specified by the parent index.
virtual Q_INVOKABLE bool	canFetchMore (const QModelIndex &parent) const
	Returns {true} if there is more data available for parent; otherwise returns {false}.
Q_INVOKABLE	Q_REVISION (6, 4) virtual void sort(int column
virtual QModelIndex	buddy (const QModelIndex &index) const
	Returns a model index for the buddy of the item represented by index.
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
	Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
virtual QSize	span (const QModelIndex &index) const
	Returns the row and column span of the item represented by index.
bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
QObject *	parent () const
	Returns a pointer to the parent object.
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject *watched, QEvent *event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false.
bool	isWindowType () const
	Returns true if the object is a window; otherwise returns false.
bool	isQuickItemType () const
	Returns true if the object is a QQuickItem; otherwise returns false.
bool	signalsBlocked () const noexcept
	Returns true if signals are blocked; otherwise returns false.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns true on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
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
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Properties
QUrl	folder
	[class begin]
QUrl	rootFolder
QUrl	parentFolder
QStringList	nameFilters
SortField	sortField
bool	sortReversed
bool	showFiles
FINALbool	showDirs
bool	showDirsFirst
bool	showDotAndDotDot
bool	showHidden
FINALbool	showOnlyReadable
bool	caseSensitive
FINALint	count
Status	status
FINALbool	sortCaseSensitive
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QAbstractItemModel
virtual bool	submit ()
	Lets the model know that it should submit cached information to permanent storage.
virtual void	revert ()
	Lets the model know that it should discard cached information.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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)
	\threadsafe
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::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
	\threadsafe
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a 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)
Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int	count
Q_INVOKABLE int const QModelIndex &	parent = QModelIndex())
	Returns the parent of the model item with the given index.
Q_INVOKABLE int	sourceRow
Q_INVOKABLE int int	count
Q_INVOKABLE int int const QModelIndex &	destinationParent
Q_INVOKABLE int int const QModelIndex int	destinationChild
Q_INVOKABLE int	sourceColumn
Q_INVOKABLE const QModelIndex &	parent = QModelIndex())
Q_INVOKABLE int const QModelIndex &	destinationParent
Q_INVOKABLE int const QModelIndex int	destinationChild
Q_INVOKABLE Qt::SortOrder	order = Qt::AscendingOrder)
Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()
Protected Member Functions inherited from QAbstractListModel
	QAbstractListModel (QAbstractItemModelPrivate &dd, QObject *parent)
Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
QModelIndex	createIndex (int row, int column, const void *data=nullptr) const
	Creates a model index for the given row and column with the internal pointer ptr.
QModelIndex	createIndex (int row, int column, quintptr id) const
	Creates a model index for the given row and column with the internal identifier, id.
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)
	Begins a row insertion operation.
void	endInsertRows ()
	Ends a row insertion operation.
void	beginRemoveRows (const QModelIndex &parent, int first, int last)
	Begins a row removal operation.
void	endRemoveRows ()
	Ends a row removal operation.
bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
void	endMoveRows ()
	Ends a row move operation.
void	beginInsertColumns (const QModelIndex &parent, int first, int last)
	Begins a column insertion operation.
void	endInsertColumns ()
	Ends a column insertion operation.
void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
	Begins a column removal operation.
void	endRemoveColumns ()
	Ends a column removal operation.
bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
	Begins a column move operation.
void	endMoveColumns ()
	Ends a column move operation.
void	beginResetModel ()
	Begins a model reset operation.
void	endResetModel ()
	Completes a model reset operation.
void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
	Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndexList	persistentIndexList () const
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

[class begin]

Definition at line 34 of file qquickfolderlistmodel_p.h.

Member Enumeration Documentation

Roles

enum QQuickFolderListModel::Roles

Enumerator
FileNameRole
FilePathRole
FileBaseNameRole
FileSuffixRole
FileSizeRole
FileLastModifiedRole
FileLastReadRole
FileIsDirRole
FileUrlRole
FileURLRole

Definition at line 66 of file qquickfolderlistmodel_p.h.

SortField

enum QQuickFolderListModel::SortField

Enumerator
Unsorted
Name
Time
Size
Type

Definition at line 100 of file qquickfolderlistmodel_p.h.

Status

enum QQuickFolderListModel::Status

Enumerator
Null
Ready
Loading

Definition at line 123 of file qquickfolderlistmodel_p.h.

Constructor & Destructor Documentation

QQuickFolderListModel()

QQuickFolderListModel::QQuickFolderListModel

(

QObject *

parent = nullptr

)

[class props]

\qmlmodule Qt.labs.folderlistmodel 2.

[abslistmodel]

\QtMinorVersion \title Qt Labs FolderListModel QML Types

The FolderListModel provides a model of the contents of a file system folder.

To use this module, import the module with the following line:

\qml import Qt.labs.folderlistmodel \endqml

\qmltype FolderListModel
\inqmlmodule Qt.labs.folderlistmodel

! \nativetype QQuickFolderListModel

The FolderListModel provides a model of the contents of a file system folder.

FolderListModel provides access to information about the contents of a folder in the local file system, exposing a list of files to views and other data components.

Note

This type is made available by importing the Qt.labs.folderlistmodel module. {Elements in the Qt.labs module are not guaranteed to remain compatible in future versions.}

Some features in FolderListModel depend on \l QFileSystemWatcher. If \l QFileSystemWatcher is disabled, the folder set using setFolder is not watched for changes, which results in signals typically emitted on directory changes (like directoryUpdated or directoryChanged) not being emitted without manually calling setFolder again. For more information, see \l{Qt Configure Options}.

\qml import Qt.labs.folderlistmodel \endqml

The \l folder property specifies the folder to access. Information about the files and directories in the folder is supplied via the model's interface. Components access names and paths via the following roles:

\list

• fileName (string)
• filePath (string)
• fileURL (url) (since Qt 5.2; deprecated since Qt 5.15)
• fileUrl (url) (since Qt 5.15)
• fileBaseName (string)
• fileSuffix (string)
• fileSize (qlonglong)
• fileModified (date)
• fileAccessed (date)
• fileIsDir (bool) \endlist

Additionally a file entry can be differentiated from a folder entry via the isFolder() method.

Definition at line 326 of file qquickfolderlistmodel.cpp.

~QQuickFolderListModel()

QQuickFolderListModel::~QQuickFolderListModel

(

)

Definition at line 343 of file qquickfolderlistmodel.cpp.

Member Function Documentation

caseSensitive()

bool QQuickFolderListModel::caseSensitive

(

)

const

\qmlproperty bool FolderListModel::caseSensitive

Since

5.7

Use case sensitive pattern matching.

By default, this property is true.

Definition at line 811 of file qquickfolderlistmodel.cpp.

classBegin()

void QQuickFolderListModel::classBegin ( )

overridevirtual

[parserstatus]

Implements QQmlParserStatus.

Definition at line 559 of file qquickfolderlistmodel.cpp.

componentComplete()

void QQuickFolderListModel::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 563 of file qquickfolderlistmodel.cpp.

count()

int QQuickFolderListModel::count ( ) const

inline

[abslistmodel]

[count]

Definition at line 86 of file qquickfolderlistmodel_p.h.

data()

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

overridevirtual

Returns the data stored under the given role for the item referred to by the index.

Note

If you do not have a value to return, return an invalid (default-constructed) QVariant.

See also

Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 347 of file qquickfolderlistmodel.cpp.

folder()

QUrl QQuickFolderListModel::folder

(

)

const

[count]

\qmlproperty url FolderListModel::folder

[prop funcs]

The folder property holds a URL for the folder that the model currently provides.

The value must be a file: or qrc: URL, or a relative URL.

The default value is the application's working directory at the time when the FolderListModel is first initialized.

Definition at line 427 of file qquickfolderlistmodel.cpp.

folderChanged

void QQuickFolderListModel::folderChanged ( )

signal

[notifier]

get()

QVariant QQuickFolderListModel::get	(	int	idx,
		const QString &	property ) const

\qmlmethod var FolderListModel::get(int index, string property)

Returns the folder property for the given index. The following properties are available:

\list

• fileName (string)
• filePath (string)
• fileURL (url) (since Qt 5.2; deprecated since Qt 5.15)
• fileUrl (url) (since Qt 5.15)
• fileBaseName (string)
• fileSuffix (string)
• fileSize (qlonglong)
• fileModified (date)
• fileAccessed (date)
• fileIsDir (bool) \endlist

Definition at line 909 of file qquickfolderlistmodel.cpp.

index()

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

overridevirtual

Returns the index of the data in row and column with parent.

See also

parent()

Reimplemented from QAbstractListModel.

Definition at line 411 of file qquickfolderlistmodel.cpp.

indexOf()

int QQuickFolderListModel::indexOf

(

const QUrl &

file

)

const

\qmlmethod int FolderListModel::indexOf(url file)

Since

5.6

Returns the index of the given file URL if the model contains it, or -1 if not.

Definition at line 925 of file qquickfolderlistmodel.cpp.

isFolder()

bool QQuickFolderListModel::isFolder

(

int

index

)

const

[prop funcs]

\qmlmethod bool FolderListModel::isFolder(int index)

Returns true if the entry index is a folder; otherwise returns false.

Definition at line 636 of file qquickfolderlistmodel.cpp.

nameFilters()

QStringList QQuickFolderListModel::nameFilters

(

)

const

\qmlproperty list<string> FolderListModel::nameFilters

The nameFilters property contains a list of file name filters. The filters may include the ? and * wildcards.

The example below filters on PNG and JPEG files:

\qml FolderListModel { nameFilters: [ "*.png", "*.jpg" ] } \endqml

Note

Directories are not excluded by filters.

Definition at line 544 of file qquickfolderlistmodel.cpp.

parentFolder()

QUrl QQuickFolderListModel::parentFolder

(

)

const

\qmlproperty url FolderListModel::parentFolder \readonly

Returns the URL of the parent of the current \l folder.

Definition at line 508 of file qquickfolderlistmodel.cpp.

Q_REVISION [1/2]

QQuickFolderListModel::Q_REVISION ( 2 , 1  ) const

signal

Q_REVISION [2/2]

QQuickFolderListModel::Q_REVISION ( 2 , 11  )

signal

roleFromString()

int QQuickFolderListModel::roleFromString

(

const QString &

roleName

)

const

[parserstatus]

Definition at line 601 of file qquickfolderlistmodel.cpp.

roleNames()

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

overridevirtual

Since

4.6

Returns the model's role names.

The default role names set by Qt are:

\table \header

• Qt Role
• QML Role Name \row
• Qt::DisplayRole
• display \row
• Qt::DecorationRole
• decoration \row
• Qt::EditRole
• edit \row
• Qt::ToolTipRole
• toolTip \row
• Qt::StatusTipRole
• statusTip \row
• Qt::WhatsThisRole
• whatsThis \endtable

Reimplemented from QAbstractItemModel.

Definition at line 391 of file qquickfolderlistmodel.cpp.

rootFolder()

QUrl QQuickFolderListModel::rootFolder

(

)

const

\qmlproperty url FolderListModel::rootFolder

When this property is set, the given folder will be treated as the root in the file system, so that you can only traverse subfolders within it.

Definition at line 478 of file qquickfolderlistmodel.cpp.

rowCount()

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

overridevirtual

\qmlproperty int FolderListModel::count \readonly

Returns the number of items in the current folder that match the filter criteria.

Implements QAbstractItemModel.

Definition at line 404 of file qquickfolderlistmodel.cpp.

rowCountChanged

void QQuickFolderListModel::rowCountChanged ( ) const

signal

setCaseSensitive()

void QQuickFolderListModel::setCaseSensitive

(

bool

on

)

Definition at line 817 of file qquickfolderlistmodel.cpp.

setFolder()

void QQuickFolderListModel::setFolder

(

const QUrl &

folder

)

Definition at line 433 of file qquickfolderlistmodel.cpp.

setNameFilters()

void QQuickFolderListModel::setNameFilters

(

const QStringList &

filters

)

Definition at line 550 of file qquickfolderlistmodel.cpp.

setRootFolder()

void QQuickFolderListModel::setRootFolder

(

const QUrl &

path

)

Definition at line 484 of file qquickfolderlistmodel.cpp.

setShowDirs()

void QQuickFolderListModel::setShowDirs

(

bool

showDirs

)

Definition at line 692 of file qquickfolderlistmodel.cpp.

setShowDirsFirst()

void QQuickFolderListModel::setShowDirsFirst

(

bool

showDirsFirst

)

Definition at line 715 of file qquickfolderlistmodel.cpp.

setShowDotAndDotDot()

void QQuickFolderListModel::setShowDotAndDotDot

(

bool

on

)

Definition at line 740 of file qquickfolderlistmodel.cpp.

setShowFiles()

void QQuickFolderListModel::setShowFiles

(

bool

showFiles

)

Definition at line 666 of file qquickfolderlistmodel.cpp.

setShowHidden()

void QQuickFolderListModel::setShowHidden

(

bool

on

)

Definition at line 766 of file qquickfolderlistmodel.cpp.

setShowOnlyReadable()

void QQuickFolderListModel::setShowOnlyReadable

(

bool

on

)

Definition at line 792 of file qquickfolderlistmodel.cpp.

setSortCaseSensitive()

void QQuickFolderListModel::setSortCaseSensitive

(

bool

on

)

Definition at line 880 of file qquickfolderlistmodel.cpp.

setSortField()

void QQuickFolderListModel::setSortField

(

SortField

field

)

Definition at line 592 of file qquickfolderlistmodel.cpp.

setSortReversed()

void QQuickFolderListModel::setSortReversed

(

bool

rev

)

Definition at line 620 of file qquickfolderlistmodel.cpp.

showDirs()

bool QQuickFolderListModel::showDirs

(

)

const

\qmlproperty bool FolderListModel::showDirs

If true, directories are included in the model; otherwise only files are included.

By default, this property is true.

Note that the nameFilters are not applied to directories.

See also

showDotAndDotDot

Definition at line 686 of file qquickfolderlistmodel.cpp.

showDirsFirst()

bool QQuickFolderListModel::showDirsFirst

(

)

const

\qmlproperty bool FolderListModel::showDirsFirst

If true, if directories are included in the model they will always be shown first, then the files.

By default, this property is false.

Definition at line 709 of file qquickfolderlistmodel.cpp.

showDotAndDotDot()

bool QQuickFolderListModel::showDotAndDotDot

(

)

const

\qmlproperty bool FolderListModel::showDotAndDotDot

If true, the "." and ".." directories are included in the model; otherwise they are excluded.

By default, this property is false.

See also

showDirs

Definition at line 734 of file qquickfolderlistmodel.cpp.

showFiles()

bool QQuickFolderListModel::showFiles

(

)

const

\qmlproperty bool FolderListModel::showFiles

Since

5.2

If true, files are included in the model; otherwise only directories are included.

By default, this property is true.

See also

showDirs

Definition at line 660 of file qquickfolderlistmodel.cpp.

showHidden()

bool QQuickFolderListModel::showHidden

(

)

const

\qmlproperty bool FolderListModel::showHidden

Since

5.2

If true, hidden files and directories are included in the model; otherwise they are excluded.

By default, this property is false.

Definition at line 760 of file qquickfolderlistmodel.cpp.

showOnlyReadable()

bool QQuickFolderListModel::showOnlyReadable

(

)

const

\qmlproperty bool FolderListModel::showOnlyReadable

If true, only readable files and directories are shown; otherwise all files and directories are shown.

By default, this property is false.

See also

showDirs

Definition at line 786 of file qquickfolderlistmodel.cpp.

sortCaseSensitive()

bool QQuickFolderListModel::sortCaseSensitive

(

)

const

\qmlproperty bool FolderListModel::sortCaseSensitive

Since

5.12

If set to true, the sort is case sensitive. This property is true by default.

Definition at line 874 of file qquickfolderlistmodel.cpp.

sortField()

QQuickFolderListModel::SortField QQuickFolderListModel::sortField

(

)

const

\qmlproperty enumeration FolderListModel::sortField

The sortField property contains the field to use for sorting. sortField may be one of:

\value FolderListModel.Unsorted no sorting is applied \value FolderListModel.Name sort by filename (default) \value FolderListModel.Time sort by time modified \value FolderListModel.Size sort by file size \value FolderListModel.Type sort by file type/extension

See also

sortReversed

Definition at line 586 of file qquickfolderlistmodel.cpp.

sortReversed()

bool QQuickFolderListModel::sortReversed

(

)

const

\qmlproperty bool FolderListModel::sortReversed

If set to true, reverses the sort order. The default is false.

See also

sortField

Definition at line 614 of file qquickfolderlistmodel.cpp.

status()

QQuickFolderListModel::Status QQuickFolderListModel::status

(

)

const

\qmlproperty enumeration FolderListModel::status

Since

5.11 \readonly

This property holds the status of folder reading. It can be one of:

\value FolderListModel.Null no folder has been set \value FolderListModel.Ready the folder has been loaded \value FolderListModel.Loading the folder is currently being loaded

Use this status to provide an update or respond to the status change in some way. For example, you could:

\list

• Trigger a state change: \qml State { name: 'loaded'; when: folderModel.status == FolderListModel.Ready } \endqml

• Implement an onStatusChanged signal handler: \qml FolderListModel { id: folderModel onStatusChanged: if (folderModel.status == FolderListModel.Ready) console.log('Loaded') } \endqml

• Bind to the status value: \qml Text { text: folderModel.status == FolderListModel.Ready ? 'Loaded' : 'Not loaded' } \endqml \endlist

Definition at line 861 of file qquickfolderlistmodel.cpp.

Property Documentation

caseSensitive

bool QQuickFolderListModel::caseSensitive

readwrite

Definition at line 53 of file qquickfolderlistmodel_p.h.

count

FINALint QQuickFolderListModel::count

read

Definition at line 54 of file qquickfolderlistmodel_p.h.

folder

QUrl QQuickFolderListModel::folder

readwrite

[class begin]

[class props]

Definition at line 41 of file qquickfolderlistmodel_p.h.

nameFilters

QStringList QQuickFolderListModel::nameFilters

readwrite

Definition at line 44 of file qquickfolderlistmodel_p.h.

parentFolder

QUrl QQuickFolderListModel::parentFolder

read

Definition at line 43 of file qquickfolderlistmodel_p.h.

rootFolder

QUrl QQuickFolderListModel::rootFolder

readwrite

Definition at line 42 of file qquickfolderlistmodel_p.h.

showDirs

FINALbool QQuickFolderListModel::showDirs

readwrite

Definition at line 48 of file qquickfolderlistmodel_p.h.

showDirsFirst

bool QQuickFolderListModel::showDirsFirst

readwrite

Definition at line 49 of file qquickfolderlistmodel_p.h.

showDotAndDotDot

bool QQuickFolderListModel::showDotAndDotDot

readwrite

Definition at line 50 of file qquickfolderlistmodel_p.h.

showFiles

bool QQuickFolderListModel::showFiles

readwrite

Definition at line 47 of file qquickfolderlistmodel_p.h.

showHidden

bool QQuickFolderListModel::showHidden

readwrite

Definition at line 51 of file qquickfolderlistmodel_p.h.

showOnlyReadable

FINALbool QQuickFolderListModel::showOnlyReadable

readwrite

Definition at line 52 of file qquickfolderlistmodel_p.h.

sortCaseSensitive

FINALbool QQuickFolderListModel::sortCaseSensitive

readwrite

Definition at line 56 of file qquickfolderlistmodel_p.h.

sortField

SortField QQuickFolderListModel::sortField

readwrite

Definition at line 45 of file qquickfolderlistmodel_p.h.

sortReversed

bool QQuickFolderListModel::sortReversed

readwrite

Definition at line 46 of file qquickfolderlistmodel_p.h.

status

Status QQuickFolderListModel::status

read

Definition at line 55 of file qquickfolderlistmodel_p.h.

---

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

• qtdeclarative/src/labs/folderlistmodel/qquickfolderlistmodel_p.h (be00682962ccf70398f2688c51d3fcf976f22d70)
• qtdeclarative/src/labs/folderlistmodel/qquickfolderlistmodel.cpp (a464ff5bfa15201de64d05121dc192dbd4655890)