1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 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 
46 QT_BEGIN_NAMESPACE
47 
48 
49 #ifndef QT_NO_STANDARDPATHS
50 
51 class Q_CORE_EXPORT QStandardPaths
52 {
53     Q_GADGET
54 
55 public:
56     // Do not re-order, must match QDesktopServices
57     enum StandardLocation {
58         DesktopLocation,
59         DocumentsLocation,
60         FontsLocation,
61         ApplicationsLocation,
62         MusicLocation,
63         MoviesLocation,
64         PicturesLocation,
65         TempLocation,
66         HomeLocation,
67         DataLocation,
68         CacheLocation,
69         GenericDataLocation,
70         RuntimeLocation,
71         ConfigLocation,
72         DownloadLocation,
73         GenericCacheLocation,
74         GenericConfigLocation,
75         AppDataLocation,
76         AppConfigLocation,
77         AppLocalDataLocation = DataLocation
78     };
79     Q_ENUM(StandardLocation)
80 
81     static QString writableLocation(StandardLocation type);
82     static QStringList standardLocations(StandardLocation type);
83 
84     enum LocateOption {
85         LocateFile = 0x0,
86         LocateDirectory = 0x1
87     };
88     Q_DECLARE_FLAGS(LocateOptions, LocateOption)
89     Q_FLAG(LocateOptions)
90 
91     static QString locate(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
92     static QStringList locateAll(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile);
93 #ifndef QT_BOOTSTRAPPED
94     static QString displayName(StandardLocation type);
95 #endif
96 
97     static QString findExecutable(const QString &executableName, const QStringList &paths = QStringList());
98 
99 #if QT_DEPRECATED_SINCE(5, 2)
100     static QT_DEPRECATED void enableTestMode(bool testMode);
101 #endif
102     static void setTestModeEnabled(bool testMode);
103     static bool isTestModeEnabled();
104 
105 private:
106     // prevent construction
107     QStandardPaths();
108     ~QStandardPaths();
109 };
110 
111 Q_DECLARE_OPERATORS_FOR_FLAGS(QStandardPaths::LocateOptions)
112 
113 #endif // QT_NO_STANDARDPATHS
114 
115 QT_END_NAMESPACE
116 
117 #endif // QSTANDARDPATHS_H
118