qquickfolderlistmodel.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
//![code]
#include "qquickfolderlistmodel_p.h"
#include "fileinfothread_p.h"
#include "fileproperty_p.h"
#include <QtCore/qloggingcategory.h>
#include <qqmlcontext.h>
#include <qqmlfile.h>
 
QT_BEGIN_NAMESPACE
 
Q_STATIC_LOGGING_CATEGORY(lcFolderListModel, "qt.labs.folderlistmodel")
 
class QQuickFolderListModelPrivate
{
    Q_DECLARE_PUBLIC(QQuickFolderListModel)
 
public:
    QQuickFolderListModelPrivate(QQuickFolderListModel *q) : q_ptr(q) { }
 
    QQuickFolderListModel *q_ptr;
    QUrl currentDir;
    QUrl rootDir;
    FileInfoThread fileInfoThread;
    QList<FileProperty> data;
    QHash<int, QByteArray> roleNames;
    QQuickFolderListModel::SortField sortField = QQuickFolderListModel::Name;
    QStringList nameFilters = { QLatin1String("*") };
    QQuickFolderListModel::Status status = QQuickFolderListModel::Null;
    bool sortReversed = false;
    bool showFiles = true;
    bool showDirs = true;
    bool showDirsFirst = false;
    bool showDotAndDotDot = false;
    bool showDot = false;
    bool showDotDot = false;
    bool showOnlyReadable = false;
    bool showHidden = false;
    bool caseSensitive = true;
    bool sortCaseSensitive = true;
    bool resettingModel = false;
 
    ~QQuickFolderListModelPrivate() {}
    void init();
    void updateSorting();
 
    void finishModelReset();
 
    // private slots
    void _q_directoryChanged(const QString &directory, const QList<FileProperty> &list);
    void _q_directoryUpdated(const QString &directory, const QList<FileProperty> &list, int fromIndex, int toIndex);
    void _q_sortFinished(const QList<FileProperty> &list);
    void _q_statusChanged(QQuickFolderListModel::Status s);
 
    static QString resolvePath(const QUrl &path);
};
 
 
void QQuickFolderListModelPrivate::init()
{
    Q_Q(QQuickFolderListModel);
    qRegisterMetaType<QList<FileProperty> >("QList<FileProperty>");
    qRegisterMetaType<QQuickFolderListModel::Status>("QQuickFolderListModel::Status");
    q->connect(&fileInfoThread, SIGNAL(directoryChanged(QString,QList<FileProperty>)),
               q, SLOT(_q_directoryChanged(QString,QList<FileProperty>)));
    q->connect(&fileInfoThread, SIGNAL(directoryUpdated(QString,QList<FileProperty>,int,int)),
               q, SLOT(_q_directoryUpdated(QString,QList<FileProperty>,int,int)));
    q->connect(&fileInfoThread, SIGNAL(sortFinished(QList<FileProperty>)),
               q, SLOT(_q_sortFinished(QList<FileProperty>)));
    q->connect(&fileInfoThread, SIGNAL(statusChanged(QQuickFolderListModel::Status)),
               q, SLOT(_q_statusChanged(QQuickFolderListModel::Status)));
    q->connect(q, SIGNAL(rowCountChanged()), q, SIGNAL(countChanged()));
}
 
 
void QQuickFolderListModelPrivate::updateSorting()
{
    Q_Q(QQuickFolderListModel);
 
    QDir::SortFlags flags;
 
    switch (sortField) {
        case QQuickFolderListModel::Unsorted:
            flags |= QDir::Unsorted;
            break;
        case QQuickFolderListModel::Name:
            flags |= QDir::Name;
            break;
        case QQuickFolderListModel::Time:
            flags |= QDir::Time;
            break;
        case QQuickFolderListModel::Size:
            flags |= QDir::Size;
            break;
        case QQuickFolderListModel::Type:
            flags |= QDir::Type;
            break;
    }
 
    emit q->layoutAboutToBeChanged();
 
    if (sortReversed)
        flags |= QDir::Reversed;
    if (!sortCaseSensitive)
        flags |= QDir::IgnoreCase;
 
    fileInfoThread.setSortFlags(flags);
}
 
