1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QRESOURCE_H
43 #define QRESOURCE_H
44
45 #include <QtCore/qstring.h>
46 #include <QtCore/qlocale.h>
47 #include <QtCore/qstringlist.h>
48 #include <QtCore/qlist.h>
49
50 QT_BEGIN_HEADER
51
52 QT_BEGIN_NAMESPACE
53
QT_MODULE(Core)54 QT_MODULE(Core)
55
56 class QResourcePrivate;
57
58 class Q_CORE_EXPORT QResource
59 {
60 public:
61 QResource(const QString &file=QString(), const QLocale &locale=QLocale());
62 ~QResource();
63
64 void setFileName(const QString &file);
65 QString fileName() const;
66 QString absoluteFilePath() const;
67
68 void setLocale(const QLocale &locale);
69 QLocale locale() const;
70
71 bool isValid() const;
72
73 bool isCompressed() const;
74 qint64 size() const;
75 const uchar *data() const;
76
77 static void addSearchPath(const QString &path);
78 static QStringList searchPaths();
79
80 static bool registerResource(const QString &rccFilename, const QString &resourceRoot=QString());
81 static bool unregisterResource(const QString &rccFilename, const QString &resourceRoot=QString());
82
83 static bool registerResource(const uchar *rccData, const QString &resourceRoot=QString());
84 static bool unregisterResource(const uchar *rccData, const QString &resourceRoot=QString());
85
86 protected:
87 friend class QResourceFileEngine;
88 friend class QResourceFileEngineIterator;
89 bool isDir() const;
90 inline bool isFile() const { return !isDir(); }
91 QStringList children() const;
92
93 protected:
94 QScopedPointer<QResourcePrivate> d_ptr;
95
96 private:
97 Q_DECLARE_PRIVATE(QResource)
98 };
99
100 QT_END_NAMESPACE
101
102 QT_END_HEADER
103
104 #endif // QRESOURCE_H
105