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 QRESOURCE_H
41#define QRESOURCE_H
42
43#include <QtCore/qstring.h>
44#include <QtCore/qlocale.h>
45#include <QtCore/qstringlist.h>
46#include <QtCore/qlist.h>
47#include <QtCore/qscopedpointer.h>
48
49QT_BEGIN_NAMESPACE
50
51
52class QResourcePrivate;
53
54class Q_CORE_EXPORT QResource
55{
56public:
57 enum Compression {
58 NoCompression,
59 ZlibCompression,
60 ZstdCompression
61 };
62
63 QResource(const QString &file=QString(), const QLocale &locale=QLocale());
64 ~QResource();
65
66 void setFileName(const QString &file);
67 QString fileName() const;
68 QString absoluteFilePath() const;
69
70 void setLocale(const QLocale &locale);
71 QLocale locale() const;
72
73 bool isValid() const;
74
75 Compression compressionAlgorithm() const;
76 qint64 size() const;
77 const uchar *data() const;
78 QDateTime lastModified() const;
79
80#if QT_DEPRECATED_SINCE(5, 13)
81 QT_DEPRECATED_X("Use QDir::addSearchPath() instead")
82 static void addSearchPath(const QString &path);
83 QT_DEPRECATED_X("Use QDir::searchPaths() instead")
84 static QStringList searchPaths();
85#endif
86#if QT_DEPRECATED_SINCE(5, 15)
87 QT_DEPRECATED_VERSION_X_5_15("Use QResource::compressionAlgorithm() instead")
88 bool isCompressed() const;
89#endif
90
91 static bool registerResource(const QString &rccFilename, const QString &resourceRoot=QString());
92 static bool unregisterResource(const QString &rccFilename, const QString &resourceRoot=QString());
93
94 static bool registerResource(const uchar *rccData, const QString &resourceRoot=QString());
95 static bool unregisterResource(const uchar *rccData, const QString &resourceRoot=QString());
96
97protected:
98 friend class QResourceFileEngine;
99 friend class QResourceFileEngineIterator;
100 bool isDir() const;
101 inline bool isFile() const { return !isDir(); }
102 QStringList children() const;
103
104protected:
105 QScopedPointer<QResourcePrivate> d_ptr;
106
107private:
108 Q_DECLARE_PRIVATE(QResource)
109};
110
111QT_END_NAMESPACE
112
113#endif // QRESOURCE_H
114