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