include/QtCore/qstandardpaths.h

0001 // Copyright (C) 2020 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003
0004 #ifndef QSTANDARDPATHS_H
0005 #define QSTANDARDPATHS_H
0006
0007 #include <QtCore/qstringlist.h>
0008 #include <QtCore/qobjectdefs.h>
0009
0010 QT_BEGIN_NAMESPACE
0011
0012
0013 #ifndef QT_NO_STANDARDPATHS
0014
0015 class Q_CORE_EXPORT QStandardPaths
0016 {
0017     Q_GADGET
0018
0019 public:
0020     enum StandardLocation {
0021         DesktopLocation,
0022         DocumentsLocation,
0023         FontsLocation,
0024         ApplicationsLocation,
0025         MusicLocation,
0026         MoviesLocation,
0027         PicturesLocation,
0028         TempLocation,
0029         HomeLocation,
0030         AppLocalDataLocation,
0031         CacheLocation,
0032         GenericDataLocation,
0033         RuntimeLocation,
0034         ConfigLocation,
0035         DownloadLocation,
0036         GenericCacheLocation,
0037         GenericConfigLocation,
0038         AppDataLocation,
0039         AppConfigLocation,
0040         PublicShareLocation,
0041         TemplatesLocation,
0042         StateLocation,
0043         GenericStateLocation,
0044     };
0045     Q_ENUM(StandardLocation)
0046
0047     static QString writableLocation(StandardLocation type);
0048     static QStringList standardLocations(StandardLocation type);
0049
0050     enum LocateOption {
0051         LocateFile = 0x0,
0052         LocateDirectory = 0x1
0053     };
0054     Q_DECLARE_FLAGS(LocateOptions, LocateOption)
0055     Q_FLAG(LocateOptions)
0056
0057     static QString locate(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
0058     static QStringList locateAll(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
0059 #ifndef QT_BOOTSTRAPPED
0060     static QString displayName(StandardLocation type);
0061 #endif
0062
0063     static QString findExecutable(const QString &executableName, const QStringList &paths = QStringList());
0064
0065     static void setTestModeEnabled(bool testMode);
0066     static bool isTestModeEnabled();
0067
0068 private:
0069     // prevent construction
0070     QStandardPaths();
0071     ~QStandardPaths();
0072 };
0073
0074 Q_DECLARE_OPERATORS_FOR_FLAGS(QStandardPaths::LocateOptions)
0075
0076 #endif // QT_NO_STANDARDPATHS
0077
0078 QT_END_NAMESPACE
0079
0080 #endif // QSTANDARDPATHS_H