src/declarative/qml/qdeclarativecomponent.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 ** 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 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 <QtScript/qscriptvalue.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 QT_MODULE(Declarative)
  57
  58 class QDeclarativeCompiledData;
  59 class QByteArray;
  60 class QDeclarativeComponentPrivate;
  61 class QDeclarativeEngine;
  62 class QDeclarativeComponentAttached;
  63 class Q_DECLARATIVE_EXPORT QDeclarativeComponent : public QObject
  64 {
  65     Q_OBJECT
  66     Q_DECLARE_PRIVATE(QDeclarativeComponent)
  67
  68     Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged)
  69     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
  70     Q_PROPERTY(QUrl url READ url CONSTANT)
  71
  72 public:
  73     QDeclarativeComponent(QObject *parent = 0);
  74     QDeclarativeComponent(QDeclarativeEngine *, QObject *parent=0);
  75     QDeclarativeComponent(QDeclarativeEngine *, const QString &fileName, QObject *parent = 0);
  76     QDeclarativeComponent(QDeclarativeEngine *, const QUrl &url, QObject *parent = 0);
  77     virtual ~QDeclarativeComponent();
  78
  79     Q_ENUMS(Status)
  80     enum Status { Null, Ready, Loading, Error };
  81     Status status() const;
  82
  83     bool isNull() const;
  84     bool isReady() const;
  85     bool isError() const;
  86     bool isLoading() const;
  87
  88     QList<QDeclarativeError> errors() const;
  89     Q_INVOKABLE QString errorString() const;
  90
  91     qreal progress() const;
  92
  93     QUrl url() const;
  94
  95     virtual QObject *create(QDeclarativeContext *context = 0);
  96     virtual QObject *beginCreate(QDeclarativeContext *);
  97     virtual void completeCreate();
  98
  99     QDeclarativeContext *creationContext() const;
 100
 101     static QDeclarativeComponentAttached *qmlAttachedProperties(QObject *);
 102
 103 public Q_SLOTS:
 104     void loadUrl(const QUrl &url);
 105     void setData(const QByteArray &, const QUrl &baseUrl);
 106
 107 Q_SIGNALS:
 108     void statusChanged(QDeclarativeComponent::Status);
 109     void progressChanged(qreal);
 110
 111 protected:
 112     QDeclarativeComponent(QDeclarativeComponentPrivate &dd, QObject* parent);
 113     Q_INVOKABLE QScriptValue createObject(QObject* parent);
 114     Q_INVOKABLE Q_REVISION(1) QScriptValue createObject(QObject* parent, const QScriptValue& valuemap); //XXX Versioning
 115
 116 private:
 117     QDeclarativeComponent(QDeclarativeEngine *, QDeclarativeCompiledData *, int, QObject *parent);
 118
 119     Q_DISABLE_COPY(QDeclarativeComponent)
 120     friend class QDeclarativeVME;
 121     friend class QDeclarativeTypeData;
 122 };
 123
 124 QT_END_NAMESPACE
 125
 126 Q_DECLARE_METATYPE(QDeclarativeComponent::Status)
 127 QML_DECLARE_TYPE(QDeclarativeComponent)
 128 QML_DECLARE_TYPEINFO(QDeclarativeComponent, QML_HAS_ATTACHED_PROPERTIES)
 129
 130 QT_END_HEADER
 131
 132 #endif // QDECLARATIVECOMPONENT_H