void QQuickFolderListModelPrivate::finishModelReset()
{
    Q_Q(QQuickFolderListModel);
    const bool wasDataEmpty = data.isEmpty();
    data.clear();
    qCDebug(lcFolderListModel) << "about to emit endResetModel";
    q->endResetModel();
    if (!wasDataEmpty)
        emit q->rowCountChanged();
    if (status != QQuickFolderListModel::Null) {
        status = QQuickFolderListModel::Null;
        emit q->statusChanged();
    }
    resettingModel = false;
}
 
void QQuickFolderListModelPrivate::_q_directoryChanged(const QString &directory, const QList<FileProperty> &list)
{
    qCDebug(lcFolderListModel) << "_q_directoryChanged called with directory" << directory;
    Q_Q(QQuickFolderListModel);
    Q_UNUSED(directory);
    if (!resettingModel) {
        resettingModel = true;
        q->beginResetModel();
    }
 
    data = list;
    q->endResetModel();
    qCDebug(lcFolderListModel) << "- endResetModel called";
    emit q->rowCountChanged();
    emit q->folderChanged();
    resettingModel = false;
}
 
 
void QQuickFolderListModelPrivate::_q_directoryUpdated(const QString &directory, const QList<FileProperty> &list, int fromIndex, int toIndex)
{
    Q_Q(QQuickFolderListModel);
    Q_UNUSED(directory);
 
    QModelIndex parent;
    if (data.size() == list.size()) {
        QModelIndex modelIndexFrom = q->createIndex(fromIndex, 0);
        QModelIndex modelIndexTo = q->createIndex(toIndex, 0);
        data = list;
        emit q->dataChanged(modelIndexFrom, modelIndexTo);
    } else {
        // File(s) inserted or removed. Since I do not know how many
        // or where, I need to update the whole list from the first item.
        // This is a little pessimistic, but optimizing it would require
        // more information in the signal from FileInfoThread.
        if (data.size() > 0) {
            q->beginRemoveRows(parent, 0, data.size() - 1);
            q->endRemoveRows();
        }
        data = list;
        if (list.size() > 0) {
            if (toIndex > list.size() - 1)
                toIndex = list.size() - 1;
            q->beginInsertRows(parent, 0, data.size() - 1);
            q->endInsertRows();
        }
        emit q->rowCountChanged();
    }
}
 
void QQuickFolderListModelPrivate::_q_sortFinished(const QList<FileProperty> &list)
{
    Q_Q(QQuickFolderListModel);
    qCDebug(lcFolderListModel) << "_q_sortFinished called with" << list.size() << "files";
 
    QModelIndex parent;
    if (data.size() > 0) {
        qCDebug(lcFolderListModel) << "- removing all existing rows...";
        q->beginRemoveRows(parent, 0, data.size()-1);
        data.clear();
        q->endRemoveRows();
        qCDebug(lcFolderListModel) << "- ...removed all existing rows";
    }
 
    qCDebug(lcFolderListModel) << "- inserting sorted rows...";
    q->beginInsertRows(parent, 0, list.size()-1);
    data = list;
    q->endInsertRows();
    qCDebug(lcFolderListModel) << "- ... inserted sorted rows";
}
 
void QQuickFolderListModelPrivate::_q_statusChanged(QQuickFolderListModel::Status s)
{
    Q_Q(QQuickFolderListModel);
 
    if (status != s) {
        status = s;
        emit q->statusChanged();
    }
}
 
QString QQuickFolderListModelPrivate::resolvePath(const QUrl &path)
{
    QString localPath = QQmlFile::urlToLocalFileOrQrc(path);
    QUrl localUrl = QUrl(localPath);
    QString fullPath = localUrl.path();
    if (localUrl.scheme().size())
      fullPath = localUrl.scheme() + QLatin1Char(':') + fullPath;
    return QDir::cleanPath(fullPath);
}
 
