1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #ifndef QDECLARATIVECOMPONENT_H
43 #define QDECLARATIVECOMPONENT_H
45 #include <QtDeclarative/qdeclarative.h>
46 #include <QtDeclarative/qdeclarativeerror.h>
48 #include <QtCore/qobject.h>
49 #include <QtCore/qstring.h>
50 #include <QtScript/qscriptvalue.h>
56 QT_MODULE(Declarative)
58 class QDeclarativeCompiledData;
60 class QDeclarativeComponentPrivate;
61 class QDeclarativeEngine;
62 class QDeclarativeComponentAttached;
63 class QDeclarativeV8Function;
64 class Q_DECLARATIVE_EXPORT QDeclarativeComponent : public QObject
67 Q_DECLARE_PRIVATE(QDeclarativeComponent)
69 Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged)
70 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
71 Q_PROPERTY(QUrl url READ url CONSTANT)
74 QDeclarativeComponent(QObject *parent = 0);
75 QDeclarativeComponent(QDeclarativeEngine *, QObject *parent=0);
76 QDeclarativeComponent(QDeclarativeEngine *, const QString &fileName, QObject *parent = 0);
77 QDeclarativeComponent(QDeclarativeEngine *, const QUrl &url, QObject *parent = 0);
78 virtual ~QDeclarativeComponent();
81 enum Status { Null, Ready, Loading, Error };
82 Status status() const;
87 bool isLoading() const;
89 QList<QDeclarativeError> errors() const;
90 Q_INVOKABLE QString errorString() const;
92 qreal progress() const;
96 virtual QObject *create(QDeclarativeContext *context = 0);
97 virtual QObject *beginCreate(QDeclarativeContext *);
98 virtual void completeCreate();
100 QDeclarativeContext *creationContext() const;
102 static QDeclarativeComponentAttached *qmlAttachedProperties(QObject *);
105 void loadUrl(const QUrl &url);
106 void setData(const QByteArray &, const QUrl &baseUrl);
109 void statusChanged(QDeclarativeComponent::Status);
110 void progressChanged(qreal);
113 QDeclarativeComponent(QDeclarativeComponentPrivate &dd, QObject* parent);
114 Q_INVOKABLE void createObject(QDeclarativeV8Function *);
117 QDeclarativeComponent(QDeclarativeEngine *, QDeclarativeCompiledData *, int, QObject *parent);
119 Q_DISABLE_COPY(QDeclarativeComponent)
120 friend class QDeclarativeVME;
121 friend class QDeclarativeTypeData;
126 Q_DECLARE_METATYPE(QDeclarativeComponent::Status)
127 QML_DECLARE_TYPE(QDeclarativeComponent)
128 QML_DECLARE_TYPEINFO(QDeclarativeComponent, QML_HAS_ATTACHED_PROPERTIES)
132 #endif // QDECLARATIVECOMPONENT_H