1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSTANDARDPATHS_H
41#define QSTANDARDPATHS_H
42
43#include <QtCore/qstringlist.h>
44#include <QtCore/qobjectdefs.h>
45
46QT_BEGIN_NAMESPACE
47
48
49#ifndef QT_NO_STANDARDPATHS
50
51class Q_CORE_EXPORT QStandardPaths
52{
53 Q_GADGET
54
55public:
56 enum StandardLocation {
57 DesktopLocation,
58 DocumentsLocation,
59 FontsLocation,
60 ApplicationsLocation,
61 MusicLocation,
62 MoviesLocation,
63 PicturesLocation,
64 TempLocation,
65 HomeLocation,
66 AppLocalDataLocation,
67 CacheLocation,
68 GenericDataLocation,
69 RuntimeLocation,
70 ConfigLocation,
71 DownloadLocation,
72 GenericCacheLocation,
73 GenericConfigLocation,
74 AppDataLocation,
75 AppConfigLocation
76 };
77 Q_ENUM(StandardLocation)
78
79 static QString writableLocation(StandardLocation type);
80 static QStringList standardLocations(StandardLocation type);
81
82 enum LocateOption {
83 LocateFile = 0x0,
84 LocateDirectory = 0x1
85 };
86 Q_DECLARE_FLAGS(LocateOptions, LocateOption)
87 Q_FLAG(LocateOptions)
88
89 static QString locate(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
90 static QStringList locateAll(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
91#ifndef QT_BOOTSTRAPPED
92 static QString displayName(StandardLocation type);
93#endif
94
95 static QString findExecutable(const QString &executableName, const QStringList &paths = QStringList());
96
97 static void setTestModeEnabled(bool testMode);
98 static bool isTestModeEnabled();
99
100private:
101 // prevent construction
102 QStandardPaths();
103 ~QStandardPaths();
104};
105
106Q_DECLARE_OPERATORS_FOR_FLAGS(QStandardPaths::LocateOptions)
107
108#endif // QT_NO_STANDARDPATHS
109
110QT_END_NAMESPACE
111
112#endif // QSTANDARDPATHS_H
113