1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtQml module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
45 #include <QtCore/qurl.h>
46 #include <QtCore/qobject.h>
47 #include <QtCore/qmap.h>
48 #include <QtQml/qjsengine.h>
49 #include <QtQml/qqmlerror.h>
50 #include <QtQml/qqmldebug.h>
57 class Q_QML_EXPORT QQmlImageProviderBase
68 ForceAsynchronousImageLoading = 0x01
70 Q_DECLARE_FLAGS(Flags, Flag)
72 virtual ~QQmlImageProviderBase();
74 virtual ImageType imageType() const = 0;
75 virtual Flags flags() const = 0;
78 friend class QQuickImageProvider;
79 QQmlImageProviderBase();
81 Q_DECLARE_OPERATORS_FOR_FLAGS(QQmlImageProviderBase::Flags)
84 class QQmlEnginePrivate;
85 class QQmlImportsPrivate;
91 class QNetworkAccessManager;
92 class QQmlNetworkAccessManagerFactory;
93 class QQmlIncubationController;
94 class Q_QML_EXPORT QQmlEngine : public QJSEngine
96 Q_PROPERTY(QString offlineStoragePath READ offlineStoragePath WRITE setOfflineStoragePath)
99 QQmlEngine(QObject *p = 0);
100 virtual ~QQmlEngine();
102 QQmlContext *rootContext() const;
104 void clearComponentCache();
105 void trimComponentCache();
107 QStringList importPathList() const;
108 void setImportPathList(const QStringList &paths);
109 void addImportPath(const QString& dir);
111 QStringList pluginPathList() const;
112 void setPluginPathList(const QStringList &paths);
113 void addPluginPath(const QString& dir);
115 bool addNamedBundle(const QString &name, const QString &fileName);
117 bool importPlugin(const QString &filePath, const QString &uri, QList<QQmlError> *errors);
119 void setNetworkAccessManagerFactory(QQmlNetworkAccessManagerFactory *);
120 QQmlNetworkAccessManagerFactory *networkAccessManagerFactory() const;
122 QNetworkAccessManager *networkAccessManager() const;
124 void addImageProvider(const QString &id, QQmlImageProviderBase *);
125 QQmlImageProviderBase *imageProvider(const QString &id) const;
126 void removeImageProvider(const QString &id);
128 void setIncubationController(QQmlIncubationController *);
129 QQmlIncubationController *incubationController() const;
131 void setOfflineStoragePath(const QString& dir);
132 QString offlineStoragePath() const;
134 QUrl baseUrl() const;
135 void setBaseUrl(const QUrl &);
137 bool outputWarningsToStandardError() const;
138 void setOutputWarningsToStandardError(bool);
140 static QQmlContext *contextForObject(const QObject *);
141 static void setContextForObject(QObject *, QQmlContext *);
143 enum ObjectOwnership { CppOwnership, JavaScriptOwnership };
144 static void setObjectOwnership(QObject *, ObjectOwnership);
145 static ObjectOwnership objectOwnership(QObject *);
147 virtual bool event(QEvent *);
151 void warnings(const QList<QQmlError> &warnings);
154 Q_DISABLE_COPY(QQmlEngine)
155 Q_DECLARE_PRIVATE(QQmlEngine)
162 #endif // QQMLENGINE_H