/*!
    \qmlmodule Qt.labs.folderlistmodel 2.\QtMinorVersion
    \title Qt Labs FolderListModel QML Types
    \ingroup qmlmodules
    \brief 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
    \ingroup qtquick-models
    \brief 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 \c Qt.labs.folderlistmodel module.
    \e{Elements in the Qt.labs module are not guaranteed to remain compatible
    in future versions.}
 
    \note Some features in FolderListModel depend on \l QFileSystemWatcher. If \l QFileSystemWatcher
    is disabled, the folder set using \c 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 \c 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
    \li \c fileName (\c string)
    \li \c filePath (\c string)
    \li \c fileUrl (\c url) (since Qt 5.15)
    \li \c fileBaseName (\c string)
    \li \c fileSuffix (\c string)
    \li \c fileSize (\c qlonglong)
    \li \c fileModified (\c date)
    \li \c fileAccessed (\c date)
    \li \c fileIsDir (\c bool)
    \endlist
 
    Additionally a file entry can be differentiated from a folder entry via the
    isFolder() method.
 
    \section1 Filtering
 
    Various properties can be set to filter the number of files and directories
    exposed by the model.
 
    The \l nameFilters property can be set to contain a list of wildcard filters
    that are applied to names of files and directories, causing only those that
    match the filters to be exposed.
 
    Directories can be included or excluded using the \l showDirs property,
    navigation directories can also be excluded by setting the \l showDotAndDotDot
    property to false, hidden files can be included or excluded using the
    \l showHidden property.
 
    It is sometimes useful to limit the files and directories exposed to those
    that the user can access. The \l showOnlyReadable property can be set to
    enable this feature.
 
    \section1 Example Usage
 
    The following example shows a FolderListModel being used to provide a list
    of QML files in a \l ListView:
 
    \qml
    import QtQuick
    import Qt.labs.folderlistmodel
 
    ListView {
        width: 200; height: 400
 
        FolderListModel {
            id: folderModel
            nameFilters: ["*.qml"]
        }
 
        Component {
            id: fileDelegate
            required property string fileName
            Text { text: fileName }
        }
 
        model: folderModel
        delegate: fileDelegate
    }
    \endqml
 
    \section1 Path Separators
 
    Qt uses "/" as a universal directory separator in the same way that "/" is
    used as a path separator in URLs. If you always use "/" as a directory
    separator, Qt will translate your paths to conform to the underlying
    operating system.
 
    \sa {QML Data Models}
*/
 
QQuickFolderListModel::QQuickFolderListModel(QObject *parent)
    : QAbstractListModel(parent), d_ptr(new QQuickFolderListModelPrivate(this))
{
    Q_D(QQuickFolderListModel);
    d->roleNames[FileNameRole] = "fileName";
    d->roleNames[FilePathRole] = "filePath";
    d->roleNames[FileBaseNameRole] = "fileBaseName";
    d->roleNames[FileSuffixRole] = "fileSuffix";
    d->roleNames[FileSizeRole] = "fileSize";
    d->roleNames[FileLastModifiedRole] = "fileModified";
    d->roleNames[FileLastReadRole] = "fileAccessed";
    d->roleNames[FileIsDirRole] = "fileIsDir";
    d->roleNames[FileUrlRole] = "fileUrl";
    d->init();
}
 
QQuickFolderListModel::~QQuickFolderListModel()
{
}
 
QVariant QQuickFolderListModel::data(const QModelIndex &index, int role) const
{
    Q_D(const QQuickFolderListModel);
    QVariant rv;
 
    const int row = index.row();
    if (row < 0 || row >= d->data.size())
        return rv;
 
    switch (role)
    {
        case FileNameRole:
            rv = d->data.at(row).fileName();
            break;
        case FilePathRole:
            rv = d->data.at(row).filePath();
            break;
        case FileBaseNameRole:
            rv = d->data.at(row).baseName();
            break;
        case FileSuffixRole:
            rv = d->data.at(row).suffix();
            break;
        case FileSizeRole:
            rv = d->data.at(row).size();
            break;
        case FileLastModifiedRole:
            rv = d->data.at(row).lastModified();
            break;
        case FileLastReadRole:
            rv = d->data.at(row).lastRead();
            break;
        case FileIsDirRole:
            rv = d->data.at(row).isDir();
            break;
        case FileUrlRole:
            rv = QUrl::fromLocalFile(d->data.at(row).filePath());
            break;
        default:
            break;
    }
    return rv;
}
 
QHash<int, QByteArray> QQuickFolderListModel::roleNames() const
{
    Q_D(const QQuickFolderListModel);
    return d->roleNames;
}
 
/*!
    \qmlproperty int FolderListModel::count
    \readonly
 
    Returns the number of items in the current folder that match the
    filter criteria.
*/
int QQuickFolderListModel::rowCount(const QModelIndex &parent) const
{
    Q_D(const QQuickFolderListModel);
    Q_UNUSED(parent);
    return d->data.size();
}
 
QModelIndex QQuickFolderListModel::index(int row, int , const QModelIndex &) const
{
    return createIndex(row, 0);
}
 
