1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qdeclarativeparserstatus.h"
47 \class QDeclarativeParserStatus
49 \brief The QDeclarativeParserStatus class provides updates on the QML parser state.
51 QDeclarativeParserStatus provides a mechanism for classes instantiated by
52 a QDeclarativeEngine to receive notification at key points in their creation.
54 This class is often used for optimization purposes, as it allows you to defer an
55 expensive operation until after all the properties have been set on an
56 object. For example, QML's \l {Text} element uses the parser status
57 to defer text layout until all of its properties have been set (we
58 don't want to layout when the \c text is assigned, and then relayout
59 when the \c font is assigned, and relayout again when the \c width is assigned,
62 To use QDeclarativeParserStatus, you must inherit both a QObject-derived class
63 and QDeclarativeParserStatus, and use the Q_INTERFACES() macro.
66 class MyObject : public QObject, public QDeclarativeParserStatus
69 Q_INTERFACES(QDeclarativeParserStatus)
72 MyObject(QObject *parent = 0);
75 void componentComplete();
81 QDeclarativeParserStatus::QDeclarativeParserStatus()
87 QDeclarativeParserStatus::~QDeclarativeParserStatus()
94 \fn void QDeclarativeParserStatus::classBegin()
96 Invoked after class creation, but before any properties have been set.
100 \fn void QDeclarativeParserStatus::componentComplete()
102 Invoked after the root component that caused this instantiation has
103 completed construction. At this point all static values and binding values
104 have been assigned to the class.