summaryrefslogtreecommitdiff
path: root/src/ivicore/doc
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@pelagicore.com>2019-03-21 13:33:35 +0100
committerDominik Holland <dominik.holland@pelagicore.com>2019-04-01 16:17:10 +0000
commitfdb9b87a029e8b32b424a9957d0c04e5f7eb8352 (patch)
tree3909af878619052be0f2e6fcebe4b809d95183fe /src/ivicore/doc
parentf550b2304355ac024d8816a3baa5d6336749aee7 (diff)
downloadqtivi-fdb9b87a029e8b32b424a9957d0c04e5f7eb8352.tar.gz
Remove the QtSimulator integration
This removes the QtSimulator code in the autogenerated simulator backends and the control_panel template. The simulation can now be scripted using the QIviSimulationEngine. Change-Id: I40330e9454f700278cbf6ac960f602385642b524 Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
Diffstat (limited to 'src/ivicore/doc')
-rw-r--r--src/ivicore/doc/qtivi-project.qdocconf2
-rw-r--r--src/ivicore/doc/src/configuration.qdoc9
-rw-r--r--src/ivicore/doc/src/ivigenerator/generator-usage.qdoc52
3 files changed, 1 insertions, 62 deletions
diff --git a/src/ivicore/doc/qtivi-project.qdocconf b/src/ivicore/doc/qtivi-project.qdocconf
index b8703d7..860e836 100644
--- a/src/ivicore/doc/qtivi-project.qdocconf
+++ b/src/ivicore/doc/qtivi-project.qdocconf
@@ -60,7 +60,7 @@ qhp.QtIvi.subprojects.examples.sortPages = true
tagfile = qtivi.tags
-depends += qtcore qtwidgets qtdoc qtquick qtqml qtautomotivesuite qtsimulator qtremoteobjects
+depends += qtcore qtwidgets qtdoc qtquick qtqml qtautomotivesuite qtremoteobjects
navigation.homepage = "Qt Automotive Suite"
navigation.landingpage = "Qt IVI"
diff --git a/src/ivicore/doc/src/configuration.qdoc b/src/ivicore/doc/src/configuration.qdoc
index f8cbad1..b6cdab2 100644
--- a/src/ivicore/doc/src/configuration.qdoc
+++ b/src/ivicore/doc/src/configuration.qdoc
@@ -50,15 +50,6 @@ summary".
\li The IVI Generator provides tooling to generate source code out of IDL files. The IVI
Generator comes with a set of templates for specific generation use-cases.
\row
- \li QtSimulator Support
- \keyword feature-qtsimulator
- \li QtSimulator module
- \li The QtSimulator Support is needed for the communication between the simulation backends and
- their control panel (controller). It enhances the built-in templates by also generating
- the needed code for the simulation backends to communicate over QtSimulator. In addition,
- it also provides a new template to generate a controller application to communicate with
- the simulation backend.
-\row
\li QtRemoteObjects Support
\keyword feature-qtremoteobjects
\li QtRemoteObjects module
diff --git a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
index 9588006..ca72f14 100644
--- a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
+++ b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc
@@ -63,7 +63,6 @@ The options and parameters are:
\list
\li \c frontend
\li \c backend_simulator
- \li \c control_panel
\li \c backend_qtro
\li \c server_qtro
\li \c <folder>
@@ -101,11 +100,6 @@ of projects with a given IDL file:
\li Generates a simulation backend for the API first generated by the \c frontend option. This
backend serves as a mock implementation.
\row
- \li \l {Control Panel} {control_panel}
- \target control-panel-template
- \li Generates a controller application, consisting of a UI and a C++ plugin, that communicate
- with the simulation backend generated from the same QFace file using QtSimulator.
- \row
\li \l {QtRemoteObjects Backend} {backend_qtro}
\target backend-qtro-template
\li Generates a QtRemoteObjects based backend client for the API first generated by the
@@ -411,52 +405,6 @@ QML files.
\li Interface-specific QML simulation files.
\endtable
-\section2 Control Panel
-
-The control_panel template is only available if the QtSimulator module was found. Please see the
-\l{feature-qtsimulator}{Configuration Page} for more information.
-
-\note Currently the control_panel template doesn't support all qface features. At the moment models
-and structs are NOT supported.
-
-\table
- \header
- \li File name
- \li Purpose
- \row
- \li "main.cpp"
- \li Launcher code loading the QML code and exporting the C++ interface.
- \row
- \li "main.qml"
- \li Main QML file containing the code to load the Control UIs for every interface.
- \row
- \li "qml.qrc"
- \li QRC file for all QML code.
- \row
- \li "FlagControl.qml"
- \li UI Element to control a flag inside a interface.
- \row
- \li "EnumControl.qml"
- \li UI Element to control a enum inside a interface.
- \row
- \li "{{module|lower|replace('.', '-')}}.pri"
- \li A standard Qt \c{.pri} file that contains all the generated files. Use this \c{.pri}
- file to include the generated files into a qmake project.
- \row
- \li "{{module.module_name|lower}}global.h"
- \li Standard file with global EXPORT defines.
- \row
- \li "{{module.module_name|lower}}module.h/cpp"
- \li Files defining a module class used for module global variables and types.
- \row
- \li "{{interface|lower}}.h/cpp"
- \li C++ code retrieving and forwarding the state using QtSimulator.
- \row
- \li "{{module.module_name|lower}}ControlUi.qml"
- \li Control UI for this interface. Contains a interface to control every
- property and method and log calls to signals.
-\endtable
-
\section2 QtRemoteObjects Backend
The backend_qtro template is only available if the QtRemoteObjects module was found. Despite the