1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLINCUBATOR_H
41#define QQMLINCUBATOR_H
42
43#include <QtQml/qtqmlglobal.h>
44#include <QtQml/qqmlerror.h>
45
46QT_BEGIN_NAMESPACE
47
48
49class QQmlEngine;
50
51class QQmlIncubatorPrivate;
52class Q_QML_EXPORT QQmlIncubator
53{
54 Q_DISABLE_COPY(QQmlIncubator)
55public:
56 enum IncubationMode {
57 Asynchronous,
58 AsynchronousIfNested,
59 Synchronous
60 };
61 enum Status {
62 Null,
63 Ready,
64 Loading,
65 Error
66 };
67
68 QQmlIncubator(IncubationMode = Asynchronous);
69 virtual ~QQmlIncubator();
70
71 void clear();
72 void forceCompletion();
73
74 bool isNull() const;
75 bool isReady() const;
76 bool isError() const;
77 bool isLoading() const;
78
79 QList<QQmlError> errors() const;
80
81 IncubationMode incubationMode() const;
82
83 Status status() const;
84
85 QObject *object() const;
86
87protected:
88 virtual void statusChanged(Status);
89 virtual void setInitialState(QObject *);
90
91private:
92 friend class QQmlComponent;
93 friend class QQmlEnginePrivate;
94 friend class QQmlIncubatorPrivate;
95 QQmlIncubatorPrivate *d;
96};
97
98class QQmlEnginePrivate;
99class Q_QML_EXPORT QQmlIncubationController
100{
101 Q_DISABLE_COPY(QQmlIncubationController)
102public:
103 QQmlIncubationController();
104 virtual ~QQmlIncubationController();
105
106 QQmlEngine *engine() const;
107 int incubatingObjectCount() const;
108
109 void incubateFor(int msecs);
110 void incubateWhile(volatile bool *flag, int msecs=0);
111
112protected:
113 virtual void incubatingObjectCountChanged(int);
114
115private:
116 friend class QQmlEngine;
117 friend class QQmlEnginePrivate;
118 friend class QQmlIncubatorPrivate;
119 QQmlEnginePrivate *d;
120};
121
122QT_END_NAMESPACE
123
124#endif // QQMLINCUBATOR_H
125