From 1c59558b03715c6be46650489547c5f9d60d3464 Mon Sep 17 00:00:00 2001
From: Fabian Kosmale <fabian.kosmale@qt.io>
Date: Mon, 5 Aug 2019 16:03:58 +0200
Subject: Introduce functions to set properties during creation

Change-Id: Idd4c8ab9e34b9bc3e00f21d7cf1e4f1a70586e7f
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
---
 src/qml/qml/qqmlcomponent.cpp | 74 +++++++++++++++++++++++++++++++++++++------
 1 file changed, 65 insertions(+), 9 deletions(-)

(limited to 'src/qml/qml/qqmlcomponent.cpp')

diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp
index fefe2bc685..ed8c41a582 100644
--- a/src/qml/qml/qqmlcomponent.cpp
+++ b/src/qml/qml/qqmlcomponent.cpp
@@ -350,6 +350,32 @@ void QQmlComponentPrivate::clear()
     compilationUnit = nullptr;
 }
 
+QObject *QQmlComponentPrivate::doBeginCreate(QQmlComponent *q, QQmlContext *context)
+{
+    if (!engine) {
+        // ###Qt6: In Qt 6, it should be impossible for users to create a QQmlComponent without an engine, and we can remove this check
+        qWarning("QQmlComponent: Must provide an engine before calling create");
+        return nullptr;
+    }
+    if (!context)
+        context = engine->rootContext();
+    return q->beginCreate(context);
+}
+
+bool QQmlComponentPrivate::setInitialProperty(QObject *component, const QString& name, const QVariant &value)
+{
+    QQmlProperty prop(component, name);
+    auto privProp = QQmlPropertyPrivate::get(prop);
+    if (!prop.isValid() || !privProp->writeValueProperty(value, nullptr)) {
+        QQmlError error{};
+        error.setUrl(url);
+        error.setDescription(QLatin1String("Could not set property %1").arg(name));
+        state.errors.push_back(error);
+        return false;
+    } else
+        return true;
+}
+
 /*!
     \internal
 */
@@ -780,18 +806,28 @@ QObject *QQmlComponent::create(QQmlContext *context)
 {
     Q_D(QQmlComponent);
 
-    if (!d->engine) {
-        // ###Qt6: In Qt 6, it should be impossible for users to create a QQmlComponent without an engine, and we can remove this check
-        qWarning("QQmlComponent: Must provide an engine before calling create");
-        return nullptr;
-    }
+    QObject *rv = d->doBeginCreate(this, context);
+    if (rv)
+        completeCreate();
+    return rv;
+}
 
-    if (!context)
-        context = d->engine->rootContext();
+/*!
+    Create an object instance of this component, and initialize its toplevel properties according to initalPropertyValues.
 
-    QObject *rv = beginCreate(context);
-    if (rv)
+
+    \sa QQmlComponent::create
+    \since 5.14
+*/
+QObject *QQmlComponent::createWithInitialProperties(const QVariantMap& initialProperties, QQmlContext *context)
+{
+    Q_D(QQmlComponent);
+
+    QObject *rv = d->doBeginCreate(this, context);
+    if (rv) {
+        setInitialProperties(rv, initialProperties);
         completeCreate();
+    }
     return rv;
 }
 
@@ -1067,6 +1103,26 @@ void QQmlComponent::create(QQmlIncubator &incubator, QQmlContext *context,
     enginePriv->incubate(incubator, forContextData);
 }
 
+/*!
+   Set toplevel properties of the component.
+
+
+   This method provides advanced control over component instance creation.
+   In general, programmers should use
+   \l QQmlComponent::createWithInitialProperties to create a component.
+
+   Use this method after beginCreate and before completeCreate has been called.
+   If a provided property does not exist, a warning is issued.
+
+   \since 5.14
+*/
+void QQmlComponent::setInitialProperties(QObject *component, const QVariantMap &properties)
+{
+    Q_D(QQmlComponent);
+    for (auto it = properties.constBegin(); it != properties.constEnd(); ++it)
+        d->setInitialProperty(component, it.key(), it.value());
+}
+
 /*
     This is essentially a copy of QQmlComponent::create(); except it takes the QQmlContextData
     arguments instead of QQmlContext which means we don't have to construct the rather weighty
-- 
cgit v1.2.3