src/qml/qml/qqmlcomponent.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  24 **
  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.
  28 **
  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.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLCOMPONENT_H
  43 #define QQMLCOMPONENT_H
  44
  45 #include <QtQml/qqml.h>
  46 #include <QtQml/qqmlerror.h>
  47
  48 #include <QtCore/qobject.h>
  49 #include <QtCore/qstring.h>
  50 #include <QtQml/qjsvalue.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QByteArray;
  58 class QQmlEngine;
  59 class QQmlComponent;
  60 class QQmlIncubator;
  61 class QQmlV8Function;
  62 class QQmlCompiledData;
  63 class QQmlComponentPrivate;
  64 class QQmlComponentAttached;
  65
  66 class Q_QML_EXPORT QQmlComponent : public QObject
  67 {
  68     Q_OBJECT
  69     Q_DECLARE_PRIVATE(QQmlComponent)
  70
  71     Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged)
  72     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
  73     Q_PROPERTY(QUrl url READ url CONSTANT)
  74
  75 public:
  76     Q_ENUMS(CompilationMode)
  77     enum CompilationMode { PreferSynchronous, Asynchronous };
  78
  79     QQmlComponent(QObject *parent = 0);
  80     QQmlComponent(QQmlEngine *, QObject *parent=0);
  81     QQmlComponent(QQmlEngine *, const QString &fileName, QObject *parent = 0);
  82     QQmlComponent(QQmlEngine *, const QString &fileName, CompilationMode mode, QObject *parent = 0);
  83     QQmlComponent(QQmlEngine *, const QUrl &url, QObject *parent = 0);
  84     QQmlComponent(QQmlEngine *, const QUrl &url, CompilationMode mode, QObject *parent = 0);
  85     virtual ~QQmlComponent();
  86
  87     Q_ENUMS(Status)
  88     enum Status { Null, Ready, Loading, Error };
  89     Status status() const;
  90
  91     bool isNull() const;
  92     bool isReady() const;
  93     bool isError() const;
  94     bool isLoading() const;
  95
  96     QList<QQmlError> errors() const;
  97     Q_INVOKABLE QString errorString() const;
  98
  99     qreal progress() const;
 100
 101     QUrl url() const;
 102
 103     virtual QObject *create(QQmlContext *context = 0);
 104     virtual QObject *beginCreate(QQmlContext *);
 105     virtual void completeCreate();
 106
 107     void create(QQmlIncubator &, QQmlContext *context = 0,
 108                 QQmlContext *forContext = 0);
 109
 110     QQmlContext *creationContext() const;
 111
 112     static QQmlComponentAttached *qmlAttachedProperties(QObject *);
 113
 114 public Q_SLOTS:
 115     void loadUrl(const QUrl &url);
 116     void loadUrl(const QUrl &url, CompilationMode mode);
 117     void setData(const QByteArray &, const QUrl &baseUrl);
 118
 119 Q_SIGNALS:
 120     void statusChanged(QQmlComponent::Status);
 121     void progressChanged(qreal);
 122
 123 protected:
 124     QQmlComponent(QQmlComponentPrivate &dd, QObject* parent);
 125     Q_INVOKABLE void createObject(QQmlV8Function *);
 126     Q_INVOKABLE void incubateObject(QQmlV8Function *);
 127
 128 private:
 129     QQmlComponent(QQmlEngine *, QQmlCompiledData *, int, QObject *parent);
 130
 131     Q_DISABLE_COPY(QQmlComponent)
 132     friend class QQmlVME;
 133     friend class QQmlTypeData;
 134 };
 135
 136 QT_END_NAMESPACE
 137
 138 Q_DECLARE_METATYPE(QQmlComponent::Status)
 139 QML_DECLARE_TYPE(QQmlComponent)
 140 QML_DECLARE_TYPEINFO(QQmlComponent, QML_HAS_ATTACHED_PROPERTIES)
 141
 142 QT_END_HEADER
 143
 144 #endif // QQMLCOMPONENT_H