src/declarative/qml/qdeclarativeincubator.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 QDECLARATIVEINCUBATOR_H
  43 #define QDECLARATIVEINCUBATOR_H
  44
  45 #include <QtDeclarative/qdeclarativeerror.h>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51
  52 class QDeclarativeEngine;
  53
  54 class QDeclarativeIncubatorPrivate;
  55 class Q_DECLARATIVE_EXPORT QDeclarativeIncubator
  56 {
  57     Q_DISABLE_COPY(QDeclarativeIncubator)
  58 public:
  59     enum IncubationMode {
  60         Asynchronous,
  61         AsynchronousIfNested,
  62         Synchronous
  63     };
  64     enum Status {
  65         Null,
  66         Ready,
  67         Loading,
  68         Error
  69     };
  70
  71     QDeclarativeIncubator(IncubationMode = Asynchronous);
  72     virtual ~QDeclarativeIncubator();
  73
  74     void clear();
  75     void forceCompletion();
  76
  77     bool isNull() const;
  78     bool isReady() const;
  79     bool isError() const;
  80     bool isLoading() const;
  81
  82     QList<QDeclarativeError> errors() const;
  83
  84     IncubationMode incubationMode() const;
  85
  86     Status status() const;
  87
  88     QObject *object() const;
  89
  90 protected:
  91     virtual void statusChanged(Status);
  92     virtual void setInitialState(QObject *);
  93
  94 private:
  95     friend class QDeclarativeComponent;
  96     friend class QDeclarativeEnginePrivate;
  97     friend class QDeclarativeIncubatorPrivate;
  98     QDeclarativeIncubatorPrivate *d;
  99 };
 100
 101 class QDeclarativeEnginePrivate;
 102 class Q_DECLARATIVE_EXPORT QDeclarativeIncubationController
 103 {
 104     Q_DISABLE_COPY(QDeclarativeIncubationController)
 105 public:
 106     QDeclarativeIncubationController();
 107     virtual ~QDeclarativeIncubationController();
 108
 109     QDeclarativeEngine *engine() const;
 110     int incubatingObjectCount() const;
 111
 112     void incubateFor(int msecs);
 113     void incubateWhile(bool *flag);
 114
 115 protected:
 116     virtual void incubatingObjectCountChanged(int);
 117
 118 private:
 119     friend class QDeclarativeEngine;
 120     friend class QDeclarativeEnginePrivate;
 121     friend class QDeclarativeIncubatorPrivate;
 122     QDeclarativeEnginePrivate *d;
 123 };
 124
 125 QT_END_NAMESPACE
 126
 127 QT_END_HEADER
 128
 129 #endif // QDECLARATIVEINCUBATOR_H