QmlDesigner: Improve error message for invalid id

* Move the message into single place
* Improve the warning

Task-number: QDS-12195
Change-Id: I70ca89f39cf04b937336936015b2ccbf7deb98c5
Reviewed-by: Marco Bubke <marco.bubke@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>

8 files changed, 60 insertions, 10 deletions

diff --git a/src/plugins/qmldesigner/CMakeLists.txt b/src/plugins/qmldesigner/CMakeLists.txt
index ae954872d9..01f03cc271 100644
--- a/src/plugins/qmldesigner/CMakeLists.txt
+++ b/src/plugins/qmldesigner/CMakeLists.txt
@@ -634,6 +634,7 @@ extend_qtc_plugin(QmlDesigner
     svgpasteaction.cpp svgpasteaction.h
     viewmanager.cpp viewmanager.h
     utils3d.cpp utils3d.h
+    dialogutils.cpp dialogutils.h
 )
 
 extend_qtc_plugin(QmlDesigner
diff --git a/src/plugins/qmldesigner/components/componentcore/dialogutils.cpp b/src/plugins/qmldesigner/components/componentcore/dialogutils.cpp
new file mode 100644
index 0000000000..f882ae528d
--- /dev/null
+++ b/src/plugins/qmldesigner/components/componentcore/dialogutils.cpp
@@ -0,0 +1,32 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+#include <model.h>
+
+#include <coreplugin/messagebox.h>
+
+namespace QmlDesigner {
+
+namespace DialogUtils {
+
+void showWarningForInvalidId(const QString &id)
+{
+    constexpr char text[] = R"(
+The ID <b>'%1'</b> is invalid.
+
+Make sure the ID is:
+<ul>
+<li>Unique within the QML file.</li>
+<li>Beginning with a lowercase letter.</li>
+<li>Without any blank space or symbol.</li>
+<li>Not a reserved QML keyword. </li>
+</ul>
+)";
+
+    Core::AsynchronousMessageBox::warning(Model::tr("Invalid Id"),
+                                          Model::tr(text).arg(id));
+}
+
+} // namespace DialogUtils
+
+} //QmlDesigner
diff --git a/src/plugins/qmldesigner/components/componentcore/dialogutils.h b/src/plugins/qmldesigner/components/componentcore/dialogutils.h
new file mode 100644
index 0000000000..3ca98016dd
--- /dev/null
+++ b/src/plugins/qmldesigner/components/componentcore/dialogutils.h
@@ -0,0 +1,17 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+#pragma once
+
+#include <qmldesignercomponents_global.h>
+
+#include <QString>
+
+namespace QmlDesigner {
+
+namespace DialogUtils {
+
+QMLDESIGNERCOMPONENTS_EXPORT void showWarningForInvalidId(const QString &id);
+
+} // namespace DialogUtils
+} //QmlDesigner
diff --git a/src/plugins/qmldesigner/components/navigator/nameitemdelegate.cpp b/src/plugins/qmldesigner/components/navigator/nameitemdelegate.cpp
index aacaf6dc0d..223e04fd96 100644
--- a/src/plugins/qmldesigner/components/navigator/nameitemdelegate.cpp
+++ b/src/plugins/qmldesigner/components/navigator/nameitemdelegate.cpp
@@ -9,9 +9,8 @@
 #include "navigatortreeview.h"
 #include "navigatorwidget.h"
 #include "choosefrompropertylistdialog.h"
-#include "qproxystyle.h"
-
 #include <model/modelutils.h>
+#include <dialogutils.h>
 #include <modelnodecontextmenu.h>
 #include <theme.h>
 #include <qmldesignerconstants.h>
