src/declarative/qml/qdeclarativeengine.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  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 <QtScript/qscriptvalue.h>
  49 #include <QtDeclarative/qdeclarativeerror.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 QT_MODULE(Declarative)
  56
  57 class QDeclarativeComponent;
  58 class QDeclarativeEnginePrivate;
  59 class QDeclarativeImportsPrivate;
  60 class QDeclarativeExpression;
  61 class QDeclarativeContext;
  62 class QDeclarativeType;
  63 class QUrl;
  64 class QScriptEngine;
  65 class QScriptContext;
  66 class QDeclarativeImageProvider;
  67 class QNetworkAccessManager;
  68 class QDeclarativeNetworkAccessManagerFactory;
  69 class Q_DECLARATIVE_EXPORT QDeclarativeEngine : public QObject
  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);
  90
  91     void setNetworkAccessManagerFactory(QDeclarativeNetworkAccessManagerFactory *);
  92     QDeclarativeNetworkAccessManagerFactory *networkAccessManagerFactory() const;
  93
  94     QNetworkAccessManager *networkAccessManager() const;
  95
  96     void addImageProvider(const QString &id, QDeclarativeImageProvider *);
  97     QDeclarativeImageProvider *imageProvider(const QString &id) const;
  98     void removeImageProvider(const QString &id);
  99
 100     void setOfflineStoragePath(const QString& dir);
 101     QString offlineStoragePath() const;
 102
 103     QUrl baseUrl() const;
 104     void setBaseUrl(const QUrl &);
 105
 106     bool outputWarningsToStandardError() const;
 107     void setOutputWarningsToStandardError(bool);
 108
 109     static QDeclarativeContext *contextForObject(const QObject *);
 110     static void setContextForObject(QObject *, QDeclarativeContext *);
 111
 112     enum ObjectOwnership { CppOwnership, JavaScriptOwnership };
 113     static void setObjectOwnership(QObject *, ObjectOwnership);
 114     static ObjectOwnership objectOwnership(QObject *);
 115
 116 Q_SIGNALS:
 117     void quit();
 118     void warnings(const QList<QDeclarativeError> &warnings);
 119
 120 private:
 121     Q_DISABLE_COPY(QDeclarativeEngine)
 122     Q_DECLARE_PRIVATE(QDeclarativeEngine)
 123 };
 124
 125 QT_END_NAMESPACE
 126
 127 QT_END_HEADER
 128
 129 #endif // QDECLARATIVEENGINE_H