diff options
Diffstat (limited to 'src/qml/doc/src/cppintegration')
| -rw-r--r-- | src/qml/doc/src/cppintegration/contextproperties.qdoc | 2 | ||||
| -rw-r--r-- | src/qml/doc/src/cppintegration/data.qdoc | 8 | ||||
| -rw-r--r-- | src/qml/doc/src/cppintegration/definetypes.qdoc | 20 | ||||
| -rw-r--r-- | src/qml/doc/src/cppintegration/extending-tutorial.qdoc | 98 | ||||
| -rw-r--r-- | src/qml/doc/src/cppintegration/topic.qdoc | 10 |
5 files changed, 69 insertions, 69 deletions
diff --git a/src/qml/doc/src/cppintegration/contextproperties.qdoc b/src/qml/doc/src/cppintegration/contextproperties.qdoc index aaac43e470..1c2bced738 100644 --- a/src/qml/doc/src/cppintegration/contextproperties.qdoc +++ b/src/qml/doc/src/cppintegration/contextproperties.qdoc @@ -74,7 +74,7 @@ QML code invokes a method on the object instance: \endtable (Note that date/time values returned from C++ to QML can be formatted through -\l{QML:Qt::formatDateTime}{Qt.formatDateTime()} and associated functions.) +\l{QtQml2::Qt::formatDateTime}{Qt.formatDateTime()} and associated functions.) If the QML item needs to receive signals from the context property, it can connect to them using the \l Connections type. For example, if \c ApplicationData has a signal named \c diff --git a/src/qml/doc/src/cppintegration/data.qdoc b/src/qml/doc/src/cppintegration/data.qdoc index ba8ad47bab..74a93436f5 100644 --- a/src/qml/doc/src/cppintegration/data.qdoc +++ b/src/qml/doc/src/cppintegration/data.qdoc @@ -119,12 +119,12 @@ when passed from C++ to QML and vice-versa: \li \l enumeration \endtable -(Note that classes provided by the QtGui module, such as QColor, QFont, -QQuaternion and QMatrix4x4, are only available from QML when the \l QtQuick -module is imported.) +\note Classes provided by the \l {Qt GUI} module, such as QColor, QFont, +QQuaternion and QMatrix4x4, are only available from QML when the \l {Qt Quick} +module is included. As a convenience, many of these types can be specified in QML by string values, -or by a related method provided by the \l {QML:Qt} object. For example, the \l +or by a related method provided by the \l {QtQml2::Qt} object. For example, the \l {Image::sourceSize} property is of type \l size (which automatically translates to the QSize type) and can be specified by a string value formatted as "width\c{x}height", or by the Qt.size() function: diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc index be5f26a865..995fb1bce8 100644 --- a/src/qml/doc/src/cppintegration/definetypes.qdoc +++ b/src/qml/doc/src/cppintegration/definetypes.qdoc @@ -40,7 +40,7 @@ as an instantiable \l{qtqml-typesystem-objecttypes.html}{QML object type} from QML, or enabling a singleton instance of the class to be imported and used from QML. -Additionally, the QtQml module provides mechanisms for implementing QML-specific +Additionally, the \l {Qt QML} module provides mechanisms for implementing QML-specific features such as \e{attached properties} and \e{default properties} in C++. (Note that a number of the important concepts covered in this document are @@ -133,7 +133,7 @@ not be instantiable should not be instantiable from QML \endlist -The QtQml module provides several methods for registering non-instantiable +The \l {Qt QML} module provides several methods for registering non-instantiable types: \list @@ -291,7 +291,7 @@ qmlRegisterRevision<BaseType,1>("MyTypes", 1, 1); \endcode This is useful when deriving from base classes provided by other authors, -e.g. when extending classes from the QtQuick library. +e.g. when extending classes from the Qt Quick module. \section1 Defining QML-Specific Types and Attributes @@ -675,19 +675,19 @@ to be declared for an item without explicitly assigning them to the \l{Item::}{children} property.) -\section2 Defining Visual Items with the QtQuick Module +\section2 Defining Visual Items with the Qt Quick Module -When building user interfaces with the QtQuick module, all QML objects that are +When building user interfaces with the \l {Qt Quick} module, all QML objects that are to be visually rendered must derive from the \l Item type, as it is the base -type for all visual objects in the QtQuick module. This \l Item type is -implemented by the QQuickItem C++ class, which is provided as part of the -QtQuick C++ module. Therefore, this class should be subclassed when it is +type for all visual objects in \l {Qt Quick}. This \l Item type is +implemented by the QQuickItem C++ class, which is provided by the +\l {Qt Quick} module. Therefore, this class should be subclassed when it is necessary to implement a visual type in C++ that can be integrated into a QML-based user interface. See the QQuickItem documentation for more information. Additionally, the \l{Writing QML Extensions with C++} tutorial demonstrates how a QQuickItem-based -visual item can be implemented in C++ and integrated into a QtQuick-based user +visual item can be implemented in C++ and integrated into a Qt Quick-based user interface. @@ -699,7 +699,7 @@ its properties have been set. For example, this may be the case if the initialization is costly, or if the initialization should not be performed until all property values have been initialized. -The QtQml module provides the QQmlParserStatus to be subclass for these +The \l {Qt QML} module provides the QQmlParserStatus to be subclass for these purposes. It defines a number of virtual methods that are invoked invoked at various stages during component instantiation. To receive these notifications, a C++ class should inherit QQmlParserStatus and also notify the Qt meta system diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc index 3253752e47..d0fb03a03c 100644 --- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc +++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc @@ -30,7 +30,7 @@ \title Writing QML Extensions with C++ \brief tutorial about extending QML with Qt C++ -The QtQml C++ module provides a set of APIs for extending QML through +The \l {Qt QML} module provides a set of APIs for extending QML through C++ extensions. You can write extensions to add your own QML types, extend existing Qt types, or call C/C++ functions that are not accessible from ordinary QML code. @@ -39,17 +39,17 @@ core QML features, including properties, signals and bindings. It also shows how extensions can be deployed through plugins. You can find the source code for this tutorial in \c Qt's -examples/quick/tutorials/extending directory. +examples/qml/tutorials/extending directory. Tutorial chapters: \list 1 -\li \l{quick/tutorials/extending/chapter1-basics}{Creating a New Type} -\li \l{quick/tutorials/extending/chapter2-methods}{Connecting to C++ Methods and Signals} -\li \l{quick/tutorials/extending/chapter3-bindings}{Property Binding} -\li \l{quick/tutorials/extending/chapter4-customPropertyTypes}{Using Custom Property Types} -\li \l{quick/tutorials/extending/chapter5-listproperties}{Using List Property Types} -\li \l{quick/tutorials/extending/chapter6-plugins}{Writing an Extension Plugin} +\li \l{tutorials/extending/chapter1-basics}{Creating a New Type} +\li \l{tutorials/extending/chapter2-methods}{Connecting to C++ Methods and Signals} +\li \l{tutorials/extending/chapter3-bindings}{Property Binding} +\li \l{tutorials/extending/chapter4-customPropertyTypes}{Using Custom Property Types} +\li \l{tutorials/extending/chapter5-listproperties}{Using List Property Types} +\li \l{tutorials/extending/chapter6-plugins}{Writing an Extension Plugin} \li \l{qml-extending-tutorial7.html}{In Summary} \endlist @@ -104,7 +104,7 @@ this new class must: Here is our \c PieChart class, defined in \c piechart.h: -\snippet quick/tutorials/extending/chapter1-basics/piechart.h 0 +\snippet tutorials/extending/chapter1-basics/piechart.h 0 The class inherits from QQuickPaintedItem because we want to override QQuickPaintedItem::paint() in perform drawing operations with the QPainter API. @@ -120,15 +120,15 @@ simply sets and returns the \c m_name and \c m_color values as appropriate, and implements \c paint() to draw a simple pie chart. It also turns off the QGraphicsItem::ItemHasNoContents flag to enable painting: -\snippet quick/tutorials/extending/chapter1-basics/piechart.cpp 0 +\snippet tutorials/extending/chapter1-basics/piechart.cpp 0 \dots 0 -\snippet quick/tutorials/extending/chapter1-basics/piechart.cpp 1 +\snippet tutorials/extending/chapter1-basics/piechart.cpp 1 Now that we have defined the \c PieChart type, we will use it from QML. The \c app.qml file creates a \c PieChart item and display the pie chart's details using a standard QML \l Text item: -\snippet quick/tutorials/extending/chapter1-basics/app.qml 0 +\snippet tutorials/extending/chapter1-basics/app.qml 0 Notice that although the color is specified as a string in QML, it is automatically converted to a QColor object for the PieChart \c color property. Automatic conversions are @@ -142,20 +142,20 @@ you don't register the type, \c app.qml won't be able to create a \c PieChart. Here is the application \c main.cpp: -\snippet quick/tutorials/extending/chapter1-basics/main.cpp 0 +\snippet tutorials/extending/chapter1-basics/main.cpp 0 This call to qmlRegisterType() registers the \c PieChart type as a type called "PieChart", in a type namespace called "Charts", with a version of 1.0. Lastly, we write a \c .pro project file that includes the files and the \c declarative library: -\quotefile quick/tutorials/extending/chapter1-basics/chapter1-basics.pro +\quotefile tutorials/extending/chapter1-basics/chapter1-basics.pro Now we can build and run the application: \image extending-tutorial-chapter1.png -Try it yourself with the code in Qt's \c examples/quick/tutorials/extending/chapter1-basics directory. +Try it yourself with the code in Qt's \c examples/qml/tutorials/extending/chapter1-basics directory. */ @@ -168,20 +168,20 @@ Suppose we want \c PieChart to have a "clearChart()" method that erases the chart and then emits a "chartCleared" signal. Our \c app.qml would be able to call \c clearChart() and receive \c chartCleared() signals like this: -\snippet quick/tutorials/extending/chapter2-methods/app.qml 0 +\snippet tutorials/extending/chapter2-methods/app.qml 0 \image extending-tutorial-chapter2.png To do this, we add a \c clearChart() method and a \c chartCleared() signal to our C++ class: -\snippet quick/tutorials/extending/chapter2-methods/piechart.h 0 +\snippet tutorials/extending/chapter2-methods/piechart.h 0 \dots -\snippet quick/tutorials/extending/chapter2-methods/piechart.h 1 +\snippet tutorials/extending/chapter2-methods/piechart.h 1 \dots -\snippet quick/tutorials/extending/chapter2-methods/piechart.h 2 +\snippet tutorials/extending/chapter2-methods/piechart.h 2 \dots -\snippet quick/tutorials/extending/chapter2-methods/piechart.h 3 +\snippet tutorials/extending/chapter2-methods/piechart.h 3 The use of Q_INVOKABLE makes the \c clearChart() method available to the Qt Meta-Object system, and in turn, to QML. Note that it could have @@ -191,7 +191,7 @@ slots are also callable from QML. Both of these approaches are valid. The \c clearChart() method simply changes the color to Qt::transparent, repaints the chart, then emits the \c chartCleared() signal: -\snippet quick/tutorials/extending/chapter2-methods/piechart.cpp 0 +\snippet tutorials/extending/chapter2-methods/piechart.cpp 0 Now when we run the application and click the window, the pie chart disappears, and the application outputs: @@ -200,7 +200,7 @@ disappears, and the application outputs: The chart has been cleared \endcode -Try out the example yourself with the updated code in Qt's \c examples/quick/tutorials/extending/chapter2-methods directory. +Try out the example yourself with the updated code in Qt's \c examples/qml/tutorials/extending/chapter2-methods directory. */ @@ -216,7 +216,7 @@ other types' values when property values are changed. Let's enable property bindings for the \c color property. That means if we have code like this: -\snippet quick/tutorials/extending/chapter3-bindings/app.qml 0 +\snippet tutorials/extending/chapter3-bindings/app.qml 0 \image extending-tutorial-chapter3.png @@ -231,17 +231,17 @@ It's easy to enable property binding for the \c color property. We add a \l{Qt's Property System}{NOTIFY} feature to its Q_PROPERTY() declaration to indicate that a "colorChanged" signal is emitted whenever the value changes. -\snippet quick/tutorials/extending/chapter3-bindings/piechart.h 0 +\snippet tutorials/extending/chapter3-bindings/piechart.h 0 \dots -\snippet quick/tutorials/extending/chapter3-bindings/piechart.h 1 +\snippet tutorials/extending/chapter3-bindings/piechart.h 1 \dots -\snippet quick/tutorials/extending/chapter3-bindings/piechart.h 2 +\snippet tutorials/extending/chapter3-bindings/piechart.h 2 \dots -\snippet quick/tutorials/extending/chapter3-bindings/piechart.h 3 +\snippet tutorials/extending/chapter3-bindings/piechart.h 3 Then, we emit this signal in \c setPieSlice(): -\snippet quick/tutorials/extending/chapter3-bindings/piechart.cpp 0 +\snippet tutorials/extending/chapter3-bindings/piechart.cpp 0 It's important for \c setColor() to check that the color value has actually changed before emitting \c colorChanged(). This ensures the signal is not emitted unnecessarily and @@ -299,43 +299,43 @@ For example, let's replace the use of the \c property with a type called "PieSlice" that has a \c color property. Instead of assigning a color, we assign an \c PieSlice value which itself contains a \c color: -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/app.qml 0 +\snippet tutorials/extending/chapter4-customPropertyTypes/app.qml 0 Like \c PieChart, this new \c PieSlice type inherits from QQuickPaintedItem and declares its properties with Q_PROPERTY(): -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/pieslice.h 0 +\snippet tutorials/extending/chapter4-customPropertyTypes/pieslice.h 0 To use it in \c PieChart, we modify the \c color property declaration and associated method signatures: -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/piechart.h 0 +\snippet tutorials/extending/chapter4-customPropertyTypes/piechart.h 0 \dots -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/piechart.h 1 +\snippet tutorials/extending/chapter4-customPropertyTypes/piechart.h 1 \dots -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/piechart.h 2 +\snippet tutorials/extending/chapter4-customPropertyTypes/piechart.h 2 \dots -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/piechart.h 3 +\snippet tutorials/extending/chapter4-customPropertyTypes/piechart.h 3 There is one thing to be aware of when implementing \c setPieSlice(). The \c PieSlice is a visual item, so it must be set as a child of the \c PieChart using QQuickItem::setParentItem() so that the \c PieChart knows to paint this child item when its contents are drawn: -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/piechart.cpp 0 +\snippet tutorials/extending/chapter4-customPropertyTypes/piechart.cpp 0 Like the \c PieChart type, the \c PieSlice type has to be registered using qmlRegisterType() to be used from QML. As with \c PieChart, we'll add the type to the "Charts" type namespace, version 1.0: -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/main.cpp 0 +\snippet tutorials/extending/chapter4-customPropertyTypes/main.cpp 0 \dots -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/main.cpp 1 +\snippet tutorials/extending/chapter4-customPropertyTypes/main.cpp 1 \dots -\snippet quick/tutorials/extending/chapter4-customPropertyTypes/main.cpp 2 +\snippet tutorials/extending/chapter4-customPropertyTypes/main.cpp 2 -Try it out with the code in Qt's \c examples/quick/tutorials/extending/chapter4-customPropertyTypes directory. +Try it out with the code in Qt's \c examples/qml/tutorials/extending/chapter4-customPropertyTypes directory. */ @@ -349,7 +349,7 @@ Right now, a \c PieChart can only have one \c PieSlice. Ideally a chart would have multiple slices, with different colors and sizes. To do this, we could have a \c slices property that accepts a list of \c PieSlice items: -\snippet quick/tutorials/extending/chapter5-listproperties/app.qml 0 +\snippet tutorials/extending/chapter5-listproperties/app.qml 0 \image extending-tutorial-chapter5.png @@ -360,11 +360,11 @@ function with a \c slices() function that returns a list of slices, and add an internal \c append_slice() function (discussed below). We also use a QList to store the internal list of slices as \c m_slices: -\snippet quick/tutorials/extending/chapter5-listproperties/piechart.h 0 +\snippet tutorials/extending/chapter5-listproperties/piechart.h 0 \dots -\snippet quick/tutorials/extending/chapter5-listproperties/piechart.h 1 +\snippet tutorials/extending/chapter5-listproperties/piechart.h 1 \dots -\snippet quick/tutorials/extending/chapter5-listproperties/piechart.h 2 +\snippet tutorials/extending/chapter5-listproperties/piechart.h 2 Although the \c slices property does not have an associated \c WRITE function, it is still modifiable because of the way QQmlListProperty works. @@ -373,7 +373,7 @@ return a QQmlListProperty value and indicate that the internal \c PieChart::append_slice() function is to be called whenever a request is made from QML to add items to the list: -\snippet quick/tutorials/extending/chapter5-listproperties/piechart.cpp 0 +\snippet tutorials/extending/chapter5-listproperties/piechart.cpp 0 The \c append_slice() function simply sets the parent item as before, and adds the new item to the \c m_slices list. As you can see, the append function for a @@ -384,7 +384,7 @@ The \c PieSlice class has also been modified to include \c fromAngle and \c angl properties and to draw the slice according to these values. This is a straightforward modification if you have read the previous pages in this tutorial, so the code is not shown here. -The complete code can be seen in the updated \c examples/quick/tutorials/extending/chapter5-listproperties directory. +The complete code can be seen in the updated \c examples/qml/tutorials/extending/chapter5-listproperties directory. */ @@ -407,22 +407,22 @@ and registers our QML types in the inherited \l{QQmlExtensionPlugin::}{registerT Here is the \c ChartsPlugin definition in \c chartsplugin.h: -\snippet quick/tutorials/extending/chapter6-plugins/chartsplugin.h 0 +\snippet tutorials/extending/chapter6-plugins/chartsplugin.h 0 And its implementation in \c chartsplugin.cpp: -\snippet quick/tutorials/extending/chapter6-plugins/chartsplugin.cpp 0 +\snippet tutorials/extending/chapter6-plugins/chartsplugin.cpp 0 Then, we write a \c .pro project file that defines the project as a plugin library and specifies with DESTDIR that library files should be built into a "lib" subdirectory: -\quotefile quick/tutorials/extending/chapter6-plugins/chapter6-plugins.pro +\quotefile tutorials/extending/chapter6-plugins/chapter6-plugins.pro Finally, we add a \l{qtqml-modules-qmldir.html}{qmldir} file that is parsed by the QML engine. In this file, we specify that a plugin named "chapter6-plugin" (the name of the example project) can be found in the "lib" subdirectory: -\quotefile quick/tutorials/extending/chapter6-plugins/Charts/qmldir +\quotefile tutorials/extending/chapter6-plugins/Charts/qmldir Now we have a plugin, and instead of having a main.cpp and an executable, we can build the project and then load the QML file using the \l{Prototyping with qmlscene}{qmlscene tool}, diff --git a/src/qml/doc/src/cppintegration/topic.qdoc b/src/qml/doc/src/cppintegration/topic.qdoc index 48f430c919..4d12ab9d08 100644 --- a/src/qml/doc/src/cppintegration/topic.qdoc +++ b/src/qml/doc/src/cppintegration/topic.qdoc @@ -29,7 +29,7 @@ \title Integrating QML and C++ \brief Description of how to integrate QML and C++ code -QML is designed to be easily extensible through C++ code. The classes in the QtQml C++ module +QML is designed to be easily extensible through C++ code. The classes in the \l {Qt QML} module enables QML objects to be loaded and manipulated from C++, and the nature of QML engine's integration with Qt's \l{Meta Object System}{meta object system} enables C++ functionality to be invoked directly from QML. This allows the development of hybrid applications which are implemented @@ -43,7 +43,7 @@ with QML and JavaScript within \l{qtqml-documents-topic.html}{QML documents}, an C++ \li Use and invoke some C++ functionality from QML (for example, to invoke your application logic, use a data model implemented in C++, or call some functions in a third-party C++ library) -\li Access functionality in the QtQml or QtQuick C++ API (for example, to dynamically generate +\li Access functionality in the \l {Qt QML} or \l {Qt Quick} C++ API (for example, to dynamically generate images using QQuickImageProvider) \li Implement your own \l{qtqml-typesystem-objecttypes.html}{QML object types} from C++ \unicode{0x2014} whether for use within your own specific application, or for distribution to others @@ -71,7 +71,7 @@ methods and signals to be accessed from QML These are the most common methods of accessing C++ functionality from QML code; for more options and details, see the main documentation pages that are described in the sections further below. -Additionally, aside from the ability to access C++ functionality from QML, the Qt QML module also +Additionally, aside from the ability to access C++ functionality from QML, the \l {Qt QML} module also provides ways to do the reverse and manipulate QML objects from C++ code. See \l{qtqml-cppintegration-interactqmlfromcpp.html}{Interacting with QML Objects from C++} for more details. @@ -104,7 +104,7 @@ registered for other purposes: for example, it could be registered as a \e {Sing single class instance to be imported by QML code, or it could be registered to enable the enumeration values of a non-instantiable class to be accessible from QML. -Additionally, the QtQml module provides mechanisms to define QML types that integrate with QML +Additionally, the \l {Qt QML} module provides mechanisms to define QML types that integrate with QML concepts like attached properties and default properties. For more information on registering and creating custom QML types from C++, see the \l @@ -115,7 +115,7 @@ For more information on registering and creating custom QML types from C++, see C++ objects and values can be embedded directly into the context (or \e scope) of loaded QML objects using \e {context properties} and \e {context objects}. This is achieved through the QQmlContext -class provided by the QtQml module, which exposes data to the context of a QML component, allowing +class provided by the \l {Qt QML} module, which exposes data to the context of a QML component, allowing data to be injected from C++ into QML. See \l{qtqml-cppintegration-contextproperties.html}{Embedding C++ Objects into QML with Context |