QML/JS: Fix terminology in messages

- Replace Qt Quick Designer with Qt Design Studio
- Replace "Qt Quick UI form" with "UI file (.ui.qml)"

Also fix the docs:

- Add missing messages
- Hide QDS  messages from Qt Creator Manual
- Make punctuation consistent
- Add some links to more information

Task-number: QDS-2670
Task-number: QTCREATORBUG-27055
Change-Id: Id90f1ad82e7297f91225bc8d650a9578ba071330
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2022-02-15 11:54:57 +01:00
parent 1f3e6b4c7a
commit d487110351
3 changed files with 76 additions and 38 deletions

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -291,7 +291,7 @@
\row \row
\li M106 \li M106
\li Warning \li Warning
\li \c Name is already a var \li \c Name already is a var
\li \li
\row \row
@@ -416,6 +416,12 @@
\li A state cannot have the specified child item \li A state cannot have the specified child item
\li \li
\row
\li M129
\li Error
\li Type cannot be instantiated recursively
\li
\row \row
\li M201 \li M201
\li Hint \li Hint
@@ -430,6 +436,7 @@
\li Use only one statement per line \li Use only one statement per line
\li \li
\if defined(qtdesignstudio)
\row \row
\li M203 \li M203
\li Warning \li Warning
@@ -463,60 +470,70 @@
\row \row
\li M208 \li M208
\li Error \li Error
\li This id might be ambiguous and is not supported in \QDS. \li This id might be ambiguous and is not supported in \QDS
\li \li
\row \row
\li M209 \li M209
\li Error \li Error
\li This type (type name) is not supported as a root element in \li This type (type name) is not supported as a root element in
\QDS. \QDS
\li \li
\endif
\row \row
\li M220 \li M220
\li Error \li Error
\li This type (type name) is not supported as a root element of a \li This type (type name) is not supported as a root element of a
UI file (.ui.qml). UI file (.ui.qml)
\li \li For more information about supported QML types, see \l{UI Files}.
\row \row
\li M221 \li M221
\li Error \li Error
\li This type (type name) is not supported in a UI file (.ui.qml). \li This type (type name) is not supported in a UI file (.ui.qml)
\li \li For more information about supported QML types, see \l{UI Files}.
\row \row
\li M222 \li M222
\li Error \li Error
\li Functions are not supported in a UI file (.ui.qml). \li Functions are not supported in a UI file (.ui.qml)
\li For a list of supported JavaScript functions, see \li For a list of supported JavaScript functions, see
\l{Supported Methods}. \l{Supported Methods}.
\row \row
\li M223 \li M223
\li Error \li Error
\li Java Script blocks are not supported in a UI file (.ui.qml). \li JavaScript blocks are not supported in a UI file (.ui.qml)
\li \li For more information about supported features, see \l{UI Files}.
\row \row
\li M224 \li M224
\li Error \li Error
\li Behavior type is not supported in a UI file (.ui.qml). \li Behavior type is not supported in a UI file (.ui.qml)
\li \li For more information about supported QML types, see \l{UI Files}.
\row \row
\li M225 \li M225
\li Error \li Error
\li States are only supported in the root item in a UI file (.ui.qml). \li States are only supported in the root item in a UI file (.ui.qml)
\li \li For more information about supported features, see \l{UI Files}.
\row \row
\li M226 \li M226
\li Error \li Error
\li Referencing the parent of the root item is not supported in a \li Referencing the parent of the root item is not supported in a
UI file (.ui.qml). UI file (.ui.qml)
\li \li For more information about supported features, see \l{UI Files}.
\row
\li M227
\li Error
\li Do not mix translation functions in a UI file (.ui.qml)
\li Even though several different translation functions, such as
\c qsTr and \c qsTrId are supported, you should pick one and
use it consistently within a UI file. For more information,
see \l{Qt QML Methods}.
\row \row
\li M300 \li M300
@@ -674,11 +691,30 @@
and most likely invalid and most likely invalid
\li \li
\row
\li M325
\li Warning
\li Logical value does not depend on actual values
\li
\row
\li M326
\li Error
\li Components are only allowed to have a single child element
\li For more information, see \l [QML] {Component}.
\row
\li M327
\li Warning
\li Components require a child element
\li For more information, see \l [QML] {Component}.
\row \row
\li M400 \li M400
\li Warning \li Warning
\li Duplicate import \li Duplicate import
\li \li An import statement has been added twice. For more information,
see \l{Import Statements}.
\endtable \endtable

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2021 The Qt Company Ltd. ** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -52,6 +52,7 @@
be edited in \QDS only. be edited in \QDS only.
\endif \endif
The following features are not supported in .ui.qml files: The following features are not supported in .ui.qml files:
\list \list
@@ -61,6 +62,7 @@
\li States in other components than the root component \li States in other components than the root component
\li Root components that are not derived from \l QQuickItem or \li Root components that are not derived from \l QQuickItem or
\l [QML]{Item} \l [QML]{Item}
\li Referencing the parent of the root component
\endlist \endlist
The following components are not supported: The following components are not supported:
@@ -69,11 +71,9 @@
\li Behavior \li Behavior
\li Binding \li Binding
\li Canvas \li Canvas
\li Component
\li Shader Effect \li Shader Effect
\li Timer \li Timer
\li Transform \li Transform
\li Transition
\endlist \endlist
\section1 Supported Methods \section1 Supported Methods
@@ -165,6 +165,8 @@
\li \l{Qt::}{qsTrNoOp()} \li \l{Qt::}{qsTrNoOp()}
\endlist \endlist
\note Do not mix translation methods in a UI file.
For more information about using the methods, see For more information about using the methods, see
\l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}. \l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}.

