Update documentation for connections editor
We added a new tab called backends. I also updated all the screenshot, so they contain the new tab. Change-Id: Ib66ffbd3a48383f621a482241cde12caef9ca7b4 Reviewed-by: Thomas Hartmann <Thomas.Hartmann@theqtcompany.com> Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
BIN
doc/images/qmldesigner-backends.png
Normal file
After Width: | Height: | Size: 3.5 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 3.3 KiB |
Before Width: | Height: | Size: 4.5 KiB After Width: | Height: | Size: 3.2 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 3.3 KiB |
@@ -41,6 +41,8 @@
|
|||||||
|
|
||||||
\li Create bindings between the properties of two objects.
|
\li Create bindings between the properties of two objects.
|
||||||
|
|
||||||
|
\li Manage backend QObjects.
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
For examples of adding connections, see
|
For examples of adding connections, see
|
||||||
@@ -125,4 +127,53 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
\section1 Managing C++ Backend Objects
|
||||||
|
|
||||||
|
Many applications provide QObject objects implemented in C++ that work as a
|
||||||
|
bridge between QML and C++. Such objects are typically registered with
|
||||||
|
qmlRegisterType or qmlRegisterSingletonType and then used by QML to
|
||||||
|
communicate with the C++ backend. Another example of such objects are the
|
||||||
|
state machines created by the \l {Using the Qt SCXML Compiler (qscxmlc)}
|
||||||
|
{Qt SCXML Compiler}.
|
||||||
|
|
||||||
|
Backend objects in a QML file are accessible if the QML file contains the
|
||||||
|
required imports. In addition, for a non-singleton QObject, a dynamic
|
||||||
|
property that contains the QObject must be specified.
|
||||||
|
|
||||||
|
A \e local QObject is instantiated in the current \e .qml file, as follows:
|
||||||
|
|
||||||
|
\badcode
|
||||||
|
property MyType myType: MyType {}.
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
Otherwise the property is just defined, as follows:
|
||||||
|
|
||||||
|
\badcode
|
||||||
|
property MyType myType
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
To manage backend objects:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
|
||||||
|
\li Select the \uicontrol Backends tab to view accessible backend
|
||||||
|
objects.
|
||||||
|
|
||||||
|
\image qmldesigner-backends.png
|
||||||
|
|
||||||
|
\li Select the \inlineimage plus.png
|
||||||
|
(\uicontrol Add) button to add a backend object in the
|
||||||
|
\uicontrol {Add New C++ Backend} dialog.
|
||||||
|
|
||||||
|
\li In the \uicontrol Type field, select the type of the backend QObject
|
||||||
|
to add.
|
||||||
|
|
||||||
|
\li Select the \uicontrol {Define object locally} check box if the
|
||||||
|
QObject is not registered as a singleton.
|
||||||
|
|
||||||
|
\li Select \uicontrol OK to add the required import and to create the
|
||||||
|
property for a non-singleton object.
|
||||||
|
|
||||||
|
\endlist
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
@@ -52,6 +52,9 @@
|
|||||||
is available, and therefore, you must explicitly generate type information
|
is available, and therefore, you must explicitly generate type information
|
||||||
for QML modules with plugins before distributing them.
|
for QML modules with plugins before distributing them.
|
||||||
|
|
||||||
|
Classes registered with \c qmlRegisterType() can be used as backend objects
|
||||||
|
in the \QMLD. For more information, see \l {Adding Connections}.
|
||||||
|
|
||||||
Ideally, QML modules have a \c{plugins.qmltypes} file in the same directory
|
Ideally, QML modules have a \c{plugins.qmltypes} file in the same directory
|
||||||
as the \c qmldir file. The \c qmltypes file contains a description of the
|
as the \c qmldir file. The \c qmltypes file contains a description of the
|
||||||
types exported by the module's plugins and is loaded by \QC when the
|
types exported by the module's plugins and is loaded by \QC when the
|
||||||
|