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 QtQml 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 QQMLFILE_H
41#define QQMLFILE_H
42
43#include <QtQml/qtqmlglobal.h>
44
45QT_BEGIN_NAMESPACE
46
47class QUrl;
48class QString;
49class QObject;
50class QQmlEngine;
51class QQmlFilePrivate;
52
53class Q_QML_EXPORT QQmlFile
54{
55public:
56 QQmlFile();
57 QQmlFile(QQmlEngine *, const QUrl &);
58 QQmlFile(QQmlEngine *, const QString &);
59 ~QQmlFile();
60
61 enum Status { Null, Ready, Error, Loading };
62
63 bool isNull() const;
64 bool isReady() const;
65 bool isError() const;
66 bool isLoading() const;
67
68 QUrl url() const;
69
70 Status status() const;
71 QString error() const;
72
73 qint64 size() const;
74 const char *data() const;
75 QByteArray dataByteArray() const;
76
77 void load(QQmlEngine *, const QUrl &);
78 void load(QQmlEngine *, const QString &);
79
80 void clear();
81 void clear(QObject *);
82
83#if QT_CONFIG(qml_network)
84 bool connectFinished(QObject *, const char *);
85 bool connectFinished(QObject *, int);
86 bool connectDownloadProgress(QObject *, const char *);
87 bool connectDownloadProgress(QObject *, int);
88#endif
89
90 static bool isSynchronous(const QString &url);
91 static bool isSynchronous(const QUrl &url);
92
93 static bool isLocalFile(const QString &url);
94 static bool isLocalFile(const QUrl &url);
95
96 static QString urlToLocalFileOrQrc(const QString &);
97 static QString urlToLocalFileOrQrc(const QUrl &);
98private:
99 Q_DISABLE_COPY(QQmlFile)
100 QQmlFilePrivate *d;
101};
102
103QT_END_NAMESPACE
104
105#endif // QQMLFILE_H
106