summaryrefslogtreecommitdiff
path: root/src/ivicore
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2020-10-21 15:15:30 +0200
committerDominik Holland <dominik.holland@qt.io>2020-12-15 13:46:01 +0100
commitcfda2bbf9ab209da0a924ff840c41612329cd91b (patch)
treeca2fc7e439c791f291c4027f5f3b7a4635b8e1d2 /src/ivicore
parentb93f8aba16a4294c4848412fb7718038a2c36f67 (diff)
downloadqtivi-cfda2bbf9ab209da0a924ff840c41612329cd91b.tar.gz
ivigenerator: Generate metainfo files for usage in Design Studio
For all generated interfaces we now also generate a metainfo file. This file is read by Qt Design Studio and makes it possible to work with the autogenerated interfaces there and connect to the provided properties. Change-Id: Ie088972e903cc6b7248db41e565eef66956939f2 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
Diffstat (limited to 'src/ivicore')
-rw-r--r--src/ivicore/doc/src/ivigenerator/generator-usage.qdoc33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
index 7d870d9..30513e0 100644
--- a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
@@ -263,6 +263,39 @@
the name which is used to export the interface to QML. For modules, it defines the
URI of the complete module. The last part of the URI is also used for the singleton
that exports all enums to QML.
+ \row
+ \li \code
+ @designer: {categoryName: "QtIvi - Vehicle Functions"}
+ \endcode
+ \li Main IDL file
+ \li Module, Interface
+ \li Defines the category name this interface should be listed under in the Qt Design Studio
+ Library. When defined for a module it sets the category name for all interfaces inside
+ that module, but it can be overridden per interface by defining it there as well.
+ \row
+ \li \code
+ @designer: {name: "Climate Control"}
+ \endcode
+ \li Main IDL file
+ \li Interface
+ \li Defines the name this interface should be listed under in the Qt Design Studio
+ Library.
+ \row
+ \li \code
+ @designer: {typeIcon: "images/climate.png"}
+ \endcode
+ \li Main IDL file
+ \li Interface
+ \li The typeIcon is a 16x16 icon used in the Navigator Pane within Qt Design Studio.
+ \note The icon needs to copied to the correct folder by a custom qmake rule.
+ \row
+ \li \code
+ @designer: {libraryIcon: "images/climate.png"}
+ \endcode
+ \li Main IDL file
+ \li Interface
+ \li The libraryIcon is shown in the Library within Qt Design Studio.
+ \note The icon needs to copied to the correct folder by a custom qmake rule.
\endtable
Annotations that are not logically part of the interface description, but rather the ones used