/*!
    \qmlproperty url FolderListModel::folder
 
    The \a folder property holds a URL for the folder that the model
    currently provides.
 
    The value must be a \c file: or \c qrc: URL, or a relative URL.
 
    The default value is the application's working directory at the time
    when the FolderListModel is first initialized.
*/
QUrl QQuickFolderListModel::folder() const
{
    Q_D(const QQuickFolderListModel);
    return d->currentDir;
}
 
void QQuickFolderListModel::setFolder(const QUrl &folder)
{
    Q_D(QQuickFolderListModel);
 
    if (folder == d->currentDir)
        return;
 
    // It's possible for the folder to be set twice in quick succession,
    // in which case we could still be waiting for FileInfoThread to finish
    // getting the list of files from the previously set folder. We should
    // at least ensure that the begin/end model reset routine is followed
    // in the correct order, and not e.g. call beginResetModel twice.
    if (d->resettingModel)
        d->finishModelReset();
 
    d->resettingModel = true;
 
    QString resolvedPath = QQuickFolderListModelPrivate::resolvePath(folder);
 
    qCDebug(lcFolderListModel) << "about to emit beginResetModel since our folder was set to" << folder;
    beginResetModel();
 
    //Remove the old path for the file system watcher
    if (!d->currentDir.isEmpty())
        d->fileInfoThread.removePath(d->currentDir.path());
 
    d->currentDir = folder;
 
    QFileInfo info(resolvedPath);
    if (!info.exists() || !info.isDir()) {
        d->finishModelReset();
        return;
    }
 
    d->fileInfoThread.setPath(resolvedPath);
}
 
 
/*!
   \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.
*/
QUrl QQuickFolderListModel::rootFolder() const
{
    Q_D(const QQuickFolderListModel);
    return d->rootDir;
}
 
void QQuickFolderListModel::setRootFolder(const QUrl &path)
{
    Q_D(QQuickFolderListModel);
 
    if (path.isEmpty())
        return;
 
    QString resolvedPath = QQuickFolderListModelPrivate::resolvePath(path);
 
    QFileInfo info(resolvedPath);
    if (!info.exists() || !info.isDir())
        return;
    if (path != d->rootDir) {
        d->fileInfoThread.setRootPath(resolvedPath);
        d->rootDir = path;
        emit rootFolderChanged();
    }
}
 
 
/*!
    \qmlproperty url FolderListModel::parentFolder
    \readonly
 
    Returns the URL of the parent of the current \l folder.
*/
QUrl QQuickFolderListModel::parentFolder() const
{
    Q_D(const QQuickFolderListModel);
 
    QString localFile = d->currentDir.toLocalFile();
    if (!localFile.isEmpty()) {
        QDir dir(localFile);
        if (dir.isRoot() || !dir.cdUp())
            return QUrl();
        localFile = dir.path();
    } else {
        const QString path = d->currentDir.path();
        const int pos = path.lastIndexOf(QLatin1Char('/'));
        if (pos <= 0)
            return QUrl();
        localFile = path.left(pos);
    }
    return QUrl::fromLocalFile(localFile);
}
 
/*!
    \qmlproperty list<string> FolderListModel::nameFilters
 
    The \a 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.
*/
QStringList QQuickFolderListModel::nameFilters() const
{
    Q_D(const QQuickFolderListModel);
    return d->nameFilters;
}
 
void QQuickFolderListModel::setNameFilters(const QStringList &filters)
{
    Q_D(QQuickFolderListModel);
    if (d->nameFilters == filters)
        return;
    d->fileInfoThread.setNameFilters(filters);
    d->nameFilters = filters;
    emit nameFilterChanged();
}
 
void QQuickFolderListModel::classBegin()
{
}
 
void QQuickFolderListModel::componentComplete()
{
    Q_D(QQuickFolderListModel);
    QString localPath = QQmlFile::urlToLocalFileOrQrc(d->currentDir);
    if (localPath.isEmpty() || !QDir(localPath).exists())
        setFolder(QUrl::fromLocalFile(QDir::currentPath()));
    d->fileInfoThread.start(QThread::LowPriority);
}
 
/*!
    \qmlproperty enumeration FolderListModel::sortField
 
    The \a sortField property contains the field to use for sorting.
    \c 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
 
    \sa sortReversed
*/
QQuickFolderListModel::SortField QQuickFolderListModel::sortField() const
{
    Q_D(const QQuickFolderListModel);
    return d->sortField;
}
 
