1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 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 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     void loadUrl(const QUrl &url);

   100     void setData(const QByteArray &, const QUrl &baseUrl);

   101 

   102     QDeclarativeContext *creationContext() const;

   103 

   104     static QDeclarativeComponentAttached *qmlAttachedProperties(QObject *);

   105 

   106 Q_SIGNALS:

   107     void statusChanged(QDeclarativeComponent::Status);

   108     void progressChanged(qreal);

   109 

   110 protected:

   111     QDeclarativeComponent(QDeclarativeComponentPrivate &dd, QObject* parent);

   112     Q_INVOKABLE QScriptValue createObject(QObject* parent);

   113 

   114 private:

   115     QDeclarativeComponent(QDeclarativeEngine *, QDeclarativeCompiledData *, int, int, QObject *parent);

   116 

   117     Q_DISABLE_COPY(QDeclarativeComponent)

   118     friend class QDeclarativeVME;

   119     friend class QDeclarativeCompositeTypeData;

   120 };

   121 

   122 QT_END_NAMESPACE

   123 

   124 Q_DECLARE_METATYPE(QDeclarativeComponent::Status)

   125 QML_DECLARE_TYPE(QDeclarativeComponent)

   126 QML_DECLARE_TYPEINFO(QDeclarativeComponent, QML_HAS_ATTACHED_PROPERTIES)

   127 

   128 QT_END_HEADER

   129 

   130 #endif // QDECLARATIVECOMPONENT_H