View File

@@ -71,7 +71,7 @@ static inline QString msgInvalidConstructor(const char *what)
StaticAnalysisMessages::StaticAnalysisMessages() StaticAnalysisMessages::StaticAnalysisMessages()
{ {
// When changing a message or severity, update the documentation, currently // When changing a message or severity, update the documentation, currently
// in creator-editors.qdoc, accordingly. // in creator-code-syntax.qdoc, accordingly.
newMsg(ErrInvalidEnumValue, Error, newMsg(ErrInvalidEnumValue, Error,
tr("Invalid value for enum.")); tr("Invalid value for enum."));
newMsg(ErrEnumValueMustBeStringOrNumber, Error, newMsg(ErrEnumValueMustBeStringOrNumber, Error,
@@ -211,36 +211,36 @@ StaticAnalysisMessages::StaticAnalysisMessages()
newMsg(ErrInvalidArrayValueLength, Error, newMsg(ErrInvalidArrayValueLength, Error,
tr("%1 elements expected in array value."), 1); tr("%1 elements expected in array value."), 1);
newMsg(WarnImperativeCodeNotEditableInVisualDesigner, Warning, newMsg(WarnImperativeCodeNotEditableInVisualDesigner, Warning,
tr("Imperative code is not supported in the Qt Quick Designer.")); tr("Imperative code is not supported in Qt Design Studio."));
newMsg(WarnUnsupportedTypeInVisualDesigner, Warning, newMsg(WarnUnsupportedTypeInVisualDesigner, Warning,
tr("This type (%1) is not supported in the Qt Quick Designer."), 1); tr("This type (%1) is not supported in Qt Design Studio."), 1);
newMsg(WarnReferenceToParentItemNotSupportedByVisualDesigner, Warning, newMsg(WarnReferenceToParentItemNotSupportedByVisualDesigner, Warning,
tr("Reference to parent item cannot be resolved correctly by the Qt Quick Designer.")); tr("Reference to parent item cannot be resolved correctly by Qt Design Studio."));
newMsg(WarnUndefinedValueForVisualDesigner, Warning, newMsg(WarnUndefinedValueForVisualDesigner, Warning,
tr("This visual property binding cannot be evaluated in the local context " tr("This visual property binding cannot be evaluated in the local context "
"and might not show up in Qt Quick Designer as expected.")); "and might not show up in Qt Design Studio as expected."));
newMsg(WarnStatesOnlyInRootItemForVisualDesigner, Warning, newMsg(WarnStatesOnlyInRootItemForVisualDesigner, Warning,
tr("Qt Quick Designer only supports states in the root item.")); tr("Qt Design Studio only supports states in the root item."));
newMsg(ErrInvalidIdeInVisualDesigner, Error, newMsg(ErrInvalidIdeInVisualDesigner, Error,
tr("This id might be ambiguous and is not supported in the Qt Quick Designer.")); tr("This id might be ambiguous and is not supported in Qt Design Studio."));
newMsg(ErrUnsupportedRootTypeInVisualDesigner, Error, newMsg(ErrUnsupportedRootTypeInVisualDesigner, Error,
tr("This type (%1) is not supported as a root element by Qt Quick Designer."), 1); tr("This type (%1) is not supported as a root element by Qt Design Studio."), 1);
newMsg(ErrUnsupportedRootTypeInQmlUi, Error, newMsg(ErrUnsupportedRootTypeInQmlUi, Error,
tr("This type (%1) is not supported as a root element of a Qt Quick UI form."), 1); tr("This type (%1) is not supported as a root element of a UI file (.ui.qml)."), 1);
newMsg(ErrUnsupportedTypeInQmlUi, Error, newMsg(ErrUnsupportedTypeInQmlUi, Error,
tr("This type (%1) is not supported in a Qt Quick UI form."), 1); tr("This type (%1) is not supported in a UI file (.ui.qml)."), 1);
newMsg(ErrFunctionsNotSupportedInQmlUi, Error, newMsg(ErrFunctionsNotSupportedInQmlUi, Error,
tr("Functions are not supported in a Qt Quick UI form.")); tr("Functions are not supported in a UI file (.ui.qml)."));
newMsg(ErrBlocksNotSupportedInQmlUi, Error, newMsg(ErrBlocksNotSupportedInQmlUi, Error,
tr("JavaScript blocks are not supported in a Qt Quick UI form.")); tr("JavaScript blocks are not supported in a UI file (.ui.qml)."));
newMsg(ErrBehavioursNotSupportedInQmlUi, Error, newMsg(ErrBehavioursNotSupportedInQmlUi, Error,
tr("Behavior type is not supported in a Qt Quick UI form.")); tr("Behavior type is not supported in a UI file (.ui.qml)."));
newMsg(ErrStatesOnlyInRootItemInQmlUi, Error, newMsg(ErrStatesOnlyInRootItemInQmlUi, Error,
tr("States are only supported in the root item in a Qt Quick UI form.")); tr("States are only supported in the root item in a UI file (.ui.qml)."));
newMsg(ErrReferenceToParentItemNotSupportedInQmlUi, Error, newMsg(ErrReferenceToParentItemNotSupportedInQmlUi, Error,
tr("Referencing the parent of the root item is not supported in a Qt Quick UI form.")); tr("Referencing the parent of the root item is not supported in a UI file (.ui.qml)."));
newMsg(ErrDoNotMixTranslationFunctionsInQmlUi, Error, newMsg(ErrDoNotMixTranslationFunctionsInQmlUi, Error,
tr("Do not mix translation functions in a Qt Quick UI form.")); tr("Do not mix translation functions in a UI file (.ui.qml)."));
newMsg(StateCannotHaveChildItem, Error, newMsg(StateCannotHaveChildItem, Error,
tr("A State cannot have a child item (%1)."), 1); tr("A State cannot have a child item (%1)."), 1);
newMsg(WarnDuplicateImport, Warning, newMsg(WarnDuplicateImport, Warning,
@@ -250,7 +250,7 @@ StaticAnalysisMessages::StaticAnalysisMessages()
newMsg(ErrTypeIsInstantiatedRecursively, Error, newMsg(ErrTypeIsInstantiatedRecursively, Error,
tr("Type cannot be instantiated recursively (%1)."), 1); tr("Type cannot be instantiated recursively (%1)."), 1);
newMsg(WarnLogicalValueDoesNotDependOnValues, Warning, newMsg(WarnLogicalValueDoesNotDependOnValues, Warning,
tr("Logical value does not depend on actual values")); tr("Logical value does not depend on actual values."));
newMsg(ErrToManyComponentChildren, Error, newMsg(ErrToManyComponentChildren, Error,
tr("Components are only allowed to have a single child element.")); tr("Components are only allowed to have a single child element."));
newMsg(WarnComponentRequiresChildren, Warning, newMsg(WarnComponentRequiresChildren, Warning,