1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
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>
58 class QQmlEnginePrivate;
59 class QQmlImportsPrivate;
65 class QQmlImageProvider;
66 class QNetworkAccessManager;
67 class QQmlNetworkAccessManagerFactory;
68 class QQmlIncubationController;
69 class Q_QML_EXPORT QQmlEngine : public QJSEngine
71 Q_PROPERTY(QString offlineStoragePath READ offlineStoragePath WRITE setOfflineStoragePath)
74 QQmlEngine(QObject *p = 0);
75 virtual ~QQmlEngine();
77 QQmlContext *rootContext() const;
79 void clearComponentCache();
81 QStringList importPathList() const;
82 void setImportPathList(const QStringList &paths);
83 void addImportPath(const QString& dir);
85 QStringList pluginPathList() const;
86 void setPluginPathList(const QStringList &paths);
87 void addPluginPath(const QString& dir);
89 bool importPlugin(const QString &filePath, const QString &uri, QString *errorString); // XXX: Qt 5: Remove this function
90 bool importPlugin(const QString &filePath, const QString &uri, QList<QQmlError> *errors);
92 void setNetworkAccessManagerFactory(QQmlNetworkAccessManagerFactory *);
93 QQmlNetworkAccessManagerFactory *networkAccessManagerFactory() const;
95 QNetworkAccessManager *networkAccessManager() const;
97 void addImageProvider(const QString &id, QQmlImageProvider *);
98 QQmlImageProvider *imageProvider(const QString &id) const;
99 void removeImageProvider(const QString &id);
101 void setIncubationController(QQmlIncubationController *);
102 QQmlIncubationController *incubationController() const;
104 void setOfflineStoragePath(const QString& dir);
105 QString offlineStoragePath() const;
107 QUrl baseUrl() const;
108 void setBaseUrl(const QUrl &);
110 bool outputWarningsToStandardError() const;
111 void setOutputWarningsToStandardError(bool);
113 void collectGarbage();
115 static QQmlContext *contextForObject(const QObject *);
116 static void setContextForObject(QObject *, QQmlContext *);
118 enum ObjectOwnership { CppOwnership, JavaScriptOwnership };
119 static void setObjectOwnership(QObject *, ObjectOwnership);
120 static ObjectOwnership objectOwnership(QObject *);
123 virtual bool event(QEvent *);
127 void warnings(const QList<QQmlError> &warnings);
130 Q_DISABLE_COPY(QQmlEngine)
131 Q_DECLARE_PRIVATE(QQmlEngine)
138 #endif // QQMLENGINE_H