@@ -169,8 +168,7 @@ static void setId(const QModelIndex &index, const QString &newId)
         return;
 
     if (!ModelNode::isValidId(newId)) {
-        Core::AsynchronousMessageBox::warning(NavigatorTreeView::tr("Invalid Id"),
-                                              NavigatorTreeView::tr("%1 is an invalid id.").arg(newId));
+        DialogUtils::showWarningForInvalidId(newId);
     } else if (modelNode.view()->hasId(newId)) {
         Core::AsynchronousMessageBox::warning(NavigatorTreeView::tr("Invalid Id"),
                                               NavigatorTreeView::tr("%1 already exists.").arg(newId));
diff --git a/src/plugins/qmldesigner/components/timelineeditor/timelineanimationform.cpp b/src/plugins/qmldesigner/components/timelineeditor/timelineanimationform.cpp
index 83551378ee..e65c05c39f 100644
--- a/src/plugins/qmldesigner/components/timelineeditor/timelineanimationform.cpp
+++ b/src/plugins/qmldesigner/components/timelineeditor/timelineanimationform.cpp
@@ -13,6 +13,7 @@
 #include <variantproperty.h>
 #include <qmlitemnode.h>
 #include <qmlobjectnode.h>
+#include <dialogutils.h>
 
 #include <coreplugin/messagebox.h>
 
@@ -141,8 +142,7 @@ TimelineAnimationForm::TimelineAnimationForm(QWidget *parent)
         bool error = false;
 
         if (!ModelNode::isValidId(newId)) {
-            Core::AsynchronousMessageBox::warning(tr("Invalid Id"),
-                                                  tr("%1 is an invalid id.").arg(newId));
+            DialogUtils::showWarningForInvalidId(newId);
             error = true;
         } else if (animation().view()->hasId(newId)) {
             Core::AsynchronousMessageBox::warning(tr("Invalid Id"),
diff --git a/src/plugins/qmldesigner/components/timelineeditor/timelineform.cpp b/src/plugins/qmldesigner/components/timelineeditor/timelineform.cpp
index b3d408dc0d..08915b6577 100644
--- a/src/plugins/qmldesigner/components/timelineeditor/timelineform.cpp
+++ b/src/plugins/qmldesigner/components/timelineeditor/timelineform.cpp
@@ -10,6 +10,7 @@
 #include <nodemetainfo.h>
 #include <rewritertransaction.h>
 #include <variantproperty.h>
+#include <dialogutils.h>
 
 #include <coreplugin/messagebox.h>
 
@@ -125,8 +126,7 @@ TimelineForm::TimelineForm(QWidget *parent)
         bool error = false;
 
         if (!ModelNode::isValidId(newId)) {
-            Core::AsynchronousMessageBox::warning(tr("Invalid Id"),
-                                                  tr("%1 is an invalid id.").arg(newId));
+            DialogUtils::showWarningForInvalidId(newId);
             error = true;
         } else if (m_timeline.view()->hasId(newId)) {
             Core::AsynchronousMessageBox::warning(tr("Invalid Id"),
diff --git a/src/plugins/qmldesigner/components/transitioneditor/transitionform.cpp b/src/plugins/qmldesigner/components/transitioneditor/transitionform.cpp
index 1770ba63fc..dcbb0b23b3 100644
--- a/src/plugins/qmldesigner/components/transitioneditor/transitionform.cpp
+++ b/src/plugins/qmldesigner/components/transitioneditor/transitionform.cpp
@@ -13,6 +13,7 @@
 #include <rewritertransaction.h>
 #include <variantproperty.h>
 #include <qmlitemnode.h>
+#include <dialogutils.h>
 
 #include <coreplugin/messagebox.h>
 
@@ -45,8 +46,7 @@ TransitionForm::TransitionForm(QWidget *parent)
         bool error = false;
 
         if (!ModelNode::isValidId(newId)) {
-            Core::AsynchronousMessageBox::warning(tr("Invalid ID"),
-                                                  tr("%1 is an invalid ID.").arg(newId));
+            DialogUtils::showWarningForInvalidId(newId);
             error = true;
         } else if (m_transition.view()->hasId(newId)) {
             Core::AsynchronousMessageBox::warning(tr("Invalid ID"),
diff --git a/src/plugins/qmldesigner/designercore/model/modelutils.cpp b/src/plugins/qmldesigner/designercore/model/modelutils.cpp
index cb3f482289..3dd7fe6c32 100644
--- a/src/plugins/qmldesigner/designercore/model/modelutils.cpp
+++ b/src/plugins/qmldesigner/designercore/model/modelutils.cpp
@@ -9,6 +9,8 @@
 #include <projectstorage/projectstorage.h>
 #include <projectstorage/sourcepathcache.h>
 
+#include <coreplugin/messagebox.h>
+
 #include <utils/expected.h>
 #include <utils/ranges.h>