qqmlstandardpaths_p.h

Go to the documentation of this file.

// Copyright (C) 2021 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
 
#ifndef QQMLSTANDARDPATHS_P_H
#define QQMLSTANDARDPATHS_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtCore/qobject.h>
#include <QtCore/qstandardpaths.h>
#include <QtCore/qurl.h>
#include <QtQml/qqml.h>
#include <QtQmlCore/private/qqmlcoreglobal_p.h>
 
QT_BEGIN_NAMESPACE
 
class QQmlEngine;
class QJSEngine;
 
class Q_QMLCORE_EXPORT QQmlStandardPaths : public QObject
{
    Q_OBJECT
    QML_SINGLETON
    QML_NAMED_ELEMENT(StandardPaths)
    QML_ADDED_IN_VERSION(6, 2)
    QML_EXTENDED_NAMESPACE(QStandardPaths)
 
public:
    explicit QQmlStandardPaths(QObject *parent = nullptr);
 
    Q_INVOKABLE QString displayName(QStandardPaths::StandardLocation type) const;
    Q_INVOKABLE QUrl findExecutable(const QString &executableName, const QStringList &paths = QStringList()) const;
    Q_INVOKABLE QUrl locate(QStandardPaths::StandardLocation type, const QString &fileName,
        QStandardPaths::LocateOptions options = QStandardPaths::LocateFile) const;
    Q_INVOKABLE QList<QUrl> locateAll(QStandardPaths::StandardLocation type, const QString &fileName,
        QStandardPaths::LocateOptions options = QStandardPaths::LocateFile) const;
    Q_INVOKABLE QList<QUrl> standardLocations(QStandardPaths::StandardLocation type) const;
    Q_INVOKABLE QUrl writableLocation(QStandardPaths::StandardLocation type) const;
};
 
QT_END_NAMESPACE
 
#endif // QQMLSTANDARDPATHS_P_H