src/qml/qml/qqmlincubator.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLINCUBATOR_H
  43 #define QQMLINCUBATOR_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46 #include <QtQml/qqmlerror.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52
  53 class QQmlEngine;
  54
  55 class QQmlIncubatorPrivate;
  56 class Q_QML_EXPORT QQmlIncubator
  57 {
  58     Q_DISABLE_COPY(QQmlIncubator)
  59 public:
  60     enum IncubationMode {
  61         Asynchronous,
  62         AsynchronousIfNested,
  63         Synchronous
  64     };
  65     enum Status {
  66         Null,
  67         Ready,
  68         Loading,
  69         Error
  70     };
  71
  72     QQmlIncubator(IncubationMode = Asynchronous);
  73     virtual ~QQmlIncubator();
  74
  75     void clear();
  76     void forceCompletion();
  77
  78     bool isNull() const;
  79     bool isReady() const;
  80     bool isError() const;
  81     bool isLoading() const;
  82
  83     QList<QQmlError> errors() const;
  84
  85     IncubationMode incubationMode() const;
  86
  87     Status status() const;
  88
  89     QObject *object() const;
  90
  91 protected:
  92     virtual void statusChanged(Status);
  93     virtual void setInitialState(QObject *);
  94
  95 private:
  96     friend class QQmlComponent;
  97     friend class QQmlEnginePrivate;
  98     friend class QQmlIncubatorPrivate;
  99     QQmlIncubatorPrivate *d;
 100 };
 101
 102 class QQmlEnginePrivate;
 103 class Q_QML_EXPORT QQmlIncubationController
 104 {
 105     Q_DISABLE_COPY(QQmlIncubationController)
 106 public:
 107     QQmlIncubationController();
 108     virtual ~QQmlIncubationController();
 109
 110     QQmlEngine *engine() const;
 111     int incubatingObjectCount() const;
 112
 113     void incubateFor(int msecs);
 114     void incubateWhile(volatile bool *flag, int msecs=0);
 115
 116 protected:
 117     virtual void incubatingObjectCountChanged(int);
 118
 119 private:
 120     friend class QQmlEngine;
 121     friend class QQmlEnginePrivate;
 122     friend class QQmlIncubatorPrivate;
 123     QQmlEnginePrivate *d;
 124 };
 125
 126 QT_END_NAMESPACE
 127
 128 QT_END_HEADER
 129
 130 #endif // QQMLINCUBATOR_H