              
Using QML Bindings in C++ ApplicationsQML is designed to be easily extensible to and from C++. The classes in the Qt Declarative module allow QML components to be loaded and manipulated from C++, and through Qt's meta-object system, QML and C++ objects can easily communicate through Qt signals and slots. In addition, QML plugins can be written to create reusable QML components for distribution. You may want to mix QML and C++ for a number of reasons. For example:
To use the Qt Declarative module, you must include and link to the module appropriately, as shown on the module index page. The Qt Declarative UI Runtime documentation shows how to build a basic C++ application that uses this module. Core module classesThe Qt Declarative module provides a set of C++ APIs for extending your QML applications from C++ and embedding QML into C++ applications. There are several core classes in the Qt Declarative module that provide the essential capabilities for doing this. These are:
A QDeclarativeEngine allows the configuration of global settings that apply to all of its QML component instances: for example, the QNetworkAccessManager to be used for network communications, and the file path to be used for persistent storage. QDeclarativeComponent is used to load QML documents. Each QDeclarativeComponent instance represents a single document. A component can be created from the URL or file path of a QML document, or the raw QML code of the document. Component instances are instatiated through the QDeclarativeComponent::create() method, like this: QDeclarativeEngine engine; QDeclarativeComponent component(&engine, QUrl::fromLocalFile("MyRectangle.qml")); QObject *rectangleInstance = component.create(); // ... delete rectangleInstance; QML documents can also be loaded using QDeclarativeView. This class provides a convenient QWidget-based view for embedding QML components into QGraphicsView-based applications. (For other methods of integrating QML into QWidget-based applications, see Integrating QML Code with existing Qt UI code.) Approaches to using QML with C++There are a number of ways to extend your QML application through C++. For example, you could:
These methods are shown below. Naturally these approaches are not exclusive; you can mix any of these methods throughout your application as appropriate. Loading QML components from C++A QML document can be loaded with QDeclarativeComponent or QDeclarativeView. QDeclarativeComponent loads a QML component as a C++ object; QDeclarativeView also does this, but additionally loads the QML component directly into a QGraphicsView. It is convenient for loading a displayable QML component into a QWidget-based application. For example, suppose there is a MyItem.qml file that looks like this: import QtQuick 1.0 Item { width: 100; height: 100 } This QML document can be loaded with QDeclarativeComponent or QDeclarativeView with the following C++ code. Using a QDeclarativeComponent requires calling QDeclarativeComponent::create() to create a new instance of the component, while a QDeclarativeView automatically creates an instance of the component, which is accessible via QDeclarativeView::rootObject():
This object is the instance of the MyItem.qml component that has been created. You can now modify the item's properties using QObject::setProperty() or QDeclarativeProperty: object->setProperty("width", 500); QDeclarativeProperty(object, "width").write(500); Alternatively, you can cast the object to its actual type and call functions with compile-time safety. In this case the base object of MyItem.qml is an Item, which is defined by the QDeclarativeItem class: QDeclarativeItem *item = qobject_cast<QDeclarativeItem*>(object); item->setWidth(500); You can also connect to any signals or call functions defined in the component using QMetaObject::invokeMethod() and QObject::connect(). See Exchanging data between QML and C++ below for further details. Locating child objectsQML components are essentially object trees with children that have siblings and their own children. Child objects of QML components can be located using the QObject::objectName property with QObject::findChild(). For example, if the root item in MyItem.qml had a child Rectangle item: import QtQuick 1.0 Item { width: 100; height: 100 Rectangle { anchors.fill: parent objectName: "rect" } } The child could be located like this: QObject *rect = object->findChild<QObject*>("rect"); if (rect) rect->setProperty("color", "red"); If objectName is used inside a delegate of a ListView, Repeater or some other element that creates multiple instances of its delegates, there will be multiple children with the same objectName. In this case, QObject::findChildren() can be used to find all children with a matching objectName. Warning: While it is possible to use C++ to access and manipulate QML objects deep into the object tree, we recommend that you do not take this approach outside of application testing and prototyping. One strength of QML and C++ integration is the ability to implement the QML user interface separately from the C++ logic and dataset backend, and this strategy breaks if the C++ side reaches deep into the QML components to manipulate them directly. This would make it difficult to, for example, swap a QML view component for another view, if the new component was missing a required objectName. It is better for the C++ implementation to know as little as possible about the QML user interface implementation and the composition of the QML object tree. Embedding C++ objects into QML componentsWhen loading a QML scene into a C++ application, it can be useful to directly embed C++ data into the QML object. QDeclarativeContext enables this by exposing data to the context of a QML component, allowing data to be injected from C++ into QML. For example, here is a QML item that refers to a currentDateTime value that does not exist in the current scope: // MyItem.qml import QtQuick 1.0 Text { text: currentDateTime } This currentDateTime value can be set directly by the C++ application that loads the QML component, using QDeclarativeContext::setContextProperty(): QDeclarativeView view; view.rootContext()->setContextProperty("currentDateTime", QDateTime::currentDateTime()); view.setSource(QUrl::fromLocalFile("MyItem.qml")); view.show(); Context properties can hold either QVariant or QObject* values. This means custom C++ objects can also be injected using this approach, and these objects can be modified and read directly in QML. Here, we modify the above example to embed a QObject instance instead of a QDateTime value, and the QML code invokes a method on the object instance:
(Note that date/time values returned from C++ to QML can be formatted through Qt.formatDateTime() and associated functions.) If the QML item needs to receive signals from the context property, it can connect to them using the Connections element. For example, if ApplicationData has a signal named dataChanged(), this signal can be connected to using an onDataChanged handler within a Connections object: Text { text: applicationData.getCurrentDateTime() Connections { target: applicationData onDataChanged: console.log("The application data changed!") } } Context properties can be useful for using C++ based data models in a QML view. See the String ListModel, Object ListModel and AbstractItemModel models for respective examples on using QStringListModel, QObjectList-based models and QAbstractItemModel in QML views. Also see the QDeclarativeContext documentation for more information. Defining new QML elementsWhile new QML elements can be defined in QML, they can also be defined by C++ classes; in fact, many of the core QML Elements are implemented through C++ classes. When you create a QML object using one of these elements, you are simply creating an instance of a QObject-based C++ class and setting its properties. To create a visual item that fits in with the Qt Quick elements, base your class off QDeclarativeItem instead of QObject directly. You can then implement your own painting and functionality like any other QGraphicsObject. Note that QGraphicsItem::ItemHasNoContents is set by default on QDeclarativeItem because it does not paint anything; you will need to clear this if your item is supposed to paint anything (as opposed to being solely for input handling or logical grouping). For example, here is an ImageViewer class with an image URL property: #include <QtCore> #include <QtDeclarative> class ImageViewer : public QDeclarativeItem { Q_OBJECT Q_PROPERTY(QUrl image READ image WRITE setImage NOTIFY imageChanged) public: void setImage(const QUrl &url); QUrl image() const; signals: void imageChanged(); }; Aside from the fact that it inherits QDeclarativeItem, this is an ordinary class that could exist outside of QML. However, once it is registered with the QML engine using qmlRegisterType(): qmlRegisterType<ImageViewer>("MyLibrary", 1, 0, "ImageViewer"); Then, any QML code loaded by your C++ application or plugin can create and manipulate ImageViewer objects: import MyLibrary 1.0 ImageViewer { image: "smile.png" } It is advised that you avoid using QGraphicsItem functionality beyond the properties documented in QDeclarativeItem. This is because the GraphicsView backend is intended to be an implementation detail for QML, so the QtQuick items can be moved to faster backends as they become available with no change from a QML perspective. To minimize any porting requirements for custom visual items, try to stick to the documented properties in QDeclarativeItem where possible. Properties QDeclarativeItem inherits but doesn't document are classed as implementation details; they are not officially supported and may disappear between releases. Note that custom C++ types do not have to inherit from QDeclarativeItem; this is only necessary if it is a displayable item. If the item is not displayable, it can simply inherit from QObject. For more information on defining new QML elements, see the Writing QML extensions with C++ tutorial and the Extending QML Functionalities using C++ reference documentation. Exchanging data between QML and C++QML and C++ objects can communicate with one another through signals, slots and property modifications. For a C++ object, any data that is exposed to Qt's Meta-Object System - that is, properties, signals, slots and Q_INVOKABLE methods - become available to QML. On the QML side, all QML object data is automatically made available to the meta-object system and can be accessed from C++. Calling functionsQML functions can be called from C++ and vice-versa. All QML functions are exposed to the meta-object system and can be called using QMetaObject::invokeMethod(). Here is a C++ application that uses this to call a QML function:
Notice the Q_RETURN_ARG() and Q_ARG() arguments for QMetaObject::invokeMethod() must be specified as QVariant types, as this is the generic data type used for QML functions and return values. To call a C++ function from QML, the function must be either a Qt slot, or a function marked with the Q_INVOKABLE macro, to be available to QML. In the following example, the QML code invokes methods on the myObject object, which has been set using QDeclarativeContext::setContextProperty():
QML supports the calling of overloaded C++ functions. If there are multiple C++ functions with the same name but different arguments, the correct function will be called according to the number and the types of arguments that are provided. Receiving signalsAll QML signals are automatically available to C++, and can be connected to using QObject::connect() like any ordinary Qt C++ signal. In return, any C++ signal can be received by a QML object using signal handlers. Here is a QML component with a signal named qmlSignal. This signal is connected to a C++ object's slot using QObject::connect(), so that the cppSlot() method is called whenever the qmlSignal is emitted:
To connect to Qt C++ signals from within QML, use a signal handler with the on<SignalName> syntax. If the C++ object is directly creatable from within QML (see Defining new QML elements above) then the signal handler can be defined within the object declaration. In the following example, the QML code creates a ImageViewer object, and the imageChanged and loadingError signals of the C++ object are connected to through onImagedChanged and onLoadingError signal handlers in QML:
(Note that if a signal has been declared as the NOTIFY signal for a property, QML allows it to be received with an on<Property>Changed handler even if the signal's name does not follow the <Property>Changed naming convention. In the above example, if the "imageChanged" signal was named "imageModified" instead, the onImageChanged signal handler would still be called.) If, however, the object with the signal is not created from within the QML code, and the QML item only has a reference to the created object - for example, if the object was set using QDeclarativeContext::setContextProperty() - then the Connections element can be used instead to create the signal handler:
C++ signals can use enum values as parameters provided that the enum is declared in the class that is emitting the signal, and that the enum is registered using Q_ENUMS. See Using enumerations of a custom type below for details. Modifying propertiesAny properties declared in a QML object are automatically accessible from C++. Given a QML item like this: // MyItem.qml import QtQuick 1.0 Item { property int someNumber: 100 } The value of the someNumber property can be set and read using QDeclarativeProperty, or QObject::setProperty() and QObject::property(): QDeclarativeEngine engine; QDeclarativeComponent component(&engine, "MyItem.qml"); QObject *object = component.create(); qDebug() << "Property value:" << QDeclarativeProperty::read(object, "someNumber").toInt(); QDeclarativeProperty::write(object, "someNumber", 5000); qDebug() << "Property value:" << object->property("someNumber").toInt(); object->setProperty("someNumber", 100); You should always use QObject::setProperty(), QDeclarativeProperty or QMetaProperty::write() to change a QML property value, to ensure the QML engine is made aware of the property change. For example, say you have a custom element PushButton with a buttonText property that internally reflects the value of a m_buttonText member variable. Modifying the member variable directly like this is not a good idea: // BAD! QDeclarativeComponent component(engine, "MyButton.qml"); PushButton *button = qobject_cast<PushButton*>(component.create()); button->m_buttonText = "Click me"; Since the value is changed directly, this bypasses Qt's meta-object system and the QML engine is not made aware of the property change. This means property bindings to buttonText would not be updated, and any onButtonTextChanged handlers would not be called. Any Qt properties - that is, those declared with the Q_PROPERTY() macro - are accessible from QML. Here is a modified version of the earlier example on this page; here, the ApplicationData class has a backgroundColor property. This property can be written to and read from QML:
Notice the backgroundColorChanged signal is declared as the NOTIFY signal for the backgroundColor property. If a Qt property does not have an associated NOTIFY signal, the property cannot be used for Property Binding in QML, as the QML engine would not be notified when the value changes. If you are using custom types in QML, make sure their properties have NOTIFY signals so that they can be used in property bindings. See Tutorial: Writing QML extensions with C++ for further details and examples on using Qt properties with QML. Supported data typesAny C++ data that is used from QML - whether as custom properties, or parameters for signals or functions - must be of a type that is recognizable by QML. By default, QML recognizes the following data types:
To allow a custom C++ type to be created or used in QML, the C++ class must be registered as a QML type using qmlRegisterType(), as shown in the Defining new QML elements section above. JavaScript arrays and objectsThere is built-in support for automatic type conversion between QVariantList and JavaScript arrays, and QVariantMap and JavaScript objects. For example, the function defined in QML below left expects two arguments, an array and an object, and prints their contents using the standard JavaScript syntax for array and object item access. The C++ code below right calls this function, passing a QVariantList and a QVariantMap, which are automatically converted to JavaScript array and object values, repectively:
This produces output like: Array item: 10 Array item: #00ff00 Array item: bottles Object item: language = QML Object item: released = Tue Sep 21 2010 00:00:00 GMT+1000 (EST) Similarly, if a C++ type uses a QVariantList or QVariantMap type for a property or method parameter, the value can be created as a JavaScript array or object in the QML side, and is automatically converted to a QVariantList or QVariantMap when it is passed to C++. Using enumerations of a custom typeTo use an enumeration from a custom C++ component, the enumeration must be declared with Q_ENUMS() to register it with Qt's meta object system. For example, the following C++ type has a Status enum: class ImageViewer : public QDeclarativeItem { Q_OBJECT Q_ENUMS(Status) Q_PROPERTY(Status status READ status NOTIFY statusChanged) public: enum Status { Ready, Loading, Error }; Status status() const; signals: void statusChanged(); }; Providing the ImageViewer class has been registered using qmlRegisterType(), its Status enum can now be used from QML: ImageViewer { onStatusChanged: { if (status == ImageViewer.Ready) console.log("Image viewer is ready!") } } The C++ type must be registered with QML to use its enums. If your C++ type is not instantiable, it can be registered using qmlRegisterUncreatableType(). To be accessible from QML, the names of enum values must begin with a capital letter. See the Writing QML extensions with C++ tutorial and the Extending QML Functionalities using C++ reference documentation for more information. Using enumeration values as signal parametersC++ signals may pass enumeration values as signal parameters to QML, providing that the enumeration and the signal are declared within the same class, or that the enumeration value is one of those declared in the Qt Namespace. Additionally, if a C++ signal with an enum parameter should be connectable to a QML function using the connect() function, the enum type must be registered using qRegisterMetaType(). For QML signals, enum values may be used as signal parameters using the int type: ImageViewer { signal someOtherSignal(int statusValue) Component.onCompleted: { someOtherSignal(ImageViewer.Loading) } } Automatic type conversion from stringsAs a convenience, some basic types can be specified in QML using format strings to make it easier to pass simple values from QML to C++.
(More details on these string formats and types can be found in the basic type documentation.) These string formats can be used to set QML property values and pass arguments to C++ functions. This is demonstrated by various examples on this page; in the above Qt properties example, the ApplicationData class has a backgroundColor property of a QColor type, which is set from the QML code with the string "red" rather rather than an actual QColor object. If it is preferred to pass an explicitly-typed value rather than a string, the global Qt object provides convenience functions for creating some of the object types listed above. For example, Qt.rgba() creates a QColor value from four RGBA values. The QColor returned from this function could be used instead of a string to set a QColor-type property or to call a C++ function that requires a QColor parameter. Writing QML pluginsThe Qt Declarative module includes the QDeclarativeExtensionPlugin class, which is an abstract class for writing QML plugins. This allows QML extension types to be dynamically loaded into QML applications. See the QDeclarativeExtensionPlugin documentation and How to Create Qt Plugins for more details. Managing resource files with the Qt resource systemThe Qt resource system allows resource files to be stored as binary files in an application executable. This can be useful when building a mixed QML/C++ application as it enables QML files (as well as other resources such as images and sound files) to be referred to through the resource system URI scheme rather than relative or absolute paths to filesystem resources. Note, however, that if you use the resource system, the application executable must be re-compiled whenever a QML source file is changed in order to update the resources in the package. To use the resource system in a mixed QML/C++ application:
Once this is done, all files specified by relative paths in QML will be loaded from the resource system instead. Use of the resource system is completely transparent to the QML layer; this means all QML code should refer to resource files using relative paths and should not use the qrc scheme. This scheme should only be used from C++ code for referring to resource files. Here is a application packaged using the Qt resource system. The directory structure looks like this: project
|- example.qrc
|- main.qml
|- images
|- background.png
|- main.cpp
|- project.pro
The main.qml and background.png files will be packaged as resource files. This is done in the example.qrc resource collection file: <!DOCTYPE RCC>
<RCC version="1.0">
<qresource prefix="/">
<file>main.qml</file>
<file>images/background.png</file>
</qresource>
</RCC>
Since background.png is a resource file, main.qml can refer to it using the relative path specified in example.qrc: // main.qml import QtQuick 1.0 Image { source: "images/background.png" } To allow QML to locate resource files correctly, the main.cpp loads the main QML file, main.qml, as a resource file using the qrc scheme: int main(int argc, char *argv[]) { QApplication app(argc, argv); QDeclarativeView view; view.setSource(QUrl("qrc:/main.qml")); view.show(); return app.exec(); } Finally project.pro uses the RESOURCES variable to indicate that example.qrc should be used to build the application resources: QT += declarative SOURCES += main.cpp RESOURCES += example.qrc See The Qt Resource System for more information. |