void QQuickFolderListModel::setSortField(SortField field)
{
    Q_D(QQuickFolderListModel);
 
    if (field != d->sortField) {
        d->sortField = field;
        d->updateSorting();
        emit sortFieldChanged();
    }
}
 
int QQuickFolderListModel::roleFromString(const QString &roleName) const
{
    Q_D(const QQuickFolderListModel);
    return d->roleNames.key(roleName.toLatin1(), -1);
}
 
/*!
    \qmlproperty bool FolderListModel::sortReversed
 
    If set to true, reverses the sort order.  The default is false.
 
    \sa sortField
*/
bool QQuickFolderListModel::sortReversed() const
{
    Q_D(const QQuickFolderListModel);
    return d->sortReversed;
}
 
void QQuickFolderListModel::setSortReversed(bool rev)
{
    Q_D(QQuickFolderListModel);
 
    if (rev != d->sortReversed) {
        d->sortReversed = rev;
        d->updateSorting();
        emit sortReversedChanged();
    }
}
 
/*!
    \qmlmethod bool FolderListModel::isFolder(int index)
 
    Returns true if the entry \a index is a folder; otherwise
    returns false.
*/
bool QQuickFolderListModel::isFolder(int index) const
{
    if (index != -1) {
        QModelIndex idx = createIndex(index, 0);
        if (idx.isValid()) {
            QVariant var = data(idx, FileIsDirRole);
            if (var.isValid())
                return var.toBool();
        }
    }
    return false;
}
 
/*!
    \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.
 
    \sa showDirs
*/
bool QQuickFolderListModel::showFiles() const
{
    Q_D(const QQuickFolderListModel);
    return d->showFiles;
}
 
void QQuickFolderListModel::setShowFiles(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showFiles) {
        d->fileInfoThread.setShowFiles(on);
        d->showFiles = on;
        emit showFilesChanged();
    }
}
 
/*!
    \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.
 
    \sa showDotAndDotDot
*/
bool QQuickFolderListModel::showDirs() const
{
    Q_D(const QQuickFolderListModel);
    return d->showDirs;
}
 
void  QQuickFolderListModel::setShowDirs(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showDirs) {
        d->fileInfoThread.setShowDirs(on);
        d->showDirs = on;
        emit showDirsChanged();
    }
}
 
/*!
    \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.
 
*/
bool QQuickFolderListModel::showDirsFirst() const
{
    Q_D(const QQuickFolderListModel);
    return d->showDirsFirst;
}
 
void  QQuickFolderListModel::setShowDirsFirst(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showDirsFirst) {
       d->fileInfoThread.setShowDirsFirst(on);
       d->showDirsFirst = on;
       emit showDirsFirstChanged();
    }
}
 
 
/*!
    \qmlproperty bool FolderListModel::showDotAndDotDot
 
    If true, the "." and ".." directories are included in the model; otherwise
    they are excluded.
 
    By default, this property is false.
 
    \sa showDirs, showDot, showDotDot
*/
bool QQuickFolderListModel::showDotAndDotDot() const
{
    Q_D(const QQuickFolderListModel);
    return d->showDotAndDotDot;
}
 
void  QQuickFolderListModel::setShowDotAndDotDot(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showDotAndDotDot) {
        d->fileInfoThread.setShowDotAndDotDot(on);
        d->showDotAndDotDot = on;
        emit showDotAndDotDotChanged();
    }
}
 
 
/*!
    \qmlproperty bool FolderListModel::showDot
    \since 6.12
 
    If true, the current "." directory will be included in the model.
 
    By default, this property is false.
 
    \sa showDotAndDotDot, showDotDot
*/
bool QQuickFolderListModel::showDot() const
{
    Q_D(const QQuickFolderListModel);
    return d->showDot;
}
 
void QQuickFolderListModel::setShowDot(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showDot) {
        d->fileInfoThread.setShowDot(on);
        d->showDot = on;
        emit showDotChanged();
    }
}
 
 
/*!
    \qmlproperty bool FolderListModel::showDotDot
    \since 6.12
 
    If true, the ".." (parent) directory will be included in the model.
 
    By default, this property is false.
 
    \sa showDotAndDotDot, showDot
*/
bool QQuickFolderListModel::showDotDot() const
{
    Q_D(const QQuickFolderListModel);
    return d->showDotDot;
}
 
