src/declarative/qml/qdeclarativecomponent.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 QtDeclarative 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 QDECLARATIVECOMPONENT_H
  43 #define QDECLARATIVECOMPONENT_H
  44
  45 #include <QtDeclarative/qdeclarative.h>
  46 #include <QtDeclarative/qdeclarativeerror.h>
  47
  48 #include <QtCore/qobject.h>
  49 #include <QtCore/qstring.h>
  50 #include <QtDeclarative/qjsvalue.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QByteArray;
  58 class QDeclarativeEngine;
  59 class QDeclarativeComponent;
  60 class QDeclarativeIncubator;
  61 class QDeclarativeV8Function;
  62 class QDeclarativeCompiledData;
  63 class QDeclarativeComponentPrivate;
  64 class QDeclarativeComponentAttached;
  65
  66 class Q_DECLARATIVE_EXPORT QDeclarativeComponent : public QObject
  67 {
  68     Q_OBJECT
  69     Q_DECLARE_PRIVATE(QDeclarativeComponent)
  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     QDeclarativeComponent(QObject *parent = 0);
  77     QDeclarativeComponent(QDeclarativeEngine *, QObject *parent=0);
  78     QDeclarativeComponent(QDeclarativeEngine *, const QString &fileName, QObject *parent = 0);
  79     QDeclarativeComponent(QDeclarativeEngine *, const QUrl &url, QObject *parent = 0);
  80     virtual ~QDeclarativeComponent();
  81
  82     Q_ENUMS(Status)
  83     enum Status { Null, Ready, Loading, Error };
  84     Status status() const;
  85
  86     bool isNull() const;
  87     bool isReady() const;
  88     bool isError() const;
  89     bool isLoading() const;
  90
  91     QList<QDeclarativeError> errors() const;
  92     Q_INVOKABLE QString errorString() const;
  93
  94     qreal progress() const;
  95
  96     QUrl url() const;
  97
  98     virtual QObject *create(QDeclarativeContext *context = 0);
  99     virtual QObject *beginCreate(QDeclarativeContext *);
 100     virtual void completeCreate();
 101
 102     void create(QDeclarativeIncubator &, QDeclarativeContext *context = 0,
 103                 QDeclarativeContext *forContext = 0);
 104
 105     QDeclarativeContext *creationContext() const;
 106
 107     static QDeclarativeComponentAttached *qmlAttachedProperties(QObject *);
 108
 109 public Q_SLOTS:
 110     void loadUrl(const QUrl &url);
 111     void setData(const QByteArray &, const QUrl &baseUrl);
 112
 113 Q_SIGNALS:
 114     void statusChanged(QDeclarativeComponent::Status);
 115     void progressChanged(qreal);
 116
 117 protected:
 118     QDeclarativeComponent(QDeclarativeComponentPrivate &dd, QObject* parent);
 119     Q_INVOKABLE void createObject(QDeclarativeV8Function *);
 120     Q_INVOKABLE void incubateObject(QDeclarativeV8Function *);
 121
 122 private:
 123     QDeclarativeComponent(QDeclarativeEngine *, QDeclarativeCompiledData *, int, QObject *parent);
 124
 125     Q_DISABLE_COPY(QDeclarativeComponent)
 126     friend class QDeclarativeVME;
 127     friend class QDeclarativeTypeData;
 128 };
 129
 130 QT_END_NAMESPACE
 131
 132 Q_DECLARE_METATYPE(QDeclarativeComponent::Status)
 133 QML_DECLARE_TYPE(QDeclarativeComponent)
 134 QML_DECLARE_TYPEINFO(QDeclarativeComponent, QML_HAS_ATTACHED_PROPERTIES)
 135
 136 QT_END_HEADER
 137
 138 #endif // QDECLARATIVECOMPONENT_H