1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). |
4 | ** Contact: http://www.qt-project.org/legal |
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 Digia. For licensing terms and |
14 | ** conditions see http://qt.digia.com/licensing. For further information |
15 | ** use the contact form at http://qt.digia.com/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 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 2.1 requirements |
23 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
24 | ** |
25 | ** In addition, as a special exception, Digia gives you certain additional |
26 | ** rights. These rights are described in the Digia Qt LGPL Exception |
27 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
28 | ** |
29 | ** GNU General Public License Usage |
30 | ** Alternatively, this file may be used under the terms of the GNU |
31 | ** General Public License version 3.0 as published by the Free Software |
32 | ** Foundation and appearing in the file LICENSE.GPL included in the |
33 | ** packaging of this file. Please review the following information to |
34 | ** ensure the GNU General Public License version 3.0 requirements will be |
35 | ** met: http://www.gnu.org/copyleft/gpl.html. |
36 | ** |
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 | |
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 | |