src/declarative/qml/qdeclarativeengine.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEENGINE_H
  43 #define QDECLARATIVEENGINE_H
  44
  45 #include <QtCore/qurl.h>
  46 #include <QtCore/qobject.h>
  47 #include <QtCore/qmap.h>
  48 #include <QtDeclarative/qjsengine.h>
  49 #include <QtDeclarative/qdeclarativeerror.h>
  50 #include <QtDeclarative/qdeclarativedebug.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QDeclarativeComponent;
  58 class QDeclarativeEnginePrivate;
  59 class QDeclarativeImportsPrivate;
  60 class QDeclarativeExpression;
  61 class QDeclarativeContext;
  62 class QDeclarativeType;
  63 class QUrl;
  64 class QScriptContext;
  65 class QDeclarativeImageProvider;
  66 class QNetworkAccessManager;
  67 class QDeclarativeNetworkAccessManagerFactory;
  68 class QDeclarativeIncubationController;
  69 class Q_DECLARATIVE_EXPORT QDeclarativeEngine : public QJSEngine
  70 {
  71     Q_PROPERTY(QString offlineStoragePath READ offlineStoragePath WRITE setOfflineStoragePath)
  72     Q_OBJECT
  73 public:
  74     QDeclarativeEngine(QObject *p = 0);
  75     virtual ~QDeclarativeEngine();
  76
  77     QDeclarativeContext *rootContext() const;
  78
  79     void clearComponentCache();
  80
  81     QStringList importPathList() const;
  82     void setImportPathList(const QStringList &paths);
  83     void addImportPath(const QString& dir);
  84
  85     QStringList pluginPathList() const;
  86     void setPluginPathList(const QStringList &paths);
  87     void addPluginPath(const QString& dir);
  88
  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<QDeclarativeError> *errors);
  91
  92     void setNetworkAccessManagerFactory(QDeclarativeNetworkAccessManagerFactory *);
  93     QDeclarativeNetworkAccessManagerFactory *networkAccessManagerFactory() const;
  94
  95     QNetworkAccessManager *networkAccessManager() const;
  96
  97     void addImageProvider(const QString &id, QDeclarativeImageProvider *);
  98     QDeclarativeImageProvider *imageProvider(const QString &id) const;
  99     void removeImageProvider(const QString &id);
 100
 101     void setIncubationController(QDeclarativeIncubationController *);
 102     QDeclarativeIncubationController *incubationController() const;
 103
 104     void setOfflineStoragePath(const QString& dir);
 105     QString offlineStoragePath() const;
 106
 107     QUrl baseUrl() const;
 108     void setBaseUrl(const QUrl &);
 109
 110     bool outputWarningsToStandardError() const;
 111     void setOutputWarningsToStandardError(bool);
 112
 113     void collectGarbage();
 114
 115     static QDeclarativeContext *contextForObject(const QObject *);
 116     static void setContextForObject(QObject *, QDeclarativeContext *);
 117
 118     enum ObjectOwnership { CppOwnership, JavaScriptOwnership };
 119     static void setObjectOwnership(QObject *, ObjectOwnership);
 120     static ObjectOwnership objectOwnership(QObject *);
 121
 122 protected:
 123     virtual bool event(QEvent *);
 124
 125 Q_SIGNALS:
 126     void quit();
 127     void warnings(const QList<QDeclarativeError> &warnings);
 128
 129 private:
 130     Q_DISABLE_COPY(QDeclarativeEngine)
 131     Q_DECLARE_PRIVATE(QDeclarativeEngine)
 132 };
 133
 134 QT_END_NAMESPACE
 135
 136 QT_END_HEADER
 137
 138 #endif // QDECLARATIVEENGINE_H