summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2021-09-16 16:00:07 +0200
committerDominik Holland <dominik.holland@qt.io>2021-09-22 13:51:56 +0200
commitfe874d5625c324e76f2beccb16b8036498c26165 (patch)
tree6c832a2f4b42fd0b0bc4f94b53f3f3087f4c90fa
parent69377143cc5fab6cf68c892305252ef00c0a6d05 (diff)
Refactor examples and its documentation
* Remove -if- in example names * Replace _ in example names with - * Move all related docs and images to the example folder Pick-to: 6.2 Change-Id: I1fe38c7d4d735c48224c8bdf8622c701ab056070 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
-rw-r--r--examples/ifmedia/mediaplayer/doc/images/mediaplayer.png (renamed from src/ifmedia/doc/images/examples_mediaplayer.png)bin61704 -> 61704 bytes
-rw-r--r--examples/ifmedia/mediaplayer/doc/src/mediaplayer.qdoc (renamed from src/ifmedia/doc/src/examples-mediaplayer.qdoc)2
-rw-r--r--examples/ifmedia/tuner/doc/images/tuner.png (renamed from src/ifmedia/doc/images/examples_tuner.png)bin34382 -> 34382 bytes
-rw-r--r--examples/ifmedia/tuner/doc/src/tuner.qdoc (renamed from src/ifmedia/doc/src/examples-tuner.qdoc)2
-rw-r--r--examples/ifvehiclefunctions/CMakeLists.txt6
-rw-r--r--examples/ifvehiclefunctions/climate-qml/CMakeLists.txt (renamed from examples/ifvehiclefunctions/climate_qml/CMakeLists.txt)0
-rw-r--r--examples/ifvehiclefunctions/climate-qml/climate-qml.pro (renamed from examples/ifvehiclefunctions/climate_qml/climate_qml.pro)0
-rw-r--r--examples/ifvehiclefunctions/climate-qml/doc/images/climate-qml.png (renamed from src/ifvehiclefunctions/doc/images/examples_climate_qml.png)bin16135 -> 16135 bytes
-rw-r--r--examples/ifvehiclefunctions/climate-qml/doc/src/climate-qml.qdoc (renamed from src/ifvehiclefunctions/doc/src/examples-climate_qml.qdoc)12
-rw-r--r--examples/ifvehiclefunctions/climate-qml/main.cpp (renamed from examples/ifvehiclefunctions/climate_qml/main.cpp)0
-rw-r--r--examples/ifvehiclefunctions/climate-qml/main.qml (renamed from examples/ifvehiclefunctions/climate_qml/main.qml)0
-rw-r--r--examples/ifvehiclefunctions/climate-qml/qml.qrc (renamed from examples/ifvehiclefunctions/climate_qml/qml.qrc)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/CMakeLists.txt (renamed from examples/ifvehiclefunctions/climate_widget/CMakeLists.txt)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/climate-widget.pro (renamed from examples/ifvehiclefunctions/climate_widget/climate_widget.pro)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/doc/images/climate-widget.png (renamed from src/ifvehiclefunctions/doc/images/examples_climate_widget.png)bin10433 -> 10433 bytes
-rw-r--r--examples/ifvehiclefunctions/climate-widget/doc/src/climate-widget.qdoc (renamed from src/ifvehiclefunctions/doc/src/examples-climate_widget.qdoc)10
-rw-r--r--examples/ifvehiclefunctions/climate-widget/main.cpp (renamed from examples/ifvehiclefunctions/climate_widget/main.cpp)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/mainwindow.cpp (renamed from examples/ifvehiclefunctions/climate_widget/mainwindow.cpp)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/mainwindow.h (renamed from examples/ifvehiclefunctions/climate_widget/mainwindow.h)0
-rw-r--r--examples/ifvehiclefunctions/climate-widget/mainwindow.ui (renamed from examples/ifvehiclefunctions/climate_widget/mainwindow.ui)0
-rw-r--r--examples/ifvehiclefunctions/ifvehiclefunctions.pro6
-rw-r--r--examples/ifvehiclefunctions/window-qml/CMakeLists.txt (renamed from examples/ifvehiclefunctions/window_qml/CMakeLists.txt)0
-rw-r--r--examples/ifvehiclefunctions/window-qml/WindowItem.qml (renamed from examples/ifvehiclefunctions/window_qml/WindowItem.qml)0
-rw-r--r--examples/ifvehiclefunctions/window-qml/main.cpp (renamed from examples/ifvehiclefunctions/window_qml/main.cpp)0
-rw-r--r--examples/ifvehiclefunctions/window-qml/main.qml (renamed from examples/ifvehiclefunctions/window_qml/main.qml)0
-rw-r--r--examples/ifvehiclefunctions/window-qml/qml.qrc (renamed from examples/ifvehiclefunctions/window_qml/qml.qrc)0
-rw-r--r--examples/ifvehiclefunctions/window-qml/window-qml.pro (renamed from examples/ifvehiclefunctions/window_qml/window_qml.pro)0
-rw-r--r--examples/interfaceframework/CMakeLists.txt6
-rw-r--r--examples/interfaceframework/interfaceframework.pro6
-rw-r--r--examples/interfaceframework/qface-addressbook/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-addressbook/CMakeLists.txt)1
-rw-r--r--examples/interfaceframework/qface-addressbook/backend_simulator/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-addressbook/backend_simulator/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-addressbook/backend_simulator/backend_simulator.pro (renamed from examples/interfaceframework/qface-if-addressbook/backend_simulator/backend_simulator.pro)4
-rw-r--r--examples/interfaceframework/qface-addressbook/backend_simulator/plugin_resource.qrc (renamed from examples/interfaceframework/qface-if-addressbook/backend_simulator/plugin_resource.qrc)0
-rw-r--r--examples/interfaceframework/qface-addressbook/backend_simulator/simulation.qml (renamed from examples/interfaceframework/qface-if-addressbook/backend_simulator/simulation.qml)0
-rw-r--r--examples/interfaceframework/qface-addressbook/demo/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-addressbook/demo/CMakeLists.txt)16
-rw-r--r--examples/interfaceframework/qface-addressbook/demo/demo.pro (renamed from examples/interfaceframework/qface-if-addressbook/demo/demo.pro)4
-rw-r--r--examples/interfaceframework/qface-addressbook/demo/main.cpp (renamed from examples/interfaceframework/qface-if-addressbook/demo/main.cpp)0
-rw-r--r--examples/interfaceframework/qface-addressbook/demo/main.qml (renamed from examples/interfaceframework/qface-if-addressbook/demo/main.qml)0
-rw-r--r--examples/interfaceframework/qface-addressbook/demo/qml.qrc (renamed from examples/interfaceframework/qface-if-addressbook/demo/qml.qrc)0
-rw-r--r--examples/interfaceframework/qface-addressbook/doc/images/qface-addressbook.png (renamed from src/interfaceframework/doc/images/examples_qface_if_addressbook.png)bin14331 -> 14331 bytes
-rw-r--r--examples/interfaceframework/qface-addressbook/doc/src/qface-addressbook.qdoc (renamed from src/interfaceframework/doc/src/examples-qface-if-addressbook.qdoc)20
-rw-r--r--examples/interfaceframework/qface-addressbook/example-addressbook.qface (renamed from examples/interfaceframework/qface-if-addressbook/example-if-addressbook.qface)0
-rw-r--r--examples/interfaceframework/qface-addressbook/example-addressbook.yaml (renamed from examples/interfaceframework/qface-if-addressbook/example-if-addressbook.yaml)0
-rw-r--r--examples/interfaceframework/qface-addressbook/frontend/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-addressbook/frontend/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-addressbook/frontend/frontend.pro (renamed from examples/interfaceframework/qface-if-addressbook/frontend/frontend.pro)4
-rw-r--r--examples/interfaceframework/qface-addressbook/qface-addressbook.pro (renamed from examples/interfaceframework/qface-if-addressbook/qface-if-addressbook.pro)4
-rw-r--r--examples/interfaceframework/qface-climate/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-climate/CMakeLists.txt)1
-rw-r--r--examples/interfaceframework/qface-climate/backend_simulator/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-climate/backend_simulator/backend_simulator.pro (renamed from examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro)4
-rw-r--r--examples/interfaceframework/qface-climate/demo/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-climate/demo/CMakeLists.txt)16
-rw-r--r--examples/interfaceframework/qface-climate/demo/demo.pro (renamed from examples/interfaceframework/qface-if-climate/demo/demo.pro)4
-rw-r--r--examples/interfaceframework/qface-climate/demo/main.cpp (renamed from examples/interfaceframework/qface-if-climate/demo/main.cpp)0
-rw-r--r--examples/interfaceframework/qface-climate/demo/main.qml (renamed from examples/interfaceframework/qface-if-climate/demo/main.qml)0
-rw-r--r--examples/interfaceframework/qface-climate/demo/qml.qrc (renamed from examples/interfaceframework/qface-if-climate/demo/qml.qrc)0
-rw-r--r--examples/interfaceframework/qface-climate/doc/images/qface-climate.png (renamed from src/interfaceframework/doc/images/examples_qface_if_climate.png)bin39319 -> 39319 bytes
-rw-r--r--examples/interfaceframework/qface-climate/doc/src/qface-climate.qdoc (renamed from src/interfaceframework/doc/src/examples-qface-if-climate.qdoc)28
-rw-r--r--examples/interfaceframework/qface-climate/example-climate.qface (renamed from examples/interfaceframework/qface-if-climate/example-if-climate.qface)0
-rw-r--r--examples/interfaceframework/qface-climate/example-climate.yaml (renamed from examples/interfaceframework/qface-if-climate/example-if-climate.yaml)0
-rw-r--r--examples/interfaceframework/qface-climate/frontend/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-climate/frontend/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-climate/frontend/frontend.pro (renamed from examples/interfaceframework/qface-if-climate/frontend/frontend.pro)4
-rw-r--r--examples/interfaceframework/qface-climate/qface-climate.pro (renamed from examples/interfaceframework/qface-if-climate/qface-if-climate.pro)4
-rw-r--r--examples/interfaceframework/qface-remote/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-remote/CMakeLists.txt)1
-rw-r--r--examples/interfaceframework/qface-remote/backend_qtro/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-remote/backend_qtro/backend_qtro.pro (renamed from examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro)4
-rw-r--r--examples/interfaceframework/qface-remote/demo/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-remote/demo/CMakeLists.txt)18
-rw-r--r--examples/interfaceframework/qface-remote/demo/demo.pro (renamed from examples/interfaceframework/qface-if-remote/demo/demo.pro)4
-rw-r--r--examples/interfaceframework/qface-remote/demo/main.cpp (renamed from examples/interfaceframework/qface-if-remote/demo/main.cpp)0
-rw-r--r--examples/interfaceframework/qface-remote/demo/main.qml (renamed from examples/interfaceframework/qface-if-remote/demo/main.qml)0
-rw-r--r--examples/interfaceframework/qface-remote/demo/qml.qrc (renamed from examples/interfaceframework/qface-if-remote/demo/qml.qrc)0
-rw-r--r--examples/interfaceframework/qface-remote/doc/images/qface-remote.png (renamed from src/interfaceframework/doc/images/examples_qface_if_remote.png)bin11337 -> 11337 bytes
-rw-r--r--examples/interfaceframework/qface-remote/doc/src/qface-remote.qdoc (renamed from src/interfaceframework/doc/src/examples-qface-if-remote.qdoc)46
-rw-r--r--examples/interfaceframework/qface-remote/example-remote.qface (renamed from examples/interfaceframework/qface-if-remote/example-if-remote.qface)0
-rw-r--r--examples/interfaceframework/qface-remote/frontend/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-remote/frontend/CMakeLists.txt)4
-rw-r--r--examples/interfaceframework/qface-remote/frontend/frontend.pro (renamed from examples/interfaceframework/qface-if-remote/frontend/frontend.pro)4
-rw-r--r--examples/interfaceframework/qface-remote/qface-remote.pro (renamed from examples/interfaceframework/qface-if-remote/qface-if-remote.pro)2
-rw-r--r--examples/interfaceframework/qface-remote/server_qtro/CMakeLists.txt (renamed from examples/interfaceframework/qface-if-remote/server_qtro/CMakeLists.txt)20
-rw-r--r--examples/interfaceframework/qface-remote/server_qtro/main.cpp (renamed from examples/interfaceframework/qface-if-remote/server_qtro/main.cpp)0
-rw-r--r--examples/interfaceframework/qface-remote/server_qtro/processingservice.cpp (renamed from examples/interfaceframework/qface-if-remote/server_qtro/processingservice.cpp)0
-rw-r--r--examples/interfaceframework/qface-remote/server_qtro/processingservice.h (renamed from examples/interfaceframework/qface-if-remote/server_qtro/processingservice.h)0
-rw-r--r--examples/interfaceframework/qface-remote/server_qtro/server_qtro.pro (renamed from examples/interfaceframework/qface-if-remote/server_qtro/server_qtro.pro)6
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-dbus.gif (renamed from src/interfaceframework/doc/images/examples_qface_tutorial_dbus.gif)bin343966 -> 343966 bytes
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-final.gif (renamed from src/interfaceframework/doc/images/examples_qface_tutorial_final.gif)bin395076 -> 395076 bytes
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-sync.gif (renamed from src/interfaceframework/doc/images/examples_qface_tutorial_sync.gif)bin636529 -> 636529 bytes
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-unsync.gif (renamed from src/interfaceframework/doc/images/examples_qface_tutorial_unsync.gif)bin625820 -> 625820 bytes
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial.png (renamed from src/interfaceframework/doc/images/examples_qface_tutorial.png)bin163657 -> 163657 bytes
-rw-r--r--examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc (renamed from src/interfaceframework/doc/src/examples-qface-tutorial.qdoc)10
-rw-r--r--src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc2
87 files changed, 151 insertions, 154 deletions
diff --git a/src/ifmedia/doc/images/examples_mediaplayer.png b/examples/ifmedia/mediaplayer/doc/images/mediaplayer.png
index 94bb56a9..94bb56a9 100644
--- a/src/ifmedia/doc/images/examples_mediaplayer.png
+++ b/examples/ifmedia/mediaplayer/doc/images/mediaplayer.png
Binary files differ
diff --git a/src/ifmedia/doc/src/examples-mediaplayer.qdoc b/examples/ifmedia/mediaplayer/doc/src/mediaplayer.qdoc
index 32d39f47..81eefa29 100644
--- a/src/ifmedia/doc/src/examples-mediaplayer.qdoc
+++ b/examples/ifmedia/mediaplayer/doc/src/mediaplayer.qdoc
@@ -56,5 +56,5 @@
\ingroup qtifmedia-examples
\brief The Example shows how to use the MediaPlayer API from QML.
- \image examples_mediaplayer.png
+ \image mediaplayer.png
*/
diff --git a/src/ifmedia/doc/images/examples_tuner.png b/examples/ifmedia/tuner/doc/images/tuner.png
index 3caf925e..3caf925e 100644
--- a/src/ifmedia/doc/images/examples_tuner.png
+++ b/examples/ifmedia/tuner/doc/images/tuner.png
Binary files differ
diff --git a/src/ifmedia/doc/src/examples-tuner.qdoc b/examples/ifmedia/tuner/doc/src/tuner.qdoc
index 103660ad..809e26a2 100644
--- a/src/ifmedia/doc/src/examples-tuner.qdoc
+++ b/examples/ifmedia/tuner/doc/src/tuner.qdoc
@@ -56,7 +56,7 @@
\ingroup qtifmedia-examples
\brief This Example shows how to use the Tuner API from QML.
- \image examples_tuner.png
+ \image tuner.png
This Example shows how to use the Tuner API from QML.
diff --git a/examples/ifvehiclefunctions/CMakeLists.txt b/examples/ifvehiclefunctions/CMakeLists.txt
index 617352cb..00a8e2e5 100644
--- a/examples/ifvehiclefunctions/CMakeLists.txt
+++ b/examples/ifvehiclefunctions/CMakeLists.txt
@@ -1,7 +1,7 @@
# Generated from ifvehiclefunctions.pro.
-add_subdirectory(climate_qml)
-add_subdirectory(window_qml)
+add_subdirectory(climate-qml)
+add_subdirectory(window-qml)
if(TARGET Qt::Widgets)
- add_subdirectory(climate_widget)
+ add_subdirectory(climate-widget)
endif()
diff --git a/examples/ifvehiclefunctions/climate_qml/CMakeLists.txt b/examples/ifvehiclefunctions/climate-qml/CMakeLists.txt
index 4bef4f24..4bef4f24 100644
--- a/examples/ifvehiclefunctions/climate_qml/CMakeLists.txt
+++ b/examples/ifvehiclefunctions/climate-qml/CMakeLists.txt
diff --git a/examples/ifvehiclefunctions/climate_qml/climate_qml.pro b/examples/ifvehiclefunctions/climate-qml/climate-qml.pro
index 8b11c109..8b11c109 100644
--- a/examples/ifvehiclefunctions/climate_qml/climate_qml.pro
+++ b/examples/ifvehiclefunctions/climate-qml/climate-qml.pro
diff --git a/src/ifvehiclefunctions/doc/images/examples_climate_qml.png b/examples/ifvehiclefunctions/climate-qml/doc/images/climate-qml.png
index c123ff3c..c123ff3c 100644
--- a/src/ifvehiclefunctions/doc/images/examples_climate_qml.png
+++ b/examples/ifvehiclefunctions/climate-qml/doc/images/climate-qml.png
Binary files differ
diff --git a/src/ifvehiclefunctions/doc/src/examples-climate_qml.qdoc b/examples/ifvehiclefunctions/climate-qml/doc/src/climate-qml.qdoc
index 2550cc35..3fbd2711 100644
--- a/src/ifvehiclefunctions/doc/src/examples-climate_qml.qdoc
+++ b/examples/ifvehiclefunctions/climate-qml/doc/src/climate-qml.qdoc
@@ -51,33 +51,33 @@
****************************************************************************/
/*!
- \example ifvehiclefunctions/climate_qml
+ \example ifvehiclefunctions/climate-qml
\title Climate Control QML Example
\ingroup qtifvehiclefunctions-examples
\brief The Example shows how to access the climate control from QML.
- \image examples_climate_qml.png
+ \image climate-qml.png
The example shows how to access the climate control from QML.
In the example, ClimateControl is created and autoDiscovery enabled.
When autoDiscovery is enabled, the module starts searching for the presence
of a plugin that implements QIfClimateControlBackendInterface.
- \snippet ifvehiclefunctions/climate_qml/main.qml 1
+ \snippet ifvehiclefunctions/climate-qml/main.qml 1
\note To simplify the deployment process, this example loads a simulation backend.
If discovery fails, a message dialog is shown:
- \snippet ifvehiclefunctions/climate_qml/main.qml 4
+ \snippet ifvehiclefunctions/climate-qml/main.qml 4
As a Climate System can support multiple climate zones, we need to
differentiate between the zones. A \e {general zone} can be used for settings
that are applied to all zones.
General ClimateControl attribute values are handled in check boxes as follows:
- \snippet ifvehiclefunctions/climate_qml/main.qml 2
+ \snippet ifvehiclefunctions/climate-qml/main.qml 2
For the zoned ClimateControl, the \l [QML] {AbstractZonedFeature::}{zoneAt}
property is used for controlling the values from the front left climate zone:
- \snippet ifvehiclefunctions/climate_qml/main.qml 3
+ \snippet ifvehiclefunctions/climate-qml/main.qml 3
*/
diff --git a/examples/ifvehiclefunctions/climate_qml/main.cpp b/examples/ifvehiclefunctions/climate-qml/main.cpp
index 0022cd0e..0022cd0e 100644
--- a/examples/ifvehiclefunctions/climate_qml/main.cpp
+++ b/examples/ifvehiclefunctions/climate-qml/main.cpp
diff --git a/examples/ifvehiclefunctions/climate_qml/main.qml b/examples/ifvehiclefunctions/climate-qml/main.qml
index 009794b9..009794b9 100644
--- a/examples/ifvehiclefunctions/climate_qml/main.qml
+++ b/examples/ifvehiclefunctions/climate-qml/main.qml
diff --git a/examples/ifvehiclefunctions/climate_qml/qml.qrc b/examples/ifvehiclefunctions/climate-qml/qml.qrc
index 5f6483ac..5f6483ac 100644
--- a/examples/ifvehiclefunctions/climate_qml/qml.qrc
+++ b/examples/ifvehiclefunctions/climate-qml/qml.qrc
diff --git a/examples/ifvehiclefunctions/climate_widget/CMakeLists.txt b/examples/ifvehiclefunctions/climate-widget/CMakeLists.txt
index fbbac0c6..fbbac0c6 100644
--- a/examples/ifvehiclefunctions/climate_widget/CMakeLists.txt
+++ b/examples/ifvehiclefunctions/climate-widget/CMakeLists.txt
diff --git a/examples/ifvehiclefunctions/climate_widget/climate_widget.pro b/examples/ifvehiclefunctions/climate-widget/climate-widget.pro
index d897dce0..d897dce0 100644
--- a/examples/ifvehiclefunctions/climate_widget/climate_widget.pro
+++ b/examples/ifvehiclefunctions/climate-widget/climate-widget.pro
diff --git a/src/ifvehiclefunctions/doc/images/examples_climate_widget.png b/examples/ifvehiclefunctions/climate-widget/doc/images/climate-widget.png
index a0dec9a5..a0dec9a5 100644
--- a/src/ifvehiclefunctions/doc/images/examples_climate_widget.png
+++ b/examples/ifvehiclefunctions/climate-widget/doc/images/climate-widget.png
Binary files differ
diff --git a/src/ifvehiclefunctions/doc/src/examples-climate_widget.qdoc b/examples/ifvehiclefunctions/climate-widget/doc/src/climate-widget.qdoc
index 0d43da14..aa6329a1 100644
--- a/src/ifvehiclefunctions/doc/src/examples-climate_widget.qdoc
+++ b/examples/ifvehiclefunctions/climate-widget/doc/src/climate-widget.qdoc
@@ -51,12 +51,12 @@
****************************************************************************/
/*!
- \example ifvehiclefunctions/climate_widget
+ \example ifvehiclefunctions/climate-widget
\title Climate Control Widget Example
\ingroup qtifvehiclefunctions-examples
\brief This example shows how to access the climate control from C++.
- \image examples_climate_widget.png
+ \image climate-widget.png
This example shows how to access the climate control from the C++.
@@ -70,12 +70,12 @@
\l {QIfClimateControl::}{isValid()} is used for verifying that the
autoDiscovery found a backend:
- \snippet ifvehiclefunctions/climate_widget/mainwindow.cpp 1
+ \snippet ifvehiclefunctions/climate-widget/mainwindow.cpp 1
The constructor then continues to connect the climate control
attribute change signals to the UI components:
- \snippet ifvehiclefunctions/climate_widget/mainwindow.cpp 2
+ \snippet ifvehiclefunctions/climate-widget/mainwindow.cpp 2
Airflow direction is controlled using these functions:
- \snippet ifvehiclefunctions/climate_widget/mainwindow.cpp 3
+ \snippet ifvehiclefunctions/climate-widget/mainwindow.cpp 3
*/
diff --git a/examples/ifvehiclefunctions/climate_widget/main.cpp b/examples/ifvehiclefunctions/climate-widget/main.cpp
index 9757cc27..9757cc27 100644
--- a/examples/ifvehiclefunctions/climate_widget/main.cpp
+++ b/examples/ifvehiclefunctions/climate-widget/main.cpp
diff --git a/examples/ifvehiclefunctions/climate_widget/mainwindow.cpp b/examples/ifvehiclefunctions/climate-widget/mainwindow.cpp
index 8f06010a..8f06010a 100644
--- a/examples/ifvehiclefunctions/climate_widget/mainwindow.cpp
+++ b/examples/ifvehiclefunctions/climate-widget/mainwindow.cpp
diff --git a/examples/ifvehiclefunctions/climate_widget/mainwindow.h b/examples/ifvehiclefunctions/climate-widget/mainwindow.h
index 1a43adda..1a43adda 100644
--- a/examples/ifvehiclefunctions/climate_widget/mainwindow.h
+++ b/examples/ifvehiclefunctions/climate-widget/mainwindow.h
diff --git a/examples/ifvehiclefunctions/climate_widget/mainwindow.ui b/examples/ifvehiclefunctions/climate-widget/mainwindow.ui
index 7f53ae27..7f53ae27 100644
--- a/examples/ifvehiclefunctions/climate_widget/mainwindow.ui
+++ b/examples/ifvehiclefunctions/climate-widget/mainwindow.ui
diff --git a/examples/ifvehiclefunctions/ifvehiclefunctions.pro b/examples/ifvehiclefunctions/ifvehiclefunctions.pro
index 19ff424d..d290d4a7 100644
--- a/examples/ifvehiclefunctions/ifvehiclefunctions.pro
+++ b/examples/ifvehiclefunctions/ifvehiclefunctions.pro
@@ -1,7 +1,7 @@
TEMPLATE = subdirs
SUBDIRS += \
- climate_qml \
- window_qml
+ climate-qml \
+ window-qml
-qtHaveModule(widgets): SUBDIRS += climate_widget
+qtHaveModule(widgets): SUBDIRS += climate-widget
diff --git a/examples/ifvehiclefunctions/window_qml/CMakeLists.txt b/examples/ifvehiclefunctions/window-qml/CMakeLists.txt
index 41f89141..41f89141 100644
--- a/examples/ifvehiclefunctions/window_qml/CMakeLists.txt
+++ b/examples/ifvehiclefunctions/window-qml/CMakeLists.txt
diff --git a/examples/ifvehiclefunctions/window_qml/WindowItem.qml b/examples/ifvehiclefunctions/window-qml/WindowItem.qml
index 55086efd..55086efd 100644
--- a/examples/ifvehiclefunctions/window_qml/WindowItem.qml
+++ b/examples/ifvehiclefunctions/window-qml/WindowItem.qml
diff --git a/examples/ifvehiclefunctions/window_qml/main.cpp b/examples/ifvehiclefunctions/window-qml/main.cpp
index 0022cd0e..0022cd0e 100644
--- a/examples/ifvehiclefunctions/window_qml/main.cpp
+++ b/examples/ifvehiclefunctions/window-qml/main.cpp
diff --git a/examples/ifvehiclefunctions/window_qml/main.qml b/examples/ifvehiclefunctions/window-qml/main.qml
index b0b234e0..b0b234e0 100644
--- a/examples/ifvehiclefunctions/window_qml/main.qml
+++ b/examples/ifvehiclefunctions/window-qml/main.qml
diff --git a/examples/ifvehiclefunctions/window_qml/qml.qrc b/examples/ifvehiclefunctions/window-qml/qml.qrc
index 4bb0efb9..4bb0efb9 100644
--- a/examples/ifvehiclefunctions/window_qml/qml.qrc
+++ b/examples/ifvehiclefunctions/window-qml/qml.qrc
diff --git a/examples/ifvehiclefunctions/window_qml/window_qml.pro b/examples/ifvehiclefunctions/window-qml/window-qml.pro
index b3f291c9..b3f291c9 100644
--- a/examples/ifvehiclefunctions/window_qml/window_qml.pro
+++ b/examples/ifvehiclefunctions/window-qml/window-qml.pro
diff --git a/examples/interfaceframework/CMakeLists.txt b/examples/interfaceframework/CMakeLists.txt
index 0a80629e..65744ca8 100644
--- a/examples/interfaceframework/CMakeLists.txt
+++ b/examples/interfaceframework/CMakeLists.txt
@@ -4,10 +4,10 @@ cmake_minimum_required(VERSION 3.14)
project(example LANGUAGES CXX)
if(QT_FEATURE_ifcodegen)
- add_subdirectory(qface-if-climate)
- add_subdirectory(qface-if-addressbook)
+ add_subdirectory(qface-climate)
+ add_subdirectory(qface-addressbook)
endif()
if(QT_FEATURE_ifcodegen AND QT_FEATURE_remoteobjects)
- add_subdirectory(qface-if-remote)
+ add_subdirectory(qface-remote)
add_subdirectory(qface-tutorial)
endif()
diff --git a/examples/interfaceframework/interfaceframework.pro b/examples/interfaceframework/interfaceframework.pro
index 9c1e40c8..06233a70 100644
--- a/examples/interfaceframework/interfaceframework.pro
+++ b/examples/interfaceframework/interfaceframework.pro
@@ -2,9 +2,9 @@ TEMPLATE = subdirs
QT_FOR_CONFIG += interfaceframework
qtConfig(ifcodegen) {
- SUBDIRS += qface-if-climate \
- qface-if-addressbook
+ SUBDIRS += qface-climate \
+ qface-addressbook
}
-qtConfig(ifcodegen): qtConfig(remoteobjects): SUBDIRS += qface-if-remote
+qtConfig(ifcodegen): qtConfig(remoteobjects): SUBDIRS += qface-remote
qtConfig(ifcodegen): qtConfig(remoteobjects): SUBDIRS += qface-tutorial
diff --git a/examples/interfaceframework/qface-if-addressbook/CMakeLists.txt b/examples/interfaceframework/qface-addressbook/CMakeLists.txt
index b3394426..4f9f70ef 100644
--- a/examples/interfaceframework/qface-if-addressbook/CMakeLists.txt
+++ b/examples/interfaceframework/qface-addressbook/CMakeLists.txt
@@ -1,4 +1,3 @@
-# Generated from qface-if-addressbook.pro.
cmake_minimum_required(VERSION 3.14)
project(example_if_addressbook LANGUAGES CXX)
diff --git a/examples/interfaceframework/qface-if-addressbook/backend_simulator/CMakeLists.txt b/examples/interfaceframework/qface-addressbook/backend_simulator/CMakeLists.txt
index 27737ebc..a9089b5c 100644
--- a/examples/interfaceframework/qface-if-addressbook/backend_simulator/CMakeLists.txt
+++ b/examples/interfaceframework/qface-addressbook/backend_simulator/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-addressbook/interfaceframework/")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-addressbook/interfaceframework/")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -20,7 +20,7 @@ set_target_properties(addressbook_backend_simulator PROPERTIES LIBRARY_OUTPUT_DI
# Interface Framework Generator:
qt6_ifcodegen_extend_target(addressbook_backend_simulator
- IDL_FILES ../example-if-addressbook.qface
+ IDL_FILES ../example-addressbook.qface
TEMPLATE backend_simulator
)
diff --git a/examples/interfaceframework/qface-if-addressbook/backend_simulator/backend_simulator.pro b/examples/interfaceframework/qface-addressbook/backend_simulator/backend_simulator.pro
index 4dc8239b..72871754 100644
--- a/examples/interfaceframework/qface-if-addressbook/backend_simulator/backend_simulator.pro
+++ b/examples/interfaceframework/qface-addressbook/backend_simulator/backend_simulator.pro
@@ -12,12 +12,12 @@ QT += core interfaceframework
CONFIG += ifcodegen plugin
IFCODEGEN_TEMPLATE = backend_simulator
-IFCODEGEN_SOURCES = ../example-if-addressbook.qface
+IFCODEGEN_SOURCES = ../example-addressbook.qface
PLUGIN_TYPE = interfaceframework
PLUGIN_CLASS_NAME = AddressBookSimulatorPlugin
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-addressbook/interfaceframework/
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-addressbook/interfaceframework/
INSTALLS += target
#! [0]
diff --git a/examples/interfaceframework/qface-if-addressbook/backend_simulator/plugin_resource.qrc b/examples/interfaceframework/qface-addressbook/backend_simulator/plugin_resource.qrc
index 7b89debe..7b89debe 100644
--- a/examples/interfaceframework/qface-if-addressbook/backend_simulator/plugin_resource.qrc
+++ b/examples/interfaceframework/qface-addressbook/backend_simulator/plugin_resource.qrc
diff --git a/examples/interfaceframework/qface-if-addressbook/backend_simulator/simulation.qml b/examples/interfaceframework/qface-addressbook/backend_simulator/simulation.qml
index 4f564843..4f564843 100644
--- a/examples/interfaceframework/qface-if-addressbook/backend_simulator/simulation.qml
+++ b/examples/interfaceframework/qface-addressbook/backend_simulator/simulation.qml
diff --git a/examples/interfaceframework/qface-if-addressbook/demo/CMakeLists.txt b/examples/interfaceframework/qface-addressbook/demo/CMakeLists.txt
index 7871e4a6..477c867a 100644
--- a/examples/interfaceframework/qface-if-addressbook/demo/CMakeLists.txt
+++ b/examples/interfaceframework/qface-addressbook/demo/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-addressbook")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-addressbook")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -17,20 +17,20 @@ find_package(Qt6 COMPONENTS Qml)
find_package(Qt6 COMPONENTS Quick)
find_package(Qt6 COMPONENTS InterfaceFramework)
-qt_add_executable(qface-if-addressbook
+qt_add_executable(qface-addressbook
main.cpp
)
-set_target_properties(qface-if-addressbook PROPERTIES RUNTIME_OUTPUT_DIRECTORY ../)
-set_target_properties(qface-if-addressbook PROPERTIES
+set_target_properties(qface-addressbook PROPERTIES RUNTIME_OUTPUT_DIRECTORY ../)
+set_target_properties(qface-addressbook PROPERTIES
WIN32_EXECUTABLE TRUE
MACOSX_BUNDLE FALSE
)
-target_compile_definitions(qface-if-addressbook PUBLIC
+target_compile_definitions(qface-addressbook PUBLIC
QT_DEPRECATED_WARNINGS
)
-target_link_libraries(qface-if-addressbook PUBLIC
+target_link_libraries(qface-addressbook PUBLIC
QtIfAdressBookExample
Qt::Core
Qt::Gui
@@ -44,14 +44,14 @@ set(qml_resource_files
"main.qml"
)
-qt6_add_resources(qface-if-addressbook "qml"
+qt6_add_resources(qface-addressbook "qml"
PREFIX
"/"
FILES
${qml_resource_files}
)
-install(TARGETS qface-if-addressbook
+install(TARGETS qface-addressbook
RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}"
BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}"
LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}"
diff --git a/examples/interfaceframework/qface-if-addressbook/demo/demo.pro b/examples/interfaceframework/qface-addressbook/demo/demo.pro
index 9ec597fe..2bba3196 100644
--- a/examples/interfaceframework/qface-if-addressbook/demo/demo.pro
+++ b/examples/interfaceframework/qface-addressbook/demo/demo.pro
@@ -1,4 +1,4 @@
-TARGET = qface-if-addressbook
+TARGET = qface-addressbook
QMAKE_PROJECT_NAME = $$TARGET
TEMPLATE = app
@@ -34,5 +34,5 @@ DEFINES += QT_DEPRECATED_WARNINGS
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-addressbook
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-addressbook
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-addressbook/demo/main.cpp b/examples/interfaceframework/qface-addressbook/demo/main.cpp
index c0bc5fe3..c0bc5fe3 100644
--- a/examples/interfaceframework/qface-if-addressbook/demo/main.cpp
+++ b/examples/interfaceframework/qface-addressbook/demo/main.cpp
diff --git a/examples/interfaceframework/qface-if-addressbook/demo/main.qml b/examples/interfaceframework/qface-addressbook/demo/main.qml
index f1c6e068..f1c6e068 100644
--- a/examples/interfaceframework/qface-if-addressbook/demo/main.qml
+++ b/examples/interfaceframework/qface-addressbook/demo/main.qml
diff --git a/examples/interfaceframework/qface-if-addressbook/demo/qml.qrc b/examples/interfaceframework/qface-addressbook/demo/qml.qrc
index 5f6483ac..5f6483ac 100644
--- a/examples/interfaceframework/qface-if-addressbook/demo/qml.qrc
+++ b/examples/interfaceframework/qface-addressbook/demo/qml.qrc
diff --git a/src/interfaceframework/doc/images/examples_qface_if_addressbook.png b/examples/interfaceframework/qface-addressbook/doc/images/qface-addressbook.png
index 7e170f88..7e170f88 100644
--- a/src/interfaceframework/doc/images/examples_qface_if_addressbook.png
+++ b/examples/interfaceframework/qface-addressbook/doc/images/qface-addressbook.png
Binary files differ
diff --git a/src/interfaceframework/doc/src/examples-qface-if-addressbook.qdoc b/examples/interfaceframework/qface-addressbook/doc/src/qface-addressbook.qdoc
index 5e11765e..b6958c35 100644
--- a/src/interfaceframework/doc/src/examples-qface-if-addressbook.qdoc
+++ b/examples/interfaceframework/qface-addressbook/doc/src/qface-addressbook.qdoc
@@ -28,11 +28,11 @@
****************************************************************************/
/*!
-\example interfaceframework/qface-if-addressbook
+\example interfaceframework/qface-addressbook
\brief This example shows how to generate models using the Qt Interface Framework Generator.
\ingroup qtinterfaceframework-examples
\title Qt Interface Framework Generator Addressbook Example
-\image examples_qface_if_addressbook.png
+\image qface-addressbook.png
\section1 Introduction
@@ -41,14 +41,14 @@ Generator.
It will only explain the details on how to use the \e model type and how it works internally. For a
general introduction to the Qt Interface Framework Generator, please have a look at the
-\l {interfaceframework/qface-if-climate} {Qt Interface Framework Generator Climate Example}.
+\l {interfaceframework/qface-climate} {Qt Interface Framework Generator Climate Example}.
\section2 Walkthrough
The IDL file used in the example represents an addressbook API. It contains a single interface
providing the contacts as a model and a struct definition for the actual contact.
-\snippet ../../../../examples/interfaceframework/qface-if-addressbook/example-if-addressbook.qface 0
+\snippet interfaceframework/qface-addressbook/example-addressbook.qface 0
The \e contact property is defined to be of type \e model<Contact>. The \l frontend template will
create a C++ property of type \l {QIfPagingModel}{QIfPagingModel*}. The getter function of this
@@ -74,9 +74,9 @@ template doesn't know what content it should provide.
For this use-case the \l {config_simulator_default}{default} annotation can be used to configure
the simulator to provide static simulation data.
-This is done in the example-if-addressbook.yaml file:
+This is done in the example-addressbook.yaml file:
-\quotefile ../../../../examples/interfaceframework/qface-if-addressbook/example-if-addressbook.yaml
+\quotefile interfaceframework/qface-addressbook/example-addressbook.yaml
The JSON fragment assigned to the \l {config_simulator_default}{default} variable is parsed by the
Qt Interface Framework Generator and will be used to generate a simulation backend which creates two Contact
@@ -87,7 +87,7 @@ instances and returns them as content for the contacts model.
The demo application is not autogenerated, but a standard QQmlEngine setup for an application
similar to other examples.
-\snippet ../../../../examples/interfaceframework/qface-if-addressbook/demo/main.qml 0
+\snippet interfaceframework/qface-addressbook/demo/main.qml 0
The model is retrieved from the \e addressbook object using the \e contacts property and passed to
the ListView. The delegate can access the actual contact using the \l {QIfPagingModel::}{ItemRole}
@@ -107,11 +107,11 @@ resource file is added to the build system like this.
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-addressbook/backend_simulator/CMakeLists.txt 0
+\snippet interfaceframework/qface-addressbook/backend_simulator/CMakeLists.txt 0
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-addressbook/backend_simulator/backend_simulator.pro 0
+\snippet interfaceframework/qface-addressbook/backend_simulator/backend_simulator.pro 0
\section2 Providing the simulation behavior in QML
@@ -133,7 +133,7 @@ implemented by the simulation backend. For our example two types are registered:
Our simulation QML file looks like this:
-\snippet ../../../../examples/interfaceframework/qface-if-addressbook/backend_simulator/simulation.qml 0
+\snippet interfaceframework/qface-addressbook/backend_simulator/simulation.qml 0
It creates an AddressBookBackend instance and prints a message once the QML code is loaded by using
the Component.onCompleted handler.
diff --git a/examples/interfaceframework/qface-if-addressbook/example-if-addressbook.qface b/examples/interfaceframework/qface-addressbook/example-addressbook.qface
index 12eca1ab..12eca1ab 100644
--- a/examples/interfaceframework/qface-if-addressbook/example-if-addressbook.qface
+++ b/examples/interfaceframework/qface-addressbook/example-addressbook.qface
diff --git a/examples/interfaceframework/qface-if-addressbook/example-if-addressbook.yaml b/examples/interfaceframework/qface-addressbook/example-addressbook.yaml
index 2e7a3c1c..2e7a3c1c 100644
--- a/examples/interfaceframework/qface-if-addressbook/example-if-addressbook.yaml
+++ b/examples/interfaceframework/qface-addressbook/example-addressbook.yaml
diff --git a/examples/interfaceframework/qface-if-addressbook/frontend/CMakeLists.txt b/examples/interfaceframework/qface-addressbook/frontend/CMakeLists.txt
index 5f293acc..59c5bb18 100644
--- a/examples/interfaceframework/qface-if-addressbook/frontend/CMakeLists.txt
+++ b/examples/interfaceframework/qface-addressbook/frontend/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-ifaddressbook")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-addressbook")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS InterfaceFramework)
@@ -20,7 +20,7 @@ qt6_add_library(QtIfAdressBookExample)
# Interface Framework Generator:
qt6_ifcodegen_extend_target(QtIfAdressBookExample
- IDL_FILES ../example-if-addressbook.qface
+ IDL_FILES ../example-addressbook.qface
TEMPLATE frontend
)
diff --git a/examples/interfaceframework/qface-if-addressbook/frontend/frontend.pro b/examples/interfaceframework/qface-addressbook/frontend/frontend.pro
index 93fc30ae..7bfe6a7c 100644
--- a/examples/interfaceframework/qface-if-addressbook/frontend/frontend.pro
+++ b/examples/interfaceframework/qface-addressbook/frontend/frontend.pro
@@ -7,7 +7,7 @@ QT_FOR_CONFIG += interfaceframework
QT += interfaceframework qml quick
CONFIG += ifcodegen
-IFCODEGEN_SOURCES = ../example-if-addressbook.qface
+IFCODEGEN_SOURCES = ../example-addressbook.qface
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-ifaddressbook
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-addressbook
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-addressbook/qface-if-addressbook.pro b/examples/interfaceframework/qface-addressbook/qface-addressbook.pro
index 48c88ba8..48028cc6 100644
--- a/examples/interfaceframework/qface-if-addressbook/qface-if-addressbook.pro
+++ b/examples/interfaceframework/qface-addressbook/qface-addressbook.pro
@@ -9,5 +9,5 @@ CONFIG += ordered
OTHER_FILES +=
DISTFILES += \
- example-if-addressbook.qface \
- example-if-addressbook.yaml
+ example-addressbook.qface \
+ example-addressbook.yaml
diff --git a/examples/interfaceframework/qface-if-climate/CMakeLists.txt b/examples/interfaceframework/qface-climate/CMakeLists.txt
index 72827137..45fa4804 100644
--- a/examples/interfaceframework/qface-if-climate/CMakeLists.txt
+++ b/examples/interfaceframework/qface-climate/CMakeLists.txt
@@ -1,4 +1,3 @@
-# Generated from qface-if-climate.pro.
cmake_minimum_required(VERSION 3.14)
project(example_if_climate LANGUAGES CXX)
diff --git a/examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt b/examples/interfaceframework/qface-climate/backend_simulator/CMakeLists.txt
index eacf45a3..5f61f67b 100644
--- a/examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt
+++ b/examples/interfaceframework/qface-climate/backend_simulator/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-climate/interfaceframework/")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-climate/interfaceframework/")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -25,7 +25,7 @@ set_target_properties(climate_backend_simulator PROPERTIES LIBRARY_OUTPUT_DIRECT
#! [2]
# Interface Framework Generator:
qt6_ifcodegen_extend_target(climate_backend_simulator
- IDL_FILES ../example-if-climate.qface
+ IDL_FILES ../example-climate.qface
TEMPLATE backend_simulator
)
#! [2]
diff --git a/examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro b/examples/interfaceframework/qface-climate/backend_simulator/backend_simulator.pro
index 8f92435e..84413d82 100644
--- a/examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro
+++ b/examples/interfaceframework/qface-climate/backend_simulator/backend_simulator.pro
@@ -16,10 +16,10 @@ QT += core interfaceframework
#! [2]
CONFIG += ifcodegen plugin
IFCODEGEN_TEMPLATE = backend_simulator
-IFCODEGEN_SOURCES = ../example-if-climate.qface
+IFCODEGEN_SOURCES = ../example-climate.qface
PLUGIN_TYPE = interfaceframework
PLUGIN_CLASS_NAME = ClimateSimulatorPlugin
#! [2]
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-climate/interfaceframework/
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-climate/interfaceframework/
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-climate/demo/CMakeLists.txt b/examples/interfaceframework/qface-climate/demo/CMakeLists.txt
index 1b0ceb50..9806b26a 100644
--- a/examples/interfaceframework/qface-if-climate/demo/CMakeLists.txt
+++ b/examples/interfaceframework/qface-climate/demo/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-climate")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-climate")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -17,20 +17,20 @@ find_package(Qt6 COMPONENTS Qml)
find_package(Qt6 COMPONENTS Quick)
find_package(Qt6 COMPONENTS InterfaceFramework)
-qt_add_executable(qface-if-climate
+qt_add_executable(qface-climate
main.cpp
)
-set_target_properties(qface-if-climate PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
-set_target_properties(qface-if-climate PROPERTIES
+set_target_properties(qface-climate PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
+set_target_properties(qface-climate PROPERTIES
WIN32_EXECUTABLE TRUE
MACOSX_BUNDLE FALSE
)
-target_compile_definitions(qface-if-climate PUBLIC
+target_compile_definitions(qface-climate PUBLIC
QT_DEPRECATED_WARNINGS
)
-target_link_libraries(qface-if-climate PUBLIC
+target_link_libraries(qface-climate PUBLIC
QtIfClimateExample
Qt::Core
Qt::Gui
@@ -44,14 +44,14 @@ set(qml_resource_files
"main.qml"
)
-qt6_add_resources(qface-if-climate "qml"
+qt6_add_resources(qface-climate "qml"
PREFIX
"/"
FILES
${qml_resource_files}
)
-install(TARGETS qface-if-climate
+install(TARGETS qface-climate
RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}"
BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}"
LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}"
diff --git a/examples/interfaceframework/qface-if-climate/demo/demo.pro b/examples/interfaceframework/qface-climate/demo/demo.pro
index 52790c3e..7a26ef25 100644
--- a/examples/interfaceframework/qface-if-climate/demo/demo.pro
+++ b/examples/interfaceframework/qface-climate/demo/demo.pro
@@ -1,4 +1,4 @@
-TARGET = qface-if-climate
+TARGET = qface-climate
QMAKE_PROJECT_NAME = $$TARGET
TEMPLATE = app
@@ -34,5 +34,5 @@ DEFINES += QT_DEPRECATED_WARNINGS
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-climate
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-climate
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-climate/demo/main.cpp b/examples/interfaceframework/qface-climate/demo/main.cpp
index 3fc0f846..3fc0f846 100644
--- a/examples/interfaceframework/qface-if-climate/demo/main.cpp
+++ b/examples/interfaceframework/qface-climate/demo/main.cpp
diff --git a/examples/interfaceframework/qface-if-climate/demo/main.qml b/examples/interfaceframework/qface-climate/demo/main.qml
index f6723db6..f6723db6 100644
--- a/examples/interfaceframework/qface-if-climate/demo/main.qml
+++ b/examples/interfaceframework/qface-climate/demo/main.qml
diff --git a/examples/interfaceframework/qface-if-climate/demo/qml.qrc b/examples/interfaceframework/qface-climate/demo/qml.qrc
index 5f6483ac..5f6483ac 100644
--- a/examples/interfaceframework/qface-if-climate/demo/qml.qrc
+++ b/examples/interfaceframework/qface-climate/demo/qml.qrc
diff --git a/src/interfaceframework/doc/images/examples_qface_if_climate.png b/examples/interfaceframework/qface-climate/doc/images/qface-climate.png
index 7c4f943c..7c4f943c 100644
--- a/src/interfaceframework/doc/images/examples_qface_if_climate.png
+++ b/examples/interfaceframework/qface-climate/doc/images/qface-climate.png
Binary files differ
diff --git a/src/interfaceframework/doc/src/examples-qface-if-climate.qdoc b/examples/interfaceframework/qface-climate/doc/src/qface-climate.qdoc
index 734e0c27..7cfc0ac1 100644
--- a/src/interfaceframework/doc/src/examples-qface-if-climate.qdoc
+++ b/examples/interfaceframework/qface-climate/doc/src/qface-climate.qdoc
@@ -28,11 +28,11 @@
****************************************************************************/
/*!
-\example interfaceframework/qface-if-climate
+\example interfaceframework/qface-climate
\brief This Example shows how to use the Qt Interface Framework Generator.
\ingroup qtinterfaceframework-examples
\title Qt Interface Framework Generator Climate Example
-\image examples_qface_if_climate.png
+\image qface-climate.png
\section1 Introduction
@@ -120,7 +120,7 @@ of each individual item. The second definition is similar, but using the \c flag
\section2 Comments and Annotations
Compared to the minimal IDL we saw in the previous section, the full
-\fileLink {examples/interfaceframework/qface-if-climate/example-if-climate.qface}{IDL file} contains a lot of comments
+\fileLink {examples/interfaceframework/qface-climate/example-climate.qface}{IDL file} contains a lot of comments
and annotations.
Comments starting with \c /** define documentation statements and can be converted into
@@ -221,19 +221,19 @@ To call the autogenerator for our shared library, it needs to be integrated into
First the \c InterfaceFramework package needs to be found using \c find_package:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/frontend/CMakeLists.txt 0
+\snippet interfaceframework/qface-climate/frontend/CMakeLists.txt 0
Afterwards we proceed to build a library and let the autogenerator extend this target with
the generated source code by invoking \l {qt6_ifcodegen_extend_target}.
-\snippet ../../../../examples/interfaceframework/qface-if-climate/frontend/CMakeLists.txt 1
+\snippet interfaceframework/qface-climate/frontend/CMakeLists.txt 1
\e qmake:
The qmake project file needs to use the \c ifcodegen qmake feature. The snippet below shows how
to do this:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/frontend/frontend.pro 1
+\snippet interfaceframework/qface-climate/frontend/frontend.pro 1
By adding \c ifcodegen to the \c CONFIG variable, the \c ifcodegen feature file is loaded
and interprets the \c IFCODEGEN_SOURCES variable just like the \c SOURCES variable in normal qmake
@@ -243,7 +243,7 @@ However, activating the qmake feature using the \c CONFIG variable has one disad
doesn't report any errors if this feature is not available. But, you can use the following
additional code to report errors:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/frontend/frontend.pro 0
+\snippet interfaceframework/qface-climate/frontend/frontend.pro 0
The other part of the project file is a normal library setup which should work on Linux, macOS,
and Windows.
@@ -261,14 +261,14 @@ uses a different generation template.
A plugin is defined and extended by calling the codegenerator, this time with the \c backend_simulator
template:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt 2
+\snippet interfaceframework/qface-climate/backend_simulator/CMakeLists.txt 2
\e qmake:
As we want to generate a plugin instead of a plain library, we need to instruct qmake to do so by
adding \c plugin to the \c CONFIG variable.
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro 2
+\snippet interfaceframework/qface-climate/backend_simulator/backend_simulator.pro 2
For the plugin to compile correctly it needs to get the backend interface header from the previously
created library. However, this header is not part of our source tree but the build tree, because it
@@ -276,11 +276,11 @@ is also generated. We provide this header by adding it to the include path using
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt 1
+\snippet interfaceframework/qface-climate/backend_simulator/CMakeLists.txt 1
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro 1
+\snippet interfaceframework/qface-climate/backend_simulator/backend_simulator.pro 1
The \c backend_simulator template makes use of the \b @config_simulator annotations explained
\l{Annotations}{above}. This means that the generated backend provides the default values defined
@@ -304,7 +304,7 @@ types with the QML engine.
In our QML application, we still need to import the module using the same module URI used
in the IDL file. Afterwards, the interface can be instantiated like a regular QML item.
-\snippet ../../../../examples/interfaceframework/qface-if-climate/demo/main.qml 0
+\snippet interfaceframework/qface-climate/demo/main.qml 0
\dots 0
Our application doesn't know about our backend plugin, so, we need to put this plugin in the folder
@@ -316,10 +316,10 @@ To make sure this is done automatically, we add the following line to our backen
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/CMakeLists.txt 0
+\snippet interfaceframework/qface-climate/backend_simulator/CMakeLists.txt 0
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-climate/backend_simulator/backend_simulator.pro 0
+\snippet interfaceframework/qface-climate/backend_simulator/backend_simulator.pro 0
*/
diff --git a/examples/interfaceframework/qface-if-climate/example-if-climate.qface b/examples/interfaceframework/qface-climate/example-climate.qface
index 49187e3b..49187e3b 100644
--- a/examples/interfaceframework/qface-if-climate/example-if-climate.qface
+++ b/examples/interfaceframework/qface-climate/example-climate.qface
diff --git a/examples/interfaceframework/qface-if-climate/example-if-climate.yaml b/examples/interfaceframework/qface-climate/example-climate.yaml
index f774fe35..f774fe35 100644
--- a/examples/interfaceframework/qface-if-climate/example-if-climate.yaml
+++ b/examples/interfaceframework/qface-climate/example-climate.yaml
diff --git a/examples/interfaceframework/qface-if-climate/frontend/CMakeLists.txt b/examples/interfaceframework/qface-climate/frontend/CMakeLists.txt
index f2d6cb43..5f4e0df9 100644
--- a/examples/interfaceframework/qface-if-climate/frontend/CMakeLists.txt
+++ b/examples/interfaceframework/qface-climate/frontend/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-climate")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-climate")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -24,7 +24,7 @@ qt6_add_library(QtIfClimateExample)
# Interface Framework Generator:
qt6_ifcodegen_extend_target(QtIfClimateExample
- IDL_FILES ../example-if-climate.qface
+ IDL_FILES ../example-climate.qface
TEMPLATE frontend
)
#! [1]
diff --git a/examples/interfaceframework/qface-if-climate/frontend/frontend.pro b/examples/interfaceframework/qface-climate/frontend/frontend.pro
index 2a1f9015..45bd140c 100644
--- a/examples/interfaceframework/qface-if-climate/frontend/frontend.pro
+++ b/examples/interfaceframework/qface-climate/frontend/frontend.pro
@@ -10,8 +10,8 @@ QT += interfaceframework qml quick
#! [1]
CONFIG += ifcodegen
-IFCODEGEN_SOURCES = ../example-if-climate.qface
+IFCODEGEN_SOURCES = ../example-climate.qface
#! [1]
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-climate
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-climate
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-climate/qface-if-climate.pro b/examples/interfaceframework/qface-climate/qface-climate.pro
index 6879e643..769d621d 100644
--- a/examples/interfaceframework/qface-if-climate/qface-if-climate.pro
+++ b/examples/interfaceframework/qface-climate/qface-climate.pro
@@ -7,5 +7,5 @@ SUBDIRS = frontend \
CONFIG += ordered
OTHER_FILES += \
- example-if-climate.qface \
- example-if-climate.yaml
+ example-climate.qface \
+ example-climate.yaml
diff --git a/examples/interfaceframework/qface-if-remote/CMakeLists.txt b/examples/interfaceframework/qface-remote/CMakeLists.txt
index 9b6d2fc7..60d58632 100644
--- a/examples/interfaceframework/qface-if-remote/CMakeLists.txt
+++ b/examples/interfaceframework/qface-remote/CMakeLists.txt
@@ -1,4 +1,3 @@
-# Generated from qface-if-remote.pro.
cmake_minimum_required(VERSION 3.14)
project(example_if_remote LANGUAGES CXX)
diff --git a/examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt b/examples/interfaceframework/qface-remote/backend_qtro/CMakeLists.txt
index 5628738f..4ebb32a2 100644
--- a/examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt
+++ b/examples/interfaceframework/qface-remote/backend_qtro/CMakeLists.txt
@@ -9,7 +9,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-remote/interfaceframework/")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-remote/interfaceframework/")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -25,7 +25,7 @@ set_target_properties(remote_backend_qtro PROPERTIES LIBRARY_OUTPUT_DIRECTORY ..
#! [2]
# Interface Framework Generator:
qt6_ifcodegen_extend_target(remote_backend_qtro
- IDL_FILES ../example-if-remote.qface
+ IDL_FILES ../example-remote.qface
TEMPLATE backend_qtro
)
#! [2]
diff --git a/examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro b/examples/interfaceframework/qface-remote/backend_qtro/backend_qtro.pro
index be83f15e..4921ee5f 100644
--- a/examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro
+++ b/examples/interfaceframework/qface-remote/backend_qtro/backend_qtro.pro
@@ -16,10 +16,10 @@ QT += core interfaceframework
#! [2]
CONFIG += ifcodegen plugin
IFCODEGEN_TEMPLATE = backend_qtro
-IFCODEGEN_SOURCES = ../example-if-remote.qface
+IFCODEGEN_SOURCES = ../example-remote.qface
PLUGIN_TYPE = interfaceframework
PLUGIN_CLASS_NAME = RemoteClientQtROPlugin
#! [2]
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-remote/interfaceframework/
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-remote/interfaceframework/
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-remote/demo/CMakeLists.txt b/examples/interfaceframework/qface-remote/demo/CMakeLists.txt
index 01322e8b..8a1b626f 100644
--- a/examples/interfaceframework/qface-if-remote/demo/CMakeLists.txt
+++ b/examples/interfaceframework/qface-remote/demo/CMakeLists.txt
@@ -1,7 +1,7 @@
# Generated from demo.pro.
cmake_minimum_required(VERSION 3.14)
-project(qface-if-remote LANGUAGES CXX)
+project(qface-remote LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
@@ -13,7 +13,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-remote")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-remote")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Gui)
@@ -21,20 +21,20 @@ find_package(Qt6 COMPONENTS Qml)
find_package(Qt6 COMPONENTS Quick)
find_package(Qt6 COMPONENTS InterfaceFramework)
-qt_add_executable(qface-if-remote
+qt_add_executable(qface-remote
main.cpp
)
-set_target_properties(qface-if-remote PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
-set_target_properties(qface-if-remote PROPERTIES
+set_target_properties(qface-remote PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
+set_target_properties(qface-remote PROPERTIES
WIN32_EXECUTABLE TRUE
MACOSX_BUNDLE FALSE
)
-target_compile_definitions(qface-if-remote PUBLIC
+target_compile_definitions(qface-remote PUBLIC
QT_DEPRECATED_WARNINGS
)
-target_link_libraries(qface-if-remote PUBLIC
+target_link_libraries(qface-remote PUBLIC
QtIfRemoteExample
Qt::Core
Qt::Gui
@@ -48,14 +48,14 @@ set(qml_resource_files
"main.qml"
)
-qt6_add_resources(qface-if-remote "qml"
+qt6_add_resources(qface-remote "qml"
PREFIX
"/"
FILES
${qml_resource_files}
)
-install(TARGETS qface-if-remote
+install(TARGETS qface-remote
RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}"
BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}"
LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}"
diff --git a/examples/interfaceframework/qface-if-remote/demo/demo.pro b/examples/interfaceframework/qface-remote/demo/demo.pro
index ed97d881..ca6ee5f0 100644
--- a/examples/interfaceframework/qface-if-remote/demo/demo.pro
+++ b/examples/interfaceframework/qface-remote/demo/demo.pro
@@ -1,4 +1,4 @@
-TARGET = qface-if-remote
+TARGET = qface-remote
QMAKE_PROJECT_NAME = $$TARGET
TEMPLATE = app
@@ -34,5 +34,5 @@ DEFINES += QT_DEPRECATED_WARNINGS
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-remote
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-remote
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-remote/demo/main.cpp b/examples/interfaceframework/qface-remote/demo/main.cpp
index faecda76..faecda76 100644
--- a/examples/interfaceframework/qface-if-remote/demo/main.cpp
+++ b/examples/interfaceframework/qface-remote/demo/main.cpp
diff --git a/examples/interfaceframework/qface-if-remote/demo/main.qml b/examples/interfaceframework/qface-remote/demo/main.qml
index 61e0d1a9..61e0d1a9 100644
--- a/examples/interfaceframework/qface-if-remote/demo/main.qml
+++ b/examples/interfaceframework/qface-remote/demo/main.qml
diff --git a/examples/interfaceframework/qface-if-remote/demo/qml.qrc b/examples/interfaceframework/qface-remote/demo/qml.qrc
index 5f6483ac..5f6483ac 100644
--- a/examples/interfaceframework/qface-if-remote/demo/qml.qrc
+++ b/examples/interfaceframework/qface-remote/demo/qml.qrc
diff --git a/src/interfaceframework/doc/images/examples_qface_if_remote.png b/examples/interfaceframework/qface-remote/doc/images/qface-remote.png
index fc671c7d..fc671c7d 100644
--- a/src/interfaceframework/doc/images/examples_qface_if_remote.png
+++ b/examples/interfaceframework/qface-remote/doc/images/qface-remote.png
Binary files differ
diff --git a/src/interfaceframework/doc/src/examples-qface-if-remote.qdoc b/examples/interfaceframework/qface-remote/doc/src/qface-remote.qdoc
index c0c7588e..20d801af 100644
--- a/src/interfaceframework/doc/src/examples-qface-if-remote.qdoc
+++ b/examples/interfaceframework/qface-remote/doc/src/qface-remote.qdoc
@@ -28,12 +28,12 @@
****************************************************************************/
/*!
-\example interfaceframework/qface-if-remote
+\example interfaceframework/qface-remote
\brief Learn how to use the Qt Interface Framework Generator to create QtRemoteObjects based
backends.
\ingroup qtinterfaceframework-examples
\title Generate QtRemoteObjects based backends with the Qt Interface Framework Generator
-\image examples_qface_if_remote.png
+\image qface-remote.png
\section1 Introduction
@@ -63,11 +63,11 @@ contains a single interface with one property and one method.
First, we need to define which \e module we want to describe. The \e module acts as a namespace,
because the IDL file can contain multiple interfaces.
-\snippet ../../../../examples/interfaceframework/qface-if-remote/example-if-remote.qface 0
+\snippet interfaceframework/qface-remote/example-remote.qface 0
The most important part is the definition of the \e interface.
-\snippet ../../../../examples/interfaceframework/qface-if-remote/example-if-remote.qface 1
+\snippet interfaceframework/qface-remote/example-remote.qface 1
In this case, we define an \e interface named \b ProcessingService with one property and one
method. Every property and method definition needs to contain at least a type and a name. Most of
@@ -88,16 +88,16 @@ To call the autogenerator for our shared library, it needs to be integrated into
First the \c InterfaceFramework package needs to be found using \c find_package:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/frontend/CMakeLists.txt 0
+\snippet interfaceframework/qface-remote/frontend/CMakeLists.txt 0
Afterwards we proceed to build a library and let the autogenerator extend this target with
the generated source code by invoking \l {qt6_ifcodegen_extend_target}.
-\snippet ../../../../examples/interfaceframework/qface-if-remote/frontend/CMakeLists.txt 1
+\snippet interfaceframework/qface-remote/frontend/CMakeLists.txt 1
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/frontend/frontend.pro 1
+\snippet interfaceframework/qface-remote/frontend/frontend.pro 1
By adding \c ifcodegen to the \c CONFIG variable, the \c ifcodegen feature file is loaded and
interprets the \c IFCODEGEN_SOURCES variable, similar to the \c SOURCES variable in regular qmake
@@ -105,7 +105,7 @@ projects. However, activating the qmake feature via the \c CONFIG variable has o
the feature is not available, no errors are reported. We recommend using the following additional
code to report errors:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/frontend/frontend.pro 0
+\snippet interfaceframework/qface-remote/frontend/frontend.pro 0
The remaining part of the project file is a normal library setup that works on Linux, macOS, and
Windows.
@@ -123,11 +123,11 @@ integration works in the same way, but it uses a different generation template.
A plugin is defined and extended by calling the codegenerator, this time with the \c backend_simulator
template:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt 2
+\snippet interfaceframework/qface-remote/backend_qtro/CMakeLists.txt 2
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro 2
+\snippet interfaceframework/qface-remote/backend_qtro/backend_qtro.pro 2
The generated backend plugin code is usable as is, and doesn't require any further change. As we
want to generate a plugin instead of a plain library, we need to instruct qmake to do so by adding
@@ -140,11 +140,11 @@ header, we add it to the include path using the following code:
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt 1
+\snippet interfaceframework/qface-remote/backend_qtro/CMakeLists.txt 1
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro 1
+\snippet interfaceframework/qface-remote/backend_qtro/backend_qtro.pro 1
Most of the code in the backend plugin is generated by the Interface Framework Generator, but some
of it is generated by the Qt's Remote Object Compiler, \c repc. To achieve this, the Interface
@@ -161,11 +161,11 @@ follows:
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/CMakeLists.txt 0
+\snippet interfaceframework/qface-remote/backend_qtro/CMakeLists.txt 0
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/backend_qtro/backend_qtro.pro 0
+\snippet interfaceframework/qface-remote/backend_qtro/backend_qtro.pro 0
\section1 RemoteObjects Server
@@ -177,13 +177,13 @@ Generator with the \e server_qtro template:
\e CMake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/CMakeLists.txt 0
+\snippet interfaceframework/qface-remote/server_qtro/CMakeLists.txt 0
\e qmake:
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/server_qtro.pro 0
+\snippet interfaceframework/qface-remote/server_qtro/server_qtro.pro 0
\dots 0
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/server_qtro.pro 1
+\snippet interfaceframework/qface-remote/server_qtro/server_qtro.pro 1
To use the generated remote source, we need to inherit from one of the classes defined in the
generated \c rep_processingservice_source.h file. In this example, we implement our server's
@@ -193,7 +193,7 @@ class:
\code
// server_qtro/processingservice.h
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/processingservice.h 0
+\snippet interfaceframework/qface-remote/server_qtro/processingservice.h 0
Note that the base class already has the definitions for property accessors, but any custom
method or slot needs to be overridden and defined. Our implementation of the process function
@@ -202,7 +202,7 @@ merely counts and returns the length of the data passed and updates the \c lastM
\code
// server_qtro/processingservice.cpp
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/processingservice.cpp 0
+\snippet interfaceframework/qface-remote/server_qtro/processingservice.cpp 0
To make the \c ProcessingService class accessible remotely, we need to share it via the
QRemoteObjectNode::enableRemoting() function. The \c Core class generated provides a preconfigured
@@ -214,7 +214,7 @@ the start of the main event loop:
\code
// server_qtro/main.cpp
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/server_qtro/main.cpp 0
+\snippet interfaceframework/qface-remote/server_qtro/main.cpp 0
This is all you need to do to implement a service that is accessible remotely; use the properties
as usual and provide the method implementations. The QtRemoteObjects library takes care of the
@@ -237,7 +237,7 @@ in the QFace file. Afterwards the interface can be instantiated like any other Q
\code
// demo/main.qml
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/demo/main.qml 0
+\snippet interfaceframework/qface-remote/demo/main.qml 0
\dots 0
Every method call that is made through a generated API, is asynchronous. This means that instead
@@ -248,14 +248,14 @@ called when the method call has been successfully finished; or if it has failed.
\code
// demo/main.qml
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/demo/main.qml 1
+\snippet interfaceframework/qface-remote/demo/main.qml 1
In case of properties, we use bindings as usual:
\code
// demo/main.qml
\endcode
-\snippet ../../../../examples/interfaceframework/qface-if-remote/demo/main.qml 2
+\snippet interfaceframework/qface-remote/demo/main.qml 2
\section1 Running the Example
diff --git a/examples/interfaceframework/qface-if-remote/example-if-remote.qface b/examples/interfaceframework/qface-remote/example-remote.qface
index 4354e9e7..4354e9e7 100644
--- a/examples/interfaceframework/qface-if-remote/example-if-remote.qface
+++ b/examples/interfaceframework/qface-remote/example-remote.qface
diff --git a/examples/interfaceframework/qface-if-remote/frontend/CMakeLists.txt b/examples/interfaceframework/qface-remote/frontend/CMakeLists.txt
index 0e756e4f..0b2342f8 100644
--- a/examples/interfaceframework/qface-if-remote/frontend/CMakeLists.txt
+++ b/examples/interfaceframework/qface-remote/frontend/CMakeLists.txt
@@ -13,7 +13,7 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-remote")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-remote")
find_package(Qt6 COMPONENTS Core)
#! [0]
@@ -27,7 +27,7 @@ qt6_add_library(QtIfRemoteExample)
# Interface Framework Generator:
qt6_ifcodegen_extend_target(QtIfRemoteExample
- IDL_FILES ../example-if-remote.qface
+ IDL_FILES ../example-remote.qface
TEMPLATE frontend
)
#! [1]
diff --git a/examples/interfaceframework/qface-if-remote/frontend/frontend.pro b/examples/interfaceframework/qface-remote/frontend/frontend.pro
index 1765afb3..bebdf360 100644
--- a/examples/interfaceframework/qface-if-remote/frontend/frontend.pro
+++ b/examples/interfaceframework/qface-remote/frontend/frontend.pro
@@ -10,8 +10,8 @@ QT += interfaceframework qml quick
#! [1]
CONFIG += ifcodegen
-IFCODEGEN_SOURCES = ../example-if-remote.qface
+IFCODEGEN_SOURCES = ../example-remote.qface
#! [1]
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-remote
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-remote
INSTALLS += target
diff --git a/examples/interfaceframework/qface-if-remote/qface-if-remote.pro b/examples/interfaceframework/qface-remote/qface-remote.pro
index 085236b2..0dbdb0b6 100644
--- a/examples/interfaceframework/qface-if-remote/qface-if-remote.pro
+++ b/examples/interfaceframework/qface-remote/qface-remote.pro
@@ -8,4 +8,4 @@ SUBDIRS = frontend \
CONFIG += ordered
OTHER_FILES += \
- example-if-remote.qface
+ example-remote.qface
diff --git a/examples/interfaceframework/qface-if-remote/server_qtro/CMakeLists.txt b/examples/interfaceframework/qface-remote/server_qtro/CMakeLists.txt
index 17975374..185caee9 100644
--- a/examples/interfaceframework/qface-if-remote/server_qtro/CMakeLists.txt
+++ b/examples/interfaceframework/qface-remote/server_qtro/CMakeLists.txt
@@ -1,7 +1,7 @@
# Generated from server_qtro.pro.
cmake_minimum_required(VERSION 3.14)
-project(qface-if-remote-server LANGUAGES CXX)
+project(qface-remote-server LANGUAGES CXX)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
@@ -13,43 +13,43 @@ if(NOT DEFINED INSTALL_EXAMPLESDIR)
set(INSTALL_EXAMPLESDIR "examples")
endif()
-set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-if-remote-server")
+set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/interfaceframework/qface-remote-server")
find_package(Qt6 COMPONENTS Core)
find_package(Qt6 COMPONENTS Qml)
find_package(Qt6 COMPONENTS Quick)
find_package(Qt6 COMPONENTS InterfaceFramework)
-qt_add_executable(qface-if-remote-server
+qt_add_executable(qface-remote-server
main.cpp
processingservice.cpp processingservice.h
)
#! [0]
# Interface Framework Generator:
-qt6_ifcodegen_extend_target(qface-if-remote-server
- IDL_FILES ../example-if-remote.qface
+qt6_ifcodegen_extend_target(qface-remote-server
+ IDL_FILES ../example-remote.qface
TEMPLATE server_qtro
)
#! [0]
-set_target_properties(qface-if-remote-server PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
+set_target_properties(qface-remote-server PROPERTIES RUNTIME_OUTPUT_DIRECTORY ..)
-set_target_properties(qface-if-remote-server PROPERTIES
+set_target_properties(qface-remote-server PROPERTIES
WIN32_EXECUTABLE TRUE
MACOSX_BUNDLE FALSE
)
-target_compile_definitions(qface-if-remote-server PUBLIC
+target_compile_definitions(qface-remote-server PUBLIC
QT_DEPRECATED_WARNINGS
)
-target_link_libraries(qface-if-remote-server PUBLIC
+target_link_libraries(qface-remote-server PUBLIC
QtIfRemoteExample
Qt::Core
)
-install(TARGETS qface-if-remote-server
+install(TARGETS qface-remote-server
RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}"
BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}"
LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}"
diff --git a/examples/interfaceframework/qface-if-remote/server_qtro/main.cpp b/examples/interfaceframework/qface-remote/server_qtro/main.cpp
index 765ba103..765ba103 100644
--- a/examples/interfaceframework/qface-if-remote/server_qtro/main.cpp
+++ b/examples/interfaceframework/qface-remote/server_qtro/main.cpp
diff --git a/examples/interfaceframework/qface-if-remote/server_qtro/processingservice.cpp b/examples/interfaceframework/qface-remote/server_qtro/processingservice.cpp
index f3cd443f..f3cd443f 100644
--- a/examples/interfaceframework/qface-if-remote/server_qtro/processingservice.cpp
+++ b/examples/interfaceframework/qface-remote/server_qtro/processingservice.cpp
diff --git a/examples/interfaceframework/qface-if-remote/server_qtro/processingservice.h b/examples/interfaceframework/qface-remote/server_qtro/processingservice.h
index 9f68b2eb..9f68b2eb 100644
--- a/examples/interfaceframework/qface-if-remote/server_qtro/processingservice.h
+++ b/examples/interfaceframework/qface-remote/server_qtro/processingservice.h
diff --git a/examples/interfaceframework/qface-if-remote/server_qtro/server_qtro.pro b/examples/interfaceframework/qface-remote/server_qtro/server_qtro.pro
index c89a77ce..a4618e8d 100644
--- a/examples/interfaceframework/qface-if-remote/server_qtro/server_qtro.pro
+++ b/examples/interfaceframework/qface-remote/server_qtro/server_qtro.pro
@@ -1,4 +1,4 @@
-TARGET = qface-if-remote-server
+TARGET = qface-remote-server
#! [0]
TEMPLATE = app
QT -= gui
@@ -16,7 +16,7 @@ SOURCES += main.cpp \
QMAKE_RPATHDIR += $ORIGIN
#! [1]
IFCODEGEN_TEMPLATE = server_qtro
-IFCODEGEN_SOURCES = ../example-if-remote.qface
+IFCODEGEN_SOURCES = ../example-remote.qface
#! [1]
# Additional import path used to resolve QML modules in Qt Creator's code model
QML_IMPORT_PATH =
@@ -36,7 +36,7 @@ DEFINES += QT_DEPRECATED_WARNINGS
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
CONFIG += install_ok # Do not cargo-cult this!
-target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-if-remote-server
+target.path = $$[QT_INSTALL_EXAMPLES]/interfaceframework/qface-remote-server
INSTALLS += target
HEADERS += \
diff --git a/src/interfaceframework/doc/images/examples_qface_tutorial_dbus.gif b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-dbus.gif
index 6b3da504..6b3da504 100644
--- a/src/interfaceframework/doc/images/examples_qface_tutorial_dbus.gif
+++ b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-dbus.gif
Binary files differ
diff --git a/src/interfaceframework/doc/images/examples_qface_tutorial_final.gif b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-final.gif
index e8a833bd..e8a833bd 100644
--- a/src/interfaceframework/doc/images/examples_qface_tutorial_final.gif
+++ b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-final.gif
Binary files differ
diff --git a/src/interfaceframework/doc/images/examples_qface_tutorial_sync.gif b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-sync.gif
index b1dece69..b1dece69 100644
--- a/src/interfaceframework/doc/images/examples_qface_tutorial_sync.gif
+++ b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-sync.gif
Binary files differ
diff --git a/src/interfaceframework/doc/images/examples_qface_tutorial_unsync.gif b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-unsync.gif
index 7157d9e6..7157d9e6 100644
--- a/src/interfaceframework/doc/images/examples_qface_tutorial_unsync.gif
+++ b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial-unsync.gif
Binary files differ
diff --git a/src/interfaceframework/doc/images/examples_qface_tutorial.png b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial.png
index 318cceae..318cceae 100644
--- a/src/interfaceframework/doc/images/examples_qface_tutorial.png
+++ b/examples/interfaceframework/qface-tutorial/doc/images/qface-tutorial.png
Binary files differ
diff --git a/src/interfaceframework/doc/src/examples-qface-tutorial.qdoc b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc
index 38c6435d..f5e8fe21 100644
--- a/src/interfaceframework/doc/src/examples-qface-tutorial.qdoc
+++ b/examples/interfaceframework/qface-tutorial/doc/src/qface-tutorial.qdoc
@@ -31,7 +31,7 @@
\brief Demonstrates step-by-step how to generate a Middleware API based on a QML application.
\ingroup qtinterfaceframework-examples
\title Qt Interface Framework Generator Tutorial
- \image examples_qface_tutorial.png
+ \image qface-tutorial.png
This tutorial demonstrates how you can extend a QML application with your own autogenerated
Middleware API. We use an existing QML Instrument Cluster application and proceed through the
@@ -75,7 +75,7 @@
The ultimate goal is to connect all of these features together to simulate a real-time driving
experience like this:
- \image examples_qface_tutorial_final.gif
+ \image qface-tutorial-final.gif
\target chapter1
\section1 Chapter 1: Basic Middlware API with the Interface Framework Generator
@@ -684,7 +684,7 @@
just by starting the Instrument Cluster twice and checking whether the animations are in sync.
Currently, they're not.
- \image examples_qface_tutorial_unsync.gif
+ \image qface-tutorial-unsync.gif
\section2 Add a QtRemoteObjects Integration
@@ -763,7 +763,7 @@
Let's do the final test: starting two Instrument Cluster instances should now show the
animations in sync:
- \image examples_qface_tutorial_sync.gif
+ \image qface-tutorial-sync.gif
\target chapter6
\section1 Chapter 6: Develop a Production Backend with D-Bus
@@ -888,6 +888,6 @@
Now, when we start the Instrument Cluster, our backend should connect to our D-Bus server and
look like this:
- \image examples_qface_tutorial_dbus.gif
+ \image qface-tutorial-dbus.gif
*/
diff --git a/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc b/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
index 6c815fc5..c3838728 100644
--- a/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
+++ b/src/interfaceframework/doc/src/ifcodegen/ipc-integration.qdoc
@@ -71,6 +71,6 @@ parameters to the plugin and to the server are passed over a config file, either
location or at a user-specified path.
For a steb-by-step introduction to remote backends, see
-\l {interfaceframework/qface-if-remote}{Generate QtRemoteObjects based backends with the Qt Interface Framework Generator}.
+\l {interfaceframework/qface-remote}{Generate QtRemoteObjects based backends with the Qt Interface Framework Generator}.
*/