void QQuickFolderListModel::setShowDotDot(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showDotDot) {
        d->fileInfoThread.setShowDotDot(on);
        d->showDotDot = on;
        emit showDotDotChanged();
    }
}
 
 
/*!
    \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.
*/
bool QQuickFolderListModel::showHidden() const
{
    Q_D(const QQuickFolderListModel);
    return d->showHidden;
}
 
void QQuickFolderListModel::setShowHidden(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showHidden) {
        d->fileInfoThread.setShowHidden(on);
        d->showHidden = on;
        emit showHiddenChanged();
    }
}
 
/*!
    \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.
 
    \sa showDirs
*/
bool QQuickFolderListModel::showOnlyReadable() const
{
    Q_D(const QQuickFolderListModel);
    return d->showOnlyReadable;
}
 
void QQuickFolderListModel::setShowOnlyReadable(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->showOnlyReadable) {
        d->fileInfoThread.setShowOnlyReadable(on);
        d->showOnlyReadable = on;
        emit showOnlyReadableChanged();
    }
}
 
/*!
 * \qmlproperty bool FolderListModel::caseSensitive
 * \since 5.7
 *
 * Use case sensitive pattern matching.
 *
 * By default, this property is true.
 *
 */
bool QQuickFolderListModel::caseSensitive() const
{
    Q_D(const QQuickFolderListModel);
    return d->caseSensitive;
}
 
void QQuickFolderListModel::setCaseSensitive(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->caseSensitive) {
        d->fileInfoThread.setCaseSensitive(on);
        d->caseSensitive = on;
        emit caseSensitiveChanged();
    }
}
 
/*!
    \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 \a 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
    \li Trigger a state change:
    \qml
        State { name: 'loaded'; when: folderModel.status == FolderListModel.Ready }
    \endqml
 
    \li Implement an \c onStatusChanged signal handler:
    \qml
        FolderListModel {
            id: folderModel
            onStatusChanged: if (folderModel.status == FolderListModel.Ready) console.log('Loaded')
        }
    \endqml
 
    \li Bind to the status value:
    \qml
        Text { text: folderModel.status == FolderListModel.Ready ? 'Loaded' : 'Not loaded' }
    \endqml
    \endlist
*/
QQuickFolderListModel::Status QQuickFolderListModel::status() const
{
    Q_D(const QQuickFolderListModel);
    return d->status;
}
 
/*!
    \qmlproperty bool FolderListModel::sortCaseSensitive
    \since 5.12
 
    If set to \c true, the sort is case sensitive. This property is \c true by default.
*/
 
bool QQuickFolderListModel::sortCaseSensitive() const
{
    Q_D(const QQuickFolderListModel);
    return d->sortCaseSensitive;
}
 
void QQuickFolderListModel::setSortCaseSensitive(bool on)
{
    Q_D(QQuickFolderListModel);
 
    if (on != d->sortCaseSensitive) {
        d->sortCaseSensitive = on;
        d->updateSorting();
        emit sortCaseSensitiveChanged();
    }
}
 
/*!
    \qmlmethod var FolderListModel::get(int index, string property)
 
    Returns the folder \a property for the given \a index. The following properties
    are available:
 
    \list
        \li \c fileName (\c string)
        \li \c filePath (\c string)
        \li \c fileUrl (\c url) (since Qt 5.15)
        \li \c fileBaseName (\c string)
        \li \c fileSuffix (\c string)
        \li \c fileSize (\c qlonglong)
        \li \c fileModified (\c date)
        \li \c fileAccessed (\c date)
        \li \c fileIsDir (\c bool)
    \endlist
*/
QVariant QQuickFolderListModel::get(int idx, const QString &property) const
{
    int role = roleFromString(property);
    if (role >= 0 && idx >= 0)
        return data(index(idx), role);
    else
        return QVariant();
}
 
/*!
    \qmlmethod int FolderListModel::indexOf(url file)
    \since 5.6
 
    Returns the index of the given \a file URL if the model contains it,
    or -1 if not.
*/
int QQuickFolderListModel::indexOf(const QUrl &file) const
{
    Q_D(const QQuickFolderListModel);
    FileProperty toFind(QFileInfo(file.toLocalFile()));
    return d->data.indexOf(toFind);
}
 
//![code]
QT_END_NAMESPACE
 
#include "moc_qquickfolderlistmodel_p.cpp"