src/qml/qml/qqmlengine.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  20 **
  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.
  28 **
  29 ** Other Usage
  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.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLENGINE_H
  43 #define QQMLENGINE_H
  44
  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>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class Q_QML_EXPORT QQmlImageProviderBase
  58 {
  59 public:
  60     enum ImageType {
  61         Image,
  62         Pixmap,
  63         Texture,
  64         Invalid
  65     };
  66
  67     virtual ~QQmlImageProviderBase();
  68
  69     virtual ImageType imageType() const = 0;
  70
  71 private:
  72     friend class QQuickImageProvider;
  73     QQmlImageProviderBase();
  74 };
  75
  76 class QQmlComponent;
  77 class QQmlEnginePrivate;
  78 class QQmlImportsPrivate;
  79 class QQmlExpression;
  80 class QQmlContext;
  81 class QQmlType;
  82 class QUrl;
  83 class QScriptContext;
  84 class QNetworkAccessManager;
  85 class QQmlNetworkAccessManagerFactory;
  86 class QQmlIncubationController;
  87 class Q_QML_EXPORT QQmlEngine : public QJSEngine
  88 {
  89     Q_PROPERTY(QString offlineStoragePath READ offlineStoragePath WRITE setOfflineStoragePath)
  90     Q_OBJECT
  91 public:
  92     QQmlEngine(QObject *p = 0);
  93     virtual ~QQmlEngine();
  94
  95     QQmlContext *rootContext() const;
  96
  97     void clearComponentCache();
  98
  99     QStringList importPathList() const;
 100     void setImportPathList(const QStringList &paths);
 101     void addImportPath(const QString& dir);
 102
 103     QStringList pluginPathList() const;
 104     void setPluginPathList(const QStringList &paths);
 105     void addPluginPath(const QString& dir);
 106
 107     bool addNamedBundle(const QString &name, const QString &fileName);
 108
 109     bool importPlugin(const QString &filePath, const QString &uri, QString *errorString); // XXX: Qt 5: Remove this function
 110     bool importPlugin(const QString &filePath, const QString &uri, QList<QQmlError> *errors);
 111
 112     void setNetworkAccessManagerFactory(QQmlNetworkAccessManagerFactory *);
 113     QQmlNetworkAccessManagerFactory *networkAccessManagerFactory() const;
 114
 115     QNetworkAccessManager *networkAccessManager() const;
 116
 117     void addImageProvider(const QString &id, QQmlImageProviderBase *);
 118     QQmlImageProviderBase *imageProvider(const QString &id) const;
 119     void removeImageProvider(const QString &id);
 120
 121     void setIncubationController(QQmlIncubationController *);
 122     QQmlIncubationController *incubationController() const;
 123
 124     void setOfflineStoragePath(const QString& dir);
 125     QString offlineStoragePath() const;
 126
 127     QUrl baseUrl() const;
 128     void setBaseUrl(const QUrl &);
 129
 130     bool outputWarningsToStandardError() const;
 131     void setOutputWarningsToStandardError(bool);
 132
 133     void collectGarbage();
 134
 135     static QQmlContext *contextForObject(const QObject *);
 136     static void setContextForObject(QObject *, QQmlContext *);
 137
 138     enum ObjectOwnership { CppOwnership, JavaScriptOwnership };
 139     static void setObjectOwnership(QObject *, ObjectOwnership);
 140     static ObjectOwnership objectOwnership(QObject *);
 141 protected:
 142     virtual bool event(QEvent *);
 143
 144 Q_SIGNALS:
 145     void quit();
 146     void warnings(const QList<QQmlError> &warnings);
 147
 148 private:
 149     Q_DISABLE_COPY(QQmlEngine)
 150     Q_DECLARE_PRIVATE(QQmlEngine)
 151 };
 152
 153 QT_END_NAMESPACE
 154
 155 QT_END_HEADER
 156
 157 #endif // QQMLENGINE_H