diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2023-01-09 10:40:17 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-01-09 15:13:24 +0000 |
| commit | aed604fcefa1d987162bba0699f7bf25c42e4ae9 (patch) | |
| tree | 0fbfcad0f3e4214a7ffb1bc985fb31f8d2a9aa0c | |
| parent | 835a10ebfb2a65bfe73b81a617bd6012db9a26b5 (diff) | |
Documentation: Add note stating that QApplication is required for the QML types
Task-number: PYSIDE-2179
Change-Id: I5c6055ef896d18ecc38feba082608beb5240dae1
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
(cherry picked from commit d3ee83e905c656cc85e34c166da59e7957dbdfa4)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/charts/doc/src/index.qdoc | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/charts/doc/src/index.qdoc b/src/charts/doc/src/index.qdoc index f6e888e0..7f64fe27 100644 --- a/src/charts/doc/src/index.qdoc +++ b/src/charts/doc/src/index.qdoc @@ -17,6 +17,13 @@ \include {module-use.qdocinc} {using the qml api} {QtCharts} + \note An instance of QApplication is required for the QML types as the module + depends on Qt's \l{Graphics View Framework} for rendering. QGuiApplication + is not sufficient. However, projects created with Qt Creator's + Qt Quick Application wizard are based on the Qt Quick template that + uses QGuiApplication by default. All the QGuiApplication instances + in such projects must be replaced with QApplication. + \section2 C++ API \include {module-use.qdocinc} {using the c++ api} @@ -29,12 +36,6 @@ \include {module-use.qdocinc} {building_with_qmake} {charts} - \note Projects created with Qt Creator's Qt Quick Application - wizard are based on the Qt Quick 2 template that uses QGuiApplication by default. - All such QGuiApplication instances in the project must be replaced with - QApplication as the module depends on Qt's \l{Graphics View Framework} - for rendering. - \section1 Module Evolution \l{Changes to Qt Charts} lists important changes in the module API and functionality that were done for the Qt 6 series of Qt. |