feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Document QML_IMPORT_PATH and QML_DESIGNER_IMPORT_PATH

Browse Source 
QML_IMPORT_PATH has never been officially documented and
QML_DESIGNER_IMPORT_PATH was added recently.

Change-Id: I932445404a185286d8f03077df492a34db9b0ea6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Thomas Hartmann
2016-10-25 09:51:39 +02:00
committed by Tim Jenssen
parent 2a3cb8d7cb
commit 6dec313692
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/qtquick/qtquick-modules-with-plugins.qdoc
View File

@@ -55,6 +55,11 @@
Classes registered with \c qmlRegisterType() can be used as backend objects Classes registered with \c qmlRegisterType() can be used as backend objects
in the \QMLD. For more information, see \l {Adding Connections}. in the \QMLD. For more information, see \l {Adding Connections}.
By default, \QC will look in the QML import path of Qt for QML modules.
If your applications adds additional import paths that \QC should use,
then you can specify those using \c{QML_IMPORT_PATH} in the \c{.pro} file of your
application.
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
@@ -117,4 +122,9 @@
environment variable to check whether the plugin is currently being run environment variable to check whether the plugin is currently being run
by an application or edited in the \uicontrol Design mode. by an application or edited in the \uicontrol Design mode.
If you want to use a different module in \QMLD than in your actual
application for example to mockup C++ items, then you can use \c{QML_DESIGNER_IMPORT_PATH}
in the \c{.pro} file.
Modules in the import paths defined in \c{QML_DESIGNER_IMPORT_PATH} will be used only in \QMLD.
*/ */