/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QDECLARATIVEINCUBATOR_H
#define QDECLARATIVEINCUBATOR_H

#include <QtDeclarative/qdeclarativeerror.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE


class QDeclarativeEngine;

class QDeclarativeIncubatorPrivate;
class Q_DECLARATIVE_EXPORT QDeclarativeIncubator
{
    Q_DISABLE_COPY(QDeclarativeIncubator)
public:
    enum IncubationMode {
        Asynchronous,
        AsynchronousIfNested,
        Synchronous
    };
    enum Status { 
        Null, 
        Ready, 
        Loading, 
        Error 
    };

    QDeclarativeIncubator(IncubationMode = Asynchronous);
    virtual ~QDeclarativeIncubator();

    void clear();
    void forceCompletion();

    bool isNull() const;
    bool isReady() const;
    bool isError() const;
    bool isLoading() const;

    QList<QDeclarativeError> errors() const;

    IncubationMode incubationMode() const;

    Status status() const;

    QObject *object() const;

protected:
    virtual void statusChanged(Status);
    virtual void setInitialState(QObject *);

private:
    friend class QDeclarativeComponent;
    friend class QDeclarativeEnginePrivate;
    friend class QDeclarativeIncubatorPrivate;
    QDeclarativeIncubatorPrivate *d;
};

class QDeclarativeEnginePrivate;
class Q_DECLARATIVE_EXPORT QDeclarativeIncubationController
{
    Q_DISABLE_COPY(QDeclarativeIncubationController)
public:
    QDeclarativeIncubationController();
    virtual ~QDeclarativeIncubationController();

    QDeclarativeEngine *engine() const;
    int incubatingObjectCount() const;

    void incubateFor(int msecs);
    void incubateWhile(bool *flag);

protected:
    virtual void incubatingObjectCountChanged(int);

private:
    friend class QDeclarativeEngine;
    friend class QDeclarativeEnginePrivate;
    friend class QDeclarativeIncubatorPrivate;
    QDeclarativeEnginePrivate *d;
};

QT_END_NAMESPACE

QT_END_HEADER

#endif // QDECLARATIVEINCUBATOR_H