src/qml/qml/qqmlparserstatus.cpp

   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 #include "qqmlparserstatus.h"
  43
  44 QT_BEGIN_NAMESPACE
  45
  46 /*!
  47     \class QQmlParserStatus
  48     \since 5.0
  49     \inmodule QtQml
  50     \brief The QQmlParserStatus class provides updates on the QML parser state.
  51
  52     QQmlParserStatus provides a mechanism for classes instantiated by
  53     a QQmlEngine to receive notification at key points in their creation.
  54
  55     This class is often used for optimization purposes, as it allows you to defer an
  56     expensive operation until after all the properties have been set on an
  57     object. For example, QML's \l {Text} element uses the parser status
  58     to defer text layout until all of its properties have been set (we
  59     don't want to layout when the \c text is assigned, and then relayout
  60     when the \c font is assigned, and relayout again when the \c width is assigned,
  61     and so on).
  62
  63     Be aware that QQmlParserStatus methods are only called when a class is instantiated
  64     by a QQmlEngine. If you create the same class directly from C++, these methods will
  65     not be called automatically. To avoid this problem, it is recommended that you start
  66     deferring operations from classBegin instead of from the initial creation of your class.
  67     This will still prevent multiple revaluations during initial binding assignment in QML,
  68     but will not defer operations invoked from C++.
  69
  70     To use QQmlParserStatus, you must inherit both a QObject-derived class
  71     and QQmlParserStatus, and use the Q_INTERFACES() macro.
  72
  73     \code
  74     class MyObject : public QObject, public QQmlParserStatus
  75     {
  76         Q_OBJECT
  77         Q_INTERFACES(QQmlParserStatus)
  78
  79     public:
  80         MyObject(QObject *parent = 0);
  81         ...
  82         void classBegin();
  83         void componentComplete();
  84     }
  85     \endcode
  86
  87     The QtQuick 1.0 version of this class is named QDeclarativeParserStatus.
  88 */
  89
  90 /*! \internal */
  91 QQmlParserStatus::QQmlParserStatus()
  92 : d(0)
  93 {
  94 }
  95
  96 /*! \internal */
  97 QQmlParserStatus::~QQmlParserStatus()
  98 {
  99     if(d)
 100         (*d) = 0;
 101 }
 102
 103 /*!
 104     \fn void QQmlParserStatus::classBegin()
 105
 106     Invoked after class creation, but before any properties have been set.
 107 */
 108
 109 /*!
 110     \fn void QQmlParserStatus::componentComplete()
 111
 112     Invoked after the root component that caused this instantiation has
 113     completed construction.  At this point all static values and binding values
 114     have been assigned to the class.
 115 */
 116
 117 QT_END_NAMESPACE