QQmlParserStatus Class | Qt QML 5.9

Qt 5.9 | Qt QML | C++ Classes | QQmlParserStatus

Qt 5.9.4 Reference Documentation

# QQmlParserStatus Class

The QQmlParserStatus class provides updates on the QML parser state. More...

Header: | #include <QQmlParserStatus>
qmake: | QT += qml
Since: | Qt 5.0

- List of all members, including inherited members

## Public Functions

virtual void | classBegin() = 0
virtual void | componentComplete() = 0

## Detailed Description

The QQmlParserStatus class provides updates on the QML parser state.

QQmlParserStatus provides a mechanism for classes instantiated by a QQmlEngine to receive notification at key points in their creation.

This class is often used for optimization purposes, as it allows you to defer an expensive operation until after all the properties have been set on an object. For example, QML's Text element uses the parser status to defer text layout until all of its properties have been set (we don't want to layout when the `text` is assigned, and then relayout when the `font` is assigned, and relayout again when the `width` is assigned, and so on).

Be aware that QQmlParserStatus methods are only called when a class is instantiated by a QQmlEngine. If you create the same class directly from C++, these methods will not be called automatically. To avoid this problem, it is recommended that you start deferring operations from classBegin instead of from the initial creation of your class. This will still prevent multiple revaluations during initial binding assignment in QML, but will not defer operations invoked from C++.

To use QQmlParserStatus, you must inherit both a QObject-derived class and QQmlParserStatus, and use the Q_INTERFACES() macro.

      class MyObject : public QObject, public QQmlParserStatus
      {
          Q_OBJECT
          Q_INTERFACES(QQmlParserStatus)

      public:
          MyObject(QObject *parent = 0);
          ...
          void classBegin();
          void componentComplete();
      }

The Qt Quick 1 version of this class is named QDeclarativeParserStatus.

## Member Function Documentation

### `[pure virtual]` void QQmlParserStatus::classBegin()

Invoked after class creation, but before any properties have been set.

### `[pure virtual]` void QQmlParserStatus::componentComplete()

Invoked after the root component that caused this instantiation has completed construction. At this point all static values and binding values have been assigned to the class.