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>

1 files changed, 303 insertions, 0 deletions

diff --git a/examples/ifvehiclefunctions/climate-qml/main.qml b/examples/ifvehiclefunctions/climate-qml/main.qml
new file mode 100644
index 00000000..009794b9
--- /dev/null
+++ b/examples/ifvehiclefunctions/climate-qml/main.qml
@@ -0,0 +1,303 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Copyright (C) 2019 Luxoft Sweden AB
+** Copyright (C) 2018 Pelagicore AG
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtInterfaceFramework module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick
+import QtQuick.Controls
+import QtQuick.Window
+import QtQuick.Layouts
+
+import QtInterfaceFramework.VehicleFunctions
+
+ApplicationWindow {
+    title: "Climate Control"
+    width: 384
+    height: 324
+    visible: true
+
+    //![1]
+    ClimateControl {
+        id: climateControl
+        discoveryMode: ClimateControl.LoadOnlySimulationBackends
+    }
+    //![1]
+
+    ColumnLayout {
+        anchors.fill: parent
+        anchors.margins: 10
+
+        //![2]
+        GroupBox {
+            title: "Air Flow Direction"
+
+            ColumnLayout {
+                anchors.fill: parent
+                CheckBox {
+                    text: "Windshield"
+                    checked: climateControl.airflowDirections & ClimateControl.Windshield
+                    onClicked: {
+                        if (checked)
+                            climateControl.airflowDirections |= ClimateControl.Windshield
+                        else
+                            climateControl.airflowDirections &= ~ClimateControl.Windshield
+                    }
+                }
+
+                CheckBox {
+                    text: "Dashboard"
+                    checked: climateControl.airflowDirections & ClimateControl.Dashboard
+                    onClicked: {
+                        if (checked)
+                            climateControl.airflowDirections |= ClimateControl.Dashboard
+                        else
+                            climateControl.airflowDirections &= ~ClimateControl.Dashboard
+                    }
+                }
+
+                CheckBox {
+                    text: "Floor"
+                    checked: climateControl.airflowDirections & ClimateControl.Floor
+                    onClicked: {
+                        if (checked)
+                            climateControl.airflowDirections |= ClimateControl.Floor
+                        else
+                            climateControl.airflowDirections &= ~ClimateControl.Floor
+                    }
+                }
+            }
+        }
+
+        CheckBox {
+            text: "Air Condition"
+            checked: climateControl.airConditioningEnabled
+            onClicked: {
+                    climateControl.airConditioningEnabled = checked
+            }
+        }
+
+        CheckBox {
+            text: "Heater"
+            checked: climateControl.heaterEnabled
+            onClicked: {
+                    climateControl.heaterEnabled = checked
+            }
+        }
+
+        CheckBox {
+            text: "Air Recirculation"
+            checked: climateControl.recirculationMode === ClimateControl.RecirculationOn
+            onClicked: {
+                if (checked)
+                    climateControl.recirculationMode = ClimateControl.RecirculationOn
+                else
+                    climateControl.recirculationMode = ClimateControl.RecirculationOff
+            }
+        }
+
+        ColumnLayout {
+            RowLayout {
+
+                Label {
+                    text: "Fan Speed"
+                }
+
+                SpinBox {
+                    value: climateControl.fanSpeedLevel
+                    onValueChanged: {
+                        climateControl.fanSpeedLevel = value
+                    }
+                }
+            }
+
+
+            RowLayout {
+
+                Label {
+                    text: "Steering Wheel Heater"
+                }
+
+                SpinBox {
+                    value: climateControl.steeringWheelHeater
+                    onValueChanged: {
+                        climateControl.steeringWheelHeater = value
+                    }
+                }
+            }
+        }
+        //![2]
+        Row {
+            //![3]
+            GroupBox {
+                title: "Front Left Zone"
+
+                ColumnLayout {
+                    RowLayout {
+
+                        Label {
+                            text: "Temperature"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.FrontLeft.targetTemperature
+                            onValueChanged: {
+                                climateControl.zoneAt.FrontLeft.targetTemperature = value
+                            }
+                        }
+                    }
+
+
+                    RowLayout {
+
+                        Label {
+                            text: "Seat Heater"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.FrontLeft.seatHeater
+                            onValueChanged: {
+                                climateControl.zoneAt.FrontLeft.seatHeater = value
+                            }
+                        }
+                    }
+                }
+            }
+
+            GroupBox {
+                title: "Front Right Zone"
+
+                ColumnLayout {
+                    RowLayout {
+
+                        Label {
+                            text: "Temperature"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.FrontRight.targetTemperature
+                            onValueChanged: {
+                                climateControl.zoneAt.FrontRight.targetTemperature = value
+                            }
+                        }
+                    }
+
+
+                    RowLayout {
+
+                        Label {
+                            text: "Seat Heater"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.FrontRight.seatHeater
+                            onValueChanged: {
+                                climateControl.zoneAt.FrontRight.seatHeater = value
+                            }
+                        }
+                    }
+                }
+            }
+
+            GroupBox {
+                title: "Rear Zone"
+
+                ColumnLayout {
+                    RowLayout {
+
+                        Label {
+                            text: "Temperature"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.Rear.targetTemperature
+                            onValueChanged: {
+                                climateControl.zoneAt.Rear.targetTemperature = value
+                            }
+                        }
+                    }
+
+
+                    RowLayout {
+
+                        Label {
+                            text: "Seat Heater"
+                        }
+
+                        SpinBox {
+                            value: climateControl.zoneAt.Rear.seatHeater
+                            onValueChanged: {
+                                climateControl.zoneAt.Rear.seatHeater = value
+                            }
+                        }
+                    }
+                }
+            }
+            //![3]
+        }
+    }
+
+    Dialog {
+        id: messageDialog
+        anchors.centerIn: parent
+        title: "Auto Discovery Failed !"
+        standardButtons: Dialog.Ok
+
+        Label {
+            text: "No Climate Backend available"
+        }
+    }
+
+    //![4]
+    Component.onCompleted: {
+        if (!climateControl.isValid)
+            messageDialog.open()
+    }
+    //![4]
+}