From c27554068efe63d2093d6a28cc83cb95190003a2 Mon Sep 17 00:00:00 2001
From: Simon Hausmann <simon.hausmann@qt.io>
Date: Tue, 9 Jul 2019 09:12:01 +0200
Subject: Fix docs to explain the new type syntax for QML methods

[ChangeLog][QtQml] It is now possible to specify types for method
parameters and their return value in QML (basic and object types), using
TypeScript-like syntax with a colon separator. The syntax for QML
declared signals supports the same style.

This change also adapts the remaining snippets and docs to the "fresher"
qml signal parameter syntax.

Change-Id: I601781f01f696276951b04785584adab39fedfd9
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
---
 src/qml/doc/snippets/qml/events.qml                         |  8 ++++----
 src/qml/doc/snippets/qml/qtbinding/functions-qml/MyItem.qml |  2 +-
 src/qml/doc/snippets/qml/qtbinding/functions-qml/main.cpp   | 10 +++++-----
 src/qml/doc/snippets/qml/qtbinding/signals-qml/MyItem.qml   |  2 +-
 src/qml/doc/snippets/qml/statemachine/guardcondition.qml    |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'src/qml/doc/snippets')

diff --git a/src/qml/doc/snippets/qml/events.qml b/src/qml/doc/snippets/qml/events.qml
index 90bf5d7b3d..f437e32890 100644
--- a/src/qml/doc/snippets/qml/events.qml
+++ b/src/qml/doc/snippets/qml/events.qml
@@ -59,8 +59,8 @@ Rectangle {
 
 //! [signal declaration]
     signal trigger
-    signal send (string notice)
-    signal perform (string task, variant object)
+    signal send(notice: string)
+    signal perform(task: string, object: variant)
 //! [signal declaration]
 
 //! [signal handler declaration]
@@ -88,7 +88,7 @@ Rectangle {
 Rectangle {
     id: messenger
 
-    signal send( string person, string notice)
+    signal send(person: string, notice: string)
 
     onSend: {
         console.log("For " + person + ", the notice is: " + notice)
@@ -102,7 +102,7 @@ Rectangle {
 Rectangle {
     id: relay
 
-    signal send( string person, string notice)
+    signal send(person: string, notice: string)
     onSend: console.log("Send signal to: " + person + ", " + notice)
 
     Component.onCompleted: {
diff --git a/src/qml/doc/snippets/qml/qtbinding/functions-qml/MyItem.qml b/src/qml/doc/snippets/qml/qtbinding/functions-qml/MyItem.qml
index 073a5dc361..59907c38e7 100644
--- a/src/qml/doc/snippets/qml/qtbinding/functions-qml/MyItem.qml
+++ b/src/qml/doc/snippets/qml/qtbinding/functions-qml/MyItem.qml
@@ -52,7 +52,7 @@
 import QtQuick 2.0
 
 Item {
-    function myQmlFunction(msg) {
+    function myQmlFunction(msg: string) : string {
         console.log("Got message:", msg)
         return "some return value"
     }
diff --git a/src/qml/doc/snippets/qml/qtbinding/functions-qml/main.cpp b/src/qml/doc/snippets/qml/qtbinding/functions-qml/main.cpp
index c82f71f749..a562eae2b4 100644
--- a/src/qml/doc/snippets/qml/qtbinding/functions-qml/main.cpp
+++ b/src/qml/doc/snippets/qml/qtbinding/functions-qml/main.cpp
@@ -60,13 +60,13 @@ QQmlEngine engine;
 QQmlComponent component(&engine, "MyItem.qml");
 QObject *object = component.create();
 
-QVariant returnedValue;
-QVariant msg = "Hello from C++";
+QString returnedValue;
+QString msg = "Hello from C++";
 QMetaObject::invokeMethod(object, "myQmlFunction",
-        Q_RETURN_ARG(QVariant, returnedValue),
-        Q_ARG(QVariant, msg));
+        Q_RETURN_ARG(QString, returnedValue),
+        Q_ARG(QString, msg));
 
-qDebug() << "QML function returned:" << returnedValue.toString();
+qDebug() << "QML function returned:" << returnedValue;
 delete object;
 //![0]
 }
diff --git a/src/qml/doc/snippets/qml/qtbinding/signals-qml/MyItem.qml b/src/qml/doc/snippets/qml/qtbinding/signals-qml/MyItem.qml
index eebf2db832..aadc89b72c 100644
--- a/src/qml/doc/snippets/qml/qtbinding/signals-qml/MyItem.qml
+++ b/src/qml/doc/snippets/qml/qtbinding/signals-qml/MyItem.qml
@@ -55,7 +55,7 @@ Item {
     id: item
     width: 100; height: 100
 
-    signal qmlSignal(string msg)
+    signal qmlSignal(msg: string)
 
     MouseArea {
         anchors.fill: parent
diff --git a/src/qml/doc/snippets/qml/statemachine/guardcondition.qml b/src/qml/doc/snippets/qml/statemachine/guardcondition.qml
index 8388b96c21..f1ec89b6ba 100644
--- a/src/qml/doc/snippets/qml/statemachine/guardcondition.qml
+++ b/src/qml/doc/snippets/qml/statemachine/guardcondition.qml
@@ -70,7 +70,7 @@ Rectangle {
             }
         }
         // define the signal the SignalTransition is connected with
-        signal mysignal(string mystr)
+        signal mysignal(mystr: string)
         // on clicking the button emit the signal with a single string argument
         onClicked: button.mysignal("test")
     }
-- 
cgit v1.2.3