Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
The QFileSystemModel class provides a data model for the local filesystem. More...
#include <qfilesystemmodel.h>
Public Types | |
enum | Roles { FileIconRole = Qt::DecorationRole , FileInfoRole = Qt::UserRole - 1 , FilePathRole = Qt::UserRole + 1 , FileNameRole = Qt::UserRole + 2 , FilePermissions = Qt::UserRole + 3 } |
\value FileIconRole \value FilePathRole \value FileNameRole \value FilePermissions \value FileInfoRole The QFileInfo object for the index More... | |
enum | Option { DontWatchForChanges = 0x00000001 , DontResolveSymlinks = 0x00000002 , DontUseCustomDirectoryIcons = 0x00000004 } |
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 | rootPathChanged (const QString &newPath) |
This signal is emitted whenever the root path has been changed to a newPath. | |
void | fileRenamed (const QString &path, const QString &oldName, const QString &newName) |
This signal is emitted whenever a file with the oldName is successfully renamed to newName. | |
void | directoryLoaded (const QString &path) |
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 | |
QFileSystemModel (QObject *parent=nullptr) | |
Constructs a file system model with the given parent. | |
~QFileSystemModel () | |
Destroys this file system model. | |
QModelIndex | index (int row, int column, const QModelIndex &parent=QModelIndex()) const override |
\reimp | |
QModelIndex | 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. | |
QModelIndex | parent (const QModelIndex &child) const override |
\reimp | |
QModelIndex | sibling (int row, int column, const QModelIndex &idx) const override |
\reimp | |
bool | hasChildren (const QModelIndex &parent=QModelIndex()) const override |
\reimp | |
bool | canFetchMore (const QModelIndex &parent) const override |
\reimp | |
void | fetchMore (const QModelIndex &parent) override |
\reimp | |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
\reimp | |
int | columnCount (const QModelIndex &parent=QModelIndex()) const override |
\reimp | |
QVariant | myComputer (int role=Qt::DisplayRole) const |
Returns the data stored under the given role for the item "My Computer". | |
QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const override |
\reimp | |
bool | setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override |
\reimp | |
QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override |
\reimp | |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
\reimp | |
void | sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override |
\reimp | |
QStringList | mimeTypes () const override |
Returns a list of MIME types that can be used to describe a list of items in the model. | |
QMimeData * | mimeData (const QModelIndexList &indexes) const override |
Returns an object that contains a serialized description of the specified indexes. | |
bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override |
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. | |
Qt::DropActions | supportedDropActions () const override |
\reimp | |
QHash< int, QByteArray > | roleNames () const override |
\reimp | |
QModelIndex | setRootPath (const QString &path) |
Sets the directory that is being watched by the model to newPath by installing a \l{QFileSystemWatcher}{file system watcher} on it. | |
QString | rootPath () const |
The currently set root path. | |
QDir | rootDirectory () const |
The currently set directory. | |
void | setIconProvider (QAbstractFileIconProvider *provider) |
Sets the provider of file icons for the directory model. | |
QAbstractFileIconProvider * | iconProvider () const |
Returns the file icon provider for this directory model. | |
void | setFilter (QDir::Filters filters) |
Sets the directory model's filter to that specified by filters. | |
QDir::Filters | filter () const |
Returns the filter specified for the directory model. | |
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) |
Sets the name filters to apply against the existing files. | |
QStringList | nameFilters () const |
Returns a list of filters applied to the names in the model. | |
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 |
Returns the path of the item stored in the model under the index given. | |
bool | isDir (const QModelIndex &index) const |
Returns true if the model item index represents a directory; otherwise returns false . | |
qint64 | size (const QModelIndex &index) const |
Returns the size in bytes of index. | |
QString | type (const QModelIndex &index) const |
Returns the type of file index such as "Directory" or "JPEG file". | |
QDateTime | lastModified (const QModelIndex &index) const |
Returns the date and time (in local time) when index was last modified. | |
QDateTime | lastModified (const QModelIndex &index, const QTimeZone &tz) const |
QModelIndex | mkdir (const QModelIndex &parent, const QString &name) |
Create a directory with the name in the parent model index. | |
bool | 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. | |
QString | fileName (const QModelIndex &index) const |
Returns the file name for the item stored in the model under the given index. | |
QIcon | fileIcon (const QModelIndex &index) const |
Returns the icon for the item stored in the model under the given index. | |
QFile::Permissions | permissions (const QModelIndex &index) const |
Returns the complete OR-ed together combination of QFile::Permission for the index. | |
QFileInfo | fileInfo (const QModelIndex &index) const |
Returns the QFileInfo for the item stored in the model under the given index. | |
bool | 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. | |
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 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 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 | 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 |
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 | 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 . | |
Protected Member Functions | |
QFileSystemModel (QFileSystemModelPrivate &, QObject *parent=nullptr) | |
void | timerEvent (QTimerEvent *event) override |
\reimp | |
bool | event (QEvent *event) override |
\reimp | |
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 | 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) | |
Properties | |
bool | resolveSymlinks |
Whether the directory model should resolve symbolic links. | |
bool | readOnly |
Whether the directory model allows writing to the file system. | |
bool | nameFilterDisables |
Whether files that don't pass the name filter are hidden or disabled. | |
Options | options |
the various options that affect the model | |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Friends | |
class | QFileDialogPrivate |
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 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) | |
The QFileSystemModel class provides a data model for the local filesystem.
\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().
Definition at line 21 of file qfilesystemmodel.h.
\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.
Enumerator | |
---|---|
DontWatchForChanges | |
DontResolveSymlinks | |
DontUseCustomDirectoryIcons |
Definition at line 44 of file qfilesystemmodel.h.
\value FileIconRole \value FilePathRole \value FileNameRole \value FilePermissions \value FileInfoRole The QFileInfo object for the index
Enumerator | |
---|---|
FileIconRole | |
FileInfoRole | |
FilePathRole | |
FileNameRole | |
FilePermissions |
Definition at line 36 of file qfilesystemmodel.h.
Constructs a file system model with the given parent.
Definition at line 194 of file qfilesystemmodel.cpp.
|
default |
Destroys this file system model.
|
protected |
Definition at line 202 of file qfilesystemmodel.cpp.
References d.
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 632 of file qfilesystemmodel.cpp.
|
overridevirtual |
\reimp
Implements QAbstractItemModel.
Definition at line 677 of file qfilesystemmodel.cpp.
References QFileSystemModelPrivate::NumColumns, and parent().
Referenced by index(), and sibling().
|
overridevirtual |
\reimp
Implements QAbstractItemModel.
Definition at line 708 of file qfilesystemmodel.cpp.
References Qt::AlignTrailing, Qt::AlignVCenter, d, Qt::DecorationRole, Qt::DisplayRole, Qt::EditRole, fileInfo(), FileInfoRole, FileNameRole, filePath(), FilePathRole, FilePermissions, QVariant::fromValue(), icon, QIcon::isNull(), QFileSystemModelPrivate::NameColumn, permissions(), Q_FALLTHROUGH, qWarning, QFileSystemModelPrivate::SizeColumn, Qt::TextAlignmentRole, QFileSystemModelPrivate::TimeColumn, and QFileSystemModelPrivate::TypeColumn.
Referenced by fileName(), and QUrlModel::setData().
This signal is emitted when the gatherer thread has finished to load the path.
Referenced by QFileSystemModelPrivate::init(), and main().
|
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.
Reimplemented from QAbstractItemModel.
Definition at line 1202 of file qfilesystemmodel.cpp.
References QFile::copy(), Qt::CopyAction, fileName, filePath(), isReadOnly(), it, QFile::link(), Qt::LinkAction, Qt::MoveAction, parent(), Q_UNUSED, QFile::rename(), and QDir::separator().
|
overrideprotectedvirtual |
\reimp
Reimplemented from QObject.
Definition at line 1741 of file qfilesystemmodel.cpp.
References d, QObject::event(), and QEvent::LanguageChange.
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 644 of file qfilesystemmodel.cpp.
References d, filePath(), parent(), and QFileSystemModelPrivate::QFileSystemNode::populatedChildren.
Referenced by setRootPath().
|
inline |
Returns the icon for the item stored in the model under the given index.
Definition at line 143 of file qfilesystemmodel.h.
References Qt::DecorationRole.
QFileInfo QFileSystemModel::fileInfo | ( | const QModelIndex & | index | ) | const |
Returns the QFileInfo for the item stored in the model under the given index.
Definition at line 131 of file qfilesystemmodel.cpp.
References d.
Referenced by data(), QFileDialogPrivate::deleteCurrent(), isDir(), and remove().
|
inline |
Returns the file name for the item stored in the model under the given index.
Definition at line 141 of file qfilesystemmodel.h.
References data(), Qt::DisplayRole, and QVariant::toString().
QString QFileSystemModel::filePath | ( | const QModelIndex & | index | ) | const |
Returns the path of the item stored in the model under the index given.
Definition at line 1370 of file qfilesystemmodel.cpp.
References canonicalPath(), d, and QT_CONFIG.
Referenced by data(), dropMimeData(), fetchMore(), mimeData(), mkdir(), rmdir(), and setData().
|
signal |
This signal is emitted whenever a file with the oldName is successfully renamed to newName.
The file is located in the directory path.
Referenced by QFileDialogPrivate::createWidgets(), and setData().
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.
Definition at line 1611 of file qfilesystemmodel.cpp.
References d.
Referenced by rootDirectory().
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 973 of file qfilesystemmodel.cpp.
References d, QAbstractItemModel::flags(), Qt::ItemIsDragEnabled, Qt::ItemIsDropEnabled, Qt::ItemIsEditable, Qt::ItemNeverHasChildren, and QFileDevice::WriteUser.
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 615 of file qfilesystemmodel.cpp.
References d, parent(), and Q_ASSERT.
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 923 of file qfilesystemmodel.cpp.
References Qt::AlignLeft, Qt::DecorationRole, Qt::DisplayRole, QImage::Format_ARGB32_Premultiplied, QAbstractItemModel::headerData(), Qt::Horizontal, QFileSystemModelPrivate::NameColumn, pixmap, QFileSystemModelPrivate::SizeColumn, Qt::TextAlignmentRole, QFileSystemModelPrivate::TimeColumn, tr, Qt::transparent, and QFileSystemModelPrivate::TypeColumn.
QAbstractFileIconProvider * QFileSystemModel::iconProvider | ( | ) | const |
Returns the file icon provider for this directory model.
Definition at line 1571 of file qfilesystemmodel.cpp.
References d.
Referenced by options(), and setOptions().
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 259 of file qfilesystemmodel.cpp.
References d.
|
overridevirtual |
\reimp
Implements QAbstractItemModel.
Definition at line 217 of file qfilesystemmodel.cpp.
References QList< T >::at(), QFileSystemModelPrivate::QFileSystemNode::children, columnCount(), QAbstractItemModel::createIndex(), d, i, parent(), Q_ASSERT, rowCount(), QList< T >::size(), and QFileSystemModelPrivate::QFileSystemNode::visibleChildren.
Referenced by QUrlModel::addUrls(), QFileDialogPrivate::autoCompleteFileName(), QFileDialogPrivate::goToDirectory(), QFileDialogPrivate::goToUrl(), QFileDialogPrivate::removeDirectory(), QUrlModel::setData(), QFileDialogComboBox::setHistory(), QFileDialogComboBox::showPopup(), and QFileDialogPrivate::updateOkButton().
bool QFileSystemModel::isDir | ( | const QModelIndex & | index | ) | const |
Returns true
if the model item index represents a directory; otherwise returns false
.
Definition at line 498 of file qfilesystemmodel.cpp.
References d, fileInfo(), QFileInfo::isDir(), and QFileSystemModelPrivate::QFileSystemNode::isDir().
Referenced by QUrlModel::addUrls(), QFileDialogPrivate::deleteCurrent(), QFileDialogPrivate::enterDirectory(), QFileDialogPrivate::selectionChanged(), and QFileDialogPrivate::updateOkButton().
bool QFileSystemModel::isReadOnly | ( | ) | const |
Definition at line 1662 of file qfilesystemmodel.cpp.
References d.
Referenced by QFileDialogPrivate::deleteCurrent(), dropMimeData(), and QFileDialogPrivate::showContextMenu().
QDateTime QFileSystemModel::lastModified | ( | const QModelIndex & | index | ) | const |
Returns the date and time (in local time) when index was last modified.
This is an overloaded function, equivalent to calling:
If index is invalid, a default constructed QDateTime is returned.
Definition at line 542 of file qfilesystemmodel.cpp.
References lastModified(), and QTimeZone::LocalTime.
Referenced by lastModified().
QDateTime QFileSystemModel::lastModified | ( | const QModelIndex & | index, |
const QTimeZone & | tz ) const |
Typical arguments for tz are QTimeZone::UTC
or QTimeZone::LocalTime
. UTC does not require any conversion from the time returned by the native file system API, therefore getting the time in UTC is potentially faster. LocalTime is typically chosen if the time is shown to the user.
If index is invalid, a default constructed QDateTime is returned.
Definition at line 559 of file qfilesystemmodel.cpp.
References d.
|
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 1182 of file qfilesystemmodel.cpp.
References QList< T >::begin(), QList< T >::end(), filePath(), QUrl::fromLocalFile(), it, and QFileSystemModelPrivate::NameColumn.
|
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 1169 of file qfilesystemmodel.cpp.
QModelIndex QFileSystemModel::mkdir | ( | const QModelIndex & | parent, |
const QString & | name ) |
Create a directory with the name in the parent model index.
Definition at line 1425 of file qfilesystemmodel.cpp.
References QFileSystemModelPrivate::QFileSystemNode::children, d, dir, filePath(), parent(), QFileSystemModelPrivate::QFileSystemNode::populate(), Q_ASSERT, and QDir::separator().
Referenced by QFileDialogPrivate::createDirectory().
QVariant QFileSystemModel::myComputer | ( | int | role = Qt::DisplayRole | ) | const |
Returns the data stored under the given role for the item "My Computer".
Definition at line 687 of file qfilesystemmodel.cpp.
References QAbstractFileIconProvider::Computer, d, Qt::DecorationRole, Qt::DisplayRole, and QFileSystemModelPrivate::myComputer().
Referenced by QFileDialogPrivate::goToDirectory(), and QFileDialogPrivate::navigateToParent().
bool QFileSystemModel::nameFilterDisables | ( | ) | const |
Definition at line 1684 of file qfilesystemmodel.cpp.
References d.
QStringList QFileSystemModel::nameFilters | ( | ) | const |
Returns a list of filters applied to the names in the model.
Definition at line 1728 of file qfilesystemmodel.cpp.
References d.
Referenced by rootDirectory().
QFileSystemModel::Options QFileSystemModel::options | ( | ) | const |
Definition at line 1349 of file qfilesystemmodel.cpp.
References d, DontResolveSymlinks, QAbstractFileIconProvider::DontUseCustomDirectoryIcons, DontUseCustomDirectoryIcons, DontWatchForChanges, iconProvider(), and resolveSymlinks.
|
inline |
Returns a pointer to the parent object.
Definition at line 346 of file qobject.h.
Referenced by canFetchMore(), columnCount(), dropMimeData(), fetchMore(), hasChildren(), index(), mkdir(), rowCount(), and setData().
|
overridevirtual |
\reimp
Implements QAbstractItemModel.
Definition at line 570 of file qfilesystemmodel.cpp.
References QAbstractItemModel::createIndex(), d, QFileSystemModelPrivate::QFileSystemNode::fileName, QFileSystemModelPrivate::QFileSystemNode::parent, and Q_ASSERT.
QFile::Permissions QFileSystemModel::permissions | ( | const QModelIndex & | index | ) | const |
Returns the complete OR-ed together combination of QFile::Permission for the index.
Definition at line 1448 of file qfilesystemmodel.cpp.
References d.
Referenced by data().
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.
Definition at line 171 of file qfilesystemmodel.cpp.
References d, fileInfo(), QFileInfo::isFile(), QFileInfo::isSymLink(), QFile::remove(), and QDir::removeRecursively().
Referenced by QFileDialogPrivate::deleteCurrent(), and QFileDialogPrivate::removeDirectory().
bool QFileSystemModel::resolveSymlinks | ( | ) | const |
Definition at line 1637 of file qfilesystemmodel.cpp.
References d.
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.
Definition at line 1753 of file qfilesystemmodel.cpp.
References d, filePath(), and QDir::rmdir().
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 1253 of file qfilesystemmodel.cpp.
References FileIconRole, FileInfoRole, FileNameRole, FilePathRole, FilePermissions, QByteArrayLiteral, ret, and QAbstractItemModel::roleNames().
QDir QFileSystemModel::rootDirectory | ( | ) | const |
The currently set directory.
Definition at line 1547 of file qfilesystemmodel.cpp.
References d, dir, filter(), and nameFilters().
Referenced by QFileDialogPrivate::navigateToParent().
QString QFileSystemModel::rootPath | ( | ) | const |
The currently set root path.
Definition at line 1536 of file qfilesystemmodel.cpp.
References d.
Referenced by QFileDialogPrivate::pathChanged(), QFileDialogPrivate::rootPath(), setNameFilters(), setRootPath(), and sort().
This signal is emitted whenever the root path has been changed to a newPath.
Referenced by QFileDialogPrivate::createWidgets(), and setRootPath().
|
overridevirtual |
\reimp
Implements QAbstractItemModel.
Definition at line 661 of file qfilesystemmodel.cpp.
References d, parent(), QList< T >::size(), and QFileSystemModelPrivate::QFileSystemNode::visibleChildren.
Referenced by index().
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 858 of file qfilesystemmodel.cpp.
References QFileSystemModelPrivate::QFileSystemNode::children, QModelIndex::column(), d, QModelIndex::data(), Qt::EditRole, emit, filePath(), fileRenamed(), QList< T >::insert(), QModelIndex::isValid(), Qt::ItemIsEditable, parent(), QFileSystemModelPrivate::QFileSystemNode::parent, QFileSystemModelPrivate::QFileSystemNode::populate(), QList< T >::removeAt(), QDir::separator(), QDir::toNativeSeparators(), QVariant::toString(), QFileSystemModelPrivate::QFileSystemNode::visibleChildren, and QFileSystemModelPrivate::QFileSystemNode::visibleLocation().
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.
Definition at line 1589 of file qfilesystemmodel.cpp.
References QDir::CaseSensitive, d, and filters.
Referenced by QFileDialogPrivate::createWidgets().
void QFileSystemModel::setIconProvider | ( | QAbstractFileIconProvider * | provider | ) |
Sets the provider of file icons for the directory model.
Definition at line 1559 of file qfilesystemmodel.cpp.
References d.
Referenced by QFileDialogPrivate::createWidgets().
void QFileSystemModel::setNameFilterDisables | ( | bool | enable | ) |
Definition at line 1674 of file qfilesystemmodel.cpp.
References d.
Referenced by QFileDialogPrivate::createWidgets().
void QFileSystemModel::setNameFilters | ( | const QStringList & | filters | ) |
Sets the name filters to apply against the existing files.
Definition at line 1693 of file qfilesystemmodel.cpp.
References d, filters, QFileSystemModelPrivate::QFileSystemNode::isDir(), QFileSystemModelPrivate::QFileSystemNode::parent, QAbstractItemModel::persistentIndexList(), Q_UNUSED, and rootPath().
Referenced by QFileDialogPrivate::useNameFilter().
Options should be set before changing properties.
Definition at line 1294 of file qfilesystemmodel.cpp.
References options, and setOptions().
Definition at line 1324 of file qfilesystemmodel.cpp.
References d, DontResolveSymlinks, QAbstractFileIconProvider::DontUseCustomDirectoryIcons, DontUseCustomDirectoryIcons, DontWatchForChanges, iconProvider(), options, qWarning, and setResolveSymlinks().
Referenced by setOption().
void QFileSystemModel::setReadOnly | ( | bool | enable | ) |
Definition at line 1656 of file qfilesystemmodel.cpp.
References d.
Referenced by QFileDialogPrivate::createWidgets().
void QFileSystemModel::setResolveSymlinks | ( | bool | enable | ) |
Definition at line 1627 of file qfilesystemmodel.cpp.
Referenced by setOptions().
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.
Definition at line 1467 of file qfilesystemmodel.cpp.
References QDir::cleanPath(), d, emit, fetchMore(), QDir::fromNativeSeparators(), QString::isEmpty(), QFileSystemModelPrivate::myComputer(), rootPath(), and rootPathChanged().
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 242 of file qfilesystemmodel.cpp.
References columnCount(), QAbstractItemModel::createIndex(), QModelIndex::internalPointer(), QModelIndex::parent(), QModelIndex::row(), and QAbstractItemModel::sibling().
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 513 of file qfilesystemmodel.cpp.
References d.
|
override |
\reimp
Definition at line 1133 of file qfilesystemmodel.cpp.
References QAbstractItemModel::changePersistentIndexList(), d, emit, QAbstractItemModel::layoutAboutToBeChanged(), QAbstractItemModel::layoutChanged(), QAbstractItemModel::order, QAbstractItemModel::persistentIndexList(), QList< T >::reserve(), and rootPath().
|
overridevirtual |
\reimp
Reimplemented from QAbstractItemModel.
Definition at line 1245 of file qfilesystemmodel.cpp.
References Qt::CopyAction, Qt::LinkAction, and Qt::MoveAction.
bool QFileSystemModel::testOption | ( | Option | option | ) | const |
Returns true
if the given option is enabled; otherwise, returns false.
Definition at line 1308 of file qfilesystemmodel.cpp.
References options.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QObject.
Definition at line 474 of file qfilesystemmodel.cpp.
References d, QFileSystemModelPrivate::QFileSystemNode::hasInformation(), and i.
QString QFileSystemModel::type | ( | const QModelIndex & | index | ) | const |
Returns the type of file index such as "Directory" or "JPEG file".
Definition at line 524 of file qfilesystemmodel.cpp.
References d.
|
friend |
Definition at line 138 of file qfilesystemmodel.h.
|
readwrite |
Whether files that don't pass the name filter are hidden or disabled.
This property is true
by default
Definition at line 26 of file qfilesystemmodel.h.
|
readwrite |
the various options that affect the model
By default, all options are disabled.
Options should be set before changing properties.
Definition at line 27 of file qfilesystemmodel.h.
Referenced by setOption(), setOptions(), and testOption().
|
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 25 of file qfilesystemmodel.h.
|
readwrite |
Whether the directory model should resolve symbolic links.
This is only relevant on Windows.
By default, this property is true
.
Definition at line 24 of file qfilesystemmodel.h.
Referenced by options().