diff --git a/.gitignore b/.gitignore
index cd50124a7d9..910094d9450 100644
--- a/.gitignore
+++ b/.gitignore
@@ -157,7 +157,6 @@ tmp/
/bin/cplusplus-mkvisitor
/bin/cplusplus-update-frontend
/bin/qbs*
-/bin/qml2puppet
/bin/qmlpuppet
/bin/qtcreator
/bin/qtcreator_crash_handler
diff --git a/cmake/QtCreatorAPI.cmake b/cmake/QtCreatorAPI.cmake
index e213eb73ce0..4dea5d3a24e 100644
--- a/cmake/QtCreatorAPI.cmake
+++ b/cmake/QtCreatorAPI.cmake
@@ -325,7 +325,6 @@ function(add_qtc_library name)
endif()
get_target_property(have_automoc_prop ${name} AUTOMOC)
- # check for Qt 6 is needed because sdktool & qml2puppet still build with Qt 5
if(Qt6_VERSION AND "${have_automoc_prop}")
qt_extract_metatypes(${name})
endif()
diff --git a/cmake/QtCreatorIDEBranding.cmake b/cmake/QtCreatorIDEBranding.cmake
index d4a65cc6061..ee4c6460851 100644
--- a/cmake/QtCreatorIDEBranding.cmake
+++ b/cmake/QtCreatorIDEBranding.cmake
@@ -8,7 +8,8 @@ set(IDE_ID "qtcreator") # The IDE id (no spaces, l
set(IDE_CASED_ID "QtCreator") # The cased IDE id (no spaces!)
set(IDE_BUNDLE_IDENTIFIER "org.qt-project.${IDE_ID}") # The macOS application bundle identifier.
set(IDE_APP_ID "org.qt-project.${IDE_ID}") # The free desktop application identifier.
-set(IDE_AUTHOR "The Qt Company Ltd. and other contributors.")
+set(IDE_PUBLISHER "The Qt Company Ltd.")
+set(IDE_AUTHOR "${IDE_PUBLISHER} and other contributors.")
set(IDE_COPYRIGHT "Copyright (C) ${IDE_AUTHOR}")
set(PROJECT_USER_FILE_EXTENSION .user)
diff --git a/dist/branding/qtdesignstudio/QtCreatorIDEBranding.cmake b/dist/branding/qtdesignstudio/QtCreatorIDEBranding.cmake
index 2e889d88be1..18b781decac 100644
--- a/dist/branding/qtdesignstudio/QtCreatorIDEBranding.cmake
+++ b/dist/branding/qtdesignstudio/QtCreatorIDEBranding.cmake
@@ -9,7 +9,8 @@ set(IDE_ID "qtdesignstudio") # The IDE id (no spaces, l
set(IDE_CASED_ID "QtDesignStudio") # The cased IDE id (no spaces!)
set(IDE_BUNDLE_IDENTIFIER "org.qt-project.${IDE_ID}") # The macOS application bundle identifier.
set(IDE_APP_ID "io.qt.${IDE_ID}") # The free desktop application identifier.
-set(IDE_AUTHOR "The Qt Company Ltd. and other contributors.")
+set(IDE_PUBLISHER "The Qt Company Ltd.")
+set(IDE_AUTHOR "${IDE_PUBLISHER} and other contributors.")
set(IDE_COPYRIGHT "Copyright (C) ${IDE_AUTHOR}")
set(PROJECT_USER_FILE_EXTENSION .qtds)
@@ -34,6 +35,7 @@ set(DESIGNSTUDIO_PLUGINS
FakeVim
Git
Help
+ ImageViewer
Insight
LanguageClient
McuSupport
diff --git a/dist/branding/qtdesignstudio/QtProject/QtDesignStudio.ini b/dist/branding/qtdesignstudio/QtProject/QtDesignStudio.ini
index 2aaba0a6e31..f974dc40b17 100644
--- a/dist/branding/qtdesignstudio/QtProject/QtDesignStudio.ini
+++ b/dist/branding/qtdesignstudio/QtProject/QtDesignStudio.ini
@@ -10,6 +10,7 @@ NewDialog\AllowAllTemplates=false
NewDialog\BlacklistedCategories=U.Java, R.Qt, T.Import, H.Project, U.General
NewDialog\AlternativeWizardStyle=true
CreatorTheme=design
+RhiBackend=opengl
[Menu]
HideBuild=true
diff --git a/doc/qtcreator/config/style/qt5-sidebar.html b/doc/qtcreator/config/style/qt5-sidebar.html
index e9bdbfb1da8..ddde52f425e 100644
--- a/doc/qtcreator/config/style/qt5-sidebar.html
+++ b/doc/qtcreator/config/style/qt5-sidebar.html
@@ -15,7 +15,7 @@
- - Licenses and Acknowledgments
+ - Licenses and acknowledgments
- Command-Line Options
- Custom Wizards
- FAQ
@@ -78,7 +78,7 @@
- Keyboard Shortcuts
- Known Issues
- SDK Tool
- - Technical Support
+ - Technical support
- Version Control Systems
- Analyzers
- Build Systems
diff --git a/doc/qtcreator/images/icons/examples-32x32.png b/doc/qtcreator/images/icons/examples-32x32.png
new file mode 100644
index 00000000000..561e9cb56f1
Binary files /dev/null and b/doc/qtcreator/images/icons/examples-32x32.png differ
diff --git a/doc/qtcreator/src/analyze/creator-analyze.qdoc b/doc/qtcreator/src/analyze/creator-analyze.qdoc
index 982d4219923..b0aea3a0e64 100644
--- a/doc/qtcreator/src/analyze/creator-analyze.qdoc
+++ b/doc/qtcreator/src/analyze/creator-analyze.qdoc
@@ -30,7 +30,7 @@
\section1 Improving QML Performance
- \QC comes with the \l{Profiling QML Applications}{QML Profiler} for
+ \QC comes with the \l{Profiling QML applications}{QML Profiler} for
inspecting binding evaluations and signal handling when running QML code.
This is useful for identifying potential bottlenecks, especially in the
evaluation of bindings.
diff --git a/doc/qtcreator/src/analyze/creator-ctf-visualizer.qdoc b/doc/qtcreator/src/analyze/creator-ctf-visualizer.qdoc
index 473bea2bd8a..fd8b9ed9203 100644
--- a/doc/qtcreator/src/analyze/creator-ctf-visualizer.qdoc
+++ b/doc/qtcreator/src/analyze/creator-ctf-visualizer.qdoc
@@ -26,7 +26,7 @@
how the hardware is utilized and what the kernel and application are doing.
Tracing information can tell you more about the data that
- \l{Profiling QML Applications}{QML Profiler} collects. For example, you
+ \l{Profiling QML applications}{QML Profiler} collects. For example, you
can check why a trivial binding evaluation is taking so long. This might
be caused by C++ being executed or the disk I/O being slow.
diff --git a/doc/qtcreator/src/analyze/creator-heob.qdoc b/doc/qtcreator/src/analyze/creator-heob.qdoc
index 33d9568c07b..e163f67a74e 100644
--- a/doc/qtcreator/src/analyze/creator-heob.qdoc
+++ b/doc/qtcreator/src/analyze/creator-heob.qdoc
@@ -67,7 +67,7 @@
In \uicontrol {Extra arguments}, enter additional arguments for
running Heob. To list the available arguments in the Heob console, enter
- \c -H in this field and press \key Enter.
+ \c -H in this field and select \key Enter.
For example, use the \c -oleaks.html option to record leak data in an HTML
file. Together with this option, you can use the \c -g2 option to group the
diff --git a/doc/qtcreator/src/appman/creator-appman-how-to-run.qdoc b/doc/qtcreator/src/appman/creator-appman-how-to-run.qdoc
index e43e3320656..50008eb4d22 100644
--- a/doc/qtcreator/src/appman/creator-appman-how-to-run.qdoc
+++ b/doc/qtcreator/src/appman/creator-appman-how-to-run.qdoc
@@ -143,7 +143,7 @@
\section1 Analyze the applications
- Use the \l{Profiling QML Applications}{QML Profiler} to find causes
+ Use the \l{Profiling QML applications}{QML Profiler} to find causes
for typical performance problems in Qt Quick applications, such as
slowness and unresponsive, stuttering user interfaces. You cannot profile an
in-process runtime as an individual process.
@@ -156,5 +156,5 @@
{Remote Linux}{How To: Develop for remote Linux},
{Run on many platforms}, {Debugging}, {Debuggers}, {Debugger},
{Developing for \B2Q Devices}, {Developing for Remote Linux Devices},
- {Profiling QML Applications}, {Kits}
+ {Profiling QML applications}, {Kits}
*/
diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc
index 59e26fd0994..b0f84e9e6a7 100644
--- a/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc
+++ b/doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc
@@ -180,15 +180,15 @@
case-sensitivity. Select \uicontrol {Show Non-matching Lines} to
hide the lines that match the filter.
- Press \key {Ctrl+F} to \l{Search in current file}{search} for a string in
+ Select \key {Ctrl+F} to \l{Search in current file}{search} for a string in
the output.
To increase or decrease the output text size, select \inlineimage icons/plus.png
(\uicontrol {Zoom In}) or \inlineimage icons/minus.png
- (\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-.
+ (\uicontrol {Zoom Out}), or select \key Ctrl++ or \key Ctrl+-.
To hide the output, select the \inlineimage icons/rightsidebaricon.png
- (\uicontrol {Hide Right Sidebar}) button or press \key {Alt+Shift+0}.
+ (\uicontrol {Hide Right Sidebar}) button or select \key {Alt+Shift+0}.
\section1 CLICOLOR_FORCE Environment Variable
diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
index 5d680fef4d3..09a5bff85f4 100644
--- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
+++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
@@ -271,7 +271,7 @@
\li \c{$ENV} for environment variables
\endlist
- Press \key Tab or \key Enter to accept the selected suggestion and complete
+ Select \key Tab or \key Enter to accept the selected suggestion and complete
the code.
\sa {Build with CMake}{How To: Build with CMake}, {CMake}, {Completion},
diff --git a/doc/qtcreator/src/debugger/creator-debug-views.qdoc b/doc/qtcreator/src/debugger/creator-debug-views.qdoc
index fa73b33784d..6ea4c5bbdcb 100644
--- a/doc/qtcreator/src/debugger/creator-debug-views.qdoc
+++ b/doc/qtcreator/src/debugger/creator-debug-views.qdoc
@@ -12,7 +12,7 @@
\ingroup creator-reference-debugger-views
\ingroup studio-debugger-views
- \title Viewing Call Stack Trace
+ \title Viewing call stack trace
\brief View the nested function calls leading to the current position as a
call stack trace.
@@ -33,11 +33,11 @@
If you click a frame with a known source location, the text editor jumps to
the corresponding location and updates the
- \l {Local Variables and Function Parameters}{Locals} and
- \l {Evaluating Expressions}{Expressions} views, making it seem like the
+ \l {Local variables and function parameters}{Locals} and
+ \l {Evaluating expressions}{Expressions} views, making it seem like the
application was interrupted before entering the function.
- \section1 Loading QML Stack
+ \section1 Loading QML stack
To find out which QML file is causing a Qt Quick application to crash,
select \uicontrol {Load QML Stack} in the context menu in the
@@ -62,7 +62,7 @@
\ingroup creator-reference-debugger-views
\ingroup studio-debugger-views
- \title Setting Breakpoints
+ \title Setting breakpoints
\brief Set breakpoints to interrupt the application.
@@ -96,7 +96,7 @@
evaluates the expression each time the application passes it, and the
application stops only if the condition evaluates to \c true.
- \section1 Unclaimed and Claimed Breakpoints
+ \section1 Unclaimed and claimed breakpoints
Breakpoints come in two varieties: \c unclaimed and \c claimed.
An unclaimed breakpoint represents a task to interrupt the debugged
@@ -172,7 +172,7 @@
\list
- \li In the code editor, click the left margin or press \key F9
+ \li In the code editor, click the left margin or select \key F9
(\key F8 on \macos) on a particular line where you want the
application to stop.
@@ -291,7 +291,7 @@
\li In the \uicontrol {Breakpoint Preset} view or the
\uicontrol Breakpoints view:
\list
- \li Select the breakpoint and press \key Delete.
+ \li Select the breakpoint and select \key Delete.
\li Select \uicontrol {Delete Selected Breakpoints},
\uicontrol {Delete Selected Breakpoints}, or
\uicontrol {Delete Breakpoints of File} in the
@@ -310,13 +310,13 @@
\li Right-click the breakpoint marker in the text editor and select
\uicontrol{Disable Breakpoint}.
- \li Select a line that has a breakpoint and press \key Ctrl+F9
+ \li Select a line that has a breakpoint and select \key Ctrl+F9
(\key Ctrl+F8 on \macos).
\li In the \uicontrol {Breakpoint Preset} view or the
\uicontrol Breakpoints view:
\list
- \li Select the breakpoint and press \key Space.
+ \li Select the breakpoint and select \key Space.
\li Select \uicontrol {Disable Breakpoint} in the context menu.
\endlist
\endlist
@@ -391,7 +391,7 @@
\ingroup creator-reference-debugger-views
\ingroup studio-debugger-views
- \title Local Variables and Function Parameters
+ \title Local variables and function parameters
\brief Inspect local variables and function parameters.
@@ -412,7 +412,7 @@
local value correctly.
\if defined(qtcreator)
- \section1 Locals View Actions
+ \section1 Locals view actions
Right-click the \uicontrol Locals view to select the following actions:
@@ -435,7 +435,7 @@
//! [0]
\endif
- \section1 Selecting Object Type for Display
+ \section1 Selecting object type for display
When using GDB, you can specify whether the dynamic or the static type of
objects will be displayed. Select \uicontrol {Use dynamic object type for
@@ -458,12 +458,12 @@
\ingroup creator-reference-debugger-views
\ingroup studio-debugger-views
- \title Evaluating Expressions
+ \title Evaluating expressions
\brief Compute values of arithmetic expressions or function calls.
To access global data that is not visible in the
- \l {Local Variables and Function Parameters}{Locals} view or to compute
+ \l {Local variables and function parameters}{Locals} view or to compute
values of arithmetic expressions or function calls, use
expression evaluators in the \uicontrol Expressions view.
@@ -477,7 +477,7 @@
\image qtcreator-debugger-expressions.webp {Expressions view}
- \section1 Adding Expression Evaluators
+ \section1 Adding expression evaluators
To add expression evaluators, drag an expression from the code editor
to the \uicontrol Expressions view.
@@ -513,13 +513,13 @@
\note Evaluating expressions is slow, so remove expression evaluators after
use.
- \section1 JavaScript Expressions
+ \section1 JavaScript expressions
The QML debugger can evaluate JavaScript expressions.
\if defined(qtcreator)
- \section1 C and C++ Expressions
+ \section1 C and C++ expressions
CDB, GDB, and LLDB support the evaluation of simple C and C++ expressions,
such as arithmetic expressions made of simple values and pointers.
@@ -527,7 +527,7 @@
Depending on the backend and concrete location, some function calls
can be evaluated. CDB is the most limited backend in this respect.
- \section2 Function Calls
+ \section2 Function calls
Functions can be called only if they are actually compiled into the debugged
executable or a library used by the executable. Inlined
@@ -538,20 +538,20 @@
corruption of the application's state, or using the application's permission
to perform arbitrary actions.
- \section2 Ranged Syntax
+ \section2 Ranged syntax
When using GDB or LLDB as backend, you can use a special ranged syntax to
display multiple values with one expression. A sub-expression of form
\c{foo[a..b]} is split into a sequence of individually evaluated expressions
\c{foo[a], ..., foo[b]}.
- \section2 Compound Variables
+ \section2 Compound variables
You can expand compound variables of struct or class type to show their
members. As you also see the variable value and type, you can examine and
traverse the low-level layout of object data.
- \section2 Optimized Builds
+ \section2 Optimized builds
GDB and LLDB, and therefore \QC's debugger, also work for optimized
builds on Linux and \macos. Optimization can lead to re-ordering
@@ -569,7 +569,7 @@
\uicontrol {not in scope}. Not all uninitialized objects,
however, can be recognized as such.
- \section1 Expressions View Actions
+ \section1 Expressions view actions
Right-click the \uicontrol Expressions view to select the following actions:
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc
index dd12571c8dc..dacde64da58 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-example.qdoc
@@ -35,7 +35,7 @@
\image qtcreator-setting-breakpoint1.png
\li Go to \uicontrol Debug > \uicontrol {Start Debugging} >
- \uicontrol {Start Debugging of Startup Project} or press \key F5.
+ \uicontrol {Start Debugging of Startup Project} or select \key F5.
\li To view information about the breakpoint, go to the
\uicontrol Breakpoints view.
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdoc
index a26ac4a8f44..bee1cec4302 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdoc
@@ -262,7 +262,7 @@
shifted to the next source code line for which the code was actually
generated. To reflect such temporary changes by moving the breakpoint
markers in the source code editor, select this checkbox. For more
- information, see \l{Setting Breakpoints}.
+ information, see \l{Setting breakpoints}.
\row
\li \uicontrol {Use Python dumper}
\li Uses the abstraction layer of Python Dumper classes to create a
diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
index 31937cc381a..c15f1de3b42 100644
--- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
+++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
@@ -118,19 +118,19 @@
To interrupt a running C++ application, go to \uicontrol Debug >
\uicontrol Interrupt. The debugger automatically interrupts
- the application when it hits a \l {Setting Breakpoints}{breakpoint}.
+ the application when it hits a \l {Setting breakpoints}{breakpoint}.
Once the application stops, \QC:
\list
- \li Retrieves data representing the \l{Viewing Call Stack Trace}
+ \li Retrieves data representing the \l{Viewing call stack trace}
{call stack} at the application's current position.
- \li Retrieves the contents of \l{Local Variables and Function Parameters}
+ \li Retrieves the contents of \l{Local variables and function parameters}
{local variables}.
- \li Examines \l{Evaluating Expressions}{expressions}.
+ \li Examines \l{Evaluating expressions}{expressions}.
\li Updates the \l{Viewing and Editing Register State}{Registers},
\l{Viewing Modules}{Modules}, and \l{Viewing Disassembled Code}
@@ -206,7 +206,7 @@
objects and user interfaces, as well as execute JavaScript
expressions.
- For more information, see \l{Debugging Qt Quick Projects} and
+ For more information, see \l{Debugging Qt Quick projects} and
\l{Tutorial: Qt Quick debugging}.
\sa {Tutorial: C++ debugging}, {Debug}{How To: Debug}, {Debuggers},
@@ -227,7 +227,7 @@
\list
\li Select \inlineimage icons/qtcreator-debug-button.png
(\uicontrol {Start Debugging of Startup Project}).
- \li Press \key F5.
+ \li Select \key F5.
\li Enter \c {dr} in the locator, and select the project to debug.
\li Go to \uicontrol Debug > \uicontrol {Start Debugging} >
\uicontrol {Start Debugging of Startup Project}.
@@ -245,7 +245,7 @@
parameters.
You can specify breakpoints before or after launching the debugger.
- For more information, see \l{Setting Breakpoints}.
+ For more information, see \l{Setting breakpoints}.
\section1 Execute GDB or CDB commands
@@ -373,7 +373,7 @@
opening it makes setting breakpoints and stepping through the code easier.
You can specify breakpoints before or after attaching the debugger to the
- application. For more information, see \l{Setting Breakpoints}.
+ application. For more information, see \l{Setting breakpoints}.
\sa {Debug}{How To: Debug}, {Debugging}, {Debuggers}, {Debugger}
*/
@@ -750,7 +750,7 @@
\li Stack
\li Examine the nested function calls leading to the current position
as a call stack trace.
- \li \l {Viewing Call Stack Trace}
+ \li \l {Viewing call stack trace}
\row
\li Breakpoint Preset
@@ -758,7 +758,7 @@
\li Set \e {breakpoints} with conditions to make the application stop in
a controlled way. A \e {watchpoint} stops the application when the
value of an expression changes.
- \li \l {Setting Breakpoints}
+ \li \l {Setting breakpoints}
\row
\li Threads
\li Switch between threads.
@@ -775,11 +775,11 @@
\li Locals
\li View information about the parameters of the function in the topmost
stack frame and local variables.
- \li \l {Local Variables and Function Parameters}
+ \li \l {Local variables and function parameters}
\row
\li Expressions
\li Compute values of arithmetic expressions or function calls.
- \li \l {Evaluating Expressions}
+ \li \l {Evaluating expressions}
\row
\li Registers
\li View the current state of the CPU registers to examine the
@@ -898,8 +898,8 @@
\image qtcreator-locals.png {Locals view}
- The \l {Local Variables and Function Parameters}{Locals} and
- \l {Evaluating Expressions}{Expressions} views show structured
+ The \l {Local variables and function parameters}{Locals} and
+ \l {Evaluating expressions}{Expressions} views show structured
data, such as objects of \c class, \c struct, or \c union types, as a tree.
To access sub-structures of the objects, expand the tree nodes.
The tree shows the sub-structures in their in-memory order. To show them
@@ -924,7 +924,7 @@
\l{Debugging Helpers}{debugging helpers}.
In addition to the generic IDE functionality of the
- \l {Viewing Call Stack Trace}{Stack}, \uicontrol {Locals},
+ \l {Viewing call stack trace}{Stack}, \uicontrol {Locals},
\uicontrol {Expressions}, \l {Viewing and Editing Register State}{Registers},
and other views, \QC makes debugging Qt-based applications easy. The debugger
plugin understands the internal layout of several Qt classes, for example,
@@ -1083,7 +1083,7 @@
the contents of variables of simple data types, for example, \c int, \c float,
\c QString and \c std::string when the application is interrupted. To do so,
click the \uicontrol Value column, modify the value with the inplace editor,
- and press \key Enter.
+ and select \key Enter.
To change the complete contents of QVector or \c std::vector values, type
all values separated by commas into the \uicontrol Value column of the main
@@ -1161,7 +1161,7 @@
This allows you to select the thread that is in the focus of the debugger.
- The \l {Viewing Call Stack Trace}{Stack} view adjusts its contents
+ The \l {Viewing call stack trace}{Stack} view adjusts its contents
accordingly.
\sa {Debug}{How To: Debug}, {Debugging}, {Debuggers}, {Debugger}
@@ -1421,7 +1421,7 @@
You can use the left pane of the \uicontrol {Debugger Log} view to directly
interact with the command line of the debugger.
- Press \key {Ctrl+Enter} to send the contents of the line under the
+ Select \key {Ctrl+Enter} to send the contents of the line under the
text cursor to the debugger. Or, enter the command in the
\uicontrol Command field. The right side pane of the
\uicontrol {Debugger Log} view shows the command output.
@@ -1429,7 +1429,7 @@
\note Usually, you do not need this feature because \QC offers better ways to
handle the task. For example, instead of using the GDB
\c print command from the command line, you can evaluate an expression in
- the \l {Evaluating Expressions}{Expressions} view.
+ the \l {Evaluating expressions}{Expressions} view.
\sa {Debug}{How To: Debug}, {Debugging}, {Debuggers}, {Debugger}
*/
@@ -1493,8 +1493,8 @@
\QC uses Python scripts to translate raw memory contents and type information
data from debugger backends (GDB, LLDB, and CDB are currently supported)
into the form presented to the user in the
- \l {Local Variables and Function Parameters}{Locals}
- and \l {Evaluating Expressions}{Expressions} views.
+ \l {Local variables and function parameters}{Locals}
+ and \l {Evaluating expressions}{Expressions} views.
Unlike GDB's
\l{https://sourceware.org/gdb/onlinedocs/gdb/Pretty-Printing.html#Pretty-Printing}
diff --git a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc
index 18f410b49dd..c4d5a7a3d77 100644
--- a/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc
+++ b/doc/qtcreator/src/debugger/qtquick-debugger-example.qdoc
@@ -29,7 +29,7 @@
\uicontrol Debug mode.
For more information about all the options you have, see
- \l{Debugging Qt Quick Projects}.
+ \l{Debugging Qt Quick projects}.
\if defined(qtdesignstudio)
\note In this tutorial, you are using advanced menu items. These are not
@@ -69,7 +69,7 @@
\image qtquick-example-setting-breakpoint2.webp {Debugger view}
\li Select \inlineimage icons/debugger_stepinto_small.png
- (\uicontrol {Step Into}) on the toolbar or press \key F11 to step
+ (\uicontrol {Step Into}) on the toolbar or select \key F11 to step
into the code in the stack. The samegame.js file opens in the code
editor at the function that starts a new game.
@@ -111,5 +111,5 @@
\endlist
- \sa {Debugging Qt Quick Projects}
+ \sa {Debugging Qt Quick projects}
*/
diff --git a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
index d0b227bf436..83f79f2034f 100644
--- a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
+++ b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc
@@ -19,7 +19,7 @@
\ingroup creator-reference-debugger
\ingroup studio-debugger
- \title Debugging Qt Quick Projects
+ \title Debugging Qt Quick projects
\brief Debug JavaScript functions, execute JavaScript expressions to get
information about the state of the UI, and inspect QML properties and
@@ -34,14 +34,14 @@
\l{Customizing the Menu Bar}.
\endif
- \section1 Setting Up QML Debugging
+ \section1 Setting up QML debugging
\if defined(qtcreator)
The process of setting up debugging for Qt Quick projects depends on the
\e type of the project: \uicontrol {Qt Quick UI Prototype} or
\uicontrol {Qt Quick Application}, and the Qt version.
- \section2 Debugging Qt Quick UI Projects
+ \section2 Debugging Qt Quick UI projects
\endif
To debug Qt Quick UI projects (.qmlproject), select \uicontrol Automatic
@@ -51,7 +51,7 @@
\image qtquick-debugger-settings.webp {Debugger settings section in Run Settings}
\if defined(qtcreator)
- \section2 Debugging Qt Quick Applications
+ \section2 Debugging Qt Quick applications
To debug Qt Quick Applications:
@@ -92,7 +92,7 @@
automatically installed during \QC and Qt installation. Do not delete
them if you plan to debug QML applications.
- \section2 Using Default Values
+ \section2 Using default values
You can enable or disable QML debugging globally in \preferences >
\uicontrol {Build & Run} > \uicontrol {Default Build Properties}.
@@ -129,10 +129,10 @@
global setting.
\endif
- \section1 Starting QML Debugging
+ \section1 Starting QML debugging
To start the application, choose \uicontrol Debug > \uicontrol {Start Debugging}
- > \uicontrol {Start Debugging of Startup Project} or press \key F5. Once the
+ > \uicontrol {Start Debugging of Startup Project} or select \key F5. Once the
application starts running, it behaves and performs as usual. You can then
perform the following tasks:
@@ -191,25 +191,25 @@
\endlist
- \section1 Debugging JavaScript Functions
+ \section1 Debugging JavaScript functions
You can use the \QC \uicontrol Debug mode to inspect the state of your
application while debugging. You can interact with the debugger by:
\list
- \li \l{Viewing Call Stack Trace}{Viewing call stack trace}
+ \li \l{Viewing call stack trace}{Viewing call stack trace}
- \li \l{Setting Breakpoints}{Setting breakpoints}
+ \li \l{Setting breakpoints}{Setting breakpoints}
- \li \l{Local Variables and Function Parameters}
+ \li \l{Local variables and function parameters}
{Viewing local variables and function parameters}
- \li \l{Evaluating Expressions}
+ \li \l{Evaluating expressions}
\endlist
- \section1 Inspecting Items
+ \section1 Inspecting items
While the application is running, you can use the \uicontrol {Locals}
view to explore the QML item structure.
@@ -237,7 +237,7 @@
double-click them and enter the new values. You can view the results in the
running application.
- \section1 Inspecting User Interfaces
+ \section1 Inspecting user interfaces
When you debug complex applications, you can jump to the position in code
where an item is defined.
@@ -256,7 +256,7 @@
To move the application running in \QQV to the front, select
\uicontrol Debug > \uicontrol {Show Application on Top}.
- \section1 Executing JavaScript Expressions
+ \section1 Executing JavaScript expressions
When the application is interrupted by a breakpoint, you can use the
\uicontrol {QML Debugger Console} to execute JavaScript expressions in the
@@ -274,7 +274,7 @@
the \l Properties view.
\endif
- \section1 Applying QML Changes at Runtime
+ \section1 Applying QML changes at runtime
When you change property values in the \uicontrol {QML Debugger Console} or
in the \uicontrol Locals or \uicontrol Expression view, they are immediately
diff --git a/doc/qtcreator/src/editors/creator-code-completion.qdoc b/doc/qtcreator/src/editors/creator-code-completion.qdoc
index 0ed4de52825..568df6e96c9 100644
--- a/doc/qtcreator/src/editors/creator-code-completion.qdoc
+++ b/doc/qtcreator/src/editors/creator-code-completion.qdoc
@@ -18,7 +18,7 @@
complete the code. It shows a list of suggestions to
the statement currently under your cursor.
- Press \key Tab or \key Enter to accept the selected suggestion and complete
+ Select \key Tab or \key Enter to accept the selected suggestion and complete
the code.
\if defined(qtcreator)
@@ -29,7 +29,7 @@
\image qml-code-completion.png
\caption Suggestions for completing QML code.
- To open the list of suggestions at any time, press \key {Ctrl+Space}.
+ To open the list of suggestions at any time, select \key {Ctrl+Space}.
If only one option is available, \QC inserts it automatically.
\section1 Summary of Available Types
@@ -107,8 +107,8 @@
\section1 Complete code snippets
Code snippets can consist of multiple variables that you specify values for.
- Select an item in the list and press \key Tab or \key Enter to complete the
- code. Press \key Tab to move between the variables and specify values for
+ Select an item in the list and select \key Tab or \key Enter to complete the
+ code. Select \key Tab to move between the variables and specify values for
them. When you specify a value for a variable, all instances of the variable
within the snippet are renamed.
@@ -171,7 +171,7 @@
Select the \uicontrol {Automatically split strings} check box to split
a string to two lines by adding an end quote at the cursor position when
- you press \key Enter and a start quote at the beginning of the next line,
+ you select \key Enter and a start quote at the beginning of the next line,
before the rest of the string. In addition, pressing \key {Shift+Enter}
inserts an escape character at the cursor position and moves the rest of
the string to the next line.
@@ -182,7 +182,7 @@
closing character is added automatically at the end of the selection.
By default, the automatically inserted text is highlighted and animated,
- skipped when you type, and removed when you press \key Backspace.
+ skipped when you type, and removed when you select \key Backspace.
\if defined(qtcreator)
\sa {Complete CMake code}, {Enclose code in brackets or quotes}, {Nim}
diff --git a/doc/qtcreator/src/editors/creator-code-indentation.qdoc b/doc/qtcreator/src/editors/creator-code-indentation.qdoc
index 0fa0a4ce048..42c3b2dd9ba 100644
--- a/doc/qtcreator/src/editors/creator-code-indentation.qdoc
+++ b/doc/qtcreator/src/editors/creator-code-indentation.qdoc
@@ -16,7 +16,7 @@
When you type text or code, it is indented automatically according to the
selected text editor or code style preferences. Select a block to indent it when
- you press \key Tab. Press \key {Shift+Tab} to decrease the indentation. You
+ you select \key Tab. Select \key {Shift+Tab} to decrease the indentation. You
can disable automatic indentation.
To fix the indentation in the file currently open in the editor,
@@ -25,16 +25,16 @@
\list
\li To automatically indent the highlighted text, select
- \uicontrol {Auto-indent Selection} or press \key {Ctrl+I}.
+ \uicontrol {Auto-indent Selection} or select \key {Ctrl+I}.
\li To automatically format the highlighted text, select
- \uicontrol {Auto-format Selection} or press \key {Ctrl+;}.
+ \uicontrol {Auto-format Selection} or select \key {Ctrl+;}.
\li To adjust the wrapping of the selected paragraph, select
- \uicontrol {Rewrap Paragraph} or press \key {Ctrl+E}
+ \uicontrol {Rewrap Paragraph} or select \key {Ctrl+E}
followed by \key R.
\li To toggle text wrapping, select \uicontrol {Enable Text Wrapping}
- or press \key {Ctrl+E} followed by \key {Ctrl+W}.
+ or select \key {Ctrl+E} followed by \key {Ctrl+W}.
\li To visualize whitespace in the editor, select
- \uicontrol {Visualize Whitespace} or press \key {Ctrl+E}
+ \uicontrol {Visualize Whitespace} or select \key {Ctrl+E}
followed by \key {Ctrl+V}.
\li To clear all whitespace characters from the currently open file,
select \uicontrol {Clean Whitespace}.
diff --git a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc
index 3bf65036a25..16cb8bf6102 100644
--- a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc
+++ b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc
@@ -25,7 +25,7 @@
\list 1
\li Place the cursor on the symbol in the editor.
\li Go to \uicontrol Tools > \uicontrol {C++} >
- \uicontrol {Rename Symbol Under Cursor}, or press \key {Ctrl+Shift+R}.
+ \uicontrol {Rename Symbol Under Cursor}, or select \key {Ctrl+Shift+R}.
Use the keyboard shortcut to rename Python symbols.
\endlist
@@ -33,7 +33,7 @@
To rename a QML type in a project, go to \uicontrol Tools >
\uicontrol {QML/JS} > \uicontrol {Rename Symbol Under Cursor}
- or press \key {Ctrl+Shift+R}.
+ or select \key {Ctrl+Shift+R}.
\uicontrol {Search Results} shows the location
and number of instances of the symbol in the current project.
diff --git a/doc/qtcreator/src/editors/creator-code-syntax.qdoc b/doc/qtcreator/src/editors/creator-code-syntax.qdoc
index c9712d66320..000717c6a95 100644
--- a/doc/qtcreator/src/editors/creator-code-syntax.qdoc
+++ b/doc/qtcreator/src/editors/creator-code-syntax.qdoc
@@ -103,7 +103,7 @@
find common problems.
To run static checks, go to \uicontrol Tools > \uicontrol {QML/JS} >
- \uicontrol {Run Checks} or press \key {Ctrl+Shift+C}.
+ \uicontrol {Run Checks} or select \key {Ctrl+Shift+C}.
View the results in the \uicontrol QML and \uicontrol {QML Analysis}
filters in \l Issues.
@@ -503,13 +503,13 @@
\li Error
\li This type (type name) is not supported as a root element of a
UI file (.ui.qml)
- \li For more information about supported QML types, see \l{UI Files}.
+ \li For more information about supported QML types, see \l{UI files}.
\row
\li M221
\li Error
\li This type (type name) is not supported in a UI file (.ui.qml)
- \li For more information about supported QML types, see \l{UI Files}.
+ \li For more information about supported QML types, see \l{UI files}.
\row
\li M222
@@ -522,26 +522,26 @@
\li M223
\li Error
\li JavaScript blocks are not supported in a UI file (.ui.qml)
- \li For more information about supported features, see \l{UI Files}.
+ \li For more information about supported features, see \l{UI files}.
\row
\li M224
\li Error
\li Behavior type is not supported in a UI file (.ui.qml)
- \li For more information about supported QML types, see \l{UI Files}.
+ \li For more information about supported QML types, see \l{UI files}.
\row
\li M225
\li Error
\li States are only supported in the root item in a UI file (.ui.qml)
- \li For more information about supported features, see \l{UI Files}.
+ \li For more information about supported features, see \l{UI files}.
\row
\li M226
\li Error
\li Referencing the parent of the root item is not supported in a
UI file (.ui.qml)
- \li For more information about supported features, see \l{UI Files}.
+ \li For more information about supported features, see \l{UI files}.
\row
\li M227
@@ -766,7 +766,7 @@
To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Reset Code Model}.
- \sa {Check code syntax}, {Using QML Modules with Plugins}
+ \sa {Check code syntax}, {Using QML modules with plugins}
\if defined(qtcreator)
\sa {Analyzing Code}
diff --git a/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc b/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc
index 028e0c0980c..3126de7fc08 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc
@@ -36,7 +36,7 @@
\list 1
\li Go to \uicontrol Tools > \uicontrol {Code Pasting} >
- \uicontrol {Paste Snippet} or press \key {Alt+C,Alt+P}.
+ \uicontrol {Paste Snippet} or select \key {Alt+C,Alt+P}.
\image qtcreator-send-to-codepaster.webp {Send to Codepaster dialog}
\li In \uicontrol Protocol, select the code pasting service to use.
\li In \uicontrol {Expires after}, specify the time to keep
@@ -59,7 +59,7 @@
\list 1
\li Go to \uicontrol Tools > \uicontrol {Code Pasting} >
- \uicontrol {Fetch Snippet} or press \key {Alt+C,Alt+F}.
+ \uicontrol {Fetch Snippet} or select \key {Alt+C,Alt+F}.
\li Select the snippet to fetch from the list.
\endlist
diff --git a/doc/qtcreator/src/editors/creator-only/creator-coding-edit-mode.qdoc b/doc/qtcreator/src/editors/creator-only/creator-coding-edit-mode.qdoc
index 6afb21972d8..a0ae5419f4c 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-coding-edit-mode.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-coding-edit-mode.qdoc
@@ -162,13 +162,13 @@
\li To format the duplicated lines as a comment, go to
\uicontrol {Duplicate Selection and Comment}.
\li To turn selected text into lowercase, go to
- \uicontrol {Lowercase Selection} or press \key {Alt+U}.
+ \uicontrol {Lowercase Selection} or select \key {Alt+U}.
\li To turn selected text into uppercase, go to
- \uicontrol {Uppercase Selection} or press \key {Alt+Shift+U}.
+ \uicontrol {Uppercase Selection} or select \key {Alt+Shift+U}.
\li To sort selected lines alphabetically, go to
- \uicontrol {Sort Selected Lines} or press \key {Alt+Shift+S}.
+ \uicontrol {Sort Selected Lines} or select \key {Alt+Shift+S}.
\li To add a cursor at the next occurrence of selected text for multi-cursor
- editing, go to \uicontrol {Add Next Occurrence to Selection} or press \key {Ctrl+D}
+ editing, go to \uicontrol {Add Next Occurrence to Selection} or select \key {Ctrl+D}
\endlist
\sa {Edit Code}{How To: Edit Code},
@@ -205,7 +205,7 @@
open project using the locator:
\list 1
- \li Press \key {Ctrl+K} to activate the locator.
+ \li Select \key {Ctrl+K} to activate the locator.
\li Start typing the filename.
\image qtcreator-locator-open.webp {List of files in the locator}
\li Use the arrow keys to move to the filename in the list and press
@@ -217,7 +217,7 @@
Filters locating files also accept paths, such as \c {tools/*main.cpp}.
If the path to a file is very long, it might not fit into the locator
- window. To view the full path, press \key Alt when the filename is selected
+ window. To view the full path, select \key Alt when the filename is selected
or drag the right edge of the locator to make it wider.
If the locator does not find some files, see \l{Specify project contents}
@@ -249,12 +249,12 @@
Use keyboard shortcuts:
\list
- \li To quickly move between currently open files, press \key Ctrl+Tab.
- \li To move forward in the location history, press \key {Alt+Right}
+ \li To quickly move between currently open files, select \key Ctrl+Tab.
+ \li To move forward in the location history, select \key {Alt+Right}
(\key {Cmd+Opt+Right} on \macos).
- \li To move backward, press \key {Alt+Left} (\key {Cmd+Opt+Left} on \macos).
+ \li To move backward, select \key {Alt+Left} (\key {Cmd+Opt+Left} on \macos).
For example, after you use the \uicontrol Locator
- to jump to a symbol in the same file, press \key {Alt+Left} to jump
+ to jump to a symbol in the same file, select \key {Alt+Left} to jump
back to your original location in that file.
\endlist
@@ -292,7 +292,7 @@
\list 1
- \li Press \key {Ctrl+K} to activate the locator.
+ \li Select \key {Ctrl+K} to activate the locator.
\li Enter a colon (:) followed by a space and the upper case letters in
the symbol name (here, \c {QGuiApplication}):
@@ -313,7 +313,7 @@
\section1 Move to symbol definition or declaration
To move directly to the definition or declaration of a symbol in the
- \uicontrol Edit mode, move the cursor on the symbol and press \key {F2}.
+ \uicontrol Edit mode, move the cursor on the symbol and select \key {F2}.
Or, hold the \key Ctrl key (\key Cmd on \macos) and click
the symbol. If you have multiple splits opened, open the link in the next
@@ -343,7 +343,7 @@
\section2 Switch between function definition and decalaration
To switch between the definition and declaration of a function, place the
- cursor on either and press \key {Shift+F2} or right-click and go to
+ cursor on either and select \key {Shift+F2} or right-click and go to
\uicontrol {Switch Between Function Declaration/Definition} or
\uicontrol {Open Function Declaration/Definition in Next Split}.
For example, this allows you to navigate from anywhere within a function
@@ -357,7 +357,7 @@
\section2 Open links in another split
Links open in the same split by default. To open them in the next
- split, press \key {Ctrl+E} first. For example, press \key {Ctrl+E,F2} to
+ split, select \key {Ctrl+E} first. For example, select \key {Ctrl+E,F2} to
follow the symbol into the next split. If necessary, the view is
automatically split.
@@ -477,7 +477,7 @@
\title Insert multiple cursors
To apply a change to several places simultaneously in the editor in the
- \uicontrol Edit mode, press and hold \key Alt, and click to place cursors
+ \uicontrol Edit mode, select and hold \key Alt, and click to place cursors
in several places in the file. Any changes you make are applied
simultaneously at all the cursor positions.
@@ -486,14 +486,14 @@
To manage cursors:
\list
- \li Press the arrow keys to move all the cursors up and down.
- \li Press the \key Home and \key End key to move all the cursors
+ \li Select the arrow keys to move all the cursors up and down.
+ \li Select the \key Home and \key End key to move all the cursors
to the beginning or to the end of the line.
- \li Press and hold \key Alt and double-click strings to select
+ \li Select and hold \key Alt and double-click strings to select
several strings simultaneously.
- \li Press \key {Alt+Shift+I} to create cursors at the ends of
+ \li Select \key {Alt+Shift+I} to create cursors at the ends of
selected lines.
- \li Press \key Esc to remove all the cursors and selections.
+ \li Select \key Esc to remove all the cursors and selections.
\endlist
\sa {Edit Code}{How To: Edit Code}, {Editing Selected Lines}, {Edit Mode}
@@ -517,7 +517,7 @@
\list
\li To split the editor view into a top and bottom view, go to
- \uicontrol Window > \uicontrol Split, press \key {Ctrl+E, 2}, or
+ \uicontrol Window > \uicontrol Split, select \key {Ctrl+E, 2}, or
select the \inlineimage icons/splitbutton_horizontal.png
(\uicontrol Split) button and then select \uicontrol Split.
@@ -532,7 +532,7 @@
The \uicontrol {Split Side by Side} command creates views to the right
of the currently active editor view.
- \li To open the editor in a detached window, press \key {Ctrl+E, 4}, or
+ \li To open the editor in a detached window, select \key {Ctrl+E, 4}, or
go to \uicontrol Window > \uicontrol {Open in New Window}.
The new window behaves in the same way as the editor area
@@ -554,7 +554,7 @@
\list
\li Place the cursor within the view you want to remove and go to
\uicontrol Window > \uicontrol {Remove Current Split}.
- \li Press \key {Ctrl+E, 0}.
+ \li Select \key {Ctrl+E, 0}.
\li Select the \inlineimage icons/splitbutton_closetop.png
(\uicontrol {Remove Split}) button.
\endlist
@@ -563,7 +563,7 @@
\list
\li Go to \uicontrol Window > \uicontrol {Remove All Splits}.
- \li Press \key {Ctrl+E, 1}.
+ \li Select \key {Ctrl+E, 1}.
\endlist
\sa {Edit Code}{How To: Edit Code}, {Detach views}, {Edit Mode}
@@ -583,9 +583,9 @@
\li Right-click the line number and select \uicontrol {Toggle Bookmark}.
- \li Press \key Shift and click the left margin at a line.
+ \li Select \key Shift and click the left margin at a line.
- \li Press \key {Ctrl+M} when the cursor is on a line.
+ \li Select \key {Ctrl+M} when the cursor is on a line.
\endlist
@@ -598,7 +598,7 @@
\list
\li Go to \uicontrol Tools > \uicontrol Bookmarks >
\uicontrol {Edit Bookmark}.
- \li Press \key {Ctrl+Shift+M}.
+ \li Select \key {Ctrl+Shift+M}.
\li Right-click a bookmark and go to \uicontrol {Edit Bookmark}
in the context menu.
\endlist
@@ -610,7 +610,7 @@
To move to the previous bookmark in the current session, go to
\uicontrol Tools > \uicontrol Bookmarks > \uicontrol {Previous Bookmark}
- or press \key {Ctrl+,}.
+ or select \key {Ctrl+,}.
To move to the next bookmark in the current session, go to \uicontrol Tools >
\uicontrol Bookmarks > \uicontrol {Previous Bookmark} or press
@@ -618,7 +618,7 @@
\section2 Locate bookmarks
- To use the locator to go to a bookmark, press \key {Ctrl+K} (or \key {Cmd+K}
+ To use the locator to go to a bookmark, select \key {Ctrl+K} (or \key {Cmd+K}
on \macos) to open the locator. Enter \e b and a space to display a list of
bookmarks. To filter the bookmarks by line number or a text string, enter
the number or string after the space. Double-click a bookmark in the list to
@@ -635,7 +635,7 @@
\image qtcreator-bookmarks-view.webp {Listing bookmarks in Bookmarks view}
To move bookmarks up and down, select \uicontrol {Move Up} or
- \uicontrol {Move Down} in the context menu or press \key {Ctrl+Alt+,} or
+ \uicontrol {Move Down} in the context menu or select \key {Ctrl+Alt+,} or
\key {Ctrl+Alt+.}.
To list bookmarks alphabetically by the name of the file where you set them,
@@ -702,7 +702,7 @@
To view information about the C++ code model in the
\uicontrol {C++ Code Model Inspector} dialog and write it to a log file,
select \uicontrol Tools > \uicontrol {Debug \QC } >
- \uicontrol {Inspect C++ Code Model} or press \key {Ctrl+Shift+F12}.
+ \uicontrol {Inspect C++ Code Model} or select \key {Ctrl+Shift+F12}.
\image qtcreator-code-model-inspector.webp {Code Model Inspector dialog}
diff --git a/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc b/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
index 8bcbfd723c4..fa9382cbc1a 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
@@ -89,9 +89,9 @@
the \key Tab key.
To apply a suggestion word-by-word, select \uicontrol {Apply Word}
- or press \key {Alt+Right}.
+ or select \key {Alt+Right}.
- To reject a suggestion, press \key Esc or the arrow keys.
+ To reject a suggestion, select \key Esc or the arrow keys.
\section1 Turn suggestions on and off
diff --git a/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc b/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
index db152c0e1dd..ebd6f1eee96 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
@@ -11,18 +11,18 @@
To run the main editor in a manner similar to the Vim editor, go to
\uicontrol Edit > \uicontrol Advanced and select \uicontrol {Use FakeVim},
- or press \key {Alt+Y,Alt+Y}.
+ or select \key {Alt+Y,Alt+Y}.
\section1 Escape FakeVim mode
To temporarily escape FakeVim mode to access the normal \QC keyboard
- shortcuts like \key {Ctrl-R} for \uicontrol Run, press the comma
+ shortcuts like \key {Ctrl-R} for \uicontrol Run, select the comma
key (\key {,}) before pressing the shortcut.
\section1 Quit FakeVim mode
To quit the FakeVim mode, go to \uicontrol Edit > \uicontrol Advanced and
- clear \uicontrol {Use FakeVim}, or press \key {Alt+Y,Alt+Y}.
+ clear \uicontrol {Use FakeVim}, or select \key {Alt+Y,Alt+Y}.
\sa {FakeVim Modes and Commands}, {FakeVim}, {Change editor colors}
*/
diff --git a/doc/qtcreator/src/editors/creator-only/creator-how-to-find-symbols.qdoc b/doc/qtcreator/src/editors/creator-only/creator-how-to-find-symbols.qdoc
index 2643720f704..5b4819b53cc 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-how-to-find-symbols.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-how-to-find-symbols.qdoc
@@ -20,7 +20,7 @@
\li Place the cursor on the symbol in the editor.
\li Go to \uicontrol Tools > \uicontrol {C++} >
\uicontrol {Find References to Symbol Under Cursor},
- or press \key {Ctrl+Shift+U}.
+ or select \key {Ctrl+Shift+U}.
\image qtcreator-find-references-to-symbol-under-cursor.webp {Found symbols in the Search Results view}
\endlist
diff --git a/doc/qtcreator/src/editors/creator-only/creator-locator.qdoc b/doc/qtcreator/src/editors/creator-only/creator-locator.qdoc
index d739bd3445f..4dd6aa72eeb 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-locator.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-locator.qdoc
@@ -21,7 +21,7 @@
\list
- \li Press \key {Ctrl+K} (\key {Cmd+K} on \macos).
+ \li Select \key {Ctrl+K} (\key {Cmd+K} on \macos).
\li Go to \uicontrol Tools, and then select \uicontrol Locate.
@@ -53,8 +53,8 @@
execute.
\li Select a locator filter in the filter list to use it. Press
- the up and down arrow keys or press \key Ctrl+P and \key Ctrl+N
- to move up and down the list, and then press \key Enter to use the
+ the up and down arrow keys or select \key Ctrl+P and \key Ctrl+N
+ to move up and down the list, and then select \key Enter to use the
selected filter.
\endlist
@@ -118,8 +118,8 @@
To create a new file and open it in the editor:
\list 1
- \li Type \c f followed by \key Space, followed by path and file name
- \li Press \key Enter or select \uicontrol {Create and Open File}.
+ \li Enter \c f followed by \key Space, followed by path and file name
+ \li Select \key Enter or select \uicontrol {Create and Open File}.
\endlist
To create a directory, select \uicontrol {Create Directory}.
diff --git a/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc b/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc
index a5cbf186f99..f7cf7f89f37 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc
@@ -41,8 +41,8 @@
\li Place the cursor on the link.
\li Then, do one of the following:
\list
- \li Press \key {Ctrl+Click} (or \key {Cmd+Click} on \macos).
- \li Press \key F2.
+ \li Select \key {Ctrl+Click} (or \key {Cmd+Click} on \macos).
+ \li Select \key F2.
\li Go to \uicontrol {Follow Symbol Under Cursor} in the context
menu.
\endlist
diff --git a/doc/qtcreator/src/editors/creator-only/creator-modeling.qdoc b/doc/qtcreator/src/editors/creator-only/creator-modeling.qdoc
index 0b20f36c335..e015e4c1c31 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-modeling.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-modeling.qdoc
@@ -131,28 +131,28 @@
\list
\li Select \uicontrol {Zoom In} toolbar button.
- \li Press \key Ctrl++.
- \li Press \key Ctrl and roll the mouse wheel up.
+ \li Select \key Ctrl++.
+ \li Select \key Ctrl and roll the mouse wheel up.
\endlist
To zoom out of diagrams:
\list
\li Select \uicontrol {Zoom Out}.
- \li Press \key Ctrl+-.
- \li Press \key Ctrl and roll the mouse wheel down.
+ \li Select \key Ctrl+-.
+ \li Select \key Ctrl and roll the mouse wheel down.
\endlist
To reset the diagram size to 100%:
\list
\li Select \uicontrol {Reset Zoom}.
- \li Press \key Ctrl+0.
+ \li Select \key Ctrl+0.
\endlist
\section2 Printing Diagrams
- To print diagrams, press \key Ctrl+C when no elements are selected in
+ To print diagrams, select \key Ctrl+C when no elements are selected in
the editor to copy all elements to the clipboard by using 300 dpi. Then
paste the diagram to an application that can print images.
@@ -340,14 +340,14 @@
associations.
\li To create \e {sampling points} that divide a relation into two
- connected lines, select a relation and press \key Shift and click
+ connected lines, select a relation and select \key Shift and click
on the relation line.
If possible, the end point of a relation is moved automatically
to draw the line to the next sampling point either vertically or
horizontally.
- \li To remove a sampling point, press \key Ctrl and click the sampling
+ \li To remove a sampling point, select \key Ctrl and click the sampling
point.
\li To group elements, drag a \uicontrol Boundary element to
@@ -500,9 +500,9 @@
\section2 Add and delete points
- To add more points, press \key Shift and click a relation.
+ To add more points, select \key Shift and click a relation.
- To delete a point, press \key Ctrl and click a point.
+ To delete a point, select \key Ctrl and click a point.
\section2 Specify members
diff --git a/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc b/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
index 1600c557a95..c037a5a689e 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
@@ -71,12 +71,12 @@
\uicontrol {Zoom Out}
\li Zooms into or out of the whole state chart in the state editor.
- You can also press \key Ctrl and use the mouse wheel.
+ You can also select \key Ctrl and use the mouse wheel.
\row
\li \inlineimage icons/pan.png
\li \uicontrol Panning
- \li Pans the state chart. To increase the pace of panning, press down the
- \key Shift key.
+ \li Pans the state chart. To increase the pace of panning, select
+ \key {Shift}.
\row
\li \inlineimage icons/fittoview.png
\li \uicontrol {Fit to View}
@@ -85,7 +85,7 @@
\li \inlineimage icons/zoom.png
\li \uicontrol {Magnifier Tool}
\li Zooms into a part of the state chart. To move the magnifier tool
- faster, press down the \key Alt key.
+ faster, select and hold \key {Alt}.
\row
\li \inlineimage icons/navigator.png
\li \uicontrol {Navigator}
@@ -180,7 +180,7 @@
Drag states on top of other states to create compound states. You can also
drag child states out of their parent state. To move child states
- within their parent, press down the \key Ctrl key while dragging them.
+ within their parent, select and hold \key Ctrl while dragging them.
\section1 Aligning and Editing States
diff --git a/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc b/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc
index b709d4a6c71..60b7a540e1f 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-text-editing-macros.qdoc
@@ -21,11 +21,11 @@
\list 1
\li Go to \uicontrol Tools > \uicontrol {Text Editing Macros} >
- \uicontrol {Record Macro} or press \key {Alt+[}.
- \li Press keyboard keys.
+ \uicontrol {Record Macro} or select \key {Alt+[}.
+ \li Select keyboard keys.
\li To stop recording, go to \uicontrol Tools >
\uicontrol {Text Editing Macros} > \uicontrol {Stop Recording Macro}
- or press \key {Alt+]}.
+ or select \key {Alt+]}.
\endlist
\note The macro recorder does not support code completion.
@@ -37,7 +37,7 @@
\list
\li Go to \uicontrol Tools > \uicontrol {Text Editing Macros} >
\uicontrol {Play Last Macro}.
- \li Press \key {Alt+R}.
+ \li Select \key {Alt+R}.
\li Enter \c rm in the locator.
\endlist
diff --git a/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc b/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc
index dce4173b98e..addf18052d4 100644
--- a/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc
+++ b/doc/qtcreator/src/editors/creator-preferences-text-editor-behavior.qdoc
@@ -80,7 +80,7 @@
\uicontrol Unindents.
You can specify whether the \key Tab key automatically indents text when you
- press it. To automatically indent text, select \uicontrol Always in the
+ select it. To automatically indent text, select \uicontrol Always in the
\uicontrol {Tab key performs auto-indent} field. To only indent text when
the cursor is located within leading white space, select \uicontrol {In
Leading White Space}.
diff --git a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc
index 6ef8f778737..923db60dabb 100644
--- a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc
+++ b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc
@@ -33,7 +33,7 @@
quick fix.
\endlist
- Or, press \key {Alt+Enter} to open a context menu that has
+ Or, select \key {Alt+Enter} to open a context menu that has
quick fixes available in the current cursor position.
By default, the refactored files are saved automatically. To turn off
diff --git a/doc/qtcreator/src/editors/creator-search.qdoc b/doc/qtcreator/src/editors/creator-search.qdoc
index dfe6b594e07..d703f8794fc 100644
--- a/doc/qtcreator/src/editors/creator-search.qdoc
+++ b/doc/qtcreator/src/editors/creator-search.qdoc
@@ -21,7 +21,7 @@
\list 1
- \li Press \key {Ctrl+F} or go to \uicontrol Edit >
+ \li Select \key {Ctrl+F} or go to \uicontrol Edit >
\uicontrol {Find/Replace} > \uicontrol {Find/Replace}.
\li In \uicontrol Find, enter the text you are looking for.
@@ -32,10 +32,10 @@
type.
\li To go to the next occurrence, select \inlineimage icons/next.png
- (\uicontrol {Find Next}), or press \key F3.
+ (\uicontrol {Find Next}), or select \key F3.
\li To go to the previous occurrence, select \inlineimage icons/prev.png
- (\uicontrol {Find Previous}), or press \key {Shift+F3}.
+ (\uicontrol {Find Previous}), or select \key {Shift+F3}.
\li To select all found occurrences in a file, select
\uicontrol {Select All}.
@@ -146,7 +146,7 @@
\section1 Search in all projects
\list 1
- \li Press \key {Ctrl+Shift+F} or go to \uicontrol Edit >
+ \li Select \key {Ctrl+Shift+F} or go to \uicontrol Edit >
\uicontrol {Find/Replace} > \uicontrol {Advanced Find} >
\uicontrol {Open Advanced Find}.
\li In \uicontrol Scope, select \uicontrol {All Projects}.
diff --git a/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc b/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc
index 792a7306878..68328d108f1 100644
--- a/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc
+++ b/doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc
@@ -126,12 +126,12 @@
Use keyboard shortcuts to move within and between code blocks:
\list
- \li To go to block end, press \key {Ctrl+]}.
- \li To go to block start, press \key {Ctrl+[}.
+ \li To go to block end, select \key {Ctrl+]}.
+ \li To go to block start, select \key {Ctrl+[}.
\endlist
To also select the lines from the cursor position to the end
- or beginning of the block, press \key {Ctrl+Shift+]} and
+ or beginning of the block, select \key {Ctrl+Shift+]} and
\key {Ctrl+Shift+[}, respectively.
\endif
diff --git a/doc/qtcreator/src/external-resources/external-resources-qds.qdoc b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc
index 1cd90ae903f..44795b9ee84 100644
--- a/doc/qtcreator/src/external-resources/external-resources-qds.qdoc
+++ b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc
@@ -3,19 +3,15 @@
/*!
\externalpage https://doc.qt.io/qtdesignstudio/index.html
- \title Qt Design Studio Manual
+ \title Qt Design Studio documentation
*/
/*!
\externalpage https://doc.qt.io/qtdesignstudio/studio-optimized-3d-scenes.html
- \title Creating Optimized 3D Scenes
+ \title Creating optimized 3D scenes
*/
/*!
\externalpage https://doc.qt.io/qtdesignstudio/qtquick-optimizing-designs.html
- \title Optimizing Designs
-*/
-/*!
- \externalpage https://doc.qt.io/qtdesignstudio/studio-optimized-3d-scenes.html
- \title Creating Optimized 3D Scenes
+ \title Optimizing designs
*/
/*!
\externalpage https://doc.qt.io/QtForMCUs/
@@ -105,6 +101,38 @@
\externalpage https://doc.qt.io/qt/linguist-id-based-i18n.html
\title Text ID based translations
*/
+/*!
+ \externalpage https://doc.qt.io/qtcreator/creator-developing-mcu.html
+ \title Developing for MCUs
+*/
+/*!
+ \externalpage https://doc.qt.io/qtcreator/creator-how-tos.html#mcus
+ \title How To: Develop for MCUs
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-setup-development-host.html#prerequisites
+ \title MCU prerequisites for desktop
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-setup-development-host.html#qt-creator-setup
+ \title MCU kit for desktop
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-prerequisites.html
+ \title MCU target device-specific prerequisites
+*/
+/*!
+ \externalpage https://doc.qt.io/qtcreator/creator-how-to-create-mcu-kits.html
+ \title MCU kit for a target device
+*/
+/*!
+ \externalpage https://doc.qt.io/QtForMCUs/qtul-supported-platforms.html
+ \title Supported MCU target devices
+*/
+/*!
+ \externalpage https://wiki.qt.io/QtDesignStudio/MCU_FAQ
+ \title Qt Design Studio/MCU FAQ
+*/
/*!
\externalpage https://www.qt.io/blog/qt-design-studio-4.6-released
\title Qt Design Studio 4.6 released
diff --git a/doc/qtcreator/src/howto/creator-external-tools.qdoc b/doc/qtcreator/src/howto/creator-external-tools.qdoc
index 155b40be0f5..e1c25f3ef0b 100644
--- a/doc/qtcreator/src/howto/creator-external-tools.qdoc
+++ b/doc/qtcreator/src/howto/creator-external-tools.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -10,8 +10,8 @@
/*!
\page creator-editor-external.html
\if defined(qtdesignstudio)
- \previouspage quick-converting-ui-projects.html
- \nextpage studio-on-mcus.html
+ \previouspage creator-vcs-git.html
+ \nextpage studio-accessing-output-issues-and-warnings.html
\else
\previouspage creator-how-tos.html
\endif
diff --git a/doc/qtcreator/src/howto/creator-help.qdoc b/doc/qtcreator/src/howto/creator-help.qdoc
index 06f669472f0..8127374ebda 100644
--- a/doc/qtcreator/src/howto/creator-help.qdoc
+++ b/doc/qtcreator/src/howto/creator-help.qdoc
@@ -27,9 +27,9 @@
symbol.
\li To show tooltips for function signatures regardless of the
- cursor position in the function call, press \key {Ctrl+Shift+D}.
+ cursor position in the function call, select \key {Ctrl+Shift+D}.
- \li To show the full help on a Qt class or function, press \key F1 or
+ \li To show the full help on a Qt class or function, select \key F1 or
select \uicontrol {Context Help} in the context menu.
The documentation is shown in a
view next to the code editor, or, if there is not enough vertical
@@ -305,7 +305,7 @@
\title Detach the help window
By default, context-sensitive help opens in a window next to the
- code editor when you press \key F1. If there is not enough vertical
+ code editor when you select \key F1. If there is not enough vertical
space, the help opens in the full-screen help mode.
\if defined(qtdesignstudio)
diff --git a/doc/qtcreator/src/howto/creator-keyboard-preferences.qdoc b/doc/qtcreator/src/howto/creator-keyboard-preferences.qdoc
index 66eab4e7858..27f3cdee343 100644
--- a/doc/qtcreator/src/howto/creator-keyboard-preferences.qdoc
+++ b/doc/qtcreator/src/howto/creator-keyboard-preferences.qdoc
@@ -59,7 +59,7 @@
\list 1
\li Select \uicontrol Record.
- \li Press the keys to use as the keyboard shortcut.
+ \li Select the keys to use as the keyboard shortcut.
\li Select \uicontrol {Stop Recording} when you are done.
\endlist
diff --git a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc
index 1005f891089..fa182111007 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc
@@ -421,7 +421,7 @@
To locate Qt Test data tags:
\list 1
- \li Press \key {Ctrl+K} (\key {Cmd+K} on \macos) to activate the locator.
+ \li Select \key {Ctrl+K} (\key {Cmd+K} on \macos) to activate the locator.
\li Enter \c qdt, followed by a space.
\endlist
diff --git a/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc b/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
index 49d4958149b..c19501cc32c 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
@@ -133,7 +133,7 @@
\row
\li -presentationMode
\li Core plugin: display keyboard shortcuts as popups when you
- press them. Mostly useful when presenting \QC to someone else.
+ select them. Mostly useful when presenting \QC to someone else.
\row
\li -theme
diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-contact-qt.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-contact-qt.qdoc
index cc5ed247c5f..55d4a5bd4ff 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-how-to-contact-qt.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-contact-qt.qdoc
@@ -45,6 +45,5 @@
{#qt-creator} channel on Libera.Chat IRC, go to \uicontrol Help >
\uicontrol Contact.
- \sa {Paste and fetch code snippets}, {Technical Support},
- {Turn on crash reports}
+ \sa {Paste and fetch code snippets}, {Technical support}
*/
diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc
index fad52f18617..50a8dbe5947 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc
@@ -89,5 +89,5 @@
{Building Qt Creator from Git}.
\sa {Manage Kits}{How To: Manage Kits}, {Register installed Qt versions},
- {Install plugins}, {Licenses and Acknowledgments}
+ {Install plugins}, {Licenses and acknowledgments}
*/
diff --git a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
index 63a428febe1..b510ba618b5 100644
--- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
@@ -149,7 +149,7 @@
To trigger the GDB command that generates a core file while debugging,
go to \uicontrol View > \uicontrol Views > \l {Debugger Log}.
- In the \uicontrol Command field, type \c gcore and press \key Enter. The
+ In the \uicontrol Command field, type \c gcore and select \key Enter. The
core file is created in the current working directory. You can specify
another location for the file, including a relative or absolute path, as an
argument of the command.
@@ -285,7 +285,7 @@
One common factor in many use cases is switching editors while working on a
set of open files. While working on files A and B, users sometimes need to
- look at file C. They can press \key Ctrl+Tab to move between the files and
+ look at file C. They can select \key Ctrl+Tab to move between the files and
have the files open in the correct editor according to file type. The list
is sorted by last used.
@@ -298,9 +298,9 @@
\list
- \li Press \key F4 to switch between header and source.
+ \li Select \key F4 to switch between header and source.
- \li Press \key Alt+Left to move backwards in the navigation history.
+ \li Select \key Alt+Left to move backwards in the navigation history.
\li Use the locator (Ctrl+K) to simply tell \QC where to go.
@@ -319,7 +319,7 @@
With \QC, developers can type \c {Ctrl+K m AFun} to find the function.
Typically, they only need to type 3 to 4 characters of the function name.
- They can then fix the problem and press \key Alt+Back to go back to where
+ They can then fix the problem and select \key Alt+Back to go back to where
they were.
Other locator filters include \c c for classes, \c : for all symbols, and
diff --git a/doc/qtcreator/src/howto/creator-sessions.qdoc b/doc/qtcreator/src/howto/creator-sessions.qdoc
index 0f455cbc0fc..875c9f721c6 100644
--- a/doc/qtcreator/src/howto/creator-sessions.qdoc
+++ b/doc/qtcreator/src/howto/creator-sessions.qdoc
@@ -113,7 +113,7 @@
To locate a session:
\list 1
- \li Press \key {Ctrl+K} (\key {Cmd+K} on \macos) to activate the locator.
+ \li Select \key {Ctrl+K} (\key {Cmd+K} on \macos) to activate the locator.
\li Enter:
\list
\li \c {t} \e {}
diff --git a/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc b/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc
index 7e3df7a988b..041ba3dde53 100644
--- a/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc
+++ b/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc
@@ -18,7 +18,7 @@
add the path to the CMake executable on the \1.
\li Go to \uicontrol {Preferences} > \uicontrol Kits >
- \uicontrol {Qt Versions}, and then press \key Shift and click the
+ \uicontrol {Qt Versions}, and then select and hold \key Shift and select the
\uicontrol Add button to add the Qt version on the \1.
\li Go to \uicontrol {Preferences} > \uicontrol Kits >
diff --git a/doc/qtcreator/src/overview/creator-acknowledgements.qdoc b/doc/qtcreator/src/overview/creator-acknowledgements.qdoc
index f1ccb416af0..64ad33f08b3 100644
--- a/doc/qtcreator/src/overview/creator-acknowledgements.qdoc
+++ b/doc/qtcreator/src/overview/creator-acknowledgements.qdoc
@@ -17,7 +17,7 @@
\ingroup creator-reference
- \title Licenses and Acknowledgments
+ \title Licenses and acknowledgments
\brief Licenses and third-party components in \QC.
diff --git a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
index ecc13a24556..0fcdc482965 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
@@ -129,7 +129,7 @@
\section2 Navigating with the Keyboard
- To move between UI controls, press the the \key Tab key or the \key Left,
+ To move between UI controls, select the \key Tab key or the \key Left,
\key Right, \key Up, and \key Down arrow keys.
\section2 Setting Zoom Levels
diff --git a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc
index 13b1ec37746..c218b0ffb6c 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc
@@ -22,10 +22,10 @@
If you have not used an integrated development environment (IDE)
before, or want to know what kind of IDE \QC is, go to
\l{Overview}.
- \li \b {\l{User Interface}}
+ \li \b {\l{User interface}}
If you have not used \QC before, and want to become familiar
- with the parts of the user interface, go to \l{User Interface}.
+ with the parts of the user interface, go to \l{User interface}.
\li \b {\l{Configuring Qt Creator}}
To make \QC behave more like your favorite code editor or IDE,
diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
index 19717732963..ebd2f4d9cab 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
@@ -68,12 +68,12 @@
\image heartgame-start.webp {Heart Rate Game}
To create intuitive, modern-looking, fluid user interfaces (UI), use
- \l{Qt Quick} and \l{Qt Design Studio Manual}{\QDS}:
+ \l{Qt Quick} and \l{Qt Design Studio documentation}{\QDS}:
\list
\li \l {\QMLD}
- Or, enable the \QMLD plugin to visually edit \l{UI Files}{UI files}
+ Or, enable the \QMLD plugin to visually edit \l{UI files}
(.ui.qml).
\li \l {Converting UI Projects to Applications}
@@ -82,14 +82,14 @@
development, you have to convert them to Qt Quick
Application projects that have project configuration
files (CMakeLists.txt or .pro), .cpp, and .qrc files.
- \li \l {UI Files}
+ \li \l {UI files}
If you switch between \QC and \QDS or cooperate with
designers on a project, you might encounter .ui.qml files.
They are intended to be edited in \QDS only, so you need
to be careful not to break the code. To visually edit the
files in \QC, enable the \QMLD plugin.
- \li \l{Using QML Modules with Plugins}
+ \li \l{Using QML modules with plugins}
Load C++ plugins for QML to simulate data.
\endlist
diff --git a/doc/qtcreator/src/overview/creator-tech-support.qdoc b/doc/qtcreator/src/overview/creator-tech-support.qdoc
index d451c0656a1..d88a0e0bd09 100644
--- a/doc/qtcreator/src/overview/creator-tech-support.qdoc
+++ b/doc/qtcreator/src/overview/creator-tech-support.qdoc
@@ -19,7 +19,7 @@
\ingroup creator-reference
- \title Technical Support
+ \title Technical support
\brief Qt support sites and other useful sites.
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc
index a0ca1155568..02ac8167709 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc
@@ -31,7 +31,7 @@
between the host and devices. For more information, see
\l{\B2Q: Documentation}.
- If you have \l{Qt Design Studio Manual}{\QDS} installed, you can open
+ If you have \l{Qt Design Studio documentation}{\QDS} installed, you can open
\QDS examples from \QC in \QDS.
\list 1
@@ -72,7 +72,7 @@
\li Select \inlineimage icons/run_small.png
(\uicontrol Run) to build and run the application.
- \li To see the compilation progress, press \key{Alt+4} to open
+ \li To see the compilation progress, select \key{Alt+4} to open
\l {Compile Output}.
If build errors occur, check that you have a Qt version, a
@@ -88,5 +88,5 @@
\sa {Manage Kits}{How To: Manage Kits}, {Open projects},
{Developing for Android}, {Developing for iOS},
- {Compile Output}, {\B2Q: Documentation}, {Qt Design Studio Manual}
+ {Compile Output}, {\B2Q: Documentation}, {Qt Design Studio documentation}
*/
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc
index a0189b216ab..47d580d0c22 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc
@@ -55,7 +55,7 @@
\list
\li Select \inlineimage icons/cancel-build.png.
- \li Press \key {Alt+Backspace}.
+ \li Select \key {Alt+Backspace}.
\li Go to \uicontrol Build > \uicontrol {Cancel Build}.
\endlist
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
index 1576fc58be6..b4002f83853 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
@@ -39,10 +39,10 @@
\li Use the following keyboard shortcuts, depending on the mode you are
currently in:
\list
- \li In all modes, press \key Ctrl+O (\key Cmd+O on \macos) to open the
+ \li In all modes, select \key Ctrl+O (\key Cmd+O on \macos) to open the
\uicontrol {Open File} dialog, where you can select a project file.
\li On Windows and Linux, in all modes except the \uicontrol Help mode,
- press \key Ctrl+Shift+O to open the \uicontrol {Load Project} dialog.
+ select \key Ctrl+Shift+O to open the \uicontrol {Load Project} dialog.
\li In the \uicontrol Welcome mode, \uicontrol Projects tab, press
\key Ctrl+Shift+number (\key Cmd+Shift+number on \macos), where
the number is the number of a project in the list of recently opened
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc
index 1e01dbad8aa..546d5aa032d 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc
@@ -72,7 +72,7 @@
\uicontrol {Qt Versions} > \uicontrol Add.
To add a Qt version on a remote Linux device or in Docker,
- press \key Shift and click \uicontrol Add.
+ select \key Shift and click \uicontrol Add.
\li Select the qmake executable for the Qt version to add.
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
index 9b1fd30dc36..acbf3a20c69 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
@@ -56,7 +56,7 @@
If you selected CMake as the build system for the project, a
\e {Release with Debug Information} build configuration is also available.
It is similar to a \e profile configuration, but with
- \l{Debugging Qt Quick Projects}{QML debugging and profiling} explicitly turned off.
+ \l{Debugging Qt Quick projects}{QML debugging and profiling} explicitly turned off.
You can also use a \e {Minimum Size Release} build configuration to create the
final installation binary package. It is a release build that makes the size
of the binary package as small as possible, even if this makes the
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc
index 486b8b8c4c5..4899e2d06c7 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc
@@ -38,7 +38,7 @@
However, you can usually leave this field empty.
\note To create a build configuration that supports debugging for a
- Qt Quick application project, you also need to \l {Using Default Values}
+ Qt Quick application project, you also need to \l {Using default values}
{enable QML debugging} either globally or in the \uicontrol {Build Settings}
of the project.
diff --git a/doc/qtcreator/src/python/creator-tutorial-python-application-qt-widgets-ui.qdoc b/doc/qtcreator/src/python/creator-tutorial-python-application-qt-widgets-ui.qdoc
index 8380a6495ca..1b9ffeaf57c 100644
--- a/doc/qtcreator/src/python/creator-tutorial-python-application-qt-widgets-ui.qdoc
+++ b/doc/qtcreator/src/python/creator-tutorial-python-application-qt-widgets-ui.qdoc
@@ -100,7 +100,7 @@
\b{Select me}.
\li Double-click the \uicontrol {Push Button} widget and enter the text
\b{Click me}.
- \li Press \key {Ctrl+S} (or \key {Cmd+S}) to save your changes.
+ \li Select \key {Ctrl+S} (or \key {Cmd+S}) to save your changes.
\endlist
For more information about designing UIs with \QD, see \l{\QD Manual}.
diff --git a/doc/qtcreator/src/python/creator-tutorial-python-application-qtquick.qdoc b/doc/qtcreator/src/python/creator-tutorial-python-application-qtquick.qdoc
index c49dc1cbd5a..eb153c88b6f 100644
--- a/doc/qtcreator/src/python/creator-tutorial-python-application-qtquick.qdoc
+++ b/doc/qtcreator/src/python/creator-tutorial-python-application-qtquick.qdoc
@@ -190,7 +190,7 @@
}
\endcode
- You can also use \l{Qt Design Studio Manual}{\QDS} to design Qt Quick UIs.
+ You can also use \l{Qt Design Studio documentation}{\QDS} to design Qt Quick UIs.
\section1 Run the application
diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc
index abb0fbb189c..2d1ee0f8fd9 100644
--- a/doc/qtcreator/src/qtcreator-toc.qdoc
+++ b/doc/qtcreator/src/qtcreator-toc.qdoc
@@ -17,7 +17,7 @@
\li \l{Getting Started}
\list
\li \l{Overview}
- \li \l{User Interface}
+ \li \l{User interface}
\li \l{Configuring Qt Creator}
\endlist
\li \l{Creating Projects}
diff --git a/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc b/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc
index 60c9b29f4df..0a0cb3181c5 100644
--- a/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc
+++ b/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc
@@ -202,7 +202,7 @@
\uicontrol {Always allow from this computer} check box, and then select
\uicontrol OK.
- \li To run the application on the device, press \key {Ctrl+R}.
+ \li To run the application on the device, select \key {Ctrl+R}.
\endlist
*/
diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
index ab1e9afe08c..6bc3afd7fa6 100644
--- a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
+++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc
@@ -27,7 +27,7 @@
For more examples, see \l{Qt Quick Examples and Tutorials}.
You can use a visual editor to develop Qt Quick applications in \QDS. For
- more information, see \l{Qt Design Studio Manual}.
+ more information, see \l{Qt Design Studio documentation}.
\include qtquick-tutorial-create-empty-project.qdocinc qtquick empty application
@@ -149,7 +149,7 @@
\skipto import
\printuntil /^\ {0}\}/
- Press \key {Ctrl+R} to run the application, and click the rectangles to
+ Select \key {Ctrl+R} to run the application, and click the rectangles to
move the Qt logo from one rectangle to another.
\section1 Animate transitions
@@ -180,6 +180,6 @@
\printuntil /^\ {0}\}/
- Press \key {Ctrl+R} to run the application, and click the rectangles to
+ Select \key {Ctrl+R} to run the application, and click the rectangles to
view the animated transitions.
*/
diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-designer-plugin.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-designer-plugin.qdoc
index 3eeed1adf07..11b7cff99ce 100644
--- a/doc/qtcreator/src/qtquick/creator-only/qtquick-designer-plugin.qdoc
+++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-designer-plugin.qdoc
@@ -13,7 +13,7 @@
Use wizards to create Qt Quick projects that have boiler-plate code. Change
the code in the \uicontrol Edit mode or use a separate visual editor,
- \l{Qt Design Studio Manual}{\QDS} to open and edit \l{UI Files}{UI files}
+ \l{Qt Design Studio documentation}{\QDS} to open and edit \l{UI files}
(.ui.qml).
Don't edit UI files in the \uicontrol Edit mode because it is easy
@@ -43,7 +43,7 @@
{QML types}, see the Qt reference documentation available online and
in the \uicontrol Help mode.
- For more information about using \QMLD, see \l{Qt Design Studio Manual}.
+ For more information about using \QMLD, see \l{Qt Design Studio documentation}.
\sa {Create Qt Quick Applications}, {Create Qt Quick UI Prototypes},
{Enable and disable plugins}
diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-from-qmlproject-to-pro.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-from-qmlproject-to-pro.qdoc
new file mode 100644
index 00000000000..80e532610de
--- /dev/null
+++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-from-qmlproject-to-pro.qdoc
@@ -0,0 +1,17 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \page quick-converting-ui-projects.html
+ \nextpage creator-editor-external.html
+ \previouspage creator-reference.html
+
+ \ingroup creator-reference-ui-design
+
+ \title Converting UI Projects to Applications
+
+ \brief Converting a project that has a .qmlproject file to one that has a
+ .pro file.
+
+ \include qtquick-converting-ui-projects-to-applications.qdocinc {converting-ui-projects-to-applications} {Qt Quick UI Prototype}
+*/
diff --git a/doc/qtcreator/src/qtquick/qtquick-converting-ui-projects-to-applications.qdocinc b/doc/qtcreator/src/qtquick/qtquick-converting-ui-projects-to-applications.qdocinc
new file mode 100644
index 00000000000..ea7b8cf70f1
--- /dev/null
+++ b/doc/qtcreator/src/qtquick/qtquick-converting-ui-projects-to-applications.qdocinc
@@ -0,0 +1,178 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+//! [converting-ui-projects-to-applications]
+
+ \1 projects are useful for creating user interfaces. To
+ use them for application development in Qt Creator you have to add:
+
+ \list
+ \li A project configuration file (CMakeLists.txt or a .pro file)
+ \li C++ code (.cpp)
+ \li Resource files
+ \li Code needed for deploying applications to \l{glossary-device}
+ {devices}
+ \endlist
+
+ For more information about integrating QML and C++, see
+ \l{Overview - QML and C++ Integration}.
+
+ \note Since \QDS 2.3.0, \QDS project wizard templates generate projects that
+ can be built with CMake. You can open the \e CMakeLists.txt project file in
+ Qt Creator to continue developing the project. Also, you can use Qt Creator
+ to create a Qt Quick Application project that you can open in \QDS.
+
+ \target wizard-template-note
+ \note Since \QDS 3.9.0, \QDS project wizard templates generate projects that
+ automatically check out and build the Qt Quick Studio Components from
+ \l{https://code.qt.io/cgit/qt-labs/qtquickdesigner-components.git/} {Qt Code Review},
+ using CMake. To turn off this feature, use the option \e BUILD_QDS_COMPONENTS
+ in the CMake configuration.
+
+ \if defined(qtcreator)
+ For more information about using \QDS to create projects, see
+ \l{Qt Design Studio documentation}.
+ \endif
+
+ To use qmake as the build system, use a Qt Creator
+ wizard template to create a Qt Quick application that is built using the
+ qmake build system and then copy the source files from the Qt UI Quick
+ project to the application project.
+
+ You can use the \c RESOURCES option in the project configuration file to
+ automatically add all the QML files and related assets to a
+ \l{The Qt Resource System}{Qt resource collection file (.qrc)}. However,
+ large files should be included as external binary resources instead of
+ compiling them into the binary.
+
+ The wizard automatically adds the \c QML_IMPORT_PATH option to the project
+ file for specifying the required \l{QML Import Path}{QML import path}. The
+ path is only needed if more than one subdirectory has QML files.
+
+ Then you can use the \l QQuickView class in the main C++ source file to
+ show the main QML file when the application starts.
+
+ \if defined(qtcreator)
+ The \e {Qt Quick Designer Components} module is installed when you
+ install \QDS. If you use Qt Quick Studio Components or Effects
+ from the module in a project that you want to edit in Qt Creator,
+ you have to build the module and install it to your Qt to be able to
+ build your project. For more information, see
+ \l{Adding Qt Quick Designer Components to Qt Installations}.
+
+ The \l{Qt Quick Timeline} module is installed when you install \QDS.
+ If you only install Qt Creator and Qt, remember to also select the
+ Qt Quick Timeline module for installation. If your Qt is older than
+ 5.14, you must build the Qt Quick Timeline module and install it to
+ your Qt to be able to build your project.
+
+ \section1 Converting into qmake Projects
+
+ To convert a project that has a .qmlproject file to one that has a .pro
+ file:
+
+ \list 1
+ \li Select \uicontrol File > \uicontrol {New Project} >
+ \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application} >
+ \uicontrol Choose.
+ \li In the \uicontrol {Build system} field, select \l qmake as the build
+ system to use for building and running the project, and then select
+ \uicontrol Next (or \uicontrol Continue on \macos).
+ \li Follow the instructions of the wizard to create the project.
+ \li In the file explorer, copy the source files from the Qt Quick UI
+ project directory to a subdirectory in the application
+ project directory. For the purpose of these instructions, the
+ directory is called \c qml.
+ \li Open the application project file, and edit the value of the
+ \c RESOURCES option to add the following line:
+ \badcode
+ RESOURCES += \
+ $$files(qml/*)
+ \endcode
+ \li Also edit the value of the \c QML_IMPORT_PATH option to specify the
+ QML import path:
+ \badcode
+ QML_IMPORT_PATH = qml/imports
+ \endcode
+ Where \c {qml/imports} is the import path.
+ \li Select \uicontrol Build > \uicontrol {Run qmake} to apply the
+ \c RESOURCES option to the build configuration.
+ \li Open the \e {main.cpp} file and replace the QQmlApplicationEngine
+ object with a QQuickView object:
+ \quotefromfile progressbar/main.cpp
+ \skipto QQuickView view;
+ \printuntil view.show()
+ Where \c {qrc:/qml/imports} is the import path and
+ \c {qrc:/qml/ProgressBar.ui.qml} is the path to and the
+ name of the main QML file in the Qt Quick UI project.
+ \li Select \uicontrol Build > \uicontrol Run to build and run your
+ project.
+
+ \note If you get error messages related to modules, perfom the steps
+ described in \l{Adding Qt Quick Designer Components to Qt Installations}.
+ \endlist
+
+ For example, if you copy the source files of the \e ProgressBar
+ example from your \QDS installation (located in the
+ \c{\share\qtcreator\examples\ProgressBar} directory) to an empty
+ Qt Quick application project and make the necessary changes, the
+ \e {main.cpp} file should look as follows:
+
+ \quotefile progressbar/main.cpp
+ \endif
+
+ \if defined(qtdesignstudio)
+ If you only install Qt Creator and Qt, remember to also select the
+ Qt Quick Timeline module for installation.
+ \endif
+
+ \section1 Handling Large Data Files
+
+ Graphical assets used in the UI, such as images, effects, or 3D scenes
+ are a typical cause for performance problems in UIs. Even building the
+ application requires huge amounts of memory if you try to include large
+ asset files, such as 100-MB 3D models or 64-MB textures, into the \c .qrc
+ file for compiling them into the binary.
+
+ First try to optimize your assets, as described in
+ \l{Optimizing designs} and \l {Creating optimized 3D scenes}.
+
+ Large assets should either be loaded directly from the file system or by
+ using the Qt resource system dynamically. For more information, see
+ \l{The Qt Resource System}.
+
+ \section1 Adding Qt Quick Designer Components to Qt Installations
+
+ Since \QDS 3.9, the Qt Quick Studio Components module is installed by default
+ as part of the application created with \QDS. You can also install the module manually.
+
+ For example:
+ \list 1
+ \li Clone the module repository.
+ \badcode
+ git clone https://code.qt.io/qt-labs/qtquickdesigner-components.git
+ \endcode
+
+ \li Install the Qt Quick Designer Components module.
+
+ \badcode
+ mkdir build
+ cd build
+ cmake -GNinja -DCMAKE_INSTALL_PREFIX=
+ cmake --build .
+ cmake --install .
+ \endcode
+ \note Here, \e and \e
+ needs to be replaced with the real location on your local drive. For example,
+ \e can be something like \e /Qt/6.3.0/msvc2019_64
+ and \e like this \e ../qtquickdesigner-components/
+ \endlist
+
+ \if defined(qtcreator)
+ \sa {Create Qt Quick UI Prototypes}
+ \endif
+
+
+//! [converting-ui-projects-to-applications]
+*/
diff --git a/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc b/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc
deleted file mode 100644
index ec520333197..00000000000
--- a/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc
+++ /dev/null
@@ -1,194 +0,0 @@
-// Copyright (C) 2021 The Qt Company Ltd.
-// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
-
-/*!
- \page quick-converting-ui-projects.html
- \if defined(qtdesignstudio)
- \previouspage studio-porting-projects.html
- \nextpage creator-editor-external.html
- \else
- \previouspage creator-reference.html
- \endif
-
- \ingroup creator-reference-ui-design
-
- \title Converting UI Projects to Applications
-
- \brief Converting a project that has a .qmlproject file to one that has a
- .pro file.
-
- Qt Quick UI Prototype projects are useful for creating user interfaces. To
- use them for application development in Qt Creator you have to add:
-
- \list
- \li Project configuration file (CMakeLists.txt or .pro)
- \li C++ code (.cpp)
- \li Resource files
- \li Code needed for deploying applications to \l{glossary-device}
- {devices}
- \endlist
-
- For more information about integrating QML and C++, see
- \l{Overview - QML and C++ Integration}.
-
- \note Since \QDS 2.3.0, \QDS project wizard templates generate projects that
- can be built with CMake. You can open the \e CMakeLists.txt project file in
- Qt Creator to continue developing the project. Also, you can use Qt Creator
- to create a Qt Quick Application project that you can open in \QDS.
-
- \target wizard-template-note
- \note Since \QDS 3.9.0, \QDS project wizard templates generate projects that
- automatically checkout and build the Qt Quick Studio Components from
- \l{https://code.qt.io/cgit/qt-labs/qtquickdesigner-components.git/} {Qt Code Review},
- using CMake. To turn off this feature, use the option \e BUILD_QDS_COMPONENTS
- in the CMake configuration.
-
- \if defined(qtdesignstudio)
- For more information, see \l{Designer-Developer Workflow}.
- \else
- For more information about using \QDS to create projects, see
- \l{Qt Design Studio Manual}.
- \endif
-
-
- If you want to use qmake as the build system, you can use a Qt Creator
- wizard template to create a Qt Quick application that is built using the
- qmake build system and then copy the source files from the Qt UI Quick
- project to the application project.
-
- You can use the \c RESOURCES option in the project configuration file to
- automatically add all the QML files and related assets to a
- \l{The Qt Resource System}{Qt resource collection file (.qrc)}. However,
- large files should be included as external binary resources instead of
- compiling them into the binary.
-
- The wizard automatically adds the \c QML_IMPORT_PATH option to the project
- file for specifying the required \l{QML Import Path}{QML import path}. The
- path is only needed if more than one subdirectory has QML files.
-
- Then you can use the \l QQuickView class in the main C++ source file to
- show the main QML file when the application starts.
-
- The \e {Qt Quick Designer Components} module is installed when you
- install \QDS. If you use Qt Quick Studio Components or Effects
- from the module in a project that you want to edit in Qt Creator,
- you have to build the module and install it to your Qt to be able to
- build your project. For more information, see
- \l{Adding Qt Quick Designer Components to Qt Installations}.
-
- The \l{Qt Quick Timeline} module is installed when you install \QDS.
- If you only install Qt Creator and Qt, remember to also select the
- Qt Quick Timeline module for installation. If your Qt is older than
- 5.14, you must build the Qt Quick Timeline module and install it to
- your Qt to be able to build your project.
-
- \section1 Converting into qmake Projects
-
- To convert a project that has a .qmlproject file to one that has a .pro
- file:
-
- \list 1
- \li Select \uicontrol File > \uicontrol {New Project} >
- \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application} >
- \uicontrol Choose.
- \li In the \uicontrol {Build system} field, select \l qmake as the build
- system to use for building and running the project, and then select
- \uicontrol Next (or \uicontrol Continue on \macos).
- \li Follow the instructions of the wizard to create the project.
- \li In the file explorer, copy the source files from the Qt Quick UI
- project directory to a subdirectory in the application
- project directory. For the purpose of these instructions, the
- directory is called \c qml.
- \li Open the application project file, and edit the value of the
- \c RESOURCES option to add the following line:
- \badcode
- RESOURCES += \
- $$files(qml/*)
- \endcode
- \li Also edit the value of the \c QML_IMPORT_PATH option to specify the
- QML import path:
- \badcode
- QML_IMPORT_PATH = qml/imports
- \endcode
- Where \c {qml/imports} is the import path.
- \li Select \uicontrol Build > \uicontrol {Run qmake} to apply the
- \c RESOURCES option to the build configuration.
- \li Open the \e {main.cpp} file and replace the QQmlApplicationEngine
- object with a QQuickView object:
- \quotefromfile progressbar/main.cpp
- \skipto QQuickView view;
- \printuntil view.show()
- Where \c {qrc:/qml/imports} is the import path and
- \c {qrc:/qml/ProgressBar.ui.qml} is the path to and the
- name of the main QML file in the Qt Quick UI project.
- \li Select \uicontrol Build > \uicontrol Run to build and run your
- project.
-
- \note If you get error messages related to modules, perfom the steps
- described in \l{Adding Qt Quick Designer Components to Qt Installations}.
- \endlist
-
- For example, if you copy the source files of the \e ProgressBar
- example from your \QDS installation (located in the
- \c{\share\qtcreator\examples\ProgressBar} directory) to an empty
- Qt Quick application project and make the necessary changes, the
- \e {main.cpp} file should look as follows:
-
- \quotefile progressbar/main.cpp
-
- \section1 Handling Large Data Files
-
- Graphical assets used in the UI, such as images, effects, or 3D scenes
- are a typical cause for performance problems in UIs. Even building the
- application requires huge amounts of memory if you try to include large
- asset files, such as 100-MB 3D models or 64-MB textures, into the \c .qrc
- file for compiling them into the binary.
-
- First try to optimize your assets, as described in \l{Optimizing Designs}
- and \l {Creating Optimized 3D Scenes}.
-
- If you really need large assets, they should either be loaded directly from
- the file system or use the Qt resource system in the dynamic way. For more
- information, see \l{The Qt Resource System} in the Qt documentation.
-
- \section1 Adding Custom Fonts
-
- \if defined(qtdesignstudio)
- To \l{Using Custom Fonts}{use custom fonts}
- \else
- To use custom fonts
- \endif
- from the Qt Quick UI project, call the QFontDatabase::addApplicationFont()
- function from the \e {main.cpp} file.
-
- \section1 Adding Qt Quick Designer Components to Qt Installations
-
- Since \QDS 3.9, the Qt Quick Studio Components module is installed by default
- as part of the application. You can also install the module manually.
-
- For example:
- \list 1
- \li Clone the module repository.
- \badcode
- git clone https://code.qt.io/qt-labs/qtquickdesigner-components.git
- \endcode
-
- \li Install the Qt Quick Designer Components module.
- Enter the following commands:
- \badcode
- mkdir build
- cd build
- cmake -GNinja -DCMAKE_INSTALL_PREFIX=
- cmake --build .
- cmake --install .
- \endcode
- \note Here, \e and \e
- needs to be replaced with the real location on your local drive. For example,
- \e can be something like \e /Qt/6.3.0/msvc2019_64
- and \e like this \e ../qtquickdesigner-components/
- \endlist
-
- \if defined(qtcreator)
- \sa {Create Qt Quick UI Prototypes}
- \endif
-*/
diff --git a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
index 87142f4a511..ccbe29b5554 100644
--- a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
@@ -7,7 +7,7 @@
\previouspage studio-live-preview-desktop.html
\nextpage qt-design-viewer.html
- \title Previewing on Devices
+ \title Previewing on devices
\else
\previouspage creator-how-tos.html
@@ -49,7 +49,7 @@
\image design-studio-select-kit.webp
\endif
\li Select \uicontrol Build > \uicontrol {QML Preview} or
- press \key {Alt+P}.
+ select \key {Alt+P}.
\endlist
\section2 On Android
diff --git a/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc
index e1f7e3bce54..f91c923b516 100644
--- a/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc
@@ -18,7 +18,7 @@
\ingroup creator-reference-ui-design
- \title Using QML Modules with Plugins
+ \title Using QML modules with plugins
\brief Using C++ plugins to expose custom components to Qt Quick
applications.
@@ -129,16 +129,16 @@
\if defined(qtdesignstudio)
\section1 Running QML Modules in Design Mode
- A QML emulation layer (also called QML Puppet) is used in the
+ The QML Puppet is used in the
\uicontrol Design mode to render and preview images and to collect
data. To be able to render custom components correctly from QML modules,
- the emulation layer must be built with the same Qt version and compiler
+ the QML Puppet must be built with the same Qt version and compiler
as the QML modules.
\include qtdesignstudio-qt-runtime-version.qdocinc qt-runtime-version
A plugin should behave differently depending on whether it is run by the
- emulation layer or an application. For example, animations should not be run
+ QML Puppet or an application. For example, animations should not be run
in the \uicontrol Design mode. You can use the value of the \c QML_PUPPET_MODE
environment variable to check whether the plugin is currently being run
by an application or edited in the \uicontrol Design mode.
diff --git a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc
index 4449f9e1bab..af567a7f754 100644
--- a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc
@@ -153,7 +153,7 @@
\ingroup creator-reference-analyzer
- \title Profiling QML Applications
+ \title Profiling QML applications
\brief Improve the performance of QML applications.
diff --git a/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc b/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc
index 13317a7336e..23bf9a1d4fd 100644
--- a/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc
@@ -18,7 +18,7 @@
\ingroup creator-reference-ui-design
- \title UI Files
+ \title UI files
\brief Limitations of \QDS UI files (.ui.qml).
@@ -156,7 +156,7 @@
\l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}.
\if defined(qtdesignstudio)
- \section1 Using UI Files
+ \section1 Using UI files
You can edit the UI files in the \l {2D} and
\uicontrol {Code} views. Components that are
diff --git a/doc/qtcreator/src/user-interface/creator-how-to-view-output.qdoc b/doc/qtcreator/src/user-interface/creator-how-to-view-output.qdoc
index 03f3e817560..b1d0cd768ad 100644
--- a/doc/qtcreator/src/user-interface/creator-how-to-view-output.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-how-to-view-output.qdoc
@@ -41,11 +41,11 @@
\endlist
To maximize an open output view, select the \inlineimage icons/arrowup.png
- (\uicontrol Maximize) button or press \key {Alt+Shift+9}.
+ (\uicontrol Maximize) button or select \key {Alt+Shift+9}.
To increase or decrease the output text size, select \inlineimage icons/plus.png
(\uicontrol {Zoom In}) or \inlineimage icons/minus.png
- (\uicontrol {Zoom Out}), or press \key Ctrl++ or \key Ctrl+-. Zooming is
+ (\uicontrol {Zoom Out}), or select \key Ctrl++ or \key Ctrl+-. Zooming is
not supported in all output views.
\section1 Change text encoding
@@ -60,7 +60,7 @@
\section1 Find and filter output
- To search in output, press \key {Ctrl+F} when the view is active. Enter
+ To search in output, select \key {Ctrl+F} when the view is active. Enter
search criteria in the \uicontrol Find field. For more information, see
\l{Search in current file}.
diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-main-menu.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-main-menu.qdoc
index 22d57b98c27..beddf52bdf6 100644
--- a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-main-menu.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-main-menu.qdoc
@@ -16,7 +16,7 @@
\image qtcreator-without-menubar.webp {Qt Creator without the main menu}
\caption \QC without the main menu bar.
- To show the main menu again, press \key {Ctrl+Alt+M}.
+ To show the main menu again, select \key {Ctrl+Alt+M}.
\sa {Show and hide sidebars},{Switch between modes}
*/
diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc
index 071c4381230..0bb3c6ac31d 100644
--- a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc
@@ -32,7 +32,7 @@
\li \uicontrol Welcome
\li \key Ctrl+1
\li Open projects, tutorials, and examples.
- \li \l{User Interface}
+ \li \l{User interface}
\row
\li \uicontrol Edit
\li \key Ctrl+2
diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-reference-sidebar-views.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-reference-sidebar-views.qdoc
index fc072d7687c..8fb8ebf315d 100644
--- a/doc/qtcreator/src/user-interface/creator-only/creator-reference-sidebar-views.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-only/creator-reference-sidebar-views.qdoc
@@ -84,7 +84,7 @@
\list 1
\li Right-click a class in the code editor.
- \li Select \uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
+ \li Select \uicontrol {Open Type Hierarchy} or select \key {Ctrl+Shift+T}.
\endlist
\image qtcreator-type-hierarchy-view.png {Type Hierarchy view}
@@ -118,7 +118,7 @@
\list 1
\li Right-click a file in the editor.
\li Select \uicontrol {Open Include Hierarchy}
- or press \key {Ctrl+Shift+I}.
+ or select \key {Ctrl+Shift+I}.
\endlist
\image qtcreator-include-hierarchy-view.png {Include Hierarchy view}
diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-reference-terminal-view.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-reference-terminal-view.qdoc
index dac80681896..de8bf56335f 100644
--- a/doc/qtcreator/src/user-interface/creator-only/creator-reference-terminal-view.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-only/creator-reference-terminal-view.qdoc
@@ -39,10 +39,10 @@
\li To select a word in a terminal, double-click it. To select the whole line,
triple-click it. To select all text, select \uicontrol {Select All}
- in the context menu or press \key {Ctrl+A}.
+ in the context menu or select \key {Ctrl+A}.
\li To open links in a browser, files in the editor, or folders in the
- \l Projects view, hover the mouse over them, and press \key Ctrl.
+ \l Projects view, hover the mouse over them, and select \key Ctrl.
\li To \l{Search in current file}{search} through the output, press
\key {Ctrl+F}.
diff --git a/doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc b/doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
index abe322edeb7..f53031965b4 100644
--- a/doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
@@ -54,7 +54,7 @@
To jump from one issue to the next or previous
one, select \inlineimage icons/arrowup.png
and \inlineimage icons/arrowdown.png
- or press \key F6 and \key Shift+F6.
+ or select \key F6 and \key Shift+F6.
By default, a new build clears the \uicontrol Issues view. To keep
the issues from the previous build rounds, deselect \preferences >
diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc
index a266a47fab3..dec2b657fc4 100644
--- a/doc/qtcreator/src/user-interface/creator-ui.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc
@@ -11,7 +11,7 @@
\nextpage creator-configuring.html
\endif
- \title User Interface
+ \title User interface
\if defined(qtcreator)
When you start \QC, it opens to the \uicontrol Welcome mode.
diff --git a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc
index 31e13c8185e..d2d51abfe60 100644
--- a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc
+++ b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc
@@ -11,7 +11,7 @@
\page creator-vcs-git.html
\if defined(qtdesignstudio)
\previouspage studio-finding-the-qt-runtime-version.html
- \nextpage studio-porting-projects.html
+ \nextpage creator-editor-external.html
\title Using Git
\else
diff --git a/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc b/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc
index 5f68781285a..0185ddd3550 100644
--- a/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc
+++ b/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc
@@ -155,8 +155,8 @@
\image qtcreator-textfinder-objectname.png {Changing object names}
- \li Press \key {Ctrl+A} (or \key {Cmd+A}) to select the widgets and
- select \uicontrol{Lay out Horizontally} (or press \key {Ctrl+H} on Linux or
+ \li Select \key {Ctrl+A} (or \key {Cmd+A}) to select the widgets and
+ select \uicontrol{Lay out Horizontally} (or select \key {Ctrl+H} on Linux or
Windows or \key {Ctrl+Shift+H} on \macos) to apply a horizontal
layout (QHBoxLayout).
@@ -165,7 +165,7 @@
\li Drag a \uicontrol{Text Edit} widget (QTextEdit) to the form.
\li Select the screen area, and then select \uicontrol{Lay out Vertically}
- (or press \key {Ctrl+L}) to apply a vertical layout (QVBoxLayout).
+ (or select \key {Ctrl+L}) to apply a vertical layout (QVBoxLayout).
\image qtcreator-textfinder-ui.png {Text Finder UI}
@@ -193,7 +193,7 @@
\endlist
- \li Press \key {Ctrl+S} (or \key {Cmd+S}) to save your changes.
+ \li Select \key {Ctrl+S} (or \key {Cmd+S}) to save your changes.
\endlist
diff --git a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc
index 23709d331bd..ce5082b0aea 100644
--- a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc
+++ b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc
@@ -40,7 +40,7 @@
\section1 Code Editor Integration
To switch between forms (\uicontrol Design mode) and code (\uicontrol Edit mode),
- press \key Shift+F4.
+ select \key Shift+F4.
You can use \QC to create stub implementations of slot functions. In the
\uicontrol Design mode, right-click a widget to open a context menu, and then
@@ -58,7 +58,7 @@
To open resource files from the code editor, select
\uicontrol {Follow Symbol Under Cursor} in the context menu
- or press \key F2 when the cursor is over a string literal.
+ or select \key F2 when the cursor is over a string literal.
\section1 Specifying Settings for \QD
@@ -81,7 +81,7 @@
\endlist
To preview the settings, select \uicontrol Tools > \uicontrol{Form Editor} >
- \uicontrol Preview, or press \key Alt+Shift+R.
+ \uicontrol Preview, or select \key Alt+Shift+R.
\section1 Previewing Forms Using Device Profiles
diff --git a/doc/qtdesignstudio/config/qtdesignstudio-icon-macros.qdocconf b/doc/qtdesignstudio/config/qtdesignstudio-icon-macros.qdocconf
new file mode 100644
index 00000000000..4fa7cb16ab1
--- /dev/null
+++ b/doc/qtdesignstudio/config/qtdesignstudio-icon-macros.qdocconf
@@ -0,0 +1,278 @@
+macro.image3dbackgroundcolor = "\\inlineimage icons/3d-background-color.png {the Background color button}"
+macro.imageactionicon = "\\inlineimage icons/action-icon.png {the Action button}"
+macro.imageactioniconbinding = "\\inlineimage icons/action-icon-binding.png {the Binding button}"
+macro.imageaddfile16px = "\\inlineimage icons/add-file-16px.png {the Add a file button}"
+macro.imageaddmaterial = "\\inlineimage icons/add_material.png {the Add a material button}"
+macro.imageaddtexture = "\\inlineimage icons/add_texture.png {the Add a texture button}"
+macro.imageailogo = "\\inlineimage ai-logo.png {the Adobe Illustrator logo}"
+macro.imagealias = "\\inlineimage icons/alias.png {the Alias button}"
+macro.imagealignbottom = "\\inlineimage icons/align-bottom.png {the Align bottom edges button}"
+macro.imagealigncameraon = "\\inlineimage icons/align-camera-on.png {the Align view to camera button}"
+macro.imagealigncenterhorizontal = "\\inlineimage icons/align-center-horizontal.png {the Align horizontal centers button}"
+macro.imagealigncentervertical = "\\inlineimage icons/align-center-vertical.png {the Align vertical centers button}"
+macro.imagealignleft = "\\inlineimage icons/align-left.png {the Align left edges button}"
+macro.imagealignright = "\\inlineimage icons/align-right.png {the Align right edges button}"
+macro.imagealigntop = "\\inlineimage icons/align-top.png {the Align top edges button}"
+macro.imagealignviewon = "\\inlineimage icons/align-view-on.png {the Align cameras to view button}"
+macro.imageanchorbottom = "\\inlineimage icons/anchor-bottom.png {the Anchor component to the bottom button}"
+macro.imageanchorcenterhorizontal = "\\inlineimage icons/anchor-center-horizontal.png {the Anchor component horizontally button}"
+macro.imageanchorcentervertical = "\\inlineimage icons/anchor-center-vertical.png {the Anchor component vertically button}"
+macro.imageanchorfill = "\\inlineimage icons/anchor-fill.png {the Fill parent component button}"
+macro.imageanchorleft = "\\inlineimage icons/anchor-left.png {the Anchor component to the left button}"
+macro.imageanchorrigh = "\\inlineimage icons/anchor-right.png {the Anchor component to the right button}"
+macro.imageanchortop = "\\inlineimage icons/anchor-top.png {the Anchor component to the top button}"
+macro.imageanimatedimageicon16 = "\\inlineimage animated-image-icon16.png {the Animated Image component}"
+macro.imageanimation = "\\inlineimage icons/animation.png {the Animation button}"
+macro.imageannotation = "\\inlineimage icons/annotation.png {the Annotation button}"
+macro.imageapply = "\\inlineimage icons/apply.png {the Apply button}"
+macro.imagearea = "\\inlineimage icons/area.png {the Area Light component}"
+macro.imagearrowleft = "\\inlineimage icons/arrowleft.png {the Arrow left button}"
+macro.imagearrowright = "\\inlineimage icons/arrowright.png {the Arrow right button}"
+macro.imageassign = "\\inlineimage icons/assign.png {the Assign button}"
+macro.imageassigneffectcomposer = "\\inlineimage icons/assign-effect-composer.png {the Assign current composition to selected item button}"
+macro.imageattractor16px = "\\inlineimage icons/attractor-16px.png {the Attractor button}"
+macro.imagebackoneframe = "\\inlineimage icons/back_one_frame.png {the Previous frame button}"
+macro.imagebakelights = "\\inlineimage icons/bakelights.png {the Bake Lights button}"
+macro.imageblenderlogo = "\\inlineimage blender-logo.png {the Blender logo}"
+macro.imageblendmode16px = "\\inlineimage icons/blend-mode-16px.png {the Blend mode button}"
+macro.imageborderimageicon16 = "\\inlineimage border-image-icon16.png {the Border Image component}"
+macro.imageboundingrect = "\\inlineimage icons/boundingrect.png {the Bound button}"
+macro.imagebrightnesscontrast16px = "\\inlineimage icons/brightness-contrast-16px.png {the Brightness Contrast component}"
+macro.imagebrowsebutton = "\\inlineimage icons/browse-button.png {the Browse button}"
+macro.imagebuild32x32 = "\\inlineimage icons/build-32x32.png {the Build icon}"
+macro.imagebusyindicatoricon16 = "\\inlineimage icons/busyindicator-icon16.png {the Busy Indicator component}"
+macro.imagebuttonicon16 = "\\inlineimage icons/button-icon16.png {the Button component}"
+macro.imagecameraspeed = "\\inlineimage icons/camera_speed.png {the Camera speed button}"
+macro.imagecanvascolor = "\\inlineimage icons/canvas-color.png {the Canvas color button}"
+macro.imagecheckboxicon16 = "\\inlineimage icons/checkbox-icon16.png {the Checkbox component}"
+macro.imageclearview = "\\inlineimage icons/clear-view.png {the Clear View button}"
+macro.imageclose = "\\inlineimage icons/close.png {the Close button}"
+macro.imagecolourize16px = "\\inlineimage icons/colourize-16px.png {the Colourize button}"
+macro.imagecolumnpositionericon16px = "\\inlineimage column-positioner-icon-16px.png {the Column Positioner button}"
+macro.imagecomboboxicon16 = "\\inlineimage icons/combobox-icon16.png {the Combo box component}"
+macro.imagecopyformatting = "\\inlineimage icons/copy-formatting.png {the Copy Formatting button}"
+macro.imagecreatecomponent = "\\inlineimage icons/create_component.png {the Create Component button}"
+macro.imagecurveeditor = "\\inlineimage icons/curve_editor.png {the Curve editor button}"
+macro.imagecustomborder16px = "\\inlineimage icons/custom-border-16px.png {the Border component}"
+macro.imagecustomrectangle16px = "\\inlineimage icons/custom-rectangle-16px.png {the Rectangle component}"
+macro.imagedelaybuttonicon16 = "\\inlineimage icons/delaybutton-icon16.png {the Delay button component}"
+macro.imagedemo32x32 = "\\inlineimage icons/demo-32x32.png {the Demo icon}"
+macro.imagedesaturation16px = "\\inlineimage icons/desaturation-16px.png {the Desaturation component}"
+macro.imagedetachgroupicon = "\\inlineimage icons/detach-group-icon.png {the Detach Group button}"
+macro.imagedialicon16 = "\\inlineimage icons/dial-icon16.png {the Dial component}"
+macro.imagedirectional = "\\inlineimage icons/directional.png {the Directional light component}"
+macro.imagedirectionalblur16px = "\\inlineimage icons/directional-blur-16px.png {the Directional blur component}"
+macro.imagedisplace16px = "\\inlineimage icons/displace-16px.png {the Displace component}"
+macro.imagedistributebottom = "\\inlineimage icons/distribute-bottom.png {the Distribute bottom button}"
+macro.imagedistributecenterhorizontal = "\\inlineimage icons/distribute-center-horizontal.png {the Distribute horizontal center button}"
+macro.imagedistributecentervertical = "\\inlineimage icons/distribute-center-vertical.png {the Distribute vertical center button}"
+macro.imagedistributeleft = "\\inlineimage icons/distribute-left.png {the Distribute left button}"
+macro.imagedistributeoriginbottomright = "\\inlineimage icons/distribute-origin-bottom-right.png {the Distribute origin bottom right button}"
+macro.imagedistributeorigincenter = "\\inlineimage icons/distribute-origin-center.png {the Distribute origin center button}"
+macro.imagedistributeoriginnone = "\\inlineimage icons/distribute-origin-none.png {the Distribute origin none button}"
+macro.imagedistributeorigintopleft = "\\inlineimage icons/distribute-origin-top-left.png {the Distribute origin top left button}"
+macro.imagedistributeright = "\\inlineimage icons/distribute-right.png {the Distribute right button}"
+macro.imagedistributespacinghorizontal = "\\inlineimage icons/distribute-spacing-horizontal.png {the Distribute spacing horizontal button}"
+macro.imagedistributespacingvertical = "\\inlineimage icons/distribute-spacing-vertical.png {the Distribute spacing vertical button}"
+macro.imagedistributetop = "\\inlineimage icons/distribute-top.png {the Distribute top button}"
+macro.imagedragmarkseffectcomposer = "\\inlineimage icons/dragmarks-effect-composer.png {Dragmarks}"
+macro.imagedropshadow16px = "\\inlineimage icons/drop-shadow-16px.png {the Drop shadow component}"
+macro.imageeasingcurvelinearicon = "\\inlineimage icons/easing-curve-linear-icon.png {the Linear easing curve button}"
+macro.imageeasingcurvespline = "\\inlineimage icons/easing-curve-spline.png {the Spline easing curve button}"
+macro.imageeasingcurvestepicon = "\\inlineimage icons/easing-curve-step-icon.png {the Step easing curve button}"
+macro.imageeasingcurveunify = "\\inlineimage icons/easing-curve-unify.png {the Unify easing curve button}"
+macro.imageedit = "\\inlineimage icons/edit.png {the Edit button}"
+macro.imageeditcomponent = "\\inlineimage icons/edit_component.png {the Edit component button}"
+macro.imageeditlightoff = "\\inlineimage icons/edit_light_off.png {the Edit light off button}"
+macro.imageeditlighton = "\\inlineimage icons/edit_light_on.png {the Edit light on button}"
+macro.imageemitburst16px = "\\inlineimage icons/emit-burst-16px.png {the Emit burst component}"
+macro.imageemitter16px = "\\inlineimage icons/emitter-16px.png {the Emitter component}"
+macro.imageerror = "\\inlineimage icons/error.png {the Error button}"
+macro.imageexamples32x32 = "\\inlineimage icons/examples-32x32.png {the Examples icon}"
+macro.imageexport = "\\inlineimage icons/export.png {the Export component}"
+macro.imageexportjsontranslations = "\\inlineimage icons/export-json-translations.png {the Export JSON translations button}"
+macro.imageexporttranslations = "\\inlineimage icons/export-translations.png {the Export translations button}"
+macro.imageexportunchecked = "\\inlineimage icons/export_unchecked.png {the Export unchecked button}"
+macro.imageeyeopen = "\\inlineimage icons/eye_open.png {the Eye button}"
+macro.imagefastblur16px = "\\inlineimage icons/fast-blur-16px.png {the Fast blur component}"
+macro.imagefigmabindingreset = "\\inlineimage figma-binding-reset.png {the Figma binding reset button}"
+macro.imagefigmalogo = "\\inlineimage figma-logo.png {the Figma logo}"
+macro.imagefiltericon = "\\inlineimage icons/filtericon.png {the Filter Tree button}"
+macro.imagefitselected = "\\inlineimage icons/fit_selected.png {the Fit Selected button}"
+macro.imageflickableicon16 = "\\inlineimage flickable-icon16.png {the Flickable component}"
+macro.imageflowactionicon = "\\inlineimage icons/flow-action-icon.png {the Flow Action component}"
+macro.imageflowdecisionicon = "\\inlineimage icons/flow-decision-icon.png {the Flow decision component}"
+macro.imageflowpositionericon16px = "\\inlineimage flow-positioner-icon-16px.png {the Flow Positioner button}"
+macro.imageflowwildcardicon = "\\inlineimage icons/flow-wildcard-icon.png {the Flow Wildcard component}"
+macro.imagefocusscopeicon16 = "\\inlineimage focusscope-icon16.png {the Focus Scope component}"
+macro.imageforwardoneframe = "\\inlineimage icons/forward_one_frame.png {the Next frame button}"
+macro.imageframeicon16 = "\\inlineimage icons/frame-icon16.png {the Frame component}"
+macro.imagegammaadjust16px = "\\inlineimage icons/gamma-adjust-16px.png {the Gamma adjust component}"
+macro.imagegaussianblur16px = "\\inlineimage icons/gaussian-blur-16px.png {the Gaussian blur component}"
+macro.imagegeneratetranslationfiles = "\\inlineimage icons/generate-translation-files.png {the Generate translation files button}"
+macro.imagegettingstarted = "\\inlineimage icons/getting-started.png {the Getting Started icon}"
+macro.imageglobal = "\\inlineimage icons/global.png {the Global orientation button}"
+macro.imageglobalrecordkeyframes = "\\inlineimage icons/global_record_keyframes.png {the Record global keyframes button}"
+macro.imageglow16px = "\\inlineimage icons/glow-16px.png {the Glow component}"
+macro.imagegravity16px = "\\inlineimage icons/gravity-16px.png {the Gravity component}"
+macro.imagegridpositionericon16px = "\\inlineimage grid-positioner-icon-16px.png {the Grid Positioner button}"
+macro.imagegridviewicon16 = "\\inlineimage gridview-icon16.png {the Grid View component}"
+macro.imagegroup16px = "\\inlineimage icons/group-16px.png {the Group component}"
+macro.imagegroupboxicon16 = "\\inlineimage icons/groupbox-icon16.png {the Group box component}"
+macro.imagehome = "\\inlineimage icons/home.png {the Home button}"
+macro.imagehuesaturation16px = "\\inlineimage icons/hue-saturation-16px.png {the Hue saturation component}"
+macro.imageimageicon16 = "\\inlineimage image-icon16.png {the Image component}"
+macro.imageimport = "\\inlineimage icons/import.png {the Import button}"
+macro.imageimportjsontranslations = "\\inlineimage icons/import-json-translations.png {the Import JSON translations button}"
+macro.imageinnershadow16px = "\\inlineimage icons/inner-shadow-16px.png {the Inner shadow component}"
+macro.imageinstallation = "\\inlineimage icons/installation.png {the Installation icon}"
+macro.imageisoicons16px = "\\inlineimage icons/iso-icons-16px.png {the ISO Icon component}"
+macro.imageitemarc16px = "\\inlineimage icons/item-arc-16px.png {the Arc component}"
+macro.imageitemdelegateicon16 = "\\inlineimage icons/itemdelegate-icon16.png {the Item delegate component}"
+macro.imageitemellipse16px = "\\inlineimage icons/item-ellipse-16px.png {the Ellipse component}"
+macro.imageitemflippable16px = "\\inlineimage icons/item-flippable-16px.png {the Flipable component}"
+macro.imageitempie16px = "\\inlineimage icons/item-pie-16px.png {the Pie component}"
+macro.imageitempolygon16px = "\\inlineimage icons/item-polygon-16px.png {the Polygon component}"
+macro.imageitemsvg16px = "\\inlineimage icons/item-svg-16px.png {the SVG path item component}"
+macro.imageitemtriangle16px = "\\inlineimage icons/item-triangle-16px.png {the Triangle component}"
+macro.imagejumptocode16px = "\\inlineimage icons/jump-to-code-16px.png {the Jump to code button}"
+macro.imagekeyframe = "\\inlineimage icons/keyframe.png {the Keyframe marker}"
+macro.imagekeyframeautobezieractive = "\\inlineimage icons/keyframe_autobezier_active.png {the Autobezier keyframe marker}"
+macro.imagekeyframelinearactive = "\\inlineimage icons/keyframe_linear_active.png {the Linear keyframe marker}"
+macro.imagekeyframelineartobezieractive = "\\inlineimage icons/keyframe_lineartobezier_active.png {the Linear to bezier keyframe marker}"
+macro.imagekeyframemanualbezieractive = "\\inlineimage icons/keyframe_manualbezier_active.png {the Manual bezier keyframe marker}"
+macro.imagelabelicon16 = "\\inlineimage icons/label-icon16.png {the Label component}"
+macro.imagelcandoperator16px = "\\inlineimage icons/lc-and-operator-16px.png {the And component}"
+macro.imagelcbidirectionalbinding16px = "\\inlineimage icons/lc-bidirectional-binding-16px.png {the Bi Direct. Binding component}"
+macro.imagelcminmax16px = "\\inlineimage icons/lc-min-max-16px.png {the Min Max Mapper component}"
+macro.imagelcnotoperator16px = "\\inlineimage icons/lc-not-operator-16px.png {the Not operator component}"
+macro.imagelcoroperator16px = "\\inlineimage icons/lc-or-operator-16px.png {the Or operator component}"
+macro.imagelcrangemapper16px = "\\inlineimage icons/lc-range-mapper-16px.png {the Range Mapper component}"
+macro.imagelcstringmapper16px = "\\inlineimage icons/lc-string-mapper-16px.png {the String Mapper component}"
+macro.imagelevels16px = "\\inlineimage icons/levels-16px.png {the Level Adjust component}"
+macro.imagelineparticles16px = "\\inlineimage icons/line-particles-16px.png {the Line Particle component}"
+macro.imagelistviewicon16 = "\\inlineimage listview-icon16.png {the List View component}"
+macro.imagelivepreview = "\\inlineimage icons/live_preview.png {the Live Preview button}"
+macro.imagelocalrecordkeyframes = "\\inlineimage icons/local_record_keyframes.png {the Record local keyframes button}"
+macro.imagelockoff = "\\inlineimage icons/lockoff.png {the Lock off button}"
+macro.imagelockon = "\\inlineimage icons/lockon.png {the Lock on button}"
+macro.imagemaskblur16px = "\\inlineimage icons/mask-blur-16px.png {the Masked blur component}"
+macro.imagemayalogo = "\\inlineimage maya-logo.png {the Maya logo}"
+macro.imageminus = "\\inlineimage icons/minus.png {the Minus button}"
+macro.imagemodelblendparticle16px = "\\inlineimage icons/model-blend-particle-16px.png {the Model Blend Particle component}"
+macro.imagemodelparticle16px = "\\inlineimage icons/model-particle-16px.png {the Model Particle component}"
+macro.imagemodelshape16px = "\\inlineimage icons/model-shape-16px.png {the Model Shape component}"
+macro.imagemorebutton = "\\inlineimage icons/more-button.png {the More button}"
+macro.imagemouseareaicon16 = "\\inlineimage mouse-area-icon16.png {the Mouse Area component}"
+macro.imagemoveoff = "\\inlineimage icons/move_off.png {the Move button}"
+macro.imagenavigatorarrowdown = "\\inlineimage icons/navigator-arrowdown.png {the Arrow down button}"
+macro.imagenavigatorarrowup = "\\inlineimage icons/navigator-arrowup.png {the Arrow up button}"
+macro.imagenext = "\\inlineimage icons/next.png {the Next button}"
+macro.imagenextkeyframe = "\\inlineimage icons/next_keyframe.png {the Next Keyframe button}"
+macro.imagenosnapping = "\\inlineimage icons/no_snapping.png {the No Snapping button}"
+macro.imageopacitymask16px = "\\inlineimage icons/opacity-mask-16px.png {the Opacity Mask component}"
+macro.imageorthographiccamera = "\\inlineimage icons/orthographic_camera.png {the Orthographic camera button}"
+macro.imageoutput = "\\inlineimage icons/output.png {the Output button}"
+macro.imagepageicon16 = "\\inlineimage icons/page-icon16.png {the Page component}"
+macro.imagepageindicatoricon16 = "\\inlineimage icons/pageindicator-icon16.png {the Page Indicator component}"
+macro.imagepaneicon16 = "\\inlineimage icons/pane-icon16.png {the Pane component}"
+macro.imageparticleanimationoff = "\\inlineimage icons/particle-animation-off.png {the Particle animation off button}"
+macro.imageparticleanimationon = "\\inlineimage icons/particle-animation-on.png {the Particle animation on button}"
+macro.imageparticlepause = "\\inlineimage icons/particle-pause.png {the Pause button}"
+macro.imageparticleplay = "\\inlineimage icons/particle-play.png {the Play button}"
+macro.imageparticlerestart = "\\inlineimage icons/particle-restart.png {the Restart button}"
+macro.imageparticleshape16px = "\\inlineimage icons/particle-shape-16px.png {the Particle Shape component}"
+macro.imageparticlesseek = "\\inlineimage icons/particles-seek.png {the Particle Seek slider}"
+macro.imageparticlesystem16px = "\\inlineimage icons/particle-system-16px.png {the Particle System component}"
+macro.imagepasteformatting = "\\inlineimage icons/paste-formatting.png {the Paste Formatting button}"
+macro.imagepathviewicon16 = "\\inlineimage pathview-icon16.png {the Path View component}"
+macro.imagepathviewicon16 = "\\inlineimage pathview-icon16.png {the Path View component}"
+macro.imagepathviewicon16 = "\\inlineimage pathview-icon16.png {the Path View component}"
+macro.imagepauseicon = "\\inlineimage icons/pause-icon.png {the Pause button}"
+macro.imageperspectivecamera = "\\inlineimage icons/perspective_camera.png {the Perspective camera button}"
+macro.imagepin = "\\inlineimage icons/pin.png {the Pin button}"
+macro.imageplus = "\\inlineimage icons/plus.png {the Plus button}"
+macro.imagepoint = "\\inlineimage icons/point.png {the Point Light component}"
+macro.imagepointrotator16px = "\\inlineimage icons/point-rotator-16px.png {the Point Rotator component}"
+macro.imageprev = "\\inlineimage icons/prev.png {the Previous button}"
+macro.imagepreviouskeyframe = "\\inlineimage icons/previous_keyframe.png {the Previous Keyframe button}"
+macro.imageprogressbaricon16 = "\\inlineimage icons/progressbar-icon16.png {the Progress Bar component}"
+macro.imageprojecttranslationtest = "\\inlineimage icons/project-translation-test.png {the Project Translation Test button}"
+macro.imagepslogo = "\\inlineimage ps-logo.png {the PS logo}"
+macro.imageqmldesigneronlyselectitemswithcontent = "\\inlineimage icons/qmldesigner-only-select-items-with-content.png {the Select Items with Content button}"
+macro.imageqmltranslationtest = "\\inlineimage icons/qml-translation-test.png {the QML Translation Test button}"
+macro.imageqt3dslogo = "\\inlineimage qt-3ds-logo.png {the Qt 3DS logo}"
+macro.imageqtcreatoranchorsreseticon = "\\inlineimage icons/qtcreator-anchors-reset-icon.png {the Reset Anchors button}"
+macro.imageqtcreatorresetpositionicon = "\\inlineimage icons/qtcreator-reset-position-icon.png {the Reset position button}"
+macro.imageqtcreatorresetsizeicon = "\\inlineimage icons/qtcreator-reset-size-icon.png {the Reset size button}"
+macro.imageradialblur16px = "\\inlineimage icons/radial-blur-16px.png {the Radial Blur component}"
+macro.imageradiobuttonicon16 = "\\inlineimage icons/radiobutton-icon16.png {the Radio Button component}"
+macro.imagerangeslidericon16 = "\\inlineimage icons/rangeslider-icon16.png {the Range Slider component}"
+macro.imagerecordfill = "\\inlineimage icons/recordfill.png {the Record Fill button}"
+macro.imagerecticon16 = "\\inlineimage rect-icon16.png {the Rectangle component}"
+macro.imagerecursiveblur16px = "\\inlineimage icons/recursive-blur-16px.png {the Recursive Blur component}"
+macro.imagerepeller16px = "\\inlineimage icons/repeller-16px.png {the Repeller component}"
+macro.imagereset = "\\inlineimage icons/reset.png {the Reset button}"
+macro.imagereverseorder = "\\inlineimage icons/reverse_order.png {the Reverse Order button}"
+macro.imagerotateoff = "\\inlineimage icons/rotate_off.png {the Rotate button}"
+macro.imagerotationcursor = "\\inlineimage icons/rotation-cursor.png {the rotation cursor}"
+macro.imageroundbuttonicon16 = "\\inlineimage icons/roundbutton-icon16.png {the Round Button component}"
+macro.imagerowpositionericon16px = "\\inlineimage row-positioner-icon-16px.png {the Row Positioner button}"
+macro.imagerunproject = "\\inlineimage icons/run_project.png {the Run Project button}"
+macro.imagerunsmall = "\\inlineimage icons/run_small.png {the Run button}"
+macro.imagesaveaseffectcomposer = "\\inlineimage icons/save-as-effect-composer.png {the Save effect as button}"
+macro.imagesaveeffectcomposer = "\\inlineimage icons/save-effect-composer.png {the Save effect button}"
+macro.imagescaleaffector16px = "\\inlineimage icons/scale-affector-16px.png {the Scale Affector component}"
+macro.imagescaleoff = "\\inlineimage icons/scale_off.png {the Scale button}"
+macro.imagescrollviewicon16 = "\\inlineimage icons/scrollview-icon16.png {the Scroll View component}"
+macro.imageselectgroup = "\\inlineimage icons/select_group.png {the Select Group button}"
+macro.imageselectitem = "\\inlineimage icons/select_item.png {the Select Item button}"
+macro.imageselectlanguages = "\\inlineimage icons/select-languages.png {the Select languages button}"
+macro.imagesettings = "\\inlineimage icons/settings.png {the Settings button}"
+macro.imagesketchlogo = "\\inlineimage sketch-logo.png {the Sketch logo}"
+macro.imageslidericon16 = "\\inlineimage icons/slider-icon16.png {the Slider component}"
+macro.imagesnapping = "\\inlineimage icons/snapping.png {the Snapping button}"
+macro.imagesnapping3d = "\\inlineimage icons/snapping-3d.png {the 3D Snapping button}"
+macro.imagesnapping3dconf = "\\inlineimage icons/snapping-3d-conf.png {the 3D Snap Configuration button}"
+macro.imagesnappingandanchoring = "\\inlineimage icons/snapping_and_anchoring.png {the Snapping and Anchoring button}"
+macro.imagespinboxicon16 = "\\inlineimage icons/spinbox-icon16.png {the Spin Box component}"
+macro.imagesplitview = "\\inlineimage icons/split-view.png {the Split View button}"
+macro.imagespot = "\\inlineimage icons/spot.png {the Spot Light component}"
+macro.imagespriteparticle16px = "\\inlineimage icons/sprite-particle-16px.png {the Sprite Particle component}"
+macro.imagespritesequence16px = "\\inlineimage icons/sprite-sequence-16px.png {the Sprite Sequence component}"
+macro.imagestackviewicon16 = "\\inlineimage icons/stackview-icon16.png {the Stack View component}"
+macro.imagestartplayback = "\\inlineimage icons/start_playback.png {the Start Playback button}"
+macro.imagestudiocleareffectstack = "\\inlineimage icons/studio-clear-effect-stack.png {the Clear the Effect Stack button}"
+macro.imageswipeviewicon16 = "\\inlineimage icons/swipeview-icon16.png {the Swipe View component}"
+macro.imageswitchicon16 = "\\inlineimage icons/switch-icon16.png {the Switch component}"
+macro.imagetargetdirection16px = "\\inlineimage icons/target-direction-16px.png {the Target Direction component}"
+macro.imagetextareaicon16 = "\\inlineimage icons/textarea-icon16.png {the Text Area component}"
+macro.imagetextediticon16 = "\\inlineimage text-edit-icon16.png {the Text Edit component}"
+macro.imagetextfieldicon16 = "\\inlineimage icons/textfield-icon16.png {the Text Field component}"
+macro.imagetexticon16 = "\\inlineimage text-icon16.png {the Text component}"
+macro.imagetextinputicon16 = "\\inlineimage text-input-icon16.png {the Text Input component}"
+macro.imagethreshold16px = "\\inlineimage icons/threshold-16px.png {the Threshold Mask component}"
+macro.imagetofirstframe = "\\inlineimage icons/to_first_frame.png {the First frame button}"
+macro.imagetolastframe = "\\inlineimage icons/to_last_frame.png {the Last frame button}"
+macro.imagetoolbaricon16 = "\\inlineimage icons/toolbar-icon16.png {the Tool Bar component}"
+macro.imagetoolbuttonicon16 = "\\inlineimage icons/toolbutton-icon16.png {the Tab Button component}"
+macro.imagetoolseparatoricon16 = "\\inlineimage icons/toolseparator-icon16.png {the Tool Separator component}"
+macro.imagetrailemitter16px = "\\inlineimage icons/trail-emitter-16px.png {the Trail Emitter component}"
+macro.imagetransparent = "\\inlineimage icons/transparent.png {the Transparent button}"
+macro.imagetransparenticon = "\\inlineimage icons/transparent-icon.png {the Transparent button}"
+macro.imagetumblericon16 = "\\inlineimage icons/tumbler-icon16.png {the Tumbler component}"
+macro.imagetutorials = "\\inlineimage icons/tutorials.png {the Tutorials icon}"
+macro.imageunlocked = "\\inlineimage icons/unlocked.png {the Unlocked button}"
+macro.imagevectordirection16px = "\\inlineimage icons/vector-direction-16px.png {the Vector Direction component}"
+macro.imagevisibilityoff = "\\inlineimage icons/visibility-off.png {the Visibility off button}"
+macro.imagevisibilityon = "\\inlineimage icons/visibilityon.png {the Visibility on button}"
+macro.imagewander16px = "\\inlineimage icons/wander-16px.png {the Wander component}"
+macro.imagewarning = "\\inlineimage icons/warning.png {the Warning button}"
+macro.imagexdlogo = "\\inlineimage xd-logo.png {the Adobe XD logo}"
+macro.imagezoomall = "\\inlineimage icons/zoomAll.png {the Zoom All button}"
+macro.imagezoombig = "\\inlineimage icons/zoom_big.png {the Zoom Big button}"
+macro.imagezoomblur16px = "\\inlineimage icons/zoom-blur-16px.png {the Zoom Blur component}"
+macro.imagezoomin = "\\inlineimage icons/zoomIn.png {the Zoom In button}"
+macro.imagezoomout = "\\inlineimage icons/zoomOut.png {the Zoom Out button}"
+macro.imagezoomselection = "\\inlineimage icons/zoomSelection.png {the Zoom Selection button}"
+macro.imagezoomsmall = "\\inlineimage icons/zoom_small.png {the Zoom Small button}"
diff --git a/doc/qtdesignstudio/config/style/qt5-sidebar.html b/doc/qtdesignstudio/config/style/qt5-sidebar.html
index f1e2fc4af57..579d52ec7b2 100644
--- a/doc/qtdesignstudio/config/style/qt5-sidebar.html
+++ b/doc/qtdesignstudio/config/style/qt5-sidebar.html
@@ -1,34 +1,34 @@
-
Getting Started
+ Getting started
-
Key Concepts
+ Key concepts
@@ -38,30 +38,30 @@
Working with
@@ -241,7 +240,7 @@
- States
@@ -249,34 +248,34 @@
Textures
@@ -284,29 +283,21 @@
-
Best Practices
+ Best practices
-
@@ -318,17 +309,17 @@
@@ -339,14 +330,15 @@
@@ -357,36 +349,36 @@
Reference
- - 3D Components
+
- 3D components
@@ -402,25 +394,25 @@
diff --git a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc
index b89689618e0..90a3f2aba29 100644
--- a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc
+++ b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc
@@ -1,18 +1,18 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page 3d-scene-tutorial.html
\ingroup gstutorials
- \title Setting up a 3D Scene
+ \title Setting up a 3D scene
\sa {Content Library}
\brief Illustrates how to set up a 3D scene with, for example, lights, models, and materials in
\QDS.
\image 3d-scene-tutorial.webp
- The \e {Setting up a 3D Scene} tutorial illustrates how you can set up and improve a 3D
+ The \e {Setting up a 3D scene} tutorial illustrates how you can set up and improve a 3D
scene with the following:
\list
\li 3D models
@@ -30,10 +30,9 @@
Download the completed project from
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/3Dscene%20tutorial/Completed/}{here}.
- This tutorial requires that you know the basics of \QDS, see
- \l{Getting Started}.
+ To learn the basics of \QDS required to complete this tutorial, see \l{Getting started}.
- \section1 The Starting Project
+ \section1 The starting project
The starting project consists of an animated 3D model of a ball bearing. Control the animations
with a slider and a switch in the user interface.
@@ -43,9 +42,9 @@
\include run-tutorial-project.qdocinc
- \section1 Adding Materials to the 3D Models
+ \section1 Adding materials to the 3D models
- First, use materials from the \uicontrol {Content Library} view on the ball bearing.
+ First, use materials from the \uicontrol {Content Library} view on the ball bearing:
\list 1
\li In the \uicontrol 3D view, right-click the ball bearing and select
@@ -70,10 +69,12 @@
When you run the application or live preview, notice that you don't see much of the materials.
The next step is to set up the environmental light.
- \section1 Adding Environmental Lighting to the Scene
+ \section1 Adding environmental lighting to the scene
Environmental lighting is a good way to create a realistic light for your scene.
+ To add environmental lighting:
+
\list 1
\li In the \uicontrol {Content Library} view, go to the \uicontrol Environments tab.
\li Right-click the image \e BasicLights3_4k.hdr and select \uicontrol {Add Light Probe}.
@@ -85,8 +86,8 @@
When you run the application, notice an improvement in the scene lighting.
- Next, adjust the environmental light. As you will add a background image to the scene later,
- you don't want to use the skybox.
+ As you will add a background image to the scene later, you need to disable the use of skybox:
+
\list 1
\li In the \uicontrol Navigator view, select \e sceneEnvironment.
\li Go to the \uicontrol {Scene Environment} tab in \uicontrol Properties and set \uicontrol
@@ -96,9 +97,9 @@
You also want to increase the brightness of the light a bit. Go to the \uicontrol {Image Based
Lighting} tab in \uicontrol Properties and set \uicontrol Exposure to \e 10.
- \section2 Adding a Background Image to the Scene
+ \section2 Adding a background image to the scene
- In the final step of this tutorial, you add a background image to your scene.
+ In the final step of this tutorial, you add a background image to your scene:
\list 1
\li Go to the \uicontrol Textures tab in the \uicontrol {Content Library} view.
diff --git a/doc/qtdesignstudio/examples/doc/DesignEffect.qdoc b/doc/qtdesignstudio/examples/doc/DesignEffect.qdoc
index 4311b802cc2..d474a14d7be 100644
--- a/doc/qtdesignstudio/examples/doc/DesignEffect.qdoc
+++ b/doc/qtdesignstudio/examples/doc/DesignEffect.qdoc
@@ -5,12 +5,12 @@
\page design-effect-example.html
\ingroup studioexamples
- \title Design Effect
- \brief Illustrates how to use the \QDS design effect.
+ \title Design Effects Demo
+ \brief Illustrates how to use the \QDS Design Effects.
\image studio-design-effects-demo-gallery.webp
- The \e{Design Effects Demo Gallery} example illustrates the use cases of the
+ The \e{Design Effects Demo} example illustrates various use cases of the
design effects in \QDS. Learn more about design effects
\l {https://doc.qt.io/qtdesignstudio/quick-design-effects.html}{here}.
@@ -18,7 +18,7 @@
principles:
\table
\header
- \li Design Effect
+ \li Design effect
\li Description
\row
\li Neumorphism
@@ -39,7 +39,7 @@
Watch this video tutorial to learn how to create these effects using \QDS design effects:
\youtube h0p27_HScxc
- \section1 Using Neumorphism Example
+ \section1 Using the Neumorphism example
\image studio-neumorphism.webp
@@ -57,7 +57,7 @@
accurately they translate into \QDS design effects.
The animation gives a real-time animated Neumorphism design effect in \QDS.
- \section1 Using Skeuomorphism Example
+ \section1 Using the Skeuomorphism example
\image studio-skeuomorphism.webp
@@ -79,7 +79,7 @@
these buttons to test different stages of the Skeuomorphism effect.
- \section1 Using Glassmorphism Example
+ \section1 Using the Glassmorphism example
\image studio-glassmorphism.webp
@@ -97,7 +97,7 @@
part of the image hidden behind it would become blurred.
\endlist
- \section1 Using the Design Effect Demo Project
+ \section1 Using the Design Effect Demo project
\image studio-design-effects-demo-project.webp
@@ -114,7 +114,7 @@
To change the theme of the calculator between light and dark, select \uicontrol DARK.
- \section2 Using Shadow or Blur Effects
+ \section2 Using shadow or blur effects
To change the direction of the shadows on the calculator, drag \uicontrol {SHADOW DIR}
up or down.
@@ -127,8 +127,7 @@
To turn the design effects on or off in the calculator, select \uicontrol FX.
- \section2 Using Music or Sound Effects
-
+ \section2 Using music or sound effects
To play sound or music in the calculator:
\list
\li To play music in a loop, select \uicontrol CHRD, \uicontrol TECH, or
diff --git a/doc/qtdesignstudio/examples/doc/FireParticles.qdoc b/doc/qtdesignstudio/examples/doc/FireParticles.qdoc
index d198fbdf965..75f0075db8b 100644
--- a/doc/qtdesignstudio/examples/doc/FireParticles.qdoc
+++ b/doc/qtdesignstudio/examples/doc/FireParticles.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2022 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,13 +6,14 @@
\ingroup gstutorials
\sa Particles
- \title Particle System: Fire Effect
+ \title Particle System: The fire effect
+
\brief Illustrates how to create a fire effect with the \QDS
particle system.
\image fire-particles.png
- The \e{Fire Effect} tutorial illustrates how you can add a fire effect to
+ \e{The fire effect} tutorial illustrates how you can add a fire effect to
your scene using the \QDS particle system.
In this tutorial, you create a project from the beginning. You can download
@@ -20,10 +21,9 @@
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/fire-particles}
{here}.
- This tutorial requires that you know the basics of \QDS, see
- \l{Getting Started}.
+ To learn the basics of \QDS required to complete this tutorial, see \l{Getting Started}.
- \section1 Tutorial Assets
+ \section1 Tutorial assets
You need the following assets to complete this tutorial:
\list
@@ -35,9 +35,9 @@
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/fire-particles/FireParticles/content/images}
{here}.
- \section1 Creating a Fire Effect
+ \section1 Creating a fire effect
- \section2 Creating a Project
+ \section2 Creating a project
To create a new project:
@@ -67,13 +67,13 @@
\uicontrol {Properties}, set \uicontrol {Fill Color} to #000000.
\endlist
- \section2 Adding a Particle System to Your Scene
+ \section2 Adding a Particle System to your scene
To add a particle system, you first need to import the QtQuick3D.Particles3D
module to your project:
\list 1
- \li In the \uicontrol Components view, select \inlineimage icons/plus.png
+ \li In the \uicontrol Components view, select \imageplus
.
\li Find QtQuick3D.Particles3D, and select it to add it to your project.
\endlist
@@ -95,7 +95,7 @@
You now have the particle system in place. To preview it, select
\key Alt + \key{P}. You can also preview the particle system in
- the \uicontrol{3D} view by using the \l {Particle Editor} tools.
+ the \uicontrol{3D} view by using the \l {Particle editor} tools.
\section2 Adding Sprites and Sprite Animations
@@ -108,7 +108,7 @@
(\e{fire-sprites.png}) to use for the fire:
\list 1
- \li In the \uicontrol {Assets} view, select \inlineimage icons/plus.png
+ \li In the \uicontrol {Assets} view, select \imageplus
.
\li In the \uicontrol {Add Assets} dialog, find and select \e {fire-sprites.png}.
\endlist
@@ -166,7 +166,7 @@
\image fire-particles-sprite-textures.png
- \section2 Adjusting the Particle Emitter
+ \section2 Adjusting the particle emitter
The next step is to adjust the particle emitter properties:
@@ -218,7 +218,7 @@
\endlist
- \section1 Running the Project
+ \section1 Running the project
Now, the fire effect is ready. Before you run it, position the camera to show the effect
from a suitable perspective:
@@ -235,7 +235,7 @@
\image fire-particles-camera.png
Now, run the project by selecting \key Ctrl + \key{R} or the
- \inlineimage icons/run_project.png
+ \imagerunproject
button in the top toolbar.
*/
diff --git a/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc b/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc
index 8dbc8bcfbff..0e080889c40 100644
--- a/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc
+++ b/doc/qtdesignstudio/examples/doc/FresnelExample.qdoc
@@ -5,39 +5,81 @@
\page fresnel-effect-example.html
\ingroup studioexamples
- \title Fresnel Example
- \brief Illustrates how to work with the fresnel effect.
+ \title Fresnel properties on materials
+ \brief Illustrates how to work with Fresnel.
+ \sa {Material Editor and Browser}, {Setting image-based lighting}, {Directional Light},
+ {3D models}, {Content Library}
\image fresnel-example.webp
- The \e{Fresnel} example illustrates how to add and adjust a fresnel effect on
- a 3D model.
+ The \e {Fresnel properties on materials} example illustrates how to add Fresnel to a material
+ and use the material on a 3D model.
- The fresnel effect affects how materials reflect light at different viewing angles. Imagine the
+ Fresnel affects how materials reflect light at different viewing angles. Imagine the
water on a lake. If you look down at the water from straight above, you can see through the
water, but if you look from a lower angle, the reflections are stronger.
\image fresnel-angle.webp
- \section1 Running the Example
+ \section1 Running the example
To run the example in \QDS, go to the \uicontrol Welcome screen and select the example
from the \uicontrol Examples tab.
- \section1 The 3D Scene
+ \section1 The 3D scene
- The example project consists of a basic 3D scene with the following components:
+ The 3D scene of the example project consists of the following models:
\list
- \li A 3D model.
- \li A directional light.
- \li An HDR image used to light the scene (image-based lighting).
+ \li Monkey head (\e {monkeyModel})
+ \li Sphere (\e {sphere})
+ \li Plane (\e {mirror})
\endlist
- \section1 The Material
+ The 3D scene uses a directional light and an HDR image (image-based lighting) to light
+ the scene.
- The material on the 3D model in this example is a principled material with a
- clearcoat.
+ Use the example UI controls to manipulate the scene.
+
+ \table
+ \header
+ \li Control
+ \li Description
+ \row
+ \li \uicontrol {Rotate background}
+ \li Rotates the background to see the models from different angles.
+ \row
+ \li \uicontrol {Move camera} or \uicontrol {Move model}
+ \li Switches between moving the monkey head model and the camera.
+ \row
+ \li \uicontrol {Reset camera}
+ \li Resets the camera.
+ \row
+ \li \uicontrol {Reset monkey}
+ \li Resets the monkey.
+ \endtable
+
+ Navigate the scene with your keyboard using the \uicontrol {Camera controls} listed in
+ the example.
+
+ \section1 The materials
+
+ The following materials are used in this example.
+
+ \table
+ \header
+ \li Material
+ \li Description
+ \row
+ \li Monkey Material
+ \li A yellow principled material with a clearcoat.
+ \row
+ \li Green Material
+ \li A green principled material with a clearcoat.
+ \row
+ \li Mirror
+ \li A ready-made material from \uicontrol {Content Library}.
+ \endtable
\section2 Clearcoat
@@ -47,9 +89,9 @@
You adjust clearcoat properties independently from the base material.
- \section2 Fresnel Properties
+ \section2 The Fresnel properties
- The following properties affect how the fresnel effect renders. These properties are
+ The following properties affect how Fresnel renders. These properties are
available both for the base material and the clearcoat layer. Adjusting the settings for the
clearcoat has a bigger visual effect.
@@ -58,33 +100,50 @@
\li Property
\li Description
\row
- \li Fresnel power
- \li Increasing the fresnel power decreases the head-on reflections (steep viewing angle)
+ \li Fresnel Power
+ \li Increasing the Fresnel power decreases the head-on reflections (steep viewing angle)
while maintaining the reflections seen from more shallow viewing angles.
\row
\li Enable scale and bias
\li Takes the scale and bias properties into account.
\row
- \li Scale
+ \li Fresnel Scale
\li Determines the rate of change in reflection intensity as the viewing angle varies. A
large scale value results in a gentler transition between weak and strong reflections, while
a smaller scale creates a more abrupt shift in reflection intensity.
\row
- \li Bias
- \li Controls the offset for the fresnel power property and determines how quickly the
+ \li Fresnel Bias
+ \li Controls the offset for the Fresnel power property, which determines how quickly the
reflection transitions from weak to strong as the viewing
angle changes. A larger bias value shifts the transition point toward steeper angles.
\endtable
- \section3 Adjusting the Fresnel Settings
+ \section2 Adjusting the Fresnel properties
- To adjust the settings:
+ To adjust the Fresnel properties, use the sliders in the example UI.
+
+ To improve performance, select a lower reflection detail from the
+ \uicontrol {Reflection detail} dropdown menu.
+
+ To reset the Fresnel properties, select \uicontrol {Reset fresnel}.
+
+ \section1 Getting started with Fresnel
+
+ To edit an existing material:
\list 1
- \li In \uicontrol {Material Browser}, double-click \e {Monkey Material}.
+ \li In \uicontrol {Material Browser}, double-click a material.
\li In \uicontrol {Material Editor}, find the properties under
\uicontrol {Clearcoat} and \uicontrol {Fresnel} respectively.
\endlist
\note You see the changes live as you edit them in the \uicontrol 2D view.
+
+ To create a new material with Fresnel:
+
+ \list 1
+ \li In \uicontrol {Material Editor}, select \imageplus.
+ \li Edit the properties under \uicontrol {Clearcoat} and \uicontrol {Fresnel} respectively.
+ \endlist
+
*/
diff --git a/doc/qtdesignstudio/examples/doc/Optimal3DScene.qdoc b/doc/qtdesignstudio/examples/doc/Optimal3DScene.qdoc
index 34101aed178..275b3be64b2 100644
--- a/doc/qtdesignstudio/examples/doc/Optimal3DScene.qdoc
+++ b/doc/qtdesignstudio/examples/doc/Optimal3DScene.qdoc
@@ -10,6 +10,6 @@
\image studio-kitchen-combined.png
The \e {Optimal 3D Scene} example contains the source files for the Optimal
- 3D Scene described in \l {Creating Optimized 3D Scenes}.
+ 3D Scene described in \l {Creating optimized 3D scenes}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc b/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc
index e7d4f318a0b..6ac2c49a324 100644
--- a/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc
+++ b/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc
@@ -1,18 +1,18 @@
-// Copyright (C) 2022 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page state-transition-animations.html
\ingroup gstutorials
- \sa States, {Transitions}, {Working with States}
+ \sa States, {Transitions}, {Working with states}
- \title Animated State Transitions
+ \title Animated state transitions
\brief Illustrates how to create animated state transitions.
\image animated-state-transitions.jpg
- The \e{Animated State Transitions} tutorial illustrates how you can animate
- the transition between \l{Working with States}{states}.
+ The \e{Animated state transitions} tutorial illustrates how you can animate
+ the transition between \l{Working with states}{states}.
The starting point of this tutorial is the Car Demo project, you can
download it from
@@ -24,15 +24,15 @@
{here}.
This tutorial requires that you know the basics of \QDS, see
- \l{Getting Started}.
+ \l{Getting started}.
- \section1 Tutorial Assets
+ \section1 Tutorial assets
All assets you need for this tutorial are included in the Car Demo project.
\include run-tutorial-project.qdocinc
- \section1 Creating States
+ \section1 Creating states
First, you create the different states. In this tutorial, you create four
different states with different views of the car in the scene:
@@ -45,7 +45,7 @@
To create the first state:
\list 1
- \li In the \l States view, select \inlineimage icons/plus.png
+ \li In the \l States view, select \imageplus
.
\li Change the name of the new state to \e{side}.
\endlist
@@ -72,7 +72,7 @@
\image animated-state-transitions-states.png
- \section1 Creating State Transitions
+ \section1 Creating state transitions
With the states created, you need a way to move between the states in the
UI. In this tutorial, you create buttons arranged in a column to do this.
@@ -123,13 +123,13 @@
\list 1
\li Go to the \uicontrol Connections view.
\li In \uicontrol{Navigator}, select \e button_side and in
- \uicontrol {Connections}, select the \inlineimage icons/plus.png
+ \uicontrol {Connections}, select the \imageplus
button to open the connection setup options.
\li Set \uicontrol Signal to \c clicked, \uicontrol Action to
\c {Change State}, \uicontrol {State Group} to \c rectangle and
\uicontrol State to \c side in the respective
drop-down menus.
- \li Select the \inlineimage icons/close.png
+ \li Select the \imageclose
button to close the connection setup options.
\li Repeat steps 2 to 4 for the next three buttons and set them to go to
their corresponding states.
@@ -142,13 +142,13 @@
To preview, select \key Alt + \key{P}.
- \section1 Animating State Transitions
+ \section1 Animating state transitions
The final step of this tutorial is to create animations between the states:
\list 1
\li Go to \l{Transitions}.
- \li Select \inlineimage icons/plus.png
+ \li Select \imageplus
.
\li In the upper right corner of \uicontrol {Transitions}, change
the number 2000 to 1000.
diff --git a/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc b/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc
index 66fb2009670..4f801cd5151 100644
--- a/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc
+++ b/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2022 The Qt Company Ltd.
+** Copyright (C) 2024 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio documentation.
@@ -26,22 +26,22 @@
/*!
\page animation-tutorial.html
\ingroup gstutorials
- \sa {Creating Timeline Animations}
+ \sa {Creating timeline animations}
- \title Timeline Animation Tutorial
+ \title Timeline animation
\brief Illustrates how to create timeline animations and bind them to
properties in \QDS.
\image animation-tutorial.gif
- The \e{Timeline Animation} tutorial illustrates how to create timeline animations
+ The \e{Timeline animation} tutorial illustrates how to create timeline animations
and bind them to properties in \QDS. First you create a keyframe animation
which you control the running state of with a switch in the UI. Next, you
create another keyframe animation where you use a slider in the UI to
control the position of the playhead.
The starting point of this tutorial is the Animation Tutorial project,
- you can download it from
+ which you can download from
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/animation-tutorial/AnimationTutorial/Start}
{here}.
@@ -49,23 +49,22 @@
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/animation-tutorial/AnimationTutorial/Completed}
{here}.
- This tutorial requires that you know the basics of \QDS, see
- \l{Getting Started}.
+ To learn the basics of \QDS required to complete this tutorial, see \l{Getting started}.
\include run-tutorial-project.qdocinc
- \section1 Creating a Timeline Animation
+ \section1 Creating a timeline animation
First, you create an animation where the ball bearing continuously rotates
around its Y axis.
- \section2 Adding a Timeline and an Animation
+ \section2 Adding a timeline and an animation
To add a timeline to your project:
\list 1
\li In the \uicontrol Timeline view, select
- \inlineimage icons/plus.png
+ \imageplus
.
This creates a timeline and one animation.
\li On the \uicontrol {Animation Settings} tab in the
@@ -73,7 +72,7 @@
\list
\li Set \uicontrol Duration to 7500.
This sets the duration of the animation in milliseconds.
- \li Select \uicontrol {Contiunous}.
+ \li Select \uicontrol {Continuous}.
This sets the animation to start over again when it reaches the
end.
\endlist
@@ -84,14 +83,14 @@
You can see the timeline in the \uicontrol Timeline and
\uicontrol Navigator views.
- \section2 Adding Keyframes
+ \section2 Adding keyframes
Next, you add keyframes to animate the rotation of the ball bearing:
\list 1
\li In the \uicontrol Navigator view, select \e {ballbearing1}.
\li In the \uicontrol Properties view, select
- \inlineimage icons/action-icon.png (Actions)
+ \imageactionicon (Actions)
next to \uicontrol Rotation > \uicontrol {Y}.
\li Select \uicontrol {Insert Keyframe}.
\image animation-tutorial-insert-keyframe.png
@@ -109,7 +108,7 @@
timeline.
\endlist
- \section2 Controlling the Running State of the Animation
+ \section2 Controlling the running state of the animation
There is a toggle switch in the UI of this project. To use this switch to
control the running state of the animation:
@@ -117,7 +116,7 @@
\list 1
\li In the \uicontrol Navigator view, select \e {timelineAnimation}.
\li In the \uicontrol Connections view, go to the \uicontrol Bindings tab.
- \li Select \inlineimage icons/plus.png
+ \li Select \imageplus
to create a binding.
\li For the binding you created, set:
\list
@@ -131,23 +130,23 @@
You can preview the animation and try the toggle switch in the live preview.
To run the live preview, select \key Alt + \key{P}.
- \section1 Creating a Timeline and Binding it to a Property
+ \section1 Creating a timeline and binding it to a property
Next, you create the exploded view animation of the ball bearing. You don't
want this animation to run automatically but instead you want to control it
with a slider in the UI.
- \section2 Adding a Timeline Inside a Component
+ \section2 Adding a timeline inside a component
- You create this animation inside the ball bearing component, to do this:
+ To create this animation inside the ball bearing component:
\list 1
\li In the \uicontrol Navigator view, select \e {ballBearing1}.
\li Select \key {F2} to go into the component.
\li In the \uicontrol Timeline view, select
- \inlineimage icons/plus.png
+ \imageplus
to add a timeline and open the \uicontrol {Timeline Settings} dialog.
- \li Select \inlineimage icons/minus.png
+ \li Select \imageminus
next to the \uicontrol {Animation Settings} tab to remove the animation
in this timeline.
You do not need an animation when you bind the timeline to a property.
@@ -156,14 +155,14 @@
\image animation-tutorial-timeline-2.png
- \section2 Adding Keyframes
+ \section2 Adding keyframes
Now, you add keyframes for the different parts of the ball bearing:
\list 1
\li In the \uicontrol{Navigator} view, select \e{inner_race}.
\li In the \uicontrol Properties view, select
- \inlineimage icons/action-icon.png (Actions)
+ \imageactionicon (Actions)
next to \uicontrol Translation > \uicontrol Y.
\li Select \uicontrol {Insert Keyframe}.
\li In the \uicontrol Timeline view, select the
@@ -190,7 +189,7 @@
You can preview the animation by dragging the playhead in the
\uicontrol Timeline view.
- \section2 Controlling the Animation with a Slider
+ \section2 Controlling the animation with a slider
Now, you use the slider on the main screen to control the exploded
view animation that you created.
@@ -200,7 +199,7 @@
\list 1
\li In the \uicontrol Navigator view, select \e Node.
\li On the \uicontrol Properties tab in the \uicontrol Connections view,
- select \inlineimage icons/plus.png
+ select \imageplus
.
\li In the \uicontrol {Property Type} field, enter \e {Item}.
This field is a drop-down list, but you can also type text.
@@ -213,7 +212,7 @@
\list 1
\li In the \uicontrol {Timeline} view, select
- \inlineimage icons/animation.png
+ \imageanimation
.
\li In the \uicontrol {Expression binding field}, enter
\c {property0.value}.
@@ -229,7 +228,7 @@
\li In the \uicontrol {Navigator} view, select \e {ballbearing1}.
\li In the \uicontrol {Connections} view, go to the
\uicontrol {Bindings} tab.
- \li Select \inlineimage icons/plus.png
+ \li Select \imageplus
.
\li For the binding you just created:
\list
diff --git a/doc/qtdesignstudio/examples/doc/coffeemachine.qdoc b/doc/qtdesignstudio/examples/doc/coffeemachine.qdoc
index 3d4da576061..ed007b0effd 100644
--- a/doc/qtdesignstudio/examples/doc/coffeemachine.qdoc
+++ b/doc/qtdesignstudio/examples/doc/coffeemachine.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -21,7 +21,7 @@
the viewport and the timeline to animate the \l{glossary-transition}
{transitions} between and on the screens.
- \section1 Application Flow
+ \section1 Application flow
On the startup screen, \e {AnimationFlowForm.ui.qml}, users can select
from several types of coffee to fill the empty cup. The selection
@@ -88,11 +88,11 @@
is triggered. It sets the application flow status to \c "reset", so
that the application returns to the startup screen.
- \section1 Using Timelines to Animate Transitions
+ \section1 Using timelines to animate transitions
The Coffee Machine application screens for choosing coffee, empty cup, and
- brewing each use custom components specified in separate \l{UI Files}
- {UI files} (ui.qml).
+ brewing each use custom components specified in separate \l{UI files}
+ (ui.qml).
We use the \l Timeline view to animate the transitions between the screens
during the application flow in \e {ApplicationFlowForm.ui.qml}.
@@ -100,15 +100,15 @@
\image coffee-machine-timeline.png
Our viewport contains 200 frames, so we select the
- \inlineimage icons/plus.png "Plus button"
+ \imageplus
button to add a 1200-frame timeline to the root component.
We use the default values for all other fields.
To start recording the transition from the startup screen to the coffee
selection screen on the timeline, we select \e choosingCoffee in
\l Navigator. We check that the playhead is at frame 0, and then
- select the \inlineimage icons/recordfill.png
- (\uicontrol {Auto Key (K)}) button (or press \key k).
+ select the \imagerecordfill
+ (\uicontrol {Auto Key (K)}) button (or select \key K).
At frame 0, we set the X coordinate to 0 in \l Properties >
\uicontrol {Geometry - 2D} > \uicontrol Position. We then move the
@@ -120,9 +120,9 @@
new timeline appears in the view.
For more information about using the timeline, see
- \l {Creating Timeline Animations}.
+ \l {Creating timeline animations}.
- \section1 Using States to Move Between Screens
+ \section1 Using states to move between screens
We use the \l States view to determine the contents of the
viewport. The animations are run when moving from one state to another.
@@ -137,7 +137,7 @@
\c {"settings"} and \c {"selection"} states.
We then return to the \uicontrol Timeline view and select
- \inlineimage icons/animation.png "Timeline Settings button"
+ \imageanimation
to open the \uicontrol {Timeline Settings} dialog. We select
the \uicontrol Add button to create animations for each part
of the timeline. Therefore, the start and end frame of each
diff --git a/doc/qtdesignstudio/examples/doc/ebikedesign.qdoc b/doc/qtdesignstudio/examples/doc/ebikedesign.qdoc
index fd61f4a1c31..f379d4c9ad3 100644
--- a/doc/qtdesignstudio/examples/doc/ebikedesign.qdoc
+++ b/doc/qtdesignstudio/examples/doc/ebikedesign.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -27,21 +27,21 @@
viewport, and the timeline to animate the \l{glossary-transition}
{transitions} between and on the screens.
- \section1 Using Timelines to Animate Transitions
+ \section1 Using timelines to animate transitions
We use the \l Timeline view to animate the transitions between
the screens in \e {Screen01.ui.qml}.
Our viewport contains 1000 frames, so we select the
- \inlineimage icons/plus.png "Plus button"
+ \imageplus
button to add a 5000-frame timeline to the root component.
We use the default values for all other fields.
To start recording the transitions between the Standard screen and the
Trip and Navigator screens on the timeline, we select \e screenCanvas in
the \l Navigator view. We check that the playhead is at frame 0, and then
- select the \inlineimage icons/recordfill.png
- (\uicontrol {Auto Key (K)}) button (or press \key k).
+ select the \imagerecordfill
+ (\uicontrol {Auto Key (K)}) button (or select \key K).
\image ebikedesign-timeline.png "Timeline view"
@@ -69,9 +69,9 @@
speedometer grow and shrink in size depending on its current position.
For more information about using the timeline, see
- \l {Creating Timeline Animations}.
+ \l {Creating timeline animations}.
- \section1 Using States to Move Between Screens
+ \section1 Using states to move between screens
We use the \l States view to determine the contents of the viewport.
The animations are run in a particular state or when moving from one state
@@ -92,7 +92,7 @@
ToBig, and FromBig.
We then return to the \uicontrol Timeline view and select
- \inlineimage icons/animation.png "Timeline Settings button"
+ \imageanimation
to open the \uicontrol {Timeline Settings} dialog. We select
the \uicontrol Add button to create animations for each part
of the timeline. Therefore, the start and end frame of each
diff --git a/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc b/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc
index d8e347b898f..5f85955c8a4 100644
--- a/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc
+++ b/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc
@@ -5,12 +5,12 @@
\page effect-composer-example.html
\ingroup studioexamples
- \title Effect Composer Example
+ \title Effect Composer example
\brief Illustrates how to work with the Effect Composer effects.
\image effect-composer-example.webp {The Effect Composer example project}
- The \e {Effect Composer Example} illustrates how to work with the \uicontrol {Effect Composer}
+ The \e {Effect Composer} example illustrates how to work with the \uicontrol {Effect Composer}
effects. Use the example project to experiment with effects and get familiar with
\uicontrol {Effect Composer}. To learn more, see \l {Effect Composer}.
@@ -22,18 +22,18 @@
The example project has a scalable design. When you resize the window to fit your screen, some
components will adjust automatically.
- \section1 Running the Example
+ \section1 Running the example
To run the example in \QDS, go to the \uicontrol Welcome screen and select the example
from the \uicontrol Examples tab.
- \section1 The Effects
+ \section1 The effects
The following table introduces the effects in this example.
\table
\header
- \li Effect Name
+ \li Effect name
\li Description
\row
\li \uicontrol {Displace}
@@ -49,14 +49,14 @@
\li A weather effect, a combination of a rain effect and a thunder effect.
\endtable
- \section1 The Structure of the Example
+ \section1 The structure of the example
In addition to the effects, the example project also includes the following components:
\list
\li A \l {3D} scene
\list
- \li \l {Importing 3D Assets}{A 3D model}
+ \li \l {Importing 3D assets}{A 3D model}
\li \l {Lights}{A directional light}
\li \l {Cameras}{A scene camera}
\li \l {OrbitCameraController}
@@ -64,11 +64,11 @@
\li \l {Text} components
\li \l {Rectangle} components
\li \l {Shapes#Border}{Border} components
- \li \l {Creating Buttons}{Custom Buttons}
- \li \l {Creating Custom Components}{Custom Sliders}
+ \li \l {Creating buttons}{Custom buttons}
+ \li \l {Creating custom components}{Custom sliders}
\endlist
The example project also uses \uicontrol States and \uicontrol Transitions. To learn more, see
- \l {Working with States} and \l {Transitions}.
+ \l {Working with states} and \l {Transitions}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp b/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp
index 75436595aac..9233bdcc71e 100644
Binary files a/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp and b/doc/qtdesignstudio/examples/doc/images/fresnel-example.webp differ
diff --git a/doc/qtdesignstudio/examples/doc/loginui1.qdoc b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
index 6810f08742b..bd9b52e5263 100644
--- a/doc/qtdesignstudio/examples/doc/loginui1.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
@@ -4,15 +4,14 @@
/*!
\example Loginui1
\ingroup gstutorials
- \nextpage {Log In UI - Positioning}
+ \nextpage {Login UI: Positioning}
- \title Log In UI - Components
+ \title Login UI: Components
\brief Illustrates how to use wizard templates to create a simple UI
that contains a text label, images, and push buttons.
\image loginui1.webp
-
- \e{Log In UI - Components} is the first tutorial in a series of tutorials
+ \e{Login UI: Components} is the first tutorial in a series of tutorials
that describes how to use the \QDS wizard templates to create a project and
a button UI control, and how to modify the files generated by the wizard
templates to design the UI.
@@ -20,12 +19,12 @@
You can download the completed project from
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui1}{here}.
- \section1 Creating the UI Project
+ \section1 Creating the UI project
For the purposes of this tutorial, you will use the empty wizard template.
Wizard templates are available also for creating UIs that are optimized for
mobile platforms and for launcher applications. For more information about
- the options you have, see \l {Creating Projects}.
+ the options you have, see \l {Creating projects}.
To create a project:
@@ -63,7 +62,7 @@
Remove the button and the text component from the UI to have a clean workspace. Later
in this tutorial, you will add and modify them as you need.
- To remove this button, select it and press \key {Backspace}. Repeat for the
+ To remove this button, select it and select \key {Backspace}. Repeat for the
text component.
Next, you will edit the values of the properties of the component instances
@@ -93,7 +92,7 @@
To add the assets:
\list 1
- \li Select \uicontrol Assets > \inlineimage icons/plus.png
+ \li Select \uicontrol Assets > \imageplus
(Select \uicontrol View > \uicontrol Views > \uicontrol Assets to enable it,
if you can't find it).
\image loginui1-add-assets.webp "The Assets view."
@@ -104,7 +103,7 @@
\endlist
To preview the changes that you make, select the \uicontrol {Live Preview} button
- or press \key {Alt+P}.
+ or select \key {Alt+P}.
The \e Screen01.ui.qml file that the wizard template created for you should
be open. If it is not, you can double-click it in the \uicontrol Projects view
@@ -141,7 +140,7 @@
white (\e #ffffff).
\image loginui1-properties-text.webp "Text properties."
\endlist
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -164,8 +163,8 @@
button controls available in \uicontrol Components >
\uicontrol {Qt Quick Controls} to create the kind of push button that you
want, you can create your button from scratch using default components. For
- more information, see \l {Creating Buttons} and
- \l {Creating Scalable Buttons and Borders}.
+ more information, see \l {Creating buttons} and
+ \l {Creating scalable buttons and borders}.
To create a push button by using the wizard template:
@@ -187,7 +186,7 @@
Next, you will change the appearance of the EntryField component by
modifying its properties.
- \section1 Styling the Button
+ \section1 Styling the button
You can now modify the properties of the EntryField component to your
liking. To make the changes apply to all the EntryField instances, you
@@ -217,7 +216,7 @@
\li In \uicontrol Properties > \uicontrol Rectangle, set:
\list
\li \uicontrol {Fill color} to transparent light gray (\e #28e7e7e7).
- You can also use the \l{Picking Colors}{color picker} to set the color.
+ You can also use the \l{Picking colors}{color picker} to set the color.
\li \uicontrol {Border color} to white (\e #ffffff).
\li \uicontrol Radius to \e 50 to give the button rounded corners.
\endlist
@@ -239,7 +238,7 @@
\li In the \uicontrol States view, select the \e normal state and
repeat the changes in the background color and text properties,
as necessary. Repeat for the \e down state.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -254,9 +253,9 @@
Next, you will add instances of the \e EntryField component to the
\e Screen01 component and modify their properties.
- \section1 Adding Entry Fields to the UI
+ \section1 Adding entry fields to the UI
- You will now add EntryField instances to the UI and modify their properties.
+ You will now add two entry fields to the UI and modify their properties:
\list 1
\li Double-click \e Screen01.ui.qml in \uicontrol Projects
@@ -280,11 +279,11 @@
to another position in the \uicontrol {2D} view. Use the
guidelines to align the button instances below the tag line:
\image loginui1-align-entry-fields.webp "Aligned entry fields."
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
- \section1 Creating Another Button
+ \section1 Creating another button
We want to center-align the text of two additional push buttons and use
brighter colors for them, so we create a second button component as
@@ -329,7 +328,7 @@
turn the button background green when the button is pressed down.
Also, in \uicontrol Text > \uicontrol Character >
\uicontrol {Text color}, keep the text color as white (\e #ffffff).
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -337,9 +336,9 @@
\image loginui1-button-styled.webp "Modified push button in the 2D view."
- \section1 Adding Push Buttons to the UI
+ \section1 Adding push buttons to the UI
- You will now add PushButton instances to the UI and modify their properties.
+ You will now add two buttons to the UI and modify their properties:
\list 1
\li Double-click \e Screen01.ui.qml in \uicontrol Projects
@@ -362,7 +361,7 @@
\li Select the second PushButton instance, and change its ID to
\e createAccount and text label to \e {Create Account}. Again,
mark the text translatable.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -371,11 +370,11 @@
\image loginui1-ready.webp "The finished UI in the 2D view and live preview."
- \section1 Learn More
+ \section1 Learn more
The \e {Learn More} sections provide additional information about the
tasks performed by the wizards and about other basic tasks and concepts.
- \section2 Projects and Files
+ \section2 Projects and files
\QDS creates a set of files and folders that you need to create
a UI. The files are listed in the \l{File System} view.
@@ -388,7 +387,7 @@
\li The \e {loginui1.qml} file defines the functionality of
the UI. For the time being, it does not do anything.
\li The \e {Screen01.ui.qml} file is a custom component created by
- the wizard template. For more information, see \l {UI Files}.
+ the wizard template. For more information, see \l {UI files}.
By default, this is the main file in the project, but you can
change that in the .qmlproject file. While the custom component
@@ -410,11 +409,11 @@
\e EventListSimulator.qml files are not used in this example, so
you can ignore them for now.
\endlist
- \l{UI Files}{UI files} define a hierarchy of components with a
- highly-readable, structured layout. Every UI file consists of two parts:
- an imports section and an component declaration section. The components and
- functionality most common to UIs are provided in the \c QtQuick import. You
- can view the code of a \e .ui.qml file in the \l{Code} view.
+ \l{UI files} define a hierarchy of components with a highly-readable,
+ structured layout. Every UI file consists of two parts: an imports section
+ and a component declaration section. The components and functionality most
+ common to UIs are provided in the \c QtQuick import. You can view the code
+ of a \e .ui.qml file in the \l{Code} view.
\section2 Components
@@ -448,7 +447,7 @@
descriptions of all components, see \l{All QML Types} in the Qt reference
documentation.
- \section3 Regtangle Properties
+ \section3 Regtangle properties
The default \l {basic-rectangle}{Rectangle} component is used for drawing
shapes with four sides and four corners. You can fill rectangles either with
@@ -462,7 +461,7 @@
component. It is available in \uicontrol Components
> \uicontrol {Qt Quick Studio Components}.
- \section3 Text Properties
+ \section3 Text properties
The \l Text component is used for adding static text to the UI, such as
titles and labels. You can select the font to use and specify extensive
@@ -472,19 +471,19 @@
If you want to create a label with a background, use the \l Label component
from the \uicontrol {Qt Quick Controls} module instead of the text component.
- \section3 Image Properties
+ \section3 Image properties
The \l {Images}{Image} component is used for adding images to the UI in several
supported formats, including bitmap formats such as PNG and JPEG and vector
graphics formats such as SVG. To add an image to \uicontrol Assets, select
- \inlineimage icons/plus.png
+ \imageplus
, and then select the image file.
If you need to display animated images, use the \l {Animated Image}
component, also available in \uicontrol Components >
\uicontrol {Default Components} > \uicontrol Basic.
- \section2 UI Controls
+ \section2 UI controls
The \e {Custom Button} wizard template creates a button component
based on the \l {Button} control in the \l {Qt Quick Controls} module. It
@@ -510,11 +509,11 @@
For more information, see \l{The id Attribute}.
- \section1 Next Steps
+ \section1 Next steps
To learn how to add more UI controls and position them on the page using
anchors and layouts so that the UI is scalable, see the next tutorial in
- the series, \l {Log In UI - Positioning}.
+ the series, \l {Login UI: Positioning}.
For a more advanced example of creating a menu button and using it to
construct a button bar, see \l {Side Menu}.
diff --git a/doc/qtdesignstudio/examples/doc/loginui2.qdoc b/doc/qtdesignstudio/examples/doc/loginui2.qdoc
index 77ae6668e4e..6105a816f91 100644
--- a/doc/qtdesignstudio/examples/doc/loginui2.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui2.qdoc
@@ -4,16 +4,16 @@
/*!
\example Loginui2
\ingroup gstutorials
- \previouspage {Log In UI - Components}
- \nextpage {Log In UI - States}
+ \previouspage {Login UI - Components}
+ \nextpage {Login UI: States}
- \title Log In UI - Positioning
+ \title Login UI: Positioning
\brief Illustrates how to position UI components on pages using anchors and
positioners.
- \image loginui2.webp "Log In UI"
+ \image loginui2.webp "Login UI"
- \e{Log In UI - Positioning} is the second in a series of tutorials that build
+ \e{Login UI: Positioning} is the second in a series of tutorials that build
on each other to illustrate how to use \QDS to create a simple UI with
some basic UI components, such as pages, buttons, and entry fields. The
second tutorial in the series describes how to position the UI components
@@ -24,23 +24,23 @@
with different screen sizes, you will use anchors and positioners.
The starting point for this tutorial is the completed
- \l{Log In UI - Components} project. You can download the project
+ \l{Login UI: Components} project. You can download the project
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui1}{here}.
Additionally, you can download the completed project of this tutorial
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui2}{here}.
- The \e {Learn More} sections provide additional information about the
+ The \e {Learn more} sections provide additional information about the
task at hand.
- \section1 Anchoring UI Components
+ \section1 Anchoring UI components
- First, you will \l {Setting Anchors and Margins}{anchor} the
+ First, you will \l {Setting anchors and margins}{anchor} the
static page elements, background image (\e adventurePage), logo
(\e qt_logo_green_128x128px), and tag line (\e tagLine), to the page.
To preview the changes that you make, select the \uicontrol {Live Preview} button
- or press \key {Alt+P}.
+ or select \key {Alt+P}.
To anchor component instances on a page:
@@ -50,24 +50,24 @@
\li Select \e adventurePage in the \l Navigator view to display its
properties in the \l Properties view.
\li In \uicontrol Properties > \uicontrol Layout, select
- the \inlineimage icons/anchor-fill.png
+ the \imageanchorfill
anchor button to anchor \e adventurePage to its
parent in the \uicontrol Target field. This attaches the background
image to the rectangle on all sides.
\note Selecting the anchor button should automatically select the
four buttons on the left side of it. If it doesn't, select
- \inlineimage icons/reset.png on the \uicontrol {2D} view toolbar to refresh the
+ \imagereset on the \uicontrol {2D} view toolbar to refresh the
\uicontrol{2D} view.
\image loginui2-layout.png "Layout properties"
\li Select \e qt_logo_green_128x128px in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-top.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-top.png to \e parent to anchor
+ \li \uicontrol Anchors to \imageanchortop and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchortop to \e parent to anchor
the logo to its parent.
- \li \uicontrol Margin \inlineimage icons/anchor-top.png to \e 40 and
- select \inlineimage icons/anchor-top.png to anchor the logo to the top of
+ \li \uicontrol Margin \imageanchortop to \e 40 and
+ select \imageanchortop to anchor the logo to the top of
the target.
\endlist
This attaches the logo to the rectangle at the top while keeping its horizontal
@@ -76,12 +76,12 @@
\li Select \e tagLine in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-top.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-top.png to
+ \li \uicontrol Anchors to \imageanchortop and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchortop to
\e qt_logo_green_128x128px to anchor the tag line to the logo.
- \li \uicontrol Margin \inlineimage icons/anchor-top.png to \e 40 and
- select \inlineimage icons/anchor-bottom.png to anchor the tag line to the
+ \li \uicontrol Margin \imageanchortop to \e 40 and
+ select \imageanchorbottom to anchor the tag line to the
bottom of the target.
\endlist
This attaches the tag line to the bottom of the logo while keeping its horizontal
@@ -92,8 +92,8 @@
\uicontrol Target field, check that the component instance is
located in the correct place in the component hierarchy in
\uicontrol Navigator. For more information,
- see \l{Arranging Components}.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ see \l{Arranging components}.
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -102,10 +102,10 @@
\image loginui2-loginpage.webp "Login page in the 2D view and live preview"
- \section1 Using Column Positioners
+ \section1 Using column positioners
You will now position the entry fields and buttons in columns
- to learn another method of \l{Using Positioners}{positioning components}.
+ to learn another method of \l{Using positioners}{positioning components}.
Then, you will anchor the columns to the page to enable their positions
to change when the screen size changes.
@@ -137,12 +137,12 @@
\li Select \e fields in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-top.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-top.png to
+ \li \uicontrol Anchors to \imageanchortop and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchortop to
\e tagLine to anchor the entry fields to the tag line.
- \li \uicontrol Margin \inlineimage icons/anchor-top.png to \e 170 and
- select \inlineimage icons/anchor-bottom.png to anchor the entry fields to the
+ \li \uicontrol Margin \imageanchortop to \e 170 and
+ select \imageanchorbottom to anchor the entry fields to the
bottom of the target.
\endlist
This attaches the entry fields to the bottom of the tag line while keeping its
@@ -151,18 +151,18 @@
\li Select \e buttons in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-bottom.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-bottom.png to
+ \li \uicontrol Anchors to \imageanchorbottom and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchorbottom to
\e parent to anchor the entry fields to the rectangle.
- \li \uicontrol Margin \inlineimage icons/anchor-bottom.png to \e 50 and
- select \inlineimage icons/anchor-bottom.png to anchor the entry fields to the
+ \li \uicontrol Margin \imageanchorbottom to \e 50 and
+ select \imageanchorbottom to anchor the entry fields to the
bottom of the target.
\endlist
This attaches the buttons to the bottom of the rectangle while keeping its
horizontal center aligned with that of the rectangle.
\image loginui2-buttons-properties.webp "Properties of buttons"
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -171,7 +171,7 @@
\image loginui2-loginpage-ready.webp "Login page in the 2D view and live preview"
- \section1 Learn More
+ \section1 Learn more
\section2 Anchors
In an anchor-based layout, each component instance can be thought of as
having a set of invisible \e anchor lines: top, bottom, left, right, fill,
@@ -183,20 +183,21 @@
component instance changes, the instances that are anchored to it will
adjust automatically to maintain the anchoring.
- For more information, see \l{Positioning with Anchors}.
+ For more information, see \l{Positioning with Anchors}{Positioning with anchors}.
+
\section2 Positioners
For many use cases, the best positioner to use is a simple grid, row, or
column, and \QDS provides components that will position children in these
formations in the most efficient manner possible. For more information
- about using preset positioners, see \l {Using Positioners}.
+ about using preset positioners, see \l {Using positioners}.
For more complicated UI designs, you can use components from the
- \l {Using Layouts}{Qt Quick Layouts module}.
+ \l {Using layouts}{Qt Quick Layouts module}.
- \section1 Next Steps
+ \section1 Next steps
To learn how to add a second page and move to it from the main page, see
- the next tutorial in the series, \l {Log In UI - States}.
+ the next tutorial in the series, \l {Login UI: States}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/loginui3.qdoc b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
index a6b978d3d67..9b44d4f2259 100644
--- a/doc/qtdesignstudio/examples/doc/loginui3.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
@@ -5,14 +5,14 @@
\example Loginui3
\ingroup gstutorials
- \title Log In UI - States
+ \title Login UI: States
\brief Illustrates how to use states to create a second UI page.
- \previouspage {Log In UI - Positioning}
- \nextpage {Log In UI - Timeline}
+ \previouspage {Login UI: Positioning}
+ \nextpage {Login UI: Timeline}
- \image loginui3.gif "Log In UI"
+ \image loginui3.gif "Login UI"
- \e{Log In UI - States} is the third in a series of tutorials that build
+ \e{Login UI: States} is the third in a series of tutorials that build
on each other to illustrate how to use \QDS to create a simple UI with
some basic UI components, such as pages, buttons, and entry fields. The
third tutorial in the series describes how to use \e states to add a
@@ -25,7 +25,7 @@
when a user selects the \e {Create Account} button.
The starting point for this tutorial is the completed
- \l{Log In UI - Positioning} project. You can download the project
+ \l{Login UI: Positioning} project. You can download the project
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui2}{here}.
Additionally, you can download the completed project of this tutorial
@@ -33,14 +33,14 @@
For more information, see \l{Working with states} and \l{Signal and Handler Event System}.
- \section1 Adding UI Components
+ \section1 Adding UI components
You will add another entry field for verifying the password that users
enter to create an account. You are already familiar with the tasks in
this section from the previous \e {Login UI} tutorials.
To preview the changes that you make, select the \uicontrol {Live Preview} button
- or press \key {Alt+P}.
+ or select \key {Alt+P}.
To add the entry field needed on the second page to the \e Screen01
component:
@@ -59,7 +59,7 @@
enter \e {Repeat Password} and select \uicontrol tr to mark the text
translatable.
\image loginui3-new-entryfield-properties.webp "Entryfield properties"
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -73,13 +73,13 @@
the login page and the \e {Create Account} button on the account creation
page.
- \section1 Using States to Simulate Page Changes
+ \section1 Using states to simulate page changes
- You will now add \l{Working with States}{states} to the UI to show and hide UI
+ You will now add \l{Working with states}{states} to the UI to show and hide UI
components in the \uicontrol {2D} view, depending on the current page:
\list 1
- \li In the \l States view, select \inlineimage icons/plus.png
+ \li In the \l States view, select \imageplus
.
\li Enter \e login as the state name.
\image loginui3-login-state.webp "States view"
@@ -98,7 +98,7 @@
\li In \uicontrol Visibility, clear the \uicontrol Visible checkbox
to hide the \e {Create Account} button in the account creation
state.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -114,7 +114,7 @@
\e {Create Account} button on the login page triggers a
transition to the account creation page.
- \section1 Connecting Buttons to States
+ \section1 Connecting buttons to states
Components have predefined signals that are emitted when users interact
with the UI. The \e PushButton component contains a \l{Mouse Area} component
@@ -122,25 +122,25 @@
is clicked within the area.
You will now use the \l {Connections} view to
- \l{Connecting Components to Signals}{connect} the clicked signal of the
+ \l{Connecting components to signals}{connect} the clicked signal of the
\e createAccount button to \e createAccount state:
\list 1
\li Select \uicontrol View > \uicontrol Views >
\uicontrol {Connections} to open the \uicontrol Connections view.
\li Select \e createAccount in \uicontrol Navigator.
- \li In the \uicontrol Connections tab, select the \inlineimage icons/plus.png
+ \li In the \uicontrol Connections tab, select the \imageplus
button to open the connection setup options.
\li Set \uicontrol Signal to \c clicked, \uicontrol Action to
\c {Change State}, \uicontrol {State Group} to \c rectangle, and
\uicontrol State to \c createAccount in the respective
drop-down menus.
- \li Select the \inlineimage icons/close.png
+ \li Select the \imageclose
button to close the connection setup options.
\image loginui3-connections.webp "Connections tab"
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\note Alternatively, right-click the \e createAccount button in
@@ -154,9 +154,9 @@
\image loginui3.gif "Moving between login page and account creation page"
- \section1 Next Steps
+ \section1 Next steps
To learn how to use a timeline to animate the transition between the login
and account creation pages, see the next tutorial in the series,
- \l {Log In UI - Timeline}.
+ \l {Login UI: Timeline}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/loginui4.qdoc b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
index 59c863d200d..6393029fb2c 100644
--- a/doc/qtdesignstudio/examples/doc/loginui4.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
@@ -5,14 +5,14 @@
\example Loginui4
\ingroup gstutorials
- \title Log In UI - Timeline
+ \title Login UI: Timeline
\brief Illustrates how to use the timeline and states to animate UI
components.
- \previouspage {Log In UI - States}
+ \previouspage {Login UI: States}
- \image loginui4.gif "Log In UI"
+ \image loginui4.gif "Login UI"
- \e{Log In UI - Timeline} is the fourth in a series of tutorials that build
+ \e{Login UI: Timeline} is the fourth in a series of tutorials that build
on each other to illustrate how to use \QDS to create a simple UI with
some basic UI components, such as pages, buttons, and entry fields. The
fourth part of the tutorial describes how to use the timeline and states
@@ -20,25 +20,24 @@
to the preceding animation, where you can navigate to the account creation
page by clicking the \e {Create Account} button.
- In \l {Log In UI - States}, you learned how to use states to simulate page
+ In \l {Login UI: States}, you learned how to use states to simulate page
changes in a UI and connections to provide user interaction with it. In
this part, you will now learn another way of animating the UI by creating
- \l{Creating Timeline Animations}{timeline animations} that you bind
+ \l{Creating timeline animations}{timeline animations} that you bind
to states.
The starting point for this tutorial is the completed
- \l{Log In UI - States} project. You can download the project
+ \l{Login UI: States} project. You can download the project
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui3}{here}.
Additionally, you can download the completed project of this tutorial
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui4}{here}.
+ For more information, see \l {Creating timeline animations}.
- For more information, see \l {Creating Timeline Animations}.
+ \section1 Animating UI components
- \section1 Animating UI Components
-
- In \l {Log In UI - States}, you changed the visibility property in different
+ In \l {Login UI: States}, you changed the visibility property in different
states to simulate changing pages. To make sure that those changes won't
interfere with the changes to the opacity property you will make next, you
will first remove the states.
@@ -52,41 +51,41 @@
column component and anchor them to the rectangle and to each other instead.
To preview the changes that you make, select the \uicontrol {Live Preview} button
- or press \key {Alt+P}.
+ or select \key {Alt+P}.
- \section2 Replacing Columns with Anchors
+ \section2 Replacing columns with anchors
First, prepare the \e Screen01 component for adding animation:
\list 1
\li Double-click \e Screen01.ui.qml in \l Projects to open it
in the \l {2D} view.
- \li In the \l States view, select \e login > \inlineimage icons/more-button.png
+ \li In the \l States view, select \e login > \imagemorebutton
> \uicontrol Delete to remove the state. Repeat for the \e createAccount state.
\li Select \e username in \l Navigator, and then select:
\list
- \li \inlineimage icons/arrowleft.png to move \e username into the parent
+ \li \imagearrowleft to move \e username into the parent
rectangle.
- \li \inlineimage icons/navigator-arrowup.png to move \e username below
+ \li \imagenavigatorarrowup to move \e username below
\e tagLine in \uicontrol Navigator to preserve the
- \l{Arranging Components}{component hierarchy}.
+ \l{Arranging components}{component hierarchy}.
\endlist
\li Repeat the previous step for \e password and \e repeatPassword.
- \li Select \e fields in \uicontrol Navigator and press \key Delete to
+ \li Select \e fields in \uicontrol Navigator and select \key Delete to
delete it.
\image loginui4-hierarchy.webp "The hierarchy of the components."
\li Select \e username in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-top.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-top.png to
+ \li \uicontrol Anchors to \imageanchortop and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchortop to
\e tagLine to anchor \e username to the tag line.
- \li \uicontrol Margin \inlineimage icons/anchor-top.png to \e 170 and
- select \inlineimage icons/anchor-bottom.png to anchor \e username to the
+ \li \uicontrol Margin \imageanchortop to \e 170 and
+ select \imageanchorbottom to anchor \e username to the
bottom of the target.
\note Selecting the anchor button should automatically update the
- \uicontrol {2D} view. If it doesn't, select \inlineimage icons/reset.png
+ \uicontrol {2D} view. If it doesn't, select \imagereset
on the \uicontrol {2D} view toolbar to refresh the \uicontrol{2D} view.
\endlist
This attaches \e username to the bottom of the tag line while keeping its
@@ -95,12 +94,12 @@
\li Select \e password in \uicontrol Navigator.
\li In \uicontrol Properties > \uicontrol Layout, set:
\list
- \li \uicontrol Anchors to \inlineimage icons/anchor-top.png and
- \inlineimage icons/anchor-center-horizontal.png.
- \li \uicontrol Target \inlineimage icons/anchor-top.png to
+ \li \uicontrol Anchors to \imageanchortop and
+ \imageanchorcenterhorizontal.
+ \li \uicontrol Target \imageanchortop to
\e username to anchor \e password to \e username.
- \li \uicontrol Margin \inlineimage icons/anchor-top.png to \e 20 and
- select \inlineimage icons/anchor-bottom.png to anchor \e password to the
+ \li \uicontrol Margin \imageanchortop to \e 20 and
+ select \imageanchorbottom to anchor \e password to the
bottom of the target.
\endlist
This attaches \e password to the bottom of \e username while keeping its
@@ -109,7 +108,7 @@
\li Repeat the previous step to anchor the top of \e repeatPassword
to the bottom of \e password with a margin of \e 20 and to
anchor it horizontally to its parent.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -117,16 +116,16 @@
\image loginui4-base-state.webp "UI with all the buttons and fields"
- \section2 Adding a Timeline
+ \section2 Adding a timeline
- You are now ready to add the \l{Creating Timeline Animations}{timeline}.
+ You are now ready to add the \l{Creating timeline animations}{timeline}.
To add a timeline with settings for running the animation:
\list 1
\li Select \uicontrol View > \uicontrol Views >
\uicontrol Timeline to open the \l Timeline view.
- \li In \uicontrol Timeline, select \inlineimage icons/plus.png
+ \li In \uicontrol Timeline, select \imageplus
to add a 1000-frame timeline and define settings for running the animation.
\li In the \uicontrol {Animation ID} field, enter
\e toCreateAccountState.
@@ -141,7 +140,7 @@
Next, you will record the animation in \uicontrol Timeline.
- \section2 Inserting Keyframes
+ \section2 Inserting keyframes
To insert keyframes and record property changes in \uicontrol Timeline:
@@ -149,13 +148,13 @@
\li Select \e repeatPassword in \uicontrol Navigator to display its
properties in \uicontrol Properties.
\li In \uicontrol Visibility > \uicontrol Opacity, select
- \inlineimage icons/action-icon.png
+ \imageactionicon
> \uicontrol {Insert Keyframe} to insert a keyframe for the
opacity property of the component.
\image loginui4-keyframe-opacity.png "Inserting keyframe for opacity property"
\li In \uicontrol Timeline, check that the playhead is in
frame \e 0, select the small arrow next to \e repeatPassword
- keyframe to expand it, and then select the \inlineimage icons/recordfill.png
+ keyframe to expand it, and then select the \imagerecordfill
(\uicontrol {Per Property Recording}) button for the
\uicontrol opacity property of \e repeatPassword to start
recording property changes.
@@ -165,7 +164,7 @@
to show the button.
Alternatively, you can fine-tune the value of a keyframe by right-clicking the
- keyframe marker \inlineimage icons/keyframe_linear_active.png
+ keyframe marker \imagekeyframelinearactive
, and selecting \uicontrol {Edit Keyframe}.
\image loginui4-timeline.webp "Recording the opacity property"
\li Select the record button again to stop recording property changes.
@@ -176,7 +175,7 @@
property of the button and to record changes for it. However, this
time the opacity value needs to be \e 1 in frame \e 0 and \e 0 in frame \e 1000.
\image loginui4-timeline-opacity.webp "Recorded timeline for the opacity properties"
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -186,7 +185,7 @@
You will now animate the top anchor margin of the \e {Repeat Password} field
to make it appear to slide down from the \e Password field.
- \section2 Animating Anchors
+ \section2 Animating anchors
To animate the top anchor margin of the \e {Repeat Password} field:
@@ -194,15 +193,15 @@
\li Select \e repeatPassword in \uicontrol Navigator to display its
properties in \uicontrol Properties.
\li In \uicontrol Layout > \uicontrol Margin (under
- \inlineimage icons/anchor-top.png
- ), select \inlineimage icons/action-icon.png
+ \imageanchortop
+ ), select \imageactionicon
> \uicontrol {Insert Keyframe} to insert a keyframe for the top
anchor margin of \e repeatPassword.
\image loginui4-keyframe-top-anchor-margin.png "Inserting keyframe for top anchor margin"
\li In \uicontrol Timeline, check that the playhead is in
frame \e 0, and select the record button for the \e anchors.topMargin
property of \e repeatPassword.
- \li In \uicontrol Layout > \uicontrol Margin (under \inlineimage icons/anchor-top.png),
+ \li In \uicontrol Layout > \uicontrol Margin (under \imageanchortop),
set a negative value for the top anchor margin, \e -100, to place \e repeatPassword
on top of \e password.
\li Move the playhead to frame \e 1000 and change the top anchor margin
@@ -211,17 +210,17 @@
\e password.
\li Select the record button again to stop recording property changes.
\image loginui4-timeline-all.webp "Recorded timeline for repeatPassword and createAccount."
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
- \section2 Adding Easing Curves
+ \section2 Adding easing curves
- You will now add an \l{Editing Easing Curves}{easing curve} to the anchor
+ You will now add an \l{Editing easing curves}{easing curve} to the anchor
margin animation that will make the transition seem smoother:
\list 1
- \li Click the keyframe marker \inlineimage icons/keyframe_linear_active.png
+ \li Click the keyframe marker \imagekeyframelinearactive
for the \e anchors.topMargin property at frame \e 1000 on the
timeline to select it.
\image loginui4-easing-curve-top-anchor-margin.webp "Top anchor margin keyframe marker"
@@ -234,8 +233,8 @@
\endlist
When you attach easing curves to keyframes, the shape of the keyframe
- marker changes from \inlineimage icons/keyframe_linear_active.png
- to \inlineimage icons/keyframe_manualbezier_active.png
+ marker changes from \imagekeyframelinearactive
+ to \imagekeyframemanualbezieractive
.
Your timeline should now look something like this:
@@ -245,14 +244,14 @@
Next, you will create states for the login and account creation pages and bind
them to the animation settings.
- \section1 Binding Animation to States
+ \section1 Binding animation to states
- To bring back the \l{Working with States}{states} in the
+ To bring back the \l{Working with states}{states} in the
\uicontrol States view and bind them to the animation settings
in \uicontrol Timeline:
\list 1
- \li In \uicontrol States, select \inlineimage icons/plus.png
+ \li In \uicontrol States, select \imageplus
twice to add two states and name them \e login and \e createAccount. You
don't need to make any property changes this time because you'll
bind the states to property animations.
@@ -260,8 +259,8 @@
the \e login state is applied when the application starts.
\image loginui4-states.webp "Created states in the States view."
\li With the base state selected, select \uicontrol Timeline >
- \inlineimage icons/settings.png (\uicontrol {Timeline Settings (S)}) on the toolbar
- (or press \key S) to open the \uicontrol {Timeline Settings} dialog.
+ \imagesettings (\uicontrol {Timeline Settings (S)}) on the toolbar
+ (or select \key S) to open the \uicontrol {Timeline Settings} dialog.
\li Double-click the cell in the \uicontrol Timeline column on the
\e login row, and select \e timeline in the list.
\li Double-click the cell in the \uicontrol Timeline column on the
@@ -270,7 +269,7 @@
\e createAccount row, and select \e toCreateAccountState.
\image loginui4-timeline-settings-states.png
\li Click \uicontrol Close to save the timeline settings.
- \li Select \uicontrol File > \uicontrol Save or press \key {Ctrl+S}
+ \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes.
\endlist
@@ -279,7 +278,7 @@
\image loginui4.gif "Moving between login page and account creation page"
- \section1 Next Steps
+ \section1 Next steps
To continue learning about \QDS, see \l{Examples} and other \l{Tutorials}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/materialbundle.qdoc b/doc/qtdesignstudio/examples/doc/materialbundle.qdoc
index 4f808b14f25..e1a89148f79 100644
--- a/doc/qtdesignstudio/examples/doc/materialbundle.qdoc
+++ b/doc/qtdesignstudio/examples/doc/materialbundle.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
diff --git a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc
index 8689960cbb8..80b0d986eac 100644
--- a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc
+++ b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc
@@ -1,11 +1,11 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page multilanguage-tutorial.html
\ingroup gstutorials
- \title Adding Multi-language Support to Your Project
+ \title Adding multi-language support to your project
\brief Illustrates how to add support for multiple languages to your
project.
@@ -13,7 +13,7 @@
The \e{Multi-language Support} tutorial illustrates how you can add
support for multiple languages to your project. In this tutorial you
- prepare a simple log in UI for multi-language support and import
+ prepare a simple login UI for multi-language support and import
translations from a JSON file.
You need to download the starting project for this tutorial from
@@ -27,7 +27,7 @@
\include run-tutorial-project.qdocinc
- \section1 JSON Translation File
+ \section1 The JSON translation file
The JSON translation file you are using in this project has the following
structure:
@@ -104,7 +104,7 @@
}
\endcode
-\section1 Preparing Your Project
+\section1 Preparing your project
First, you need to prepare your project for translation:
@@ -134,7 +134,7 @@
\endcode
\endlist
- \section1 Importing Translations
+ \section1 Importing translations
Next, you need to import your JSON translation file:
@@ -143,14 +143,14 @@
Translations to open the \uicontrol Translations view. You can
drag it to a workspace to dock it.
\li In \uicontrol Translations, select
- \inlineimage icons/select-languages.png
+ \imageselectlanguages
.
\li Select the languages that you want to support in your project,
in this case \uicontrol{English - American English} and
\uicontrol{Swedish - Svenska}.
\li Set \uicontrol{English - American English} as primary language and
select \uicontrol{Ok}.
- \li Select \inlineimage icons/import-json-translations.png
+ \li Select \imageimportjsontranslations
and open the \e ml_translations.json file. Now you can see all your
imported translations in the \uicontrol Translations view.
\image imported-translations.png
@@ -167,7 +167,7 @@
Finally, before you can see your translations in the application or in
\uicontrol{Live Preview}, you must generate Qt translation source files.
To do this, select
- \inlineimage icons/generate-translation-files.png
+ \imagegeneratetranslationfiles
in the \uicontrol Translations view.
*/
diff --git a/doc/qtdesignstudio/examples/doc/progressbar.qdoc b/doc/qtdesignstudio/examples/doc/progressbar.qdoc
index 6ce9ff1562c..b99780eb32b 100644
--- a/doc/qtdesignstudio/examples/doc/progressbar.qdoc
+++ b/doc/qtdesignstudio/examples/doc/progressbar.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -12,9 +12,9 @@
\e {Progress Bar} animates rectangles and numbers using timelines.
- \section1 Creating the Progress Bar
+ \section1 Creating the progress bar
- First, we create an empty project, as described in \l {Creating Projects}.
+ First, we create an empty project, as described in \l {Creating projects}.
For the purposes of this example, we call the project \e progressbar.
In this example, we use two overlapping instances of the preset
@@ -53,9 +53,9 @@
change for the animation.
For more information about creating and positioning components, see
- \l {Using Components} and \l {Scalable Layouts}.
+ \l {Using Components} and \l {Scalable layouts}.
- \section1 Animating Progress Bar Elements
+ \section1 Animating the progress bar elements
The text label will indicate the progress in numbers and changing color,
while the indicator rectangle will indicate it by getting wider and
@@ -63,28 +63,28 @@
in the \l Timeline view.
For more information about using the timeline, see
- \l {Creating Timeline Animations}.
+ \l {Creating timeline animations}.
- \section2 Adding Color Animation
+ \section2 Adding color animation
First, we add a color animation to the \e root component in the \e Root.qml
- file. We select the \inlineimage icons/plus.png
+ file. We select the \imageplus
button to add a 100-frame timeline to root. You can use the default
values for all other fields.
\image progressbar-timeline-settings.png "Timeline settings"
To start recording a color animation on the timeline, we check that the
- playhead is at frame 0 and then select the \inlineimage icons/recordfill.png
- (\uicontrol {Auto Key (K)}) button (or press \key k).
+ playhead is at frame 0 and then select the \imagerecordfill
+ (\uicontrol {Auto Key (K)}) button (or select \key K).
\image progressbar-timeline.png "Color animation timeline"
We then set the color at frame 0 to green (\e {#8de98d}) in
\uicontrol Properties > \uicontrol Text > \uicontrol {Text Color}.
- We can either \l{Picking Colors}{pick a color} from the color selector
+ We can either \l{Picking colors}{pick a color} from the color selector
or use the \uicontrol {Set Binding} command in the
- \inlineimage icons/action-icon.png
+ \imageactionicon
(\uicontrol Actions) menu to open the \uicontrol {Binding Editor}.
We then move the playhead to frame 50 and set the text color to red
@@ -96,7 +96,7 @@
We can drag the playhead along the timeline to see the color animation.
- \section2 Animating the Indicator
+ \section2 Animating the indicator
We select \e pb_front in \uicontrol Navigator and then select the record
button again to animate the width of the indicator. At frame 0, we set the
@@ -120,7 +120,7 @@
When we move the playhead, we can see that the color animation is also
applied to the indicator.
- \section1 Creating a Reusable Component
+ \section1 Creating a reusable component
We want the progress bar to be reusable, so we'll move it to a separate
component file. To make sure that the component will contain the timeline,
@@ -135,14 +135,14 @@
\image progressbar-move-component.png "Move Component into Separate File dialog"
- \section1 Exporting Properties
+ \section1 Exporting properties
We now select the root component in \uicontrol Navigator, and
then select \uicontrol {Go into Component} in the context menu to
open \e Root.qml in the \uicontrol {2D} view.
- We want to be able to use the keyframe value as the value of the text label,
- so we will export it as a \l{Adding Property Aliases}{property alias}. We
+ We want to use the keyframe value as the value of the text label,
+ so we will export it as a \l{Adding property aliases}{property alias}. We
select \e timeline in \uicontrol Navigator and then \uicontrol Properties >
\uicontrol Timeline > \uicontrol {Current frame} > \uicontrol Actions >
\uicontrol {Export Property as Alias}.
@@ -166,14 +166,14 @@
When we move back to the top-level file, we can see that the number of the
current keyframe (0) is displayed as the value of the text label.
- \section1 Animating Progress Bar Instances
+ \section1 Animating the progress bar instances
We want to experiment with different start and end values and easing curves,
so we copy-paste the progress bar instance twice in the top-level file. We
use a column layout to lay out the progress bar instances.
We can now add timelines for each progress bar instance, with different
- settings. We select the \inlineimage icons/plus.png
+ settings. We select the \imageplus
button to add a 4000-frame timeline to the first progress bar instance
(\e root). We select the \uicontrol Continuous check box so that the
animation will loop.
@@ -201,9 +201,9 @@
by specifying easing curves for them.
For more information about previewing UIs, see
- \l {Validating with Target Hardware}.
+ \l {Validating with target hardware}.
- \section1 Specifying Easing Curves
+ \section1 Specifying easing curves
We can add custom easing curves to every keyframe in the animations. First,
we select the keyframe to add the easing curve to, and then select
@@ -215,9 +215,9 @@
\image studio-easing-curve-editor.png "Easing Curve Editor"
When we apply easing curves to animations, the shape of the keyframe
- marker changes from \inlineimage icons/keyframe_linear_active.png
- to \inlineimage icons/keyframe_manualbezier_active.png
+ marker changes from \imagekeyframelinearactive
+ to \imagekeyframemanualbezieractive
.
- For more information, see \l{Editing Easing Curves}.
+ For more information, see \l{Editing easing curves}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc b/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc
index 5cc040d4276..2958647369f 100644
--- a/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc
+++ b/doc/qtdesignstudio/examples/doc/rainSnowParticles.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,15 +6,14 @@
\ingroup gstutorials
\sa Particles
- \title Particle System: Rain and Snow Effect
- \brief Illustrates how to create a rain and snow effect with the \QDS
+ \title Particle System: The rain and the snow effects
+ \brief Illustrates how to create a rain and a snow effect with the \QDS
particle system.
\image snow-particles.png
- The \e{Rain and Snow Effect} tutorial illustrates how you can add a rain and
- a snow effect to your
- scene using the \QDS particle system.
+ \e{The rain and the snow effects} tutorial illustrates how you can add a rain and
+ a snow effect to your scene using the \QDS particle system.
You need to download the starting project for this tutorial from
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/rain-snow-particles/Start}{here}
@@ -24,15 +23,15 @@
to get started.
\image rain-snow-tutorial-start.png
- \section1 Creating a Rain Effect
+ \section1 Creating a rain effect
- \section2 Adding a Particle System to Your Scene
+ \section2 Adding a Particle System to your scene
To add a particle system, you first need to import the QtQuick3D.Particles3D
module to your project:
\list 1
- \li In the \uicontrol Component view, select \inlineimage icons/plus.png
+ \li In the \uicontrol Component view, select \imageplus
.
\li Find QtQuick3D.Particles3D and select it to add it to your project.
\li From \uicontrol Components, drag a
@@ -43,7 +42,8 @@
\image rain-snow-tutorial-particle-system.png
- \section2 Adjusting the Behavior and Apperance of the Particle System
+ \section2 Adjusting the behavior and apperance of the Particle System
+
Next, you adjust the position, behavior, and apperance of the particle
system to create a simple rain effect:
@@ -93,7 +93,7 @@
\endlist
\endlist
- \section2 Adjusting the Size of the Emitting Area
+ \section2 Adjusting the size of the emitting area
By default, the \uicontrol {Particle Emitter} emits particles from one
point in the scene. In this scene you want to emit particles from a bigger
@@ -118,10 +118,10 @@
\image rain-snow-tutorial-navigator.png
- Now, the rain effect is ready. Press \key Alt+P to see it in the live
+ Now, the rain effect is ready. Select \key Alt+P to see it in the live
preview.
- \section1 Creating a Snow Effect
+ \section1 Creating a snow effect
To make it easy, you can duplicate the particle system you created for the
rain effect and adjust the properties to create a snow effect. To do this,
@@ -133,7 +133,7 @@
\image rain-snow-tutorial-states.png
- \section2 Turning the Rain into Snow
+ \section2 Turning the rain into snow
\list 1
\li With the new state that you just created selected in
@@ -163,9 +163,9 @@
Now you can run the snow effect in the live preview:
\list 1
\li In \uicontrol{States} next to \uicontrol State1 select
- \inlineimage icons/action-icon.png
+ \imageactionicon
and select \uicontrol{Set as Default}.
- \li Press \key{Alt+P}.
+ \li Select \key{Alt+P}.
\endlist
\image rain-snow-tutorial-default-state.png
diff --git a/doc/qtdesignstudio/examples/doc/robotarm.qdoc b/doc/qtdesignstudio/examples/doc/robotarm.qdoc
index 6c6ae78b023..00b721df020 100644
--- a/doc/qtdesignstudio/examples/doc/robotarm.qdoc
+++ b/doc/qtdesignstudio/examples/doc/robotarm.qdoc
@@ -1,11 +1,11 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page robotarm-example.html
\ingroup gstutorials
- \title Creating a C++ Backend for a \QDS Application
+ \title Creating a C++ backend for a \QDS application
\brief Illustrates how to create an application in \QDS and add a backend
in Qt Creator.
@@ -23,13 +23,13 @@
To complete this tutorial, you need experience in using \QDS and Qt Creator as well as knowledge
in C++ programming.
- \section1 The Designer-Developer Workflow
+ \section1 The designer-developer workflow
This section describes the high-level steps for creating the robot arm example.
- \section2 Creating the User Interface
+ \section2 Creating the user interface
- First, the designer creates the user interface in \QDS.
+ First, the designer creates the user interface in \QDS:
\list 1
\li Create a new 3D project.
@@ -65,7 +65,7 @@
\endlist
\endlist
- \section2 Creating the C++ Backend
+ \section2 Creating the C++ backend
With the frontend and user interface created, it is time to create the C++ backend.
diff --git a/doc/qtdesignstudio/examples/doc/sidemenu.qdoc b/doc/qtdesignstudio/examples/doc/sidemenu.qdoc
index d1db82c8ee2..3f1a9070791 100644
--- a/doc/qtdesignstudio/examples/doc/sidemenu.qdoc
+++ b/doc/qtdesignstudio/examples/doc/sidemenu.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -16,13 +16,13 @@
when users hover the cursor over them or select them.
Each button opens an image file. The side menu can be used to apply
- \l {2D Effects}{graphical effects}, such as hue, saturation,
+ \l {2D effects}{graphical effects}, such as hue, saturation,
and blur, to the images.
\note Only a subset of effects is available if you select
- \uicontrol {Qt 6} when \l{Creating Projects}{creating the project}.
+ \uicontrol {Qt 6} when \l{Creating projects}{creating the project}.
- \section1 Creating Reusable Buttons
+ \section1 Creating reusable buttons
We select \uicontrol File > \uicontrol {New File} >
\uicontrol {Qt Quick Controls} >
@@ -31,7 +31,7 @@
The button can have the following states: checked, hover, pressed, and
normal. We construct the button using different images for the button
- background, frame, and front. We then add \l{Working with States}{states} in
+ background, frame, and front. We then add \l{Working with states}{states} in
the \l States view for each of the button states. In each state, we turn
the visibility of the appropriate images on or off in the button properties,
to change the appearance of the button.
@@ -77,7 +77,7 @@
We can now use CustomButton instances to create a menu bar.
- \section1 Constructing a Menu Bar
+ \section1 Constructing a menu bar
We construct the menu bar in the \e {MainFile.ui.qml} file using the
\l {2D} view. The CustomButton component is listed in
@@ -98,10 +98,10 @@
In addition, we set the \uicontrol Checked property to \c true for the
first button instance on the menu bar to make it appear selected.
- We can now select the \inlineimage icons/run_small.png "Run button"
+ We can now select the \imagerunsmall
(\uicontrol Run) button to run the application and test our menu bar.
- \section1 Creating a Side Menu
+ \section1 Creating a side menu
We can now continue to create a side menu that slides open when users
click the burger menu. We drag-and-drop a \l Text component from
@@ -131,7 +131,7 @@
\image sidemenu-states.png "Side menu states"
- We then select the \inlineimage icons/plus.png
+ We then select the \imageplus
button in the \l Timeline view to add animation
for transitions to the \e open and \e close states:
@@ -145,8 +145,8 @@
We want to change the position of the outline and background images. To
start recording the transition from the closed state to the open state,
we select \e imageOutline in \uicontrol Navigator. We check that the
- playhead is at frame 0, and then select the \inlineimage icons/recordfill.png
- (\uicontrol {Auto Key (K)}) button (or press \key k).
+ playhead is at frame 0, and then select the \imagerecordfill
+ (\uicontrol {Auto Key (K)}) button (or select \key K).
At frame 0, we set the X coordinate to -423 in \uicontrol Properties >
\uicontrol {Geometry - 2D} > \uicontrol Position. We then move the playhead
@@ -160,21 +160,21 @@
We then record the transition of the \e imageBackground image. At frame
0, we set the X coordinate to -424 again. We then move the playhead to
frame 400 and select \uicontrol {Insert Keyframe} in the
- \inlineimage icons/action-icon.png
+ \imageactionicon
(\uicontrol Actions) menu of the X coordinate. We keep the value of the
X coordinate -424. We then move the playhead to frame 1000 and set the X
coordinate to 0.
- We select \inlineimage icons/animation.png "Timeline Settings button"
+ We select \imageanimation
to open the \uicontrol {Timeline Settings} dialog. In the
\uicontrol {Transitions to states} field, we select the state to
apply when the animation finishes. In the lower part of the
dialog, we bind the states that don't have animations to fixed frames.
For more information about using the timeline, see
- \l {Creating Timeline Animations}.
+ \l {Creating timeline animations}.
- \section1 Connecting the Burger Menu to Actions
+ \section1 Connecting the burger menu to actions
In \e {SideMenu.qml}, we use connections to bind the action of clicking
the burger menu to the signal handler for triggering the opening or
@@ -192,10 +192,10 @@
The side menu is fully visible and accepts input only in the \e open state.
- For more information about Connecting Components to Signals, see
- \l {Connecting Components to Signals}.
+ For more information about connecting components to signals, see
+ \l {Connecting components to signals}.
- \section1 Applying Effects
+ \section1 Applying effects
We nest the effects in an effects stack and bind them to the
\l {slider-control}{Slider} component instances. The effects apply
@@ -203,7 +203,7 @@
currently open one.
We use property bindings to connect the controls in the slider menu to
- \l {2D Effects}{graphical effects}. To have access to the
+ \l {2D effects}{graphical effects}. To have access to the
properties from all the slider component instances, we export them as
aliases in \e SliderMenu.ui.qml. We select \uicontrol {Export Property as Alias}
in the \uicontrol Settings menu of the \uicontrol Value property in
@@ -217,9 +217,9 @@
We use an instance of the \l {Images}{Image} component as the last item in
the stack to display images that we apply the effects to. We export the
- image source property as an \l{Adding Property Aliases}{alias} to be able
+ image source property as an \l{Adding property aliases}{alias} to be able
to switch the image inside the stack.
For more information about the available graphical effects, see
- \l {2D Effects}.
+ \l {2D effects}.
*/
diff --git a/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc b/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc
index ed7066953a4..665d8b6a556 100644
--- a/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc
+++ b/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,9 +6,9 @@
\ingroup studioexamples
\brief Illustrates how to use a virtual keyboard in an application.
- \title Simple Keyboard
+ \title Simple keyboard
- \e {Simple Keyboard} provides a virtual keyboard for entering
+ \e {Simple keyboard} provides a virtual keyboard for entering
text into several text fields. It uses functionality from the
\l{Qt Virtual Keyboard} module.
@@ -18,13 +18,13 @@
text into \l{Text Edit} or \l{Text Input} components. For more information
about using it, see \l{User Guide}{Virtual Keyboard: User Guide}.
- To test the virtual keyboard, you need to select the \inlineimage icons/run_small.png
+ To test the virtual keyboard, you need to select the \imagerunsmall
(\uicontrol Run) button to run the example on the desktop or a device.
The keyboard is not available during preview.
- \section1 Using a Virtual Keyboard
+ \section1 Using a virtual keyboard
- First, we create an empty project, as described in \l {Creating Projects}.
+ First, we create an empty project, as described in \l {Creating projects}.
For the purposes of this example, we call the project \e SimpleKeyboard.
We can use the default settings for other options, but we need to select
the \uicontrol {Use Qt Virtual Keyboard} check box on the
diff --git a/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc b/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc
index 634ea666e06..34c09f1c8f4 100644
--- a/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc
+++ b/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -26,7 +26,7 @@
Users select buttons to navigate between the screens.
We use \l{glossary-connection}{connections} to determine which
screen to open when users select a particular button and \l{glossary-state}
- {states} to show the screens. We use the \l{Creating Timeline Animations}
+ {states} to show the screens. We use the \l{Creating timeline animations}
{timeline} to create progress indicators for buttons and the \e Running
screen.
@@ -36,7 +36,7 @@
{\QMCU}, which does not support the \l Date component at the time of
writing.
- \section1 Creating an Application for MCUs
+ \section1 Creating an application for MCUs
We use the \uicontrol {\QMCU Application} project template to create
an application for MCUs, which support only a subset of the preset
@@ -61,7 +61,7 @@
This way, only the components and properties supported on MCUs are visible
in \l Components and \l Properties, and we won't accidentally
add unsupported components to our UI or specify unsupported properties for
- supported components. For more information, see \l{Creating Projects}.
+ supported components. For more information, see \l{Creating projects}.
In addition, the wizard template creates a generic \c CMakeLists.txt file
that we can use to configure and build our example application for running
@@ -71,11 +71,11 @@
1.6. You cannot run it on older versions. Also, at the time of writing,
\QMCU only supports Qt 5.
- \section1 Creating Screens
+ \section1 Creating screens
For this example, we used an external tool to design the UI and then
exported and imported our design into \QDS as assets and components
- using \QB, as instructed in \l{Exporting from Design Tools}. While
+ using \QB, as instructed in \l{Exporting from design tools}. While
exporting, we only picked components supported by \QMCU to use
for our components. For the button components, we mostly use the
\l {basic-image}{Image}, \l Text, and \l {Mouse Area} components. For the
@@ -94,9 +94,9 @@
by selecting \uicontrol File > \uicontrol {New File} >
\uicontrol {Qt Quick Files}. While designing the screens, you can
move reusable components into separate files. For more information,
- see \l{Using Components}.
+ see \l{Using components}.
- \section1 Creating a Progress Indicator
+ \section1 Creating a progress indicator
We create a reusable MultSegmentArc component, and use it in our
\e Bigbutton and \e Smallbutton components to indicate the button
@@ -125,7 +125,7 @@
We can now add a timeline animation to make the arc move around the button
when the button is pressed. In the \uicontrol Timeline view, we select the
- \inlineimage icons/plus.png
+ \imageplus
button to add a 1000-frame timeline to the \e root of the component.
We'll use the default values for all other fields.
@@ -134,15 +134,15 @@
First, we select the initial arc segment, \e arcSegment1, in
\l Navigator to display its properties in \uicontrol Properties.
In \uicontrol {Geometry - 2D} > \uicontrol Rotation, we select
- \inlineimage icons/action-icon.png
+ \imageactionicon
(\uicontrol Actions), and then select \uicontrol {Insert Keyframe} to
insert a keyframe that we can animate in the \uicontrol Timeline view.
\image washingmachineui-insert-keyframe.png "Inserting keyframe for Rotation property"
To start recording a rotation animation on the timeline, we check that the
- playhead is at frame 0 and then select the \inlineimage icons/recordfill.png
- (\uicontrol {Auto Key (K)}) button (or press \key k).
+ playhead is at frame 0 and then select the \imagerecordfill
+ (\uicontrol {Auto Key (K)}) button (or select \key K).
First, we set the rotation at frame 0 to -90 in \uicontrol Properties >
\uicontrol {Geometry - 2D} > \uicontrol Rotation. Next, we move the playhead
@@ -163,7 +163,7 @@
\image washingmachineui-multsegmentarc.gif "Rotation animation in the 2D view"
- \section1 Creating States
+ \section1 Creating states
In our UI, we use connections and states to move between screens. First,
we specify the application workflow in \e ApplicationFlow.qml. When the
@@ -179,7 +179,7 @@
in the top-left corner of the root component.
Then, we open the \uicontrol States view to create the \e start,
- \e settings, \e presets, and \e running \l{Working with States}{states} for
+ \e settings, \e presets, and \e running \l{Working with states}{states} for
displaying a particular screen by selecting \uicontrol {Create New State}.
\image washingmachineui-states.png "States view"
@@ -188,7 +188,7 @@
sometimes use \c when conditions to determine the state to apply, and
sometimes switch states using signals and JavaScript expressions.
- \section1 Connecting Buttons to State Changes
+ \section1 Connecting buttons to state changes
In each file that defines a screen, we connect signals to the
button components to change to a particular state when users select
@@ -205,10 +205,10 @@
Then, we select the mouse area for the start button, \e startMA,
in \uicontrol Navigator. On the \uicontrol Connections tab in the
- \l {Connections} view, we select the \inlineimage icons/plus.png
+ \l {Connections} view, we select the \imageplus
(\uicontrol Add) button. We set \uicontrol Signal to \c clicked,
\uicontrol Action to \c {Call Function} and \uicontrol Item to
- \c startClicked. Next, we select the \inlineimage icons/close.png
+ \c startClicked. Next, we select the \imageclose
button to close the connection setup options.
\image washingmachineui-connections.webp "Connections view"
@@ -228,9 +228,9 @@
We create similar connections between button components and signals in the
other screens to apply other actions that move users to other screens.
- For more information, see \l {Connecting Components to Signals}.
+ For more information, see \l {Connecting components to signals}.
- \section1 Showing the Current Time
+ \section1 Showing the current time
The \l Date component is not supported on \QMCU, and the
\l{https://doc.qt.io/QtForMCUs/qtul-javascript-environment.html}
diff --git a/doc/qtdesignstudio/examples/doc/webinardemo.qdoc b/doc/qtdesignstudio/examples/doc/webinardemo.qdoc
index 56aedef21be..31a1b04a8e9 100644
--- a/doc/qtdesignstudio/examples/doc/webinardemo.qdoc
+++ b/doc/qtdesignstudio/examples/doc/webinardemo.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -23,10 +23,10 @@
design to \QDS as PNG images and custom components.
Before we can begin, we must set up \QB as instructed in
- \l{Exporting Designs from Adobe Photoshop}.
+ \l{Exporting designs from Adobe Photoshop}.
We organize our design in Photoshop using artboards as instructed in
- \l{Organizing Assets}.
+ \l{Organizing assets}.
\QB automatically proposes identifiers for all groups and layers. The IDs
will be used as filenames in \QDS. We want to change some of them in the
@@ -47,7 +47,7 @@
properties for the components to export, so that we won't have to do that in
\QDS.
- \section2 Creating a Reference Image
+ \section2 Creating a reference image
\image webinardemo-qb-layoutref.png "Settings for exporting stackLayout artboard"
@@ -58,7 +58,7 @@
select \uicontrol Merged in the \uicontrol {Export As} field to merge
them all into one image when this artboard is exported.
- \section2 Creating the UI Main Page
+ \section2 Creating the UI main page
We want to use the \e backgroundGradient artboard as the main page of
the UI. Initially, it will contain a gradient image that we
@@ -68,7 +68,7 @@
\uicontrol {Export As} field to export it as a PNG file that is referred
to from the main page.
- \section2 Using Stack Layout
+ \section2 Using stack layout
\image webinardemo-qb-stacklayout.png "Settings for exporting stackLayout artboard"
@@ -109,7 +109,7 @@
\image webinardemo-blureffect.png "FastBlurItem component in Design mode"
- \section2 Creating a Menu with Reusable Buttons
+ \section2 Creating a menu with reusable buttons
The \e miniMenu artboard contains menu buttons that we will use to toggle
popup dialogs in the UI. We want to be able to reuse the buttons
@@ -123,27 +123,27 @@
separate, so that we can switch the icons depending on the state of the
button. We will implement this functionality in \QDS.
- \section2 Preparing for Animation
+ \section2 Preparing for animation
We want to animate the contents of the \e largePopup artboard in \QDS, so
we export each group and layer as a child.
- \section2 Exporting Our Design
+ \section2 Exporting our design
When we have specified settings for all the artboards and the groups and
layers in them, we select \uicontrol Export to copy the assets and metadata
to the export path we specified.
- \section1 Importing Our Design
+ \section1 Importing our design
After using \QB in Adobe Photoshop to export our design, we import it into
- a project that we create in \QDS, as instructed in \l{Importing Designs}.
+ a project that we create in \QDS, as instructed in \l{Importing designs}.
If we need to make changes in Photoshop later and export our design again,
\QDS will try to merge our changes during the import, so that none of the
changes we mage in \QDS are lost.
- \section1 Using Imported Components
+ \section1 Using imported components
The \e {LayoutReference.ui.qml} file contains a reference image of
the UI we will create. We use the imported components to create the
@@ -162,7 +162,7 @@
We can now use states and the timeline to animate the components in the UI.
- \section2 Animating Components
+ \section2 Animating components
We open the \e {Largepopup.ui.qml} file in the \uicontrol Design mode to add
animation to it. In the \l States view, we add the \e opening, \e open,
@@ -178,5 +178,5 @@
\image webinardemo-timeline.png "Popup animations in the Timeline view"
For more information about using the timeline, see
- \l {Creating Timeline Animations}.
+ \l {Creating timeline animations}.
*/
diff --git a/doc/qtdesignstudio/images/effect-composer-opacity-mask-scaled.webp b/doc/qtdesignstudio/images/effect-composer-opacity-mask-scaled.webp
new file mode 100644
index 00000000000..fa5a27207b5
Binary files /dev/null and b/doc/qtdesignstudio/images/effect-composer-opacity-mask-scaled.webp differ
diff --git a/doc/qtdesignstudio/images/effect-composer-opacity-mask-unscaled.webp b/doc/qtdesignstudio/images/effect-composer-opacity-mask-unscaled.webp
new file mode 100644
index 00000000000..10aa5c8bb85
Binary files /dev/null and b/doc/qtdesignstudio/images/effect-composer-opacity-mask-unscaled.webp differ
diff --git a/doc/qtdesignstudio/images/icons/clear-view.png b/doc/qtdesignstudio/images/icons/clear-view.png
new file mode 100644
index 00000000000..1b3fa24c270
Binary files /dev/null and b/doc/qtdesignstudio/images/icons/clear-view.png differ
diff --git a/doc/qtdesignstudio/images/icons/error.png b/doc/qtdesignstudio/images/icons/error.png
new file mode 100644
index 00000000000..f79fbd2a72a
Binary files /dev/null and b/doc/qtdesignstudio/images/icons/error.png differ
diff --git a/doc/qtdesignstudio/images/icons/output.png b/doc/qtdesignstudio/images/icons/output.png
new file mode 100644
index 00000000000..3f53f872e65
Binary files /dev/null and b/doc/qtdesignstudio/images/icons/output.png differ
diff --git a/doc/qtdesignstudio/images/icons/warning.png b/doc/qtdesignstudio/images/icons/warning.png
new file mode 100644
index 00000000000..ce4fc9c62c6
Binary files /dev/null and b/doc/qtdesignstudio/images/icons/warning.png differ
diff --git a/doc/qtdesignstudio/images/studio-issue-message.webp b/doc/qtdesignstudio/images/studio-issue-message.webp
new file mode 100644
index 00000000000..a5ad246d172
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-issue-message.webp differ
diff --git a/doc/qtdesignstudio/images/studio-mcu-components-and-properties.webp b/doc/qtdesignstudio/images/studio-mcu-components-and-properties.webp
index 1bd070f8213..e5067a7f5df 100644
Binary files a/doc/qtdesignstudio/images/studio-mcu-components-and-properties.webp and b/doc/qtdesignstudio/images/studio-mcu-components-and-properties.webp differ
diff --git a/doc/qtdesignstudio/images/studio-output-view-message.webp b/doc/qtdesignstudio/images/studio-output-view-message.webp
new file mode 100644
index 00000000000..25d2ac04b4c
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-output-view-message.webp differ
diff --git a/doc/qtdesignstudio/images/studio-output-view.webp b/doc/qtdesignstudio/images/studio-output-view.webp
new file mode 100644
index 00000000000..910d664f990
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-output-view.webp differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.png b/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.png
deleted file mode 100644
index 9f3fd2f272b..00000000000
Binary files a/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.png and /dev/null differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.webp b/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.webp
new file mode 100644
index 00000000000..39b4c324710
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-qtquick-3d-custom-effect-navigator.webp differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.png b/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.png
deleted file mode 100644
index 5dee9ca2ae9..00000000000
Binary files a/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.png and /dev/null differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.webp b/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.webp
new file mode 100644
index 00000000000..acba3cb61ae
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-qtquick-3d-shader-properties.webp differ
diff --git a/doc/qtdesignstudio/images/studio-qtquick-3d-shader-utilities-qt5.webp b/doc/qtdesignstudio/images/studio-qtquick-3d-shader-utilities-qt5.webp
new file mode 100644
index 00000000000..6ed30a05076
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-qtquick-3d-shader-utilities-qt5.webp differ
diff --git a/doc/qtdesignstudio/images/studio-warning-message.webp b/doc/qtdesignstudio/images/studio-warning-message.webp
new file mode 100644
index 00000000000..867f3cd9179
Binary files /dev/null and b/doc/qtdesignstudio/images/studio-warning-message.webp differ
diff --git a/doc/qtdesignstudio/qtdesignstudio-online.qdocconf b/doc/qtdesignstudio/qtdesignstudio-online.qdocconf
index 91d5172b2d5..d978c72e680 100644
--- a/doc/qtdesignstudio/qtdesignstudio-online.qdocconf
+++ b/doc/qtdesignstudio/qtdesignstudio-online.qdocconf
@@ -2,6 +2,7 @@ include(config/license.qdocconf)
include(config/qtdesignstudio.qdocconf)
include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf)
include(config/html-online.qdocconf)
+include(config/qtdesignstudio-icon-macros.qdocconf)
# Override macros for online use
include(../config/macros-online.qdocconf)
diff --git a/doc/qtdesignstudio/qtdesignstudio.qdocconf b/doc/qtdesignstudio/qtdesignstudio.qdocconf
index 2bb8c5e8f98..6c3762a3ffd 100644
--- a/doc/qtdesignstudio/qtdesignstudio.qdocconf
+++ b/doc/qtdesignstudio/qtdesignstudio.qdocconf
@@ -1,3 +1,4 @@
include(config/license.qdocconf)
include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
include(config/qtdesignstudio.qdocconf)
+include(config/qtdesignstudio-icon-macros.qdocconf)
diff --git a/doc/qtdesignstudio/src/best practices/best-practices-glow.qdoc b/doc/qtdesignstudio/src/best practices/best-practices-glow.qdoc
index 22a71ec681d..29847e73004 100644
--- a/doc/qtdesignstudio/src/best practices/best-practices-glow.qdoc
+++ b/doc/qtdesignstudio/src/best practices/best-practices-glow.qdoc
@@ -6,9 +6,9 @@
\page best-practices-glow.html
\nextpage {Examples}
- \title Creating Glow and Bloom Effects
+ \title Creating the glow and the bloom effects
- In \QDS, you can add a glow and bloom effect to your 3D scene using the
+ In \QDS, you can add a glow and a bloom effect to your 3D scene using the
\uicontrol ExtendedSceneEnvironment component (available in Qt 6.5 and later). With this effect,
you can, for example, create glow around illuminated areas (such as material or skyboxes when
using image-based lighting) or add ambient light. Using the glow effect is one way to make your
@@ -16,12 +16,12 @@
\image glow-example.webp
- \section1 Creating a Project with ExtendedSceneEnvironment
+ \section1 Creating a project with ExtendedSceneEnvironment
To create a project with \uicontrol ExtendedSceneEnvironment as the default
scene environment, use the \uicontrol {3D Extended} project preset.
- For more information about creating projects, see \l{Creating Projects}.
+ For more information about creating projects, see \l{Creating projects}.
\section1 Adding ExtendedSceneEnvironment to an Existing Project
@@ -31,7 +31,7 @@
\image ext-scene-env-navigator.webp
- \section1 Enabling the Glow Effect
+ \section1 Enabling the Glow effect
To enable the glow effect, select \e SceneEnvironment in the \uicontrol Navigator view and
then, in the \uicontrol Properties view, select \uicontrol Enabled in the
@@ -42,7 +42,7 @@
\note When setting up or experimenting with the glow effect, use the \l {Blend Modes}{Replace}
blend mode to see the effect more clearly.
- \section1 The Flashlight Example Project
+ \section1 The Flashlight Example project
The flashlight example used in this documentation is available from the \uicontrol Examples
section of the \QDS \uicontrol Welcome page.
@@ -54,7 +54,7 @@
\image glow-example-project.webp
- \section1 Basic Properties
+ \section1 Basic properties
Usually, the best way to achieve a realistic glow effect in your 3D scene is to adjust
the \uicontrol {Strength}, \uicontrol {Intensity}, and \uicontrol {Bloom}
@@ -131,7 +131,7 @@
\li \image glow_all_blur_levels.webp
\endtable
- \section2 Blend Modes
+ \section2 Blend modes
The following blend modes are available:
@@ -160,7 +160,7 @@
\li \image glow-replace-blend.webp
\endtable
- \section1 Improvement Properties
+ \section1 Improvement properties
The \uicontrol{High Quality} and \uicontrol{Bicubical Upsampling}
properties improve the quality of the glow blur by upsampling. Using these properties
diff --git a/doc/qtdesignstudio/src/best-practices.qdoc b/doc/qtdesignstudio/src/best-practices.qdoc
index 4abcc80f6af..345a055d3f2 100644
--- a/doc/qtdesignstudio/src/best-practices.qdoc
+++ b/doc/qtdesignstudio/src/best-practices.qdoc
@@ -6,33 +6,32 @@
\page best-practices.html
\nextpage best-practices-glow.html
- \title Best Practices
+ \title Best practices
\section1 Graphics
\list
- \li \l {Creating Glow and Bloom Effects}
+ \li \l {Creating the glow and the bloom effects}
\endlist
\section1 Performance
\list
- \li \l {Optimizing Designs}
- \li \l {QML Performance Considerations And Suggestions}
- \li \l {Creating Optimized 3D Scenes}
- \li \l {Using Components Economically}
+ \li \l {Optimizing designs}
+ \li \l {QML Performance Considerations And Suggestions}{QML performance considerations and suggestions}
+ \li \l {Creating optimized 3D scenes}
+ \li \l {Using components economically}
\endlist
\section1 Projects
\list
- \li \l {Converting Qt 5 Projects into Qt 6 Projects}
- \li \l {Converting UI Projects to Applications}
+ \li \l {Converting \QDS projects to applications}
\endlist
\section1 Workflow
\list
- \li \l {Designer-Developer Workflow}
+ \li \l {Designer-developer workflow}
\endlist
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc b/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc
index a8bddc66ff8..86d575515e7 100644
--- a/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -19,16 +19,16 @@
create instances of them.
You can achieve similar results by using different animation techniques.
- For more information, see \l{Introduction to Animation Techniques}.
+ For more information, see \l{Introduction to animation techniques}.
- \section1 Applying Animation
+ \section1 Applying animations
A property animation is applied when the value of a property changes.
Color and number animations are property animation types for specific
purposes. Specify settings for animations in \l Properties >
\uicontrol {Animation Targets}.
- \section2 Animating Color Changes
+ \section2 Animating color changes
For example, you can apply animation to the value of the \uicontrol Color
property of an instance of a \l Rectangle component to change its value
@@ -49,7 +49,7 @@
color in the \uicontrol {To color} field. Specify the duration of the
animation in the \uicontrol Duration field.
- \section2 Animating Changes in Numerical Values
+ \section2 Animating changes in numerical values
Similarly, to apply animation when a numerical value of a property changes,
create an instance of the \uicontrol {Number Animation} component.
@@ -72,7 +72,7 @@
For an example of using property animation to animate the scale and opacity
of components, see the \l{Coffee Machine} example.
- \section2 Setting Non-Animated Properties
+ \section2 Setting non-animated properties
To immediately change a property value during an animation
without animating the property change, create an instance
@@ -92,7 +92,7 @@
\image qtquick-property-action.gif "Sequential property actions and number animation"
- \section1 Playing Animations
+ \section1 Playing animations
Specify settings for playing animations in the \uicontrol Animation group.
@@ -104,7 +104,7 @@
You can connect the running property of an animation to a signal emitted
by a component to play the animation when users click a button, for
- example. For more information, see \l{Connecting Components to Signals}.
+ example. For more information, see \l{Connecting components to signals}.
To run animations several times in a loop, set the number of times they
should play in the \uicontrol Loops field. Set the value to -1 to have
@@ -120,15 +120,15 @@
\uicontrol {Sequential Animation} component for managing them as a
group.
- To pause animations, select the \inlineimage icons/pause-icon.png
+ To pause animations, select the \imagepauseicon
(\uicontrol Paused) check box.
- To attach an \l{Editing Easing Curves}{easing curve} to
- the animation, select the \inlineimage icons/curve_editor.png
+ To attach an \l{Editing easing curves}{easing curve} to
+ the animation, select the \imagecurveeditor
(\uicontrol {Easing Curve Editor}) button in the
\uicontrol {Easing Curve} field.
- \section2 Playing Groups of Animations
+ \section2 Playing groups of animations
You can create several animations that can run in parallel or in sequence.
To manage a group of animations that will play at the same time, create an
@@ -155,7 +155,7 @@
check box and specify the duration of the pause in the
\uicontrol Duration field.
- \section1 Performance Considerations
+ \section1 Performance considerations
\QDS enables you to use fluidity and dynamic transitions as well as visual
effects to great effect in a UI. However, you need to take some care when
@@ -176,7 +176,7 @@
component because script animations are run in the main thread and can
therefore cause frames to be skipped if they take too long to complete.
- \section1 Summary of Animation Components
+ \section1 Summary of the animation components
The following table lists the components that you can use to animate
component properties programmatically. They are available in
@@ -186,7 +186,7 @@
\table
\header
\li Component
- \li Use Case
+ \li Use case
\row
\li \uicontrol {Property Animation}
\li Applying animation when the value of a property changes. Color
diff --git a/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc b/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc
index 071cf04554b..476d3215a27 100644
--- a/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -12,7 +12,7 @@
\previouspage quick-components-creating.html
\nextpage quick-scalable-image.html
- \title Creating Buttons
+ \title Creating buttons
To create a button component:
@@ -20,7 +20,7 @@
\li Select \uicontrol File > \uicontrol {New File} >
\uicontrol {Qt Quick Files} > \uicontrol {Qt Quick UI File} >
- \uicontrol Choose to create a \l{UI Files}{UI file} called
+ \uicontrol Choose to create a \l{UI files}{UI file} called
Button.ui.qml (for example).
\note Components are listed in \uicontrol Components >
@@ -42,7 +42,7 @@
\li In the \uicontrol Properties view, modify the appearance of the
rectangle:
- \list a
+ \list
\li In the \uicontrol Color field, select the button color.
@@ -50,7 +50,7 @@
the rectangle to produce rounded corners for the button.
\li Select \uicontrol {Layout}, and then select the
- \inlineimage icons/anchor-fill.png
+ \imageanchorfill
(\uicontrol {Fill to Parent}) button to anchor the Rectangle to
the Item.
@@ -61,9 +61,9 @@
\uicontrol Navigator.
\li In the \uicontrol Properties view, edit the properties of the
- \uicontrol Text component
+ \uicontrol Text component:
- \list a
+ \list
\li In the \uicontrol Text field, enter \e Button.
@@ -79,7 +79,7 @@
\endlist
- \li Press \key {Ctrl+S} to save the button.
+ \li Select \key {Ctrl+S} to save the button.
\image qmldesigner-button.png "Button component"
@@ -95,7 +95,7 @@
To create a graphical button that scales beautifully without using
vector graphics, use the \l {Border Image} component. For more
- information, see \l{Creating Scalable Buttons and Borders}.
+ information, see \l{Creating scalable buttons and borders}.
*/
/*!
@@ -103,13 +103,13 @@
\page quick-scalable-image.html
\nextpage qtquick-properties.html
- \title Creating Scalable Buttons and Borders
+ \title Creating scalable buttons and borders
You can use the \l {Border Image} component to display an image, such as a
PNG file, as a border and a background.
Use two border images and suitable graphics to change the appearance of
- a button when it is clicked. You can use use \l{Working with States}{states}
+ a button when it is clicked. You can use use \l{Working with states}{states}
to determine which image is visible depending on whether the mouse
button is pressed down. You could add more images and states to
change the appearance of the button depending on other mouse events,
@@ -124,26 +124,26 @@
\image qmldesigner-borderimage-type.png "Button component in the 2D and States views"
- \section1 Creating the Button Component
+ \section1 Creating the Button component
To create a button component, select \uicontrol File >
\uicontrol {New File} >
\uicontrol {Qt Quick Files} > \uicontrol {Qt Quick UI File} >
- \uicontrol Choose to create a \l{UI Files}{UI file} called Button.ui.qml
+ \uicontrol Choose to create a \l{UI files}{UI file} called Button.ui.qml
(for example).
\note Components are listed in \uicontrol Components >
\uicontrol {My Components} only if the filename begins with a
capital letter.
- \section1 Constructing the Button Component
+ \section1 Constructing the Button component
To construct the button component:
\list 1
\li Click \uicontrol {Design} to edit the UI file in the \l {2D} view.
- \li Select \uicontrol Assets > \inlineimage icons/plus.png
+ \li Select \uicontrol Assets > \imageplus
to copy the image files you want to use to the project folder.
\li In \l Navigator, select the root component and set the
width (\uicontrol W) and height (\uicontrol H) of the button in the
@@ -156,13 +156,13 @@
\li Drag-and-drop a \uicontrol Text component to the root component.
\li Drag-and-drop a \uicontrol {Mouse Area} to the root component.
\li Select a border image to edit the values of its properties:
- \list a
+ \list 1
\li In the \uicontrol Id field, enter an ID for the border
image. In this example, we use the ID \e inactiveButton.
\li In the \uicontrol Source field, select the image file for
the border image. For example, inactive_button.png.
\li In the \uicontrol {Layout} tab, select the
- \inlineimage icons/anchor-fill.png
+ \imageanchorfill
(\uicontrol {Fill to Parent}) button to always make the
image the same size as its parent. This makes the button
component scalable because the image size is bound to the
@@ -170,27 +170,27 @@
\endlist
\li Select the other border image to edit the values of its properties
similarly:
- \list a
+ \list 1
\li In the \uicontrol Id field, enter \e activeButton.
\li In the \uicontrol Source field, select the image file
for the button when it is clicked. For example,
active_button.png.
\li In the \uicontrol {Layout} tab, select the
- \inlineimage icons/anchor-fill.png
+ \imageanchorfill
(\uicontrol {Fill to Parent}) button.
\endlist
\li Select the text component to specify font size and color in
\uicontrol Properties:
- \list a
+ \list 1
\li In the \uicontrol Color field, use the \l{Picking Colors}
{color picker} to select the font color, or enter a value
in the field.
\li In \uicontrol Font group, \uicontrol Size field, enter the
font size.
\li In the \uicontrol {Layout} tab, select
- \inlineimage icons/anchor-center-vertical.png
+ \imageanchorcentervertical
(\uicontrol {Vertical Center}) and
- \inlineimage icons/anchor-center-horizontal.png
+ \imageanchorcenterhorizontal
(\uicontrol {Horizontal Center}) buttons to inherit the
vertical and horizontal centering from the parent.
This ensures that the button label is centered when the
@@ -198,15 +198,15 @@
\endlist
\endlist
- \section1 Using States to Change Component Property Values
+ \section1 Using States to change component property values
\list 1
- \li In the \l States view, select \inlineimage icons/plus.png
+ \li In the \l States view, select \imageplus
twice to create two new states.
\image qmldesigner-borderimage-states.png "Active and inactive states"
\li Select \uicontrol State1.
\li Change the state name to \e active.
- \li Select \inlineimage icons/action-icon.png
+ \li Select \imageactionicon
, and then select \uicontrol {Set when Condition} to determine
when the state should be applied.
\li In the \uicontrol {Binding Editor}, select the \c mouseArea
@@ -226,7 +226,7 @@
specify that the state is applied when the mouse button is not
pressed down.
\image qmldesigner-borderimage-bindings1.png "Inactive state when condition"
- \li Press \key {Ctrl+S} to save the button.
+ \li Select \key {Ctrl+S} to save the button.
\li Select the
\uicontrol {Live Preview} button on the top toolbar to see how the
button behaves when you select it. Drag the preview
@@ -244,7 +244,7 @@
and set the button text for each button instance, for example.
For more information about positioning buttons on screens, see
- \l{Scalable Layouts}.
+ \l{Scalable layouts}.
\image qmldesigner-borderimage.png "Button preview as part of a screen"
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc
index 7fb95a9880e..849e2da34cd 100644
--- a/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc
+++ b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc
@@ -3,64 +3,64 @@
/*!
//! [context-menu]
- \section1 Context Menu
+ \section1 Context menu
The following table summarizes the \uicontrol Navigator and
- \uicontrol {2D} views context menu items and provides links
+ \uicontrol {2D} view context menu items and provides links
to more information about them.
\table
\header
- \li To Learn About
- \li Go To
+ \li To learn about
+ \li Go to
\row
\li Arrange
- \li \l{Arranging Components}
+ \li \l{Arranging components}
\row
\li Edit
- \li \l{Showing and Hiding Components}
+ \li \l{Showing and hiding components}
\row
\li Anchors
- \li \l{Setting Anchors and Margins}
+ \li \l{Setting anchors and margins}
\row
\li Group
- \li \l{Organizing Components}
+ \li \l{Organizing components}
\row
\li Positioner
- \li \l{Using Positioners}
+ \li \l{Using positioners}
\row
\li Layout
- \li \l{Using Layouts}
+ \li \l{Using layouts}
\row
\li Stacked Container
- \li \l{Lists and Other Data Models}
+ \li \l{Lists and other data models}
\row
\li Timeline
\li \l{Creating a Timeline}
\row
\li Event List
- \li \l{Simulating Events}
+ \li \l{Simulating events}
\row
\li Edit Color
- \li \l{Editing Properties Inline}
+ \li \l{Editing properties inline}
\row
\li Edit Annotation
- \li \l{Annotating Designs}
+ \li \l{Annotating designs}
\row
\li Merge File with Template
- \li \l{Merging Files with Templates}
+ \li \l{Merging files with templates}
\row
\li Move Component Instances into Separate Files
- \li \l{Turning Component Instances into Custom Components}
+ \li \l{Turning component instances into custom components}
\row
- \li Connecting Components to Signals
- \li \l{Connecting Components to Signals in the Connection View}
+ \li Connecting components to signals
+ \li \l{Connecting components to signals in the Connection view}
\row
\li Go to Implementation
- \li \l{Using UI Files}
+ \li \l{Using UI files}
\row
\li Edit Component
- \li \l{Moving Within Components}
+ \li \l{Moving within components}
\endtable
//! [context-menu]
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc b/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc
index 3fa33460569..f3b0a19f072 100644
--- a/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,12 +6,12 @@
\previouspage studio-3d-loader-3d.html
\nextpage quick-components-creating.html
- \title Creating Component Instances
+ \title Creating component instances
\QDS comes with \e {preset components} that you can use in your UI by
creating instances of them.
- \image qmldesigner-editing-components.webp "Creating Component Instances"
+ \image qmldesigner-editing-components.webp "Creating component instances"
To create component instances and edit their properties:
@@ -29,23 +29,23 @@
custom properties on the \uicontrol {Properties} tab in the
\l {Connections} view.
\image add-updated-local-custom-property.webp "Connections View Properties tab"
- For more information, see \l{Specifying Custom Properties}.
+ For more information, see \l{Specifying custom properties}.
\li To enable users to interact with the component instances, connect
the instances to signals on the \uicontrol Connections tab in the
\uicontrol {Connections} view. For example, you can specify what
happens when a component instance is clicked. For more information,
- see \l{Connecting Components to Signals}.
+ see \l{Connecting components to signals}.
\image qmldesigner-connections.webp "Connections View Connections tab"
\li To dynamically change the behavior of a component instance when
another component instance changes, create bindings between them on
the \uicontrol Bindings tab in the \uicontrol {Connections} view.
- For more information, see \l{Adding Bindings Between Properties}.
+ For more information, see \l{Adding bindings between properties}.
\image qmldesigner-bindings.webp "Connections view Bindings tab"
\li Add states to apply sets of changes to the property values of one
or several component instances in the \uicontrol States view.
- For more information, see \l{Working with States}.
+ For more information, see \l{Working with states}.
\li Animate the properties of component instances in the
\uicontrol Timeline view. For more information, see
- \l{Creating Timeline Animations}.
+ \l{Creating timeline animations}.
\endlist
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc b/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc
index 74c9eb142ce..5fe197502b1 100644
--- a/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage quick-component-instances.html
\nextpage quick-buttons.html
- \title Creating Custom Components
+ \title Creating custom components
You can either use project wizard templates to create custom components and
controls or move component instances into separate files to turn them into
@@ -20,7 +20,7 @@
by dragging-and-dropping them from \uicontrol Components to the \l {2D},
\l {3D}, or \l Navigator view.
- \section1 Creating Components from Scratch
+ \section1 Creating components from scratch
To use wizard templates to create custom components:
@@ -37,7 +37,7 @@
\uicontrol Navigator or the \uicontrol {2D} view.
\li Edit component properties in the \uicontrol Properties view.
The available properties depend on the component type. You can
- \l{Specifying Custom Properties}{add properties for
+ \l{Specifying custom properties}{add properties for
components} on the \uicontrol {Properties} tab in the
\uicontrol Connections view.
\li To change the appearance and behavior of the component instances
@@ -53,13 +53,13 @@
using instances of basic components:
\list
- \li The \l{2D} View
- \li The \l{3D} View
- \li \l{Creating Buttons}
- \li \l{Creating Scalable Buttons and Borders}
+ \li The \l{2D} view
+ \li The \l{3D} view
+ \li \l{Creating buttons}
+ \li \l{Creating scalable buttons and borders}
\endlist
- \section1 Naming Conventions
+ \section1 Naming conventions
Establish naming conventions to keep the components in your UI organized.
Name your components accurately and give them suitable IDs. Particularly,
@@ -78,7 +78,7 @@
\include qtdesignstudio-components.qdocinc creating studio components
- \section1 Turning Component Instances into Custom Components
+ \section1 Turning component instances into custom components
An alternative way of creating reusable components is to turn
component instances into custom components by moving them into
@@ -98,7 +98,7 @@
To open the new component file for editing the properties that you want
to change for all instances of the component, right-click the component,
and then select \uicontrol {Go into Component} in the context menu. For
- additional ways of opening base components, see \l{Moving Within Components}.
+ additional ways of opening base components, see \l{Moving within components}.
For an example of creating a reusable custom component, see
\l{Progress Bar}.
@@ -107,7 +107,7 @@
> \uicontrol {My Components}, and you can use instances of them to build
more components.
- \section1 Merging Files with Templates
+ \section1 Merging files with templates
You can merge the current component file against an existing second
component file using the second file in a way similar to using a CSS
diff --git a/doc/qtdesignstudio/src/components/qtquick-components.qdoc b/doc/qtdesignstudio/src/components/qtquick-components.qdoc
index a0ab80b2570..7e1c0e7ef64 100644
--- a/doc/qtdesignstudio/src/components/qtquick-components.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-components.qdoc
@@ -6,7 +6,7 @@
\previouspage quick-uis.html
\nextpage quick-preset-components.html
- \title Using Components
+ \title Using components
A \e component is a reusable building block for a UI.
@@ -18,7 +18,7 @@
Some of the preset components represent simple shapes, text, or images,
while others represent complex UI controls with full functionality, such
as spin boxes or sliders. You can also add instances of preset
- \l {3D Components}{3D components} to your UIs.
+ \l {3D components}{3D components} to your UIs.
To build your own components, you can modify the \e properties of the
component instances and combine them.
@@ -27,8 +27,8 @@
\e ui.qml or \e .qml). For example, a Button component may be defined
in \e Button.ui.qml. Typically, the visual appearance of a component
is defined in a \e {UI file} (ui.qml). To create component files,
- you can use \l{Creating Components from Scratch}{wizard templates}, or
- \l{Turning Component Instances into Custom Components}
+ you can use \l{Creating components from scratch}{wizard templates}, or
+ \l{Turning component instances into custom components}
{move component instances into separate component files}.
Select \uicontrol Components to view the preset components that
@@ -41,12 +41,12 @@
Read more about components:
\list
- \li \l {Preset Components}
- \li \l {Creating Component Instances}
- \li \l {Creating Custom Components}
+ \li \l {Preset components}
+ \li \l {Creating component instances}
+ \li \l {Creating custom components}
\endlist
- \section1 Using Components Economically
+ \section1 Using components economically
It is important to understand the performance costs associated with using
components.
@@ -58,8 +58,8 @@
components that can be conveniently recombined to suit the needs of
your UI.
\li Use as few components as necessary. To minimize the number of
- components, use \l{Adding Property Aliases}{alias properties} and
- \l{Working with States}{states} to create the differences in your
+ components, use \l{Adding property aliases}{alias properties} and
+ \l{Working with states}{states} to create the differences in your
component instances. We recommend reusing components
instead of duplicating them, so the components do not need to be
processed as completely new component types. This reduces loading
@@ -69,8 +69,8 @@
a speedometer should have an \c int or \c real property for speed
to which the UI is bound.
\li Separate UI from the application logic. Designers should work with
- the \l{UI Files}{UI files} (.ui.qml), while developers should work
- on the corresponding implementation files (.qml) to define their
+ the \l{UI files} (.ui.qml), while developers should work on the
+ corresponding implementation files (.qml) to define their
programmatic behaviors or JavaScript. This enables iteration from
both the design and development side of the process without the
risk of overwriting each other's work.
diff --git a/doc/qtdesignstudio/src/components/qtquick-controls.qdoc b/doc/qtdesignstudio/src/components/qtquick-controls.qdoc
index 15b2189d2ac..85b8b98378e 100644
--- a/doc/qtdesignstudio/src/components/qtquick-controls.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-controls.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage quick-user-interaction-methods.html
\nextpage quick-data-models.html
- \title UI Controls
+ \title UI controls
You can create instances of preset UI controls to inform users about
the progress of the application or to gather input from users. They are
@@ -23,7 +23,7 @@
\li \l {Selectors}
\li \l {Tab Bar}
\li \l {Tool Bar}
- \li \l {Summary of UI Controls}
+ \li \l {Summary of the UI controls}
\endlist
You can specify values for the properties of component instances in the
@@ -32,7 +32,7 @@
are only available for a particular control. The following sections
describe the preset UI controls and their properties.
- \section1 General Control Properties
+ \section1 General control properties
You can set control properties in the \l Properties view.
@@ -57,7 +57,7 @@
\l {Check Box}. Spacing is not enforced by the controls, so each style may
interpret it differently, and some may ignore it altogether.
- \section1 Button Controls
+ \section1 Button controls
Qt Quick Controls offer a selection of button-like controls for specific
use cases. The following sections contain guidelines for choosing the button
@@ -109,7 +109,7 @@
Don't use a button to set state because a \l Switch is more suitable for
that purpose.
- \section3 Highlighted Buttons
+ \section3 Highlighted buttons
Select the \uicontrol Highlight check box in the \uicontrol Button section
to draw the users' attention towards a button. Highlighting a button has no
@@ -121,7 +121,7 @@
\image qtquickcontrols2-button-highlighted.gif "Highlighted button"
- \section3 Flat Buttons
+ \section3 Flat buttons
A flat button typically does not draw a background unless it is pressed or
checked. To create a flat button, select the \uicontrol Flat check box in
@@ -131,14 +131,14 @@
\image qtquickcontrols2-button-flat.gif "Flat button"
- \section3 Icon Buttons
+ \section3 Icon buttons
To create a button that contains an icon, use the wizard template to
\l{Creating Custom Controls}{create a custom button} and drag-and-drop
the icon to the button background component. For an example of using the
wizard template, see \l{Creating a Push Button}.
- \section2 Delay Button
+ \section2 Delay button
\image qtquickcontrols2-delaybutton.gif "Delay button"
@@ -238,7 +238,7 @@
\li Ensure that a sensible default option is checked.
\li List radio button options vertically.
\li Keep the list short.
- \li In order to avoid confusion, do not put two groups of radio buttons
+ \li To avoid confusion, do not put two groups of radio buttons
next to each other.
\endlist
@@ -286,7 +286,7 @@
of the width or height of the button, and make the button's width and height
identical.
- \section2 Displaying Text and Icons
+ \section2 Displaying text and icons
A button can contain text, an icon, or both. Specify the button text in
the \uicontrol Text field in the \uicontrol {Button Content} section. The
@@ -296,10 +296,10 @@
\image qtquick-designer-abstract-button-properties.png "Button Content properties"
- \section2 Checking Buttons
+ \section2 Checking buttons
A \e checkable button toggles between checked (on) and unchecked (off) when
- users click on it or press the space bar while the button has active
+ users select it or the space bar while the button has active
focus. Select the \uicontrol Checkable check box to make a button checkable.
To make the button checked, select the \uicontrol Checked check box.
@@ -316,10 +316,10 @@
If the buttons don't belong to the same parent, checking and unchecking
buttons does not affect the other buttons in the group.
- \section2 Button Signals
+ \section2 Button signals
A button emits the \c clicked() signal when it is activated by users.
- \l{Connecting Components to Signals}{Connect to this signal} to perform
+ \l{Connecting components to signals}{Connect to this signal} to perform
the button's action. Buttons provide the following additional signals:
\c canceled(), \c doubleClicked(), \c pressed(), \c released(), and
\c pressAndHold() for long presses.
@@ -360,9 +360,9 @@
Typical places for a busy indicator are:
\list
- \li In the corner of a \uicontrol {Tool Bar}
- \li As an overlay on top of a \uicontrol Page
- \li On the side of an \uicontrol {Item Delegate}
+ \li In the corner of a \uicontrol {Tool Bar}.
+ \li As an overlay on top of a \uicontrol {Page}.
+ \li On the side of an \uicontrol {Item Delegate}.
\endlist
\section2 Page Indicator
@@ -410,10 +410,10 @@
Typical places for an indeterminate progress bar are:
\list
- \li At the bottom of a \uicontrol {Tool Bar}
- \li Inline within the content of a \uicontrol Page
+ \li At the bottom of a \uicontrol {Tool Bar}.
+ \li Inline within the content of a \uicontrol {Page}.
\li In an \uicontrol {Item Delegate} to show the progress
- of a particular item
+ of a particular item.
\endlist
\section1 Selectors
@@ -525,7 +525,7 @@
A combo box is used to select a value from a static multiple-line drop-down
list. Users cannot add new values, and only one option can be selected.
- Combo box values are provided by a \l{Lists and Other Data Models}
+ Combo box values are provided by a \l{Lists and other data models}
{data model}. The data model is usually a JavaScript array, a \l ListModel,
or an integer, but other types of data models are also supported.
@@ -621,7 +621,7 @@
position its contents, for instance by creating a \l RowLayout. If the
toolbar contains only one item, it will resize to fit the implicit item
size. This makes a toolbar particularly suitable for use together with
- \l{Using Layouts}{layouts}. However, you can specify content width
+ \l{Using layouts}{layouts}. However, you can specify content width
(\uicontrol W) and height (\uicontrol H) in the \uicontrol {Content size}
field in the \uicontrol Pane section.
@@ -630,7 +630,7 @@
be used in horizontal or vertical toolbars by setting the value of
the \uicontrol Orientation field.
- \section1 Styling Controls
+ \section1 Styling controls
The preset UI controls can be \l {Styling Qt Quick Controls}{styled}.
The \uicontrol {2D} view reads the preferred style from a
@@ -647,148 +647,148 @@
For more information about how to customize a particular control, see
\l{Customization Reference}.
- \section1 Summary of UI Controls
+ \section1 Summary of the UI controls
The following table lists preset UI controls with links to their developer
documentation. They are available in \uicontrol Components >
- \uicontrol {Qt Quick Controls}. The \e MCU column indicates which controls
+ \uicontrol {Qt Quick Controls}. The \e {MCU support} column indicates which controls
are supported on MCUs.
\table
\header
\li Icon
\li Name
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage icons/busyindicator-icon16.png
+ \li \imagebusyindicatoricon16
\li \l [QtQuickControls]{BusyIndicator}{Busy Indicator}
- \li
+ \li No
\li Indicates activity while content is being loaded.
\row
- \li \inlineimage icons/button-icon16.png
+ \li \imagebuttonicon16
\li \l [QtQuickControls]{Button}
- \li \inlineimage ok.png
+ \li Yes
\li A push button that you can associate with an action.
\row
- \li \inlineimage icons/checkbox-icon16.png
+ \li \imagecheckboxicon16
\li \l [QtQuickControls]{CheckBox}{Check Box}
- \li \inlineimage ok.png
+ \li Yes
\li An option button that can be toggled on (checked) or off
(unchecked).
\row
- \li \inlineimage icons/checkbox-icon16.png
+ \li \imagecheckboxicon16
\li \l [QtQuickControls]{CheckDelegate}{Check Delegate}
- \li
+ \li No
\li An item delegate that can be toggled on (checked) or off
(unchecked).
\row
- \li \inlineimage icons/combobox-icon16.png
+ \li \imagecomboboxicon16
\li \l [QtQuickControls]{ComboBox}{Combo Box}
- \li
+ \li No
\li A combined button and popup list that is populated by using a data
model.
\row
- \li \inlineimage icons/delaybutton-icon16.png
+ \li \imagedelaybuttonicon16
\li \l [QtQuickControls]{DelayButton}{Delay Button}
- \li
+ \li No
\li An option button that is triggered when held down long enough.
\row
- \li \inlineimage icons/dial-icon16.png
+ \li \imagedialicon16
\li \l [QtQuickControls]{Dial}
- \li \inlineimage ok.png
+ \li Yes
\li A circular dial that is rotated to set a value.
\row
- \li \inlineimage icons/pageindicator-icon16.png
+ \li \imagepageindicatoricon16
\li \l [QtQuickControls]{PageIndicator}{Page Indicator}
- \li
+ \li No
\li Indicates the indicate the currently active page in a container of
multiple pages.
\row
- \li \inlineimage icons/progressbar-icon16.png
+ \li \imageprogressbaricon16
\li \l [QtQuickControls]{ProgressBar}{Progress Bar}
- \li \inlineimage ok.png
+ \li Yes
\li Indicates the progress of an operation.
\row
- \li \inlineimage icons/radiobutton-icon16.png
+ \li \imageradiobuttonicon16
\li \l [QtQuickControls]{RadioButton}{Radio Button}
- \li \inlineimage ok.png
+ \li Yes
\li An option button that can be switched on (checked) or off
(unchecked).
\row
- \li \inlineimage icons/radiobutton-icon16.png
+ \li \imageradiobuttonicon16
\li \l [QtQuickControls]{RadioDelegate}{Radio Delegate}
- \li
+ \li No
\li An item delegate that can be toggled on (checked) or off
(unchecked).
\row
- \li \inlineimage icons/rangeslider-icon16.png
+ \li \imagerangeslidericon16
\li \l [QtQuickControls]{RangeSlider}{Range Slider}
- \li
+ \li No
\li Enables users to select a range of values by sliding two handles
along a track.
\row
- \li \inlineimage icons/roundbutton-icon16.png
+ \li \imageroundbuttonicon16
\li \l [QtQuickControls]{RoundButton}{Round Button}
- \li
+ \li No
\li A push button with rounded corners that you can associate with an
action.
\row
- \li \inlineimage icons/slider-icon16.png
+ \li \imageslidericon16
\li \l [QtQuickControls]{Slider}
- \li \inlineimage ok.png
+ \li Yes
\li Enables users to select a value by sliding a handle along a track.
\row
- \li \inlineimage icons/spinbox-icon16.png
+ \li \imagespinboxicon16
\li \l [QtQuickControls]{SpinBox}{Spin Box}
- \li
+ \li No
\li Enables users to specify a value by clicking the up or down buttons,
by pressing up or down on the keyboard, or by entering a value in
the box.
\row
- \li \inlineimage icons/switch-icon16.png
+ \li \imageswitchicon16
\li \l [QtQuickControls]{Switch}
- \li \inlineimage ok.png
+ \li Yes
\li An option button that can be toggled on or off.
\row
- \li \inlineimage icons/switch-icon16.png
+ \li \imageswitchicon16
\li \l [QtQuickControls]{SwitchDelegate}{Switch Delegate}
- \li
+ \li No
\li An item delegate with a switch indicator that can be toggled on or
off.
\row
- \li \inlineimage icons/toolbar-icon16.png
+ \li \imagetoolbaricon16
\li \l [QtQuickControls] {TabBar}{Tab Bar}
- \li
+ \li No
\li Enables users to switch between different views or subtasks.
\row
- \li \inlineimage icons/toolbutton-icon16.png
+ \li \imagetoolbuttonicon16
\li \l [QtQuickControls]{TabButton}{Tab Button}
\li
\li A button that is functionally similar to \uicontrol Button, but
provides a look that is more suitable for a \uicontrol {Tab Bar}.
\row
- \li \inlineimage icons/toolbar-icon16.png
+ \li \imagetoolbaricon16
\li \l [QtQuickControls]{ToolBar}{Tool Bar}
- \li
+ \li No
\li A container of application-wide and context sensitive actions and
controls, such as navigation buttons and search fields.
\row
- \li \inlineimage icons/toolbutton-icon16.png
+ \li \imagetoolbuttonicon16
\li \l [QtQuickControls]{ToolButton}{Tool Button}
- \li
+ \li No
\li A button that is functionally similar to \uicontrol Button, but
provides a look that is more suitable for a \uicontrol {Tool Bar}.
\row
- \li \inlineimage icons/toolseparator-icon16.png
+ \li \imagetoolseparatoricon16
\li \l [QtQuickControls]{ToolSeparator}{Tool Separator}
- \li
+ \li No
\li Separates a group of items from adjacent items on a
\uicontrol {Tool Bar}.
\row
- \li \inlineimage icons/tumbler-icon16.png
+ \li \imagetumblericon16
\li \l [QtQuickControls]{Tumbler}
- \li
+ \li No
\li A spinnable wheel of items that can be selected.
\endtable
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc
index 2aa89a744dd..5beafac3982 100644
--- a/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc
@@ -6,7 +6,7 @@
\previouspage quick-controls.html
\nextpage quick-2d-effects.html
- \title Lists and Other Data Models
+ \title Lists and other data models
Applications typically need to handle and display data that is organized
into list or grid views. Models, views, and delegates are used for
@@ -28,7 +28,7 @@
For more information, see \l{Models and Views in Qt Quick}.
- \section1 List and Grid Views
+ \section1 List Views and Grid Views
Create instances of \uicontrol {List View} and \uicontrol {Grid View}
components to organize other component instances in list or grid format.
@@ -95,7 +95,7 @@
to realize that setting a cache will only postpone issues caused by
slow-loading delegates, it is not a solution to this problem.
- \section1 View Highlight
+ \section1 View highlight
In the \uicontrol {List View Highlight} and \uicontrol {Grid View Highlight}
sections, you can specify properties for highlighting items in views.
@@ -130,7 +130,7 @@
\uicontrol {Resize duration}, and \uicontrol {Resize velocity} fields
control the speed of the move and resize animations for the highlight.
- \section1 Editing List Models
+ \section1 Editing list models
When you add a \l{GridView}{Grid View}, \l{ListView}{List View}, or
\l{PathView}{Path View}, the ListModel and the delegate component that
@@ -165,11 +165,11 @@
\include qtquick-pathview-editor.qdocinc pathview
\include qtquick-pathview-editor.qdocinc svgpath
- \section1 Summary of Model Components
+ \section1 Summary of the model components
The following table lists the components that you can use to add data models
to UIs. The \e Location column indicates the location of the component in
- \uicontrol Components. The \e MCU column indicates which
+ \uicontrol Components. The \e {MCU support} column indicates which
components are supported on MCUs.
\table
@@ -177,65 +177,65 @@
\li Icon
\li Name
\li Location
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage gridview-icon16.png
+ \li \imagegridviewicon16
\li \l{GridView}{Grid View}
\li Default Components - Views
- \li
+ \li No
\li A grid vizualization of a model.
\row
- \li \inlineimage icons/itemdelegate-icon16.png
+ \li \imageitemdelegateicon16
\li \l{ItemDelegate}{Item Delegate}
\li Qt Quick Controls
- \li
+ \li No
\li A standard view item that can be used as a delegate in various
views and controls, such as \l ListView and \l ComboBox.
\row
- \li \inlineimage listview-icon16.png
+ \li \imagelistviewicon16
\li \l{ListView}{List View}
\li Default Components - Views
- \li \inlineimage ok.png
+ \li Yes
\li A list vizualization of a model.
\row
- \li \inlineimage pathview-icon16.png
+ \li \imagepathviewicon16
\li \l{Path View}
\li Default Components - Views
- \li
+ \li No
\li Vizualizes the contents of a model along a path.
\row
- \li \inlineimage icons/scrollview-icon16.png
+ \li \imagescrollviewicon16
\li \l [QtQuickControls] {ScrollView}{Scroll View}
\li Qt Quick Controls
- \li
+ \li No
\li Provides scrolling for user-defined content. It can be used instead
of a \l Flickable component.
\row
- \li \inlineimage icons/stackview-icon16.png
+ \li \imagestackviewicon16
\li \l [QtQuickControls] {StackView}{Stack View}
\li Qt Quick Controls
- \li
+ \li No
\li A stack-based navigation model.
\row
- \li \inlineimage icons/item-svg-16px.png
+ \li \imageitemsvg16px
\li \l{SVG Path Item}
\li Qt Quick Studio Components
- \li
+ \li No
\li An SVG path data string that is used to draw a path as a line.
\row
- \li \inlineimage icons/itemdelegate-icon16.png
+ \li \imageitemdelegateicon16
\li \l{SwipeDelegate}{Swipe Delegate}
\li Qt Quick Controls
- \li
+ \li No
\li A view item that can be swiped left or right to expose more
options or information. It is used as a delegate in views such
as \l ListView.
\row
- \li \inlineimage icons/swipeview-icon16.png
+ \li \imageswipeviewicon16
\li \l[QtQuickControls] {SwipeView}{Swipe View}
\li Qt Quick Controls
- \li \inlineimage ok.png
+ \li Yes
\li Enables users to navigate pages by swiping sideways.
\endtable
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-images.qdoc b/doc/qtdesignstudio/src/components/qtquick-images.qdoc
index cbece71a4b5..989015bd17f 100644
--- a/doc/qtdesignstudio/src/components/qtquick-images.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-images.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -9,13 +9,13 @@
\title Images
\target basic-image
- The Image component is used for adding images to the UI in several supported
+ The \uicontrol Image component is used for adding images to the UI in several supported
formats, including bitmap formats, such as PNG and JPEG, and vector graphics
formats, such as SVG. To use any image files in your designs, you need to
first add them to \l Assets:
\list 1
\li Select \uicontrol Assets
- > \inlineimage icons/plus.png
+ > \imageplus
.
\li Select the image file, and then select \uicontrol Open.
\li Select the location where the image will be saved in the
@@ -39,7 +39,7 @@
You can use the \l {Border Image} component to display an image,
such as a PNG file, as a border and a background. For more
information about using border images to create buttons, see
- \l {Creating Scalable Buttons and Borders}.
+ \l {Creating scalable buttons and borders}.
If you need to display animated images, such as GIFs, use the
\l {Animated Image} component.
@@ -47,7 +47,7 @@
\note Currently, the supported image formats include JPEG, JPG, PNG, SVG,
HDR, KTX, BMP, TTF, TIFF, WEBP, and GIF.
- \section1 Image Size
+ \section1 Image size
\image qtquick-designer-image-properties.png "Image properties"
@@ -77,7 +77,7 @@
Select the \uicontrol {Auto transform} check box if the image should
automatically apply image transformation metadata, such as EXIF orientation.
- \section1 Source Size
+ \section1 Source size
The \uicontrol {Source size} property specifies the scaled width and height
of the full-frame image. Unlike the value of the \uicontrol Size property,
@@ -110,7 +110,7 @@
reloaded, potentially even from the network, if it is not in the disk cache.
Select the \uicontrol Cache check box to cache the image.
- \section1 Image Alignment
+ \section1 Image alignment
You can align images horizontally and vertically in the
\uicontrol {Alignment H} and \uicontrol {Alignment V}
@@ -138,8 +138,9 @@
\section1 Border Image
- The Border Image component extends the features of the Image component.
- It is used to create borders out of images by scaling or tiling parts
+ The \uicontrol{Border Image} component extends the features of the
+ \uicontrol Image component. It is used to create borders out of images by
+ scaling or tiling parts
of each image. A source image is broken into 9 regions that are scaled or
tiled individually. The corner regions are not scaled at all, while the
horizontal and vertical regions are scaled according to the values of the
@@ -164,7 +165,7 @@
\section1 Animated Image
- The Animated Image component extends the features of the Image component,
+ The \uicontrol {Animated Image} component extends the features of the Image component,
providing a way to play animations stored as images containing a series of
frames, such as those stored in GIF files.
@@ -176,7 +177,7 @@
To play the animation, select the \uicontrol Playing check box.
- To pause the animation, select the \inlineimage icons/pause-icon.png
+ To pause the animation, select the \imagepauseicon
(\uicontrol Paused) check box.
When the \uicontrol Cache check box is selected, every frame of the
@@ -192,11 +193,11 @@
\section1 Iso Icon
- \note The Iso Icon component is not available if you selected
+ \note The \uicontrol {Iso Icon} component is not available if you selected
\uicontrol {Qt 6} when \l{Creating Projects}{creating the project}.
- The Iso Icon component specifies an icon from an ISO 7000 icon library as a
- \l [QtQuickExtras] {Picture} component. The icon to use for the type and
+ The \uicontrol {Iso Icon} component specifies an icon from an ISO 7000 icon
+ library as a \l [QtQuickExtras] {Picture} component. The icon to use for the type and
its color can be specified.
To select an icon in the \uicontrol {ISO Icon Browser} in \QDS, select
@@ -205,16 +206,16 @@
\image studio-iso-icon.png
- You can use the \l{Picking Colors}{color picker} in \l Properties to
+ You can use the \l{Picking colors}{color picker} in \l Properties to
set the value of \uicontrol {Icon color}.
\image iso-icon-browser.png
- \section1 Summary of Images
+ \section1 Summary of the image components
The following table lists the components that you can use to add images.
The \e Location column contains the tab name where you can find the
- component in \uicontrol Components. The \e MCU column
+ component in \uicontrol Components. The \e {MCU support} column
indicates which components are supported on MCUs.
\table
@@ -222,33 +223,33 @@
\li Icon
\li Name
\li Location
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage animated-image-icon16.png
+ \li \imageanimatedimageicon16
\li \l [QtQuick]{AnimatedImage}{Animated Image}
\li Default Components - Basic
- \li
+ \li No
\li An images that stores animations containing a series of frames,
such as those stored in GIF files.
\row
- \li \inlineimage border-image-icon16.png
+ \li \imageborderimageicon16
\li \l [QtQuick]{BorderImage}{Border Image}
\li Default Components - Basic
- \li \inlineimage ok.png
+ \li Yes
\li An image that is used as a border or background.
\row
- \li \inlineimage image-icon16.png
+ \li \imageimageicon16
\li \l [QtQuick]{Image}
\li Default Components - Basic
- \li \inlineimage ok.png
+ \li Yes
\li An image in one of the supported formats, including bitmap formats
such as PNG and JPEG and vector graphics formats such as SVG.
\row
- \li \inlineimage icons/iso-icons-16px.png
+ \li \imageisoicons16px
\li \l{Iso Icon}
\li Qt Quick Studio Components
- \li
+ \li No
\li An icon from an ISO 7000 icon library specified as a \l Picture
component. You can select the icon to use and its color.
diff --git a/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc b/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc
index 98ea7d12264..f97a887be24 100644
--- a/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc
@@ -6,7 +6,7 @@
\previouspage qtquick-properties.html
\nextpage qtquick-annotations.html
- \title Scalable Layouts
+ \title Scalable layouts
The position of a \l{glossary-component}{component} in a UI is either
absolute or relative to other components. The visual components exist at a
@@ -25,30 +25,30 @@
\li Action
\li Purpose
\row
- \li \l{Setting Bindings}
+ \li \l{Setting bindings}
\li To connect the properties of components.
\row
- \li \l{Setting Anchors and Margins}
+ \li \l{Setting anchors and margins}
\li To set the rules for attaching the component to other components. You can define
the distance between the components and put margins on the components.
\row
- \li \l{Aligning and Distributing Components}
+ \li \l{Aligning and distributing components}
\li To align the unanchored components left, right, vertical, horizontal, top, and
bottom with respect to each other.
\row
- \li \l{Using Positioners}
+ \li \l{Using positioners}
\li To arrange components in rows, columns, grids, or flows.
\row
- \li \l{Using Layouts}
+ \li \l{Using layouts}
\li To place the components in columns, grids, rows and stacks in layouts.
The layouts adept the nature of dynamic and resizable UI.
\row
- \li \l {Organizing Components}
+ \li \l {Organizing components}
\li To keep the components or controls collected with frames, groups,
group boxes, pages, and panes.
\endtable
- \section2 Setting Bindings
+ \section2 Setting bindings
Using \e {Property Binding}, you can connect the properties of components. So, change in
one can affect another. Once the binding is set, the property value is automatically
@@ -56,7 +56,7 @@
To set \e {Property Binding} to a component property:
\list 1
- \li Go to the \uicontrol Properties view and select \inlineimage icons/action-icon.png
+ \li Go to the \uicontrol Properties view and select \imageactionicon
(\uicontrol Actions) menu next to a property, and then select
\uicontrol {Set Binding}.
@@ -69,10 +69,10 @@
\endlist
When a binding is set, the \uicontrol Actions menu icon changes to
- \inlineimage icons/action-icon-binding.png.
+ \imageactioniconbinding.
To remove bindings, select \uicontrol Actions > \uicontrol Reset.
- See \l {Adding Bindings Between Properties} to learn how to set bindings using
+ See \l {Adding bindings between properties} to learn how to set bindings using
the \uicontrol Bindings tab in the \l Connections view.
\note For better performance, set anchors and margins for binding
@@ -80,7 +80,7 @@
component, anchor the component to its sibling components on the
left and the right.
- \section2 Setting Anchors and Margins
+ \section2 Setting anchors and margins
In an \l{Important Concepts In Qt Quick - Positioning#anchors}
{anchor-based} layout, each component has a set of
@@ -95,9 +95,9 @@
You can combine multiple anchors. For each selected button, you can
choose the target component of that anchor from the corresponding dropdown.
\li To apply fill anchors to a component, select
- \inlineimage icons/anchor-fill.png (\uicontrol {Fill to Parent}).
+ \imageanchorfill (\uicontrol {Fill to Parent}).
\li To reset the anchors to their saved state, select
- \inlineimage icons/qtcreator-anchors-reset-icon.png (\uicontrol {Reset Anchors}).
+ \imageqtcreatoranchorsreseticon (\uicontrol {Reset Anchors}).
\endlist
\image qmldesigner-anchor-buttons.png "Anchor buttons"
@@ -140,7 +140,7 @@
\uicontrol Margin. Margins work for anchors. They do not take any
effect when using layouts or absolute positioning.
- \section2 Aligning and Distributing Components
+ \section2 Aligning and distributing components
For a group of components, select them to align
and distribute them evenly. As the positions of the components are fixed,
@@ -187,18 +187,18 @@
distributed horizontally or vertically:
\list
- \li Select \inlineimage icons/distribute-origin-top-left.png
- and \inlineimage icons/distribute-spacing-horizontal.png
+ \li Select \imagedistributeorigintopleft
+ and \imagedistributespacinghorizontal
to use the left edge of the target area or item as the starting
point.
- \li Select \inlineimage icons/distribute-origin-top-left.png
- and \inlineimage icons/distribute-spacing-vertical.png
+ \li Select \imagedistributeorigintopleft
+ and \imagedistributespacingvertical
to use the top edge.
- \li Select \inlineimage icons/distribute-origin-bottom-right.png
- and \inlineimage icons/distribute-spacing-horizontal.png
+ \li Select \imagedistributeoriginbottomright
+ and \imagedistributespacinghorizontal
to use the right edge.
- \li Select \inlineimage icons/distribute-origin-bottom-right.png
- and \inlineimage icons/distribute-spacing-vertical.png
+ \li Select \imagedistributeoriginbottomright
+ and \imagedistributespacingvertical
to use the bottom edge.
\endlist
@@ -206,10 +206,10 @@
In the \uicontrol {Pixel spacing} field, set the space between
components in pixels. To disable the distribution of spacing in
- pixels, click \inlineimage icons/distribute-origin-none.png
+ pixels, click \imagedistributeoriginnone
button.
- \section2 Using Positioners
+ \section2 Using positioners
Positioner components are containers that manage the positions of their
child components. For many use cases, the best positioner to use is a simple
@@ -219,10 +219,10 @@
formations in the most efficient manner possible.
To position several components in a
- \uicontrol Column \inlineimage column-positioner-icon-16px.png,
- \uicontrol Row \inlineimage row-positioner-icon-16px.png,
- \uicontrol Grid \inlineimage grid-positioner-icon-16px.png,
- or \uicontrol Flow \inlineimage flow-positioner-icon-16px.png :
+ \uicontrol Column \imagecolumnpositionericon16px,
+ \uicontrol Row \imagerowpositionericon16px,
+ \uicontrol Grid \imagegridpositionericon16px,
+ or \uicontrol Flow \imageflowpositionericon16px :
\list 1
\li Select the components in the \l {2D} view.
@@ -231,7 +231,7 @@
\uicontrol Column, \uicontrol Grid or \uicontrol {Flow Positioner}.
\endlist
- \section3 Column Positioner
+ \section3 Column positioner
A \uicontrol Column positions its child components along a single column.
It is used as a convenient way to vertically position a series of
@@ -246,7 +246,7 @@
content and the left, right, top, and bottom edges of components
in the \l Padding section.
- \section3 Row and Flow Positioners
+ \section3 Row and the Flow positioners
A \uicontrol Row positions its child components along a single row. It is
used as a convenient way to horizontally position a series of components
@@ -255,7 +255,7 @@
The \uicontrol Flow component positions its child components like words on a
page, wrapping them to create rows or columns of components.
- \image qtquick-positioner-flow-properties.png "Flow properties"
+ \image qtquick-positioner-flow-properties.png "The Flow properties"
For flow and row positioners, also set the direction of a flow to
either left-to-right or top-to-bottom in the \uicontrol Flow field.
@@ -269,7 +269,7 @@
the width of the row is explicitly set, the left anchor remains to the
left of the row and the right anchor remains to the right of it.
- \section3 Grid Positioner
+ \section3 Grid positioner
A \uicontrol Grid creates a grid of cells that is large enough to hold all
of its child components, and places these components in the cells from left
@@ -292,7 +292,7 @@
To also mirror the horizontal alignment of components, select
\uicontrol AlignRight in the \uicontrol {Alignment H} field.
- \section2 Using Layouts
+ \section2 Using layouts
Use the components available in \uicontrol Components
> \uicontrol {Qt Quick Layouts} to arrange components in UIs.
@@ -307,7 +307,8 @@
to select its size in respect to its non-layout parent component. However,
do not anchor the child components within layouts.
- Follow the process to put components in the \uicontrol {Grid Layout}.
+ To put components in \uicontrol {Grid Layout}:
+
\list 1
\li Select all the components and right-click on one of them.
\li From the context menu, select \uicontrol Layout > \uicontrol {Grid Layout}.
@@ -348,19 +349,18 @@
the \uicontrol 2D view or \uicontrol Navigator view, and place on the top of
the \uicontrol {Stack Layout} component.
\note Alternatively, you can add components to the \uicontrol {Stack Layout} by
- selecting the \inlineimage icons/plus.png button next to the
+ selecting the \imageplus button next to the
\uicontrol {Stack Layout} component name in the \l {2D} view.
\li To move between components of \uicontrol {Stack Layout},
select the \uicontrol {Stack Layout} component in the \uicontrol 2D view. Then
- select the \inlineimage icons/prev.png
- (\uicontrol Previous) and \inlineimage icons/next.png
+ select the \imageprev
+ (\uicontrol Previous) and \imagenext
(\uicontrol Next) buttons. This updates the \uicontrol {Current index} of the
\uicontrol {Stack Layout} and brings the \uicontrol {Current index}
component on top of the stack.
\note Alternatively, select the \uicontrol {Stack Layout} component, then
go to the \uicontrol Properties view > \uicontrol {Stack Layout}, and
update the \uicontrol {Current index}. The index starts from "0" (zero).
-
\endlist
Follow the example below to understand how the \uicontrol {Stack Layout} works:
@@ -389,7 +389,7 @@
\li Go to the \uicontrol Navigator view and select the \uicontrol {Stack Layout} component.
\li Go to the \uicontrol Properties view > \uicontrol {Stack Layout}. Select
- \inlineimage icons/action-icon.png to access the context menu, then select
+ \imageactionicon to access the context menu, then select
\uicontrol {Set Binding}.
\image studio-stack-layout-add-binding.webp "Getting the context menu to bind components"
@@ -404,10 +404,9 @@
\li Drag the slider to change the color in the rectangle.
\image studio-stack-layout-example-output.webp "Stack Layout example output"
-
\endlist
- \section2 Organizing Components
+ \section2 Organizing components
You can use the \uicontrol Frame and \uicontrol {Group Box} controls to
draw frames around groups of controls.
@@ -425,27 +424,27 @@
\li Location
\li Purpose
\row
- \li \inlineimage icons/frame-icon16.png
+ \li \imageframeicon16
\li \l [QtQuickControls]{Frame}
\li Qt Quick Controls
\li A visual frame around a group of controls.
\row
- \li \inlineimage icons/group-16px.png
+ \li \imagegroup16px
\li Group
\li Qt Quick Studio Components
\li Enables handling the selected components as a group.
\row
- \li \inlineimage icons/groupbox-icon16.png
+ \li \imagegroupboxicon16
\li \l [QtQuickControls]{GroupBox}{Group Box}
\li Qt Quick Controls
\li A titled visual frame around a group of controls.
\row
- \li \inlineimage icons/page-icon16.png
+ \li \imagepageicon16
\li \l [QtQuickControls]{Page}
\li Qt Quick Controls
\li A styled page control with support for a header and footer.
\row
- \li \inlineimage icons/pane-icon16.png
+ \li \imagepaneicon16
\li \l [QtQuickControls]{Pane}
\li Qt Quick Controls
\li A background that matches the application style and theme.
diff --git a/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc
index 267517cb6c7..fddd37e608e 100644
--- a/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc
@@ -6,10 +6,10 @@
\previouspage quick-components.html
\nextpage quick-shapes.html
- \title Preset Components
+ \title Preset components
To use preset components, add the modules that contain them to your project
- by selecting \uicontrol Components > \inlineimage icons/plus.png
+ by selecting \uicontrol Components > \imageplus
. For more information, see \l{Adding and Removing Modules}. You can then
create instances of the components by dragging-and-dropping them from
\uicontrol Components to the \l {2D}, \l {3D} , or \l Navigator view.
@@ -19,7 +19,7 @@
and set its properties in the \l Properties view.
For more information about creating your own components, see
- \l{Creating Custom Components}.
+ \l{Creating custom components}.
\section1 2D Components
@@ -27,10 +27,10 @@
\li \l Shapes
\li \l Text
\li \l Images
- \li \l {User Interaction Methods}
- \li \l {UI Controls}
- \li \l {Lists and Other Data Models}
- \li \l {2D Effects}
+ \li \l {User interaction methods}
+ \li \l {UI controls}
+ \li \l {Lists and other data models}
+ \li \l {2D effects}
\li \l {Design Effects}
\li \l {Logic Helpers}
\li \l Animations
@@ -44,19 +44,19 @@
can \l{Importing 3D Assets}{import} the assets you need and work with them
to create scenes and states, as well as the transitions between them.
- \list
+ \list
\li \l {3D Views}
\li \l {Node}
\li \l {Group}
- \li \l {Instanced Rendering}
- \li \l {Skeletal Animation}
- \li \l {3D Models}
- \li \l {Materials and Shaders}
+ \li \l {Instanced rendering}
+ \li \l {Skeletal animation}
+ \li \l {3D models}
+ \li \l {Materials and shaders}
\li \l {Textures}
- \li \l {3D Materials}
- \li \l {3D Effects}
- \li \l {Custom Shaders}
- \li \l {Custom Effects and Materials}
+ \li \l {3D materials}
+ \li \l {3D effects}
+ \li \l {Custom shaders}
+ \li \l {Custom effects and materials in Qt 5}
\li \l {Lights}
\li \l {Cameras}
\li \l {Scene Environments}
@@ -64,7 +64,7 @@
\li \l {Repeater3D}
\li \l {Loader3D}
\li \l {Particles}
- \endlist
+ \endlist
When you import 3D scenes from files that you exported from 3D graphics
tools, you also import the camera, light, model, and materials as 3D
diff --git a/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc b/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc
index 73ccc3971a5..310615b0df9 100644
--- a/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc
@@ -52,7 +52,7 @@
An optional solid border can be added to a rectangle with its own color
and thickness by setting the values of the \uicontrol {Border color} and
\uicontrol {Border width} fields. To create a border without a fill color,
- select the \inlineimage icons/transparent-icon.png
+ select the \imagetransparenticon
button that sets the color to \e transparent.
By setting the value of the \uicontrol Radius field, you can create shapes
@@ -206,11 +206,11 @@
\uicontrol {Rotational axis} property determine whether the component
is rotated around the x-axis or the y-axis.
- \section1 Summary of Shapes
+ \section1 Summary of the shape components
The following table lists the components that you can use to draw shapes.
The \e Location column indicates the location of the component in
- \uicontrol Components. The \e MCU column indicates which
+ \uicontrol Components. The \e {MCU support} column indicates which
components are supported on MCUs.
\table
@@ -218,54 +218,54 @@
\li Icon
\li Name
\li Location
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage icons/item-arc-16px.png
+ \li \imageitemarc16px
\li \l Arc
\li Qt Quick Studio Components
- \li
+ \li No
\li An arc that begins and ends at given positions.
\row
- \li \inlineimage icons/custom-border-16px.png
+ \li \imagecustomborder16px
\li \l Border
\li Qt Quick Studio Components
- \li
+ \li No
\li A line with four segments that you can show and shape individually.
\row
- \li \inlineimage icons/item-pie-16px.png
+ \li \imageitempie16px
\li \l Pie
\li Qt Quick Studio Components
- \li
+ \li No
\li A pie slice or a pie with a slice missing from it.
\row
- \li \inlineimage icons/item-flippable-16px.png
+ \li \imageitemflippable16px
\li \l Flipable
\li Qt Quick Studio Components
- \li
+ \li No
\li A component that can be visibly \e flipped between its front and
back sides, like a card.
\row
- \li \inlineimage rect-icon16.png
+ \li \imagerecticon16
\li \l Rectangle
\li Default Components - Basic
- \li \inlineimage ok.png
+ \li Yes
\li A rectangle that is painted with a solid fill color or linear
gradient and an optional border. You can use the radius property
to draw circles.
\row
- \li \inlineimage icons/custom-rectangle-16px.png
+ \li \imagecustomrectangle16px
\li \l{Studio Rectangle}{Rectangle}
\li Qt Quick Studio Components
- \li
+ \li No
\li An extended rectangle that is painted with a solid fill color or
linear, conical, or radial gradients, and corners that you can
shape independently of each other.
\row
- \li \inlineimage icons/item-triangle-16px.png
+ \li \imageitemtriangle16px
\li \l Triangle
\li Qt Quick Studio Components
- \li
+ \li No
\li A triangle with different dimensions and shapes that is
enclosed in an invisible rectangle.
\endtable
diff --git a/doc/qtdesignstudio/src/components/qtquick-text.qdoc b/doc/qtdesignstudio/src/components/qtquick-text.qdoc
index 0e8695b5101..7875b79ce22 100644
--- a/doc/qtdesignstudio/src/components/qtquick-text.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-text.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -29,10 +29,10 @@
They differ from the basic components in that a common style is applied
to them and that you can specify placeholder text for them.
- \section1 Using Rich Text
+ \section1 Using rich text
You can use rich text in the \uicontrol Text and \uicontrol {Text Input}
- components. To open the rich text editor, select the \inlineimage icons/edit.png
+ components. To open the rich text editor, select the \imageedit
(\uicontrol Edit) button in \uicontrol Properties > \uicontrol Character
> \uicontrol Text.
@@ -41,19 +41,19 @@
In the rich text editor, you can:
\list
- \li Emphasize text
- \li Create hyperlinks
- \li Align text
- \li Create bulleted and numbered lists
- \li Specify text color
- \li Select text font
- \li Set font size
- \li Create tables
+ \li Emphasize text.
+ \li Create hyperlinks.
+ \li Align text.
+ \li Create bulleted and numbered lists.
+ \li Specify text color.
+ \li Select text font.
+ \li Set font size.
+ \li Create tables.
\endlist
\image qtquick-rtf-editor.png "Text formatted as rich text in the editor"
- \section1 Marking Strings for Translation
+ \section1 Marking strings for translation
To support translators, mark the strings that should be translated.
In \uicontrol Properties > \uicontrol Character > \uicontrol Text, select
@@ -77,7 +77,7 @@
For more information, see \l {Mark Strings for Translation}.
- \section1 Character Properties
+ \section1 Character properties
You can set font properties in the \uicontrol Character section
in \uicontrol Properties. For each string that you enter in the
@@ -93,7 +93,7 @@
\list 1
\li Select \uicontrol Assets
- > \inlineimage icons/plus.png
+ > \imageplus
.
\li Select the font file, and then select \uicontrol Open.
\li Select the location where the file will be saved in the
@@ -123,7 +123,7 @@
to set the spacing proportionally to the line (as a multiplier).
For example, set to 2 for double spacing.
- \section1 Text Alignment
+ \section1 Text alignment
You can align text components horizontally and vertically. By default, text
is vertically aligned to the top. Horizontal alignment follows the natural
@@ -136,11 +136,11 @@
For a single line of text, the size of the text is the area of the text.
In this common case, all alignments are equivalent. To center a text in
- its parent, use \l{Setting Anchors and Margins}{anchoring} or bind the
+ its parent, use \l{Setting anchors and margins}{anchoring} or bind the
width of the text component to that of the parent. For more information, see
- \l{Setting Bindings}.
+ \l{Setting bindings}.
- \section1 Text and Style Colors
+ \section1 Text and style colors
You can set the color of the text itself and a secondary color used by
text styles.
@@ -156,7 +156,7 @@
For more information about selecting colors, see \l{Picking Colors}. You
can only set solid colors for text components.
- \section1 Advanced Text Properties
+ \section1 Advanced text properties
The height and width of a text component are determined automatically depending
on the values of the properties you set, to accommodate the length of the
@@ -178,7 +178,7 @@
has a minimum bound specified by the \uicontrol {Min size} field and
maximum bound specified by the \uicontrol Size field.
- \section3 Wrapping and Eliding Text
+ \section3 Wrapping and eliding text
In the \uicontrol {Wrap mode} field, you can wrap the text to the text
component's width. The text will only wrap if you set an explicit width for
@@ -202,7 +202,7 @@
Multi-length strings are ordered from longest to shortest, separated by the
Unicode \e {String Terminator} character \c U009C.
- \section3 Formatting Text
+ \section3 Formatting text
Text can be either in plain text or rich text format, depending on the
value you set in the \uicontrol Format field. If you select
@@ -211,7 +211,7 @@
described on the \l {Supported HTML Subset}. Note that plain text offers
better performance than rich text.
- \section3 Rendering Text
+ \section3 Rendering text
In the \uicontrol {Render type} field, you can override the default
rendering type for a text component. Select \uicontrol NativeRendering if
@@ -238,7 +238,7 @@
\note This property only describes a preference, as the full range of
hinting levels are not supported on all of Qt's supported platforms.
- \section1 Advanced Font Properties
+ \section1 Advanced font properties
You can specify additional properties for fonts in the
\uicontrol {Font Extras} section.
@@ -279,7 +279,7 @@
\image qtquick-designer-text-input-properties.png "Text input field properties"
- \section2 Entering Passwords
+ \section2 Entering passwords
You can set properties for \uicontrol {Text Input} components that make
them suitable for entering passwords.
@@ -299,7 +299,7 @@
as users enter them. The mask character is displayed in the
\uicontrol {Password character} field.
- \section2 Entering Text
+ \section2 Entering text
You can specify how users can enter text into text edit or input fields.
@@ -318,7 +318,7 @@
To prevent users from changing the text, select the \uicontrol {Read only}
check box.
- \section2 Selecting Text
+ \section2 Selecting text
In the \uicontrol {Selection mode} field, you can specify whether
individual characters or whole words are selected when selecting text
@@ -350,7 +350,7 @@
If the \uicontrol {Persistent selection} check box is selected, a text edit
or input keeps its selection when active focus moves to another component.
- \section2 Tabs and Margins
+ \section2 Tabs and margins
You can specify additional properties for formatting a block of text in
a \uicontrol {Text Edit} component.
@@ -376,7 +376,7 @@
text does not have enough vertical or horizontal space in which to be
rendered, it will appear clipped.
- \section1 Placeholder Text
+ \section1 Placeholder text
For \uicontrol {Text Field} and \uicontrol {Text Area} controls, you can
specify text to display in a field before users enter text into it.
@@ -388,11 +388,11 @@
Select the \uicontrol Hover check box to enable the text field to accept
hover events.
- \section1 Summary of Text Components
+ \section1 Summary of the text components
The following table lists the components that you can use to add text to
UIs. The \e Location column contains the tab name where you can find the
- component in \uicontrol Components. The \e MCU column
+ component in \uicontrol Components. The \e {MCU support} column
indicates which components are supported on MCUs.
\table
@@ -400,43 +400,43 @@
\li Icon
\li Name
\li Location
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage icons/label-icon16.png
+ \li \imagelabelicon16
\li \l [QtQuickControls]{Label}
\li Qt Quick Controls
- \li
+ \li No
\li A text label with inherited styling and font.
\row
- \li \inlineimage text-icon16.png
+ \li \imagetexticon16
\li \l [QtQuick]{Text}
\li Default Components - Basic
- \li \inlineimage ok.png
+ \li Yes
\li Formatted read-only text.
\row
- \li \inlineimage icons/textarea-icon16.png
+ \li \imagetextareaicon16
\li \l [QtQuickControls]{TextArea}{Text Area}
\li Qt Quick Controls
- \li
+ \li No
\li Multiple lines of editable formatted text.
\row
- \li \inlineimage text-edit-icon16.png
+ \li \imagetextediticon16
\li \l [QtQuick]{TextEdit}{Text Edit}
\li Default Components - Basic
- \li
+ \li No
\li A single line of editable formatted text that can be validated.
\row
- \li \inlineimage icons/textfield-icon16.png
+ \li \imagetextfieldicon16
\li \l [QtQuickControls]{TextField}{Text Field}
\li Qt Quick Controls
- \li
+ \li No
\li A single line of editable plain text.
\row
- \li \inlineimage text-input-icon16.png
+ \li \imagetextinputicon16
\li \l [QtQuick]{TextInput}{Text Input}
\li Default Components - Basic
- \li
+ \li No
\li A single line of editable plain text that can be validated.
\endtable
*/
diff --git a/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc b/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc
index 71b3fee6305..1cdc002f086 100644
--- a/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc
+++ b/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage quick-images.html
\nextpage quick-controls.html
- \title User Interaction Methods
+ \title User interaction methods
You can create instances of preset basic components to add interaction
methods to UIs, such as performing actions by using a pointing device or
@@ -14,7 +14,7 @@
vertically. They are availabe in \uicontrol Components >
\uicontrol {Default Components} > \uicontrol Basic.
- In addition, you can create instances of preset \l{UI Controls} to inform
+ In addition, you can create instances of preset \l{UI controls} to inform
users about the progress of the application or to gather input from users.
The following basic components are available for user interaction:
@@ -23,7 +23,7 @@
\li \l {Mouse Area}
\li \l {Focus Scope}
\li \l {Flickable}
- \li \l {Summary of Basic Interaction Methods}
+ \li \l {Summary of the basic interaction methods}
\endlist
You can specify values for the properties of component instances in the
@@ -37,14 +37,14 @@
a defined area.
A mouse area receives events within a defined area. One quick way to define
- this area is to \l{Setting Anchors and Margins}{anchor} the mouse area to
+ this area is to \l{Setting anchors and margins}{anchor} the mouse area to
its parent's area. If the parent is a \l {basic-rectangle}{Rectangle} (or
any component that is derived from an \l {basic-item}{Item}), the mouse area
will fill the area defined by the parent's dimensions. Alternatively, you
can define an area smaller or larger than the parent. Several controls, such
as \l {Button}{buttons}, contain a mouse area.
- A mouse area emits \l{Connecting Components to Signals}{signals} in response
+ A mouse area emits \l{Connecting components to signals}{signals} in response
to different mouse events:
\list
@@ -59,7 +59,7 @@
\li \c released()
\endlist
- \section2 Mouse Area Properties
+ \section2 Mouse Area properties
A \uicontrol {Mouse Area} is an invisible component that is typically used
in conjunction with a visible component in order to provide mouse handling
@@ -125,7 +125,7 @@
propagating down this visual hierarchy until a \uicontrol {Mouse Area}
accepts the event.
- \section2 Advanced Mouse Area Properties
+ \section2 Advanced Mouse Area properties
You can place a \uicontrol {Mouse Area} instance within a component that
filters child mouse events, such as \uicontrol Flickable. However, the
@@ -140,7 +140,7 @@
For more information, see the developer documentation for the \l {MouseArea}
{Mouse Area} component.
- \section2 Drag Properties
+ \section2 Drag properties
You can specify properties for dragging components in the \uicontrol Drag
section. Select the component to drag in the \uicontrol Target field.
@@ -190,8 +190,8 @@
The \uicontrol {Focus Scope} component is not a visual component and
therefore the properties of its children need to be exposed to the parent
- component of the focus scope. \l{Using Layouts}{Layouts} and
- \l{Using Positioners}{positioners} will use these visual and styling
+ component of the focus scope. \l{Using layouts}{Layouts} and
+ \l{Using positioners}{positioners} will use these visual and styling
properties to create the layout.
For more information, see \l {Keyboard Focus in Qt Quick}.
@@ -202,7 +202,7 @@
and flicked, causing the view onto the child components to scroll. This
behavior forms the basis of components that are designed to show large
numbers of child components, such as \uicontrol {List View} and
- \uicontrol {Grid View}. For more information, see \l{List and Grid Views}.
+ \uicontrol {Grid View}. For more information, see \l{List Views and Grid Views}.
In traditional user interfaces, views can be scrolled using standard
controls, such as scroll bars and arrow buttons. In some situations, it
@@ -269,7 +269,7 @@
provides a smoother experience (no jump) at the cost of losing some of the
drag distance at the beginning.
- \section2 Flickable Geometry
+ \section2 Flickable Geometry properties
The \uicontrol {Content size} field specifies the dimensions of the
surface controlled by a flickable. Typically, set the values of the
@@ -287,35 +287,35 @@
may have an arbitrary origin due to delegate size variation, or component
insertion or removal outside the visible region.
- \section1 Summary of Basic Interaction Methods
+ \section1 Summary of the basic interaction methods
The following table lists the components that you can use to add basic
interaction methods to UIs with links to their developer documentation.
They are availabe in \uicontrol Components >
- \uicontrol {Default Components} > \uicontrol Basic. The \e MCU column
+ \uicontrol {Default Components} > \uicontrol Basic. The \e {MCU support} column
indicates which components are supported on MCUs.
\table
\header
\li Icon
\li Name
- \li MCU
+ \li MCU support
\li Purpose
\row
- \li \inlineimage flickable-icon16.png
+ \li \imageflickableicon16
\li \l [QML]{Flickable}
- \li \inlineimage ok.png
+ \li Yes
\li Enables flicking components horizontally or vertically.
\row
- \li \inlineimage focusscope-icon16.png
+ \li \imagefocusscopeicon16
\li \l{FocusScope}{Focus Scope}
- \li
+ \li No
\li Assists in keyboard focus handling when building reusable
components.
\row
- \li \inlineimage mouse-area-icon16.png
+ \li \imagemouseareaicon16
\li \l [QtQuick]{MouseArea}{Mouse Area}
- \li \inlineimage ok.png
+ \li Yes
\li Enables simple mouse handling.
\endtable
*/
diff --git a/doc/qtdesignstudio/src/developers/studio-accessing-output-issues-and-warnings.qdoc b/doc/qtdesignstudio/src/developers/studio-accessing-output-issues-and-warnings.qdoc
new file mode 100644
index 00000000000..7bcb6588abb
--- /dev/null
+++ b/doc/qtdesignstudio/src/developers/studio-accessing-output-issues-and-warnings.qdoc
@@ -0,0 +1,54 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \page studio-accessing-output-issues-and-warnings.html
+ \nextpage studio-on-mcus.html
+ \previouspage creator-editor-external.html
+
+ \title Accessing output, issue, and warning messages
+
+ \image studio-output-view.webp Qt Design Studio Output view
+
+ \QDS projects generate output information that represent the
+ executed processes. It also shows you the issues that stop a project from
+ getting executed or gives you warnings about probable failures. Warning messages
+ generated in the \uicontrol Issues relate to the code and design problems,
+ and warning messages generated in the \uicontrol Output relate to the
+ runtime failures.
+
+ \section1 Accessing the Output messages
+
+ When you run a project, details about the runtime execution processes
+ is listed in the output view. To access these messages, select
+ \imageoutput.
+
+ \image studio-output-view-message.webp Runtime execution process related output messages
+
+ \section1 Accessing the Issue and Warning messages
+
+ Technical problems in the \QDS project are visible in the
+ \uicontrol Output view. To access these issues,
+ select \imagewarning \imageerror.
+
+ Select the \e filename from the issue notification to jump into the location of the error.
+ It takes you to the location of the issue in the view (\uicontrol 2D, \uicontrol 3D, or
+ \uicontrol Code) you are currently in.
+
+ \table
+ \header
+ \li Message type
+ \li Message example
+ \row
+ \li Issue notification
+ \li \image studio-issue-message.webp
+ \row
+ \li Warning notification
+ \li \image studio-warning-message.webp
+
+ \endtable
+
+ To clear the \uicontrol Output view, select \imageclearview.
+ To close the \uicontrol Output view, select \imagedistributeoriginnone.
+
+*/
diff --git a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc
index 78e90404542..0b6e133d0b8 100644
--- a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc
+++ b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc
@@ -6,20 +6,20 @@
\previouspage studio-implementing-applications.html
\nextpage studio-debugging.html
- \title Designer-Developer Workflow
+ \title Designer-developer workflow
\note In this section, you are using advanced menu items. These are not
visible by default. To toggle the visibility of advanced menu items, see
\l{Customizing the Menu Bar}.
\QDS enables designers and developers to work together on common
- projects to develop applications. Designers use the \l{Design Views}{views}
- in the \uicontrol Design mode to modify \l{UI Files}{UI files} (\e .ui.qml),
+ projects to develop applications. Designers use the \l{Design views}{views}
+ in the \uicontrol Design mode to modify \l{UI files} (\e .ui.qml),
whereas developers use Qt Creator to work on the Qt Quick (\e .qml) and
other files that are needed to implement the application logic and to
prepare the application for production.
- \QDS \l{Creating Projects}{projects} come with boilerplate code for a
+ \QDS \l{Creating projects}{projects} come with boilerplate code for a
working Qt 6 application that you can build and run in Qt Creator using
CMake. Therefore, you can open, build, and run the projects with Qt Creator.
@@ -32,20 +32,19 @@
\e {main.py}. Use this file to start the development in Python for the UI
made with \QDS.
- \section1 Exporting a \QDS Project for C++ Development
-
- To export a \QDS project for Qt Creator, you need:
+ \section1 Exporting a \QDS project for C++ development
+ Before you export a \QDS project for Qt Creator, install the following:
\list
\li Qt Creator 13.0 or above.
\li \QDS 4.5 or above.
- \li Git.
-
- \note Learn more about getting Git \l {https://wiki.qt.io/Git_Installation} {here}.
+ \li Git. To learn more about installing Git,
+ see \l {https://wiki.qt.io/Git_Installation}.
\endlist
+ To export a \QDS project for Qt Creator:
\list 1
- \li \l {Creating a Project} {Create} or open your \QDS project with \QDS 4.5 or above.
+ \li \l {Creating a project} {Create} or open your \QDS project with \QDS 4.5 or above.
\note If you are creating a new project in \QDS, select the
\uicontrol {Target Qt Version} that is not higher than the Qt version
@@ -62,9 +61,9 @@
\image studio-project-export-cmake.webp "Exporting Qt Design Studio project to CMake"
\endlist
- \section1 Opening the \QDS Project in Qt Creator
+ \section1 Opening the \QDS project in Qt Creator
- Open the \e {CMakeLists.txt} file in Qt Creator. To open:
+ Open the \e {CMakeLists.txt} file in Qt Creator:
\list 1
\li In Qt Creator, select \uicontrol File > \uicontrol {Open File or Project}.
@@ -94,7 +93,52 @@
All the import assets are now bundled in the same folder, so the CMake
generation works properly.
- \section1 Exporting a \QDS Project for Python Development
+ \section1 CMake Generator
+ \details {FAQ}
+
+ Learn how the CMake generator works.
+
+ \section2 What does the CMake Generator convert?
+ The CMake Generator converts the contents of the \e .qmlproject file
+ to CMake.
+ \note A \QDS project can run with a missing path or file filter.
+ However, CMake generation can fail due to missing elements in the
+ \e .qmlproject file.
+
+ \section2 Which changes are tracked by the CMake Generator?
+ All the files that are listed in \e .qmlproject are tracked by the
+ CMake Generator. Editing the \e .qmlproject file triggers a CMake
+ generation. Adding, removing, and renaming files are tracked.
+
+ \section2 Why do you need Stubb or Mock QML data for \QDS?
+ \QDS doesn't understand C++ code, so the CMake Generator ignores any
+ components or properties made with C++. If you want a similar
+ representation in \QDS for the components or properties created with
+ C++, add a QML mock file for \QDS. Keep these mock files in a dedicated
+ folder within your project folder. You can later add a \c mockImports
+ variable within the \e .qmlproject file and include the folder path
+ with mock files in the \c mockImports variable. CMake ignores all folders
+ and files included in the \c mockImports variable. So they only stay in the
+ \QDS space and are not converted with CMake Generator.
+
+ Example:
+ \code
+ mockImports: [ "MockDatas" ]
+ \endcode
+ Here, MockDatas is a folder in your project folder with all the files
+ with QML mock data. If you include this code in the \e .qmlproject file,
+ the CMake Generator ignores everything inside the MockDatas folder.
+
+ \section2 Is it possible to manually change the contents of the \e CMakeLists.txt files?
+ Yes, you can make changes to the \e CMakeLists.txt files existing in the
+ App and the Root folders of your project. The \e CMakeLists.txt files
+ in other folders of your project are overwritten as soon as the
+ CMake generator runs next time. Only the \e CMakeLists.txt files in
+ the App and the Root folders of your project are not overwritten.
+
+ \enddetails
+
+ \section1 Exporting a \QDS project for Python development
\list 1
\li \l {Creating a Project} {Create} a project with \QDS 4.5 or above.
@@ -116,7 +160,7 @@
\image studio-project-export-python.webp "Exporting Qt Design Studio project to Python"
\endlist
- \section1 Opening the \QDS Project with Python
+ \section1 Opening the \QDS project with Python
After your project have the Python folder and the \e {main.py} file
available, you can start setting up your Python environment for developing
@@ -124,22 +168,22 @@
\table
\row
- \li {2,1} \image studio-project-export-python-folder.webp "The generated Python folder in the Qt Design Studio project"
- \li {2,2} \image studio-project-export-python-file.webp "The generated Python file in the Qt Design Studio project"
+ \li \image studio-project-export-python-folder.webp "The generated Python folder in the Qt Design Studio project"
+ \li \image studio-project-export-python-file.webp "The generated Python file in the Qt Design Studio project"
\endtable
\list 1
- \li If you don't have Python installed on your computer, install it.
+ \li Install Python.
The latest version of Python is available
\l {https://www.python.org/downloads/} {here}.
- \li Next, follow the steps from this document to
+ \li Follow the steps from this document to
\l {https://doc.qt.io/qtforpython-6/quickstart.html} {install PySide6}.
You need this for working with Qt in Python.
\note You need Python version between 3.8 and 3.13 to install
PySide6.
- \li After installing PySide6, install \QDS packages for PySide6. Stay
+ \li Install the \QDS packages for PySide6. Stay
in the virtual environment that was accessed for installing
PySide6. From there, execute the command in the command prompt.
\code
@@ -148,17 +192,25 @@
\li Go to your project folder in the command prompt.
\code
- cd path/to/your/project/folder
+ cd
\endcode
- \li Finally, run the command below in the command prompt to open the
+ \li Run the command below in the command prompt to open the
\e {main.py} file from your project.
\code
python Python\main.py
\endcode
+
+ \note Any extra data or Python files you add to the project and,
+ import from \e {main.py} must remain inside the \c {Python} folder.
\endlist
Your \QDS project now runs in Python. Use Python to add more
functionalities to the project. Go to \l {Qt for Python} to learn more
about developing Qt projects using Python.
+
+ \section1 Converting \QDS projects to applications
+
+ \include qtquick-converting-ui-projects-to-applications.qdocinc {converting-ui-projects-to-applications} {\QDS}
+
*/
diff --git a/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc b/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc
index 8eaedf0a7e2..7284eee1a1c 100644
--- a/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc
+++ b/doc/qtdesignstudio/src/developers/studio-jump-to-the-code.qdoc
@@ -13,10 +13,10 @@
You can jump to the code from:
\list
- \li \uicontrol {Navigator} view
- \li \uicontrol {2D} view
- \li \uicontrol {States} view
- \li \uicontrol {Connections} view
+ \li The \uicontrol {Navigator} view
+ \li The \uicontrol {2D} view
+ \li The \uicontrol {States} view
+ \li The \uicontrol {Connections} view
\endlist
\section1 Jump to the Code from the Navigator View
@@ -28,7 +28,7 @@
\image jump-to-the-code-from-navigator-view.webp
- \section1 Jump to the Code from the 2D View
+ \section1 Jump to the Code from the 2D view
\list 1
\li Right-click on a component in the \uicontrol {2D} view.
@@ -38,25 +38,25 @@
\image jump-to-the-code-from-2D-view.webp
\note Alternatively, you can select the component in the \uicontrol {Navigator} view
- or in the \uicontrol {2D} view and press \key {F4}. That takes you to the code
+ or in the \uicontrol {2D} view and select \key {F4}. That takes you to the code
location in the \uicontrol {Code} view.
- \section1 Jump to the Code from the States View
+ \section1 Jump to the Code from the States view
\list 1
\li Locate the state you want to check in the \uicontrol {States} view.
- \li Select \inlineimage icons/browse-button.png
+ \li Select \imagebrowsebutton
to open additional options.
\li Select \uicontrol {Jump to the Code}.
\endlist
\image jump-to-the-code-from-state-view.webp
- \section1 Jump to the Code from the Connections View
+ \section1 Jump to the Code from the Connections view
\list 1
\li Select a connection in the \uicontrol {Connections} view.
- \li Select \inlineimage icons/jump-to-code-16px.png
+ \li Select \imagejumptocode16px
to jump to the code segment related to the connection.
\endlist
diff --git a/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc b/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc
index 9424731fb62..aa20427bc9e 100644
--- a/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc
+++ b/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc
@@ -6,13 +6,13 @@
\previouspage studio-live-preview.html
\nextpage creator-live-preview-devices.html
- \title Previewing on Desktop
+ \title Previewing on desktop
To preview the currently active QML file on the desktop:
\list
\li Select the \uicontrol {Live Preview} button on the top toolbar.
- \li Press \key {Alt+P}.
+ \li Select \key {Alt+P}.
\image studio-live-preview.webp
\endlist
@@ -30,20 +30,20 @@
To preview the application in a different zoom level, right-click the \uicontrol {Live Preview}
button and select the zoom level.
- \section1 Overriding the Preview Tool
+ \section1 Overriding the preview tool
By default, the QML runtime is used for previewing.
To use some other tool:
\list 1
- \li Select \inlineimage icons/settings.png to go to
+ \li Select \imagesettings to go to
\uicontrol {Run Settings}.
\image studio-run-settings.webp {Run Settings}
\li In \uicontrol {Override device QML viewer}, select the folder where
the preview tool executable is located.
\endlist
- To preview the design on a device, see \l {Previewing on Devices}.
+ To preview the design on a device, see \l {Previewing on devices}.
*/
diff --git a/doc/qtdesignstudio/src/how-to/qtdesignstudio-usage-statistics.qdoc b/doc/qtdesignstudio/src/how-to/qtdesignstudio-usage-statistics.qdoc
index 750d2d11c6b..ba4b5cc5449 100644
--- a/doc/qtdesignstudio/src/how-to/qtdesignstudio-usage-statistics.qdoc
+++ b/doc/qtdesignstudio/src/how-to/qtdesignstudio-usage-statistics.qdoc
@@ -6,14 +6,14 @@
\previouspage creator-quick-ui-forms.html
\nextpage studio-collecting-usage-statistics.html
- \title Managing Data Collection
+ \title Managing data collection
See below for more information about the collected data:
\list
- \li \l {Collecting Usage Statistics}
- \li \l {Collecting User Feedback}
- \li \l {Reporting Crashes}
+ \li \l {Collecting usage statistics}
+ \li \l {Collecting user feedback}
+ \li \l {Reporting crashes}
\endlist
\section1 Principles of Data Collection
@@ -27,7 +27,7 @@
\l{https://www.qt.io/terms-conditions/privacy-and-security}
{Qt Appendix for Privacy and Security}.
- \sa {Collecting Usage Statistics}
+ \sa {Collecting usage statistics}
*/
/*!
@@ -35,17 +35,11 @@
\previouspage studio-telemetry.html
\nextpage studio-user-feedback.html
- \title Collecting Usage Statistics
+ \title Collecting usage statistics
- The telemetry plugin uses the
- \l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
- {KUserFeedback} framework to collect the usage data. The library
- has been designed from the user data privacy point of view and
- \QC respects the same privacy rules.
-
- The data is transmitted to the backend storage using an encrypted
- connection. The storage is located in the same Heroku backend as the
- \QOI backend. Physically, data is stored in the Amazon cloud.
+ The telemetry plugin uses Qt Insight, an analytics solution for collecting usage data in
+ Qt applications. The Qt Insight Tracker library ensures compliance with GDPR regulations.
+ Data is securely transmitted to a centralized backend.
\section1 Turning on Telemetry
@@ -55,5 +49,5 @@
\image studio-preferences-telemetry-usage-statistics.webp {Usage Statistics}
- \sa {Managing Data Collection}
+ \sa {Managing data collection}
*/
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc
index 0e833cead10..25395bc0910 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-compatibility-with-mcu-sdks.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,18 +6,21 @@
\page studio-compatibility-with-mcu-sdks.html
\nextpage studio-features-on-mcu-projects.html
- \title \QDS Version Compatibility with \QMCU SDKs
+ \title \QDS version compatibility with \QMCU SDKs
The following table lists the \QDS versions you can use to develop
applications with particular \QMCU SDK versions.
\table
\header
- \li \QDS Version
- \li \QMCU SDK Version
+ \li \QDS version
+ \li \QMCU SDK version
\row
- \li 4.5 or later
- \li 2.8 or later
+ \li 4.7 or later
+ \li 2.9 or later
+ \row
+ \li 4.5 up to 4.6
+ \li 2.8
\row
\li 4.4
\li 2.7
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-connecting-mcus-with-creator.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-connecting-mcus-with-creator.qdoc
index 0195a6e62af..98fefdb49b8 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-connecting-mcus-with-creator.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-connecting-mcus-with-creator.qdoc
@@ -8,18 +8,24 @@
\title Connecting MCUs with Qt Creator
- \l {Connecting MCUs} {Connect MCU boards} to a development host to
- build applications for them using the GNU Arm Embedded GCC compiler, libraries,
- and other GNU tools necessary for BareMetal software development on devices
- based on the Arm Cortex-M processors. Deploy the applications on MCUs to run
- and debug them using Qt Creator.
+ With \QMCU you can develop applications for desktop and for specific MCU
+ target devices using either Linux or Windows as the development host
+ environment.
- The toolchains are available for cross-compilation on Microsoft Windows,
- Linux, and macOS. However, the \QMCU SDK is currently only available for
- Windows and Linux.
+ When developing for desktop, you first need to install the
+ \l {MCU prerequisites for desktop}. After installing the prerequisites, you
+ need to create a \l {MCU kit for desktop} to set up the necessary environment
+ for Qt Creator to build the \QMCU application for the desktop target.
- For more information on how to manage the complete cycle of developing \QMCU
- applications using Qt tools, see:
+ If you want to start developing for a specific MCU target device, you first
+ need to install both the common and \l {MCU target device-specific prerequisites}.
+ After installing all the required prerequisites, you can launch Qt Creator
+ and create a \l {MCU kit for a target device} to set up the necessary
+ environment for Qt Creator to build and run the \QMCU application on the MCU
+ target device.
+
+ For examples on how to use Qt tools to manage the complete \QMCU application
+ development cycle for a specific target device, see:
\list
\li \l {Infineon Traveo II quick start guide}
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-projects-for-mcus.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-projects-for-mcus.qdoc
index 40995ec84a9..ea8912f12dd 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-projects-for-mcus.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-projects-for-mcus.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\page studio-projects-for-mcus.html
\nextpage studio-creating-uis-for-mcus.html
- \title Creating Projects for MCUs
+ \title Creating projects for MCUs
Use the \uicontrol {\QMCU} preset in the \QDS wizard to set up a new \QMCU
project. When you create a project with the wizard, all the necessary files
@@ -18,9 +18,9 @@
of the default components that you can deploy, run, and debug on MCU boards.
\note For more information on the default components available for MCU
- projects, see \l {Qt Design Studio Features on MCU Projects}.
+ projects, see \l {\QDS features on MCU projects}.
- \section1 Creating an MCU Project
+ \section1 Creating an MCU project
To create an MCU project:
@@ -50,7 +50,7 @@
\li .qml files define the functionality and appearance of application
components.
\li \e Screen01.ui.qml defines a custom component that you can edit in
- the \l {2D} view. For more information, see \l {UI Files}.
+ the \l {2D} view. For more information, see \l {UI files}.
While the custom component is a good starting point for new users,
you don't have to use it. Specifically, if you export and import
@@ -74,12 +74,12 @@
components available for the MCU project.
\endlist
- To use image files in the UI, select \uicontrol Assets > \inlineimage icons/plus.png
+ To use image files in the UI, select \uicontrol Assets > \imageplus
.
\sa {Using Custom Presets}
- \section1 Adding Files to MCU Projects
+ \section1 Adding files to MCU projects
You can use wizard templates to add individual files to projects.
@@ -92,14 +92,14 @@
\table
\header
\li Category
- \li Wizard Template
+ \li Wizard template
\li Purpose
\row
\li {1,5} Qt Quick Files
\row
\li Qt Quick File
\li Generates a component with one of the following default components
- or \l{Using Positioners}{positioners} as the root component:
+ or \l{Using positioners}{positioners} as the root component:
\l {basic-item}{Item}, \l {basic-rectangle}{Rectangle}, \l {Images}
{Image}, \l {Border Image}, \l Flickable, Row, Column, Flow, or
Grid.
@@ -110,7 +110,7 @@
\row
\li Qt Quick Views
\li Generates a List View. For more information, see
- \l{List and Grid Views}.
+ \l{List Views and Grid Views}.
\row
\li Qt Quick UI Form
\li Creates a UI file along with a matching QML file for
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-uis-for-mcus.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-uis-for-mcus.qdoc
index 2d11a07de8d..4032394c387 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-uis-for-mcus.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-creating-uis-for-mcus.qdoc
@@ -1,4 +1,4 @@
-/ Copyright (C) 2023 The Qt Company Ltd.
+/ Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -14,20 +14,20 @@
design from the design tools, and import your 2D UI design assets into \QDS,
which can convert them into code for developers. For more information on
managing the original assets created with specialized UI design tools, see
- \l {Asset Creation with Other Tools}.
+ \l {Asset creation with other tools}.
Once your UI design assets are in \QDS, use it to \l {Wireframing} {wireframe}
your MCU application, to visualize its structure. To modify the look and feel
of your UI further, utilize the preset UI components available in \QDS.
- \section1 Using MCU Components
+ \section1 Using MCU components
With \QDS, you can use subsets of components to create UIs for
devices that are powered by microcontroller units (MCU). The subset of
supported components depends on the \QMCU version that you use for
development.
- To develop for MCUs, \l{Creating Projects for MCUs}{create an MCU project}.
+ To develop for MCUs, \l{Creating projects for MCUs}{create an MCU project}.
Only the components available on MCUs are displayed in \l Components. Also,
only a subset of properties is supported for the supported components. The
properties that are not available on MCUs are marked in the \l Properties
@@ -35,7 +35,7 @@
\image studio-mcu-components-and-properties.webp "Components and Text properties supported for MCUs"
- For more information on the supported views and features, see \l{\QDS Features on MCU Projects}.
+ For more information on the supported views and features, see \l{\QDS features on MCU projects}.
For an example on how to create a UI that runs both on the desktop and
on MCUs, see \l {Washing Machine UI}. For step-by-step instructions on how
@@ -48,5 +48,5 @@
\li \l {Designing a UI for Renesas RH850-D1M1A}
\endlist
- \sa {Specifying Component Properties}
+ \sa {Specifying component properties}, {Qt Design Studio/MCU FAQ}
*/
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-developing-applications-for-mcus.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-developing-applications-for-mcus.qdoc
index 187de26c31e..00f8b6f9ae2 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-developing-applications-for-mcus.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-developing-applications-for-mcus.qdoc
@@ -1,4 +1,4 @@
-/ Copyright (C) 2023 The Qt Company Ltd.
+/ Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,23 +6,24 @@
\previouspage studio-creating-uis-for-mcus.html
\nextpage studio-connecting-mcus-with-creator.html
- \title Developing Applications for MCUs
+ \title Developing applications for MCUs
As a GUI/application developer, use \QDS to bring your designs to life. Add
further functionality to your applications and utilize the \l {Prototyping}
{prototyping} features of \QDS to simulate and validate interactions and
their dynamic behavior.
- You can also test, preview, and fine-tune your designs to pixel-perfection
- live on the desktop or on an actual MCU target device. For more information,
- see \l {Validating with Target Hardware}.
+ With \QDS, designers and developers can work together on common projects to
+ develop applications. As a designer you can use the views in the \e Design
+ mode to modify UI files (.ui.qml). For more information, see
+ \l {Implementing applications}.
\image qds-mcu-target-deployment.png
- With \QDS, designers and developers can work together on common projects to
- develop applications. As a designer you can use the views in the \e Design
- mode to modify UI files (.ui.qml). As a developer you can use Qt Creator to
- work on the Qt Quick (.qml) and other files that are needed to implement the
- application logic and to prepare the application for production. For more
- information, see \l {Implementing Applications}.
+ With Qt Creator, you can test, preview, and fine-tune your designs directly
+ on the desktop or on an actual MCU target device. As a developer you can use
+ Qt Creator to work on the Qt Quick (.qml) and other files that are needed to
+ implement the application logic and to prepare the application for production.
+ For more information on how to use Qt Creator to develop applications for
+ MCUs, see \l {Developing for MCUs} and \l {How To: Develop for MCUs}.
*/
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-features-on-mcu-projects.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-features-on-mcu-projects.qdoc
index b4864debbf8..7d1730a8294 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-features-on-mcu-projects.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-features-on-mcu-projects.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\page studio-features-on-mcu-projects.html
\nextpage studio-projects-for-mcus.html
- \title \QDS Features on MCU Projects
+ \title \QDS features on MCU projects
The table below provides a summary of how the key \QDS features are supported
for developing MCU projects.
@@ -14,63 +14,63 @@
\table
\header
\li View
- \li Fully Supported
- \li Partially Supported
- \li Not Supported
+ \li Fully supported
+ \li Partially supported
+ \li Not supported
\li Comments
\row
\li \l 2D
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li A scene in the \uicontrol 2D view is rendered by the regular Qt Quick
and QML, and not as \QUL and \QMCU, so some imperfections or inaccuracies
can occur. Note that the default font used in \QDS preview and \QUL are
different, and the developer must confirm both fonts are the same.
\row
\li \l 3D
- \li \b -
- \li \b -
- \li \b X
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li Yes
\li The \uicontrol 3D view is not a part of \QUL or \QMCU.
\row
\li \l {Material Editor and Browser}
- \li \b -
- \li \b -
- \li \b X
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li Yes
\li The \uicontrol {Material Editor} and \uicontrol {Material Browser} views
are not a part of \QUL or \QMCU.
\row
\li \l {Components}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li Shows only the components and modules available for MCU projects.
\row
\li \l {Assets}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li Shows all the listed assets in the \c QmlProject file.
\row
\li \l {Navigator}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li Displays the composition of the current component file as a tree
structure.
\row
\li \l {Properties}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li Shows only the preset properties available for MCU projects (such as
by Qt Quick and its modules).
\row
\li \l {Connections}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li The \uicontrol Connections view displays all signal handlers in the
current file, but it doesn't filter available signals, so you can still
see and select signals available in Qt Quick, but not in \QUL.
@@ -79,56 +79,56 @@
to filter available signal/function.
\row
\li \l {States}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li The feature is fully supported, but there are some limitations listed
in \l {\QMCU Known Issues or Limitations}.
In addition, StateGroup is disabled.
\row
\li \l {Transitions}
- \li \b X
- \li \b -
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li \e {None}
\row
\li \l {Translations}
- \li \b -
- \li \b X
- \li \b -
+ \li \e {Not applicable}
+ \li Yes
+ \li \e {Not applicable}
\li The \uicontrol Translations view previews with regular Qt Quick instead
of \QUL, and it can be inaccurate in calculating the text overflow in some translations.
\row
\li \l {Timeline}
- \li \b X
- \li \b -
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li \e {None}
\row
\li \l {Curves}
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li Linear interpolation works, and \QMCU supports the \c easing.bezierCurve property
of a keyframe in \QMCU 2.6 or higher.
\row
\li \l Code
- \li \b X
- \li \b -
- \li \b -
+ \li Yes
+ \li \e {Not applicable}
+ \li \e {Not applicable}
\li The \uicontrol Code view uses regular Qt Quick instead of \QUL, so it may
not show an error if you are using or assigning an unsupported property.
\row
\li \l {Content Library}
- \li \b -
- \li \b -
- \li \b X
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li Yes
\li The \uicontrol {Content Library} view is not a part of \QUL or \QMCU.
\row
\li \l {Texture Editor}
- \li \b -
- \li \b -
- \li \b X
+ \li \e {Not applicable}
+ \li \e {Not applicable}
+ \li Yes
\li The \uicontrol {Texture Editor} view is not a part of \QUL or \QMCU.
\endtable
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-mcu-framework.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-mcu-framework.qdoc
index 0df424505f7..ba67a04ae36 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-mcu-framework.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-mcu-framework.qdoc
@@ -1,4 +1,4 @@
-/ Copyright (C) 2023 The Qt Company Ltd.
+/ Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage studio-on-mcus.html
\nextpage studio-compatibility-with-mcu-sdks.html
- \title \QMCU Framework
+ \title \QMCU framework
\QMCU is a comprehensive framework that supports various hardware ecosystems
and platforms. One of the most important libraries provided by the \QMCU
@@ -17,11 +17,13 @@
In addition to a lightweight graphics framework, \QMCU offers a toolkit that
enables you to design, develop, and deploy graphical user interfaces (GUI)
- on microcontrollers (MCU). Also, it lets you run the applications either
- on BareMetal or a real-time operating system (RTOS).
+ on microcontrollers (MCU). Also, depending on the target device, it lets you
+ run your applications on Bare Metal, Linux, RTOS, or Zephyr® operating
+ systems. For more information on the supported target devices, compilers,
+ and operating systems, see \l {supported MCU target devices}.
- \note In addition to BareMetal and RTOS, you can use the desktop kit to run
- and test the application on desktop without flashing it each time.
+ \note You can also use the desktop kit to run and test your application on
+ desktop without flashing it each time.
For more information on \QMCU, see \l {\QMCU documentation}.
*/
diff --git a/doc/qtdesignstudio/src/mcus/qtdesignstudio-on-mcus.qdoc b/doc/qtdesignstudio/src/mcus/qtdesignstudio-on-mcus.qdoc
index 2db39fb06dd..baf71ae627d 100644
--- a/doc/qtdesignstudio/src/mcus/qtdesignstudio-on-mcus.qdoc
+++ b/doc/qtdesignstudio/src/mcus/qtdesignstudio-on-mcus.qdoc
@@ -1,8 +1,8 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \previouspage creator-editor-external.html
+ \previouspage studio-accessing-output-issues-and-warnings.html
\page studio-on-mcus.html
\nextpage studio-mcu-framework.html
@@ -10,7 +10,7 @@
\table
\row
- \li \image qds-front-gs.png
+ \li \image icons/platform-and-toolchain.png
\li With \QDS, you can use subsets of components to create UIs
for devices that are powered by microcontroller units (MCU). Use
the \uicontrol {\QMCU} preset in the \QDS wizard to set up a new
@@ -20,16 +20,16 @@
\endtable
\list
- \li \l {\QMCU Framework}
+ \li \l {\QMCU framework}
Provides an overview of the \QMCU framework.
\li \l {\QDS Version Compatibility with \QMCU SDKs}
Lists how the \QDS versions match with particular \QMCU SDKs.
- \li \l {\QDS Features on MCU Projects}
+ \li \l {\QDS features on MCU projects}
Specifies how the \QDS features are supported for developing MCU projects.
- \li \l {Creating Projects for MCUs}
+ \li \l {Creating projects for MCUs}
Describes how to use the \QDS wizard and \uicontrol {\QMCU} preset
to set up a new \QMCU project.
diff --git a/doc/qtdesignstudio/src/overviews/qt-design-viewer-navigation.qdoc b/doc/qtdesignstudio/src/overviews/qt-design-viewer-navigation.qdoc
index b1547c3ec73..61a4c378e4a 100644
--- a/doc/qtdesignstudio/src/overviews/qt-design-viewer-navigation.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qt-design-viewer-navigation.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -8,13 +8,13 @@
\nextpage qt-ui-viewer.html
- \title Creating a Single Page Navigation Web Application
+ \title Creating a single page navigation web application
This example explains how you can create a single page navigation web
application suitable to run in Qt Design Viewer. In this project,
you create the structure and navigation for the web application.
- \section1 Setting up the Project
+ \section1 Setting up the project
To set up the project:
\list 1
@@ -26,14 +26,14 @@
\li \uicontrol {Target Version} to 6.2.
\endlist
\li In \uicontrol Navigator:
- \list
+ \list 1
\li Select and delete \e Text.
\li Select \e Rectangle and in \uicontrol Properties, set
\uicontrol {Fill color} to #ffffff.
\endlist
\endlist
- \section1 Adding Components
+ \section1 Adding components
Next, add the needed components to create the structure for your web
application.
@@ -41,13 +41,13 @@
Add the \uicontrol {QtQuick Layouts} module:
\list 1
\li In \uicontrol Components, select
- \inlineimage icons/plus.png
+ \imageplus
\li Select \uicontrol {QtQuick.Layouts}.
\endlist
To add the structure for the web application,
- drag and drop the following components from \uicontrol Components
- to \e rectangle in \uicontrol Navigator.
+ drag the following components from \uicontrol Components
+ to \e rectangle in \uicontrol Navigator:
\list
\li \uicontrol Rectangle
\list
@@ -70,7 +70,7 @@
\image web-navigation-components.png
- \section1 Creating the Pages
+ \section1 Creating the pages
Next, create the separate pages for your web application. In this example,
you create pages for \e Home, \e {About Us}, and \e {Contact Us}.
@@ -95,7 +95,7 @@
\list
\li Set \uicontrol Size > \uicontrol H to 1024.
\li Next to \uicontrol Size > \uicontrol W, select
- \inlineimage icons/action-icon.png
+ \imageactionicon
and select \uicontrol Reset.
\endlist
@@ -132,7 +132,7 @@ You can see the pages you created under \uicontrol {My Components} in the
\image web-navigation-page-components.png
-\section1 Organizing the Pages
+\section1 Organizing the pages
To organize the pages vertically:
@@ -143,14 +143,14 @@ To organize the pages vertically:
\li Select \e columnLayout in Navigator and in \uicontrol Properties:
\list
\li Next to \uicontrol Size > \uicontrol W and \uicontrol Size >
- \uicontrol H, select \inlineimage icons/action-icon.png
+ \uicontrol H, select \imageactionicon
and select \uicontrol Reset.
\li Set \uicontrol {Column Spacing} to 0.
\endlist
\li Select \e flickable in \uicontrol Navigator, and in \uicontrol Properties:
\list
\li Next to \uicontrol Size > \uicontrol W and \uicontrol Size >
- \uicontrol H, select \inlineimage icons/action-icon.png
+ \uicontrol H, select \imageactionicon
and select \uicontrol Reset.
\li Set \uicontrol {Content size} > \uicontrol H to 3072.
\li On the \uicontrol Layout tab, select
@@ -181,12 +181,12 @@ code inside the \e Flickable component:
\endcode
To align the scrollbar to the right and bottom side of the window, set the height and width of the
-main rectangle so that it adapts to the window size.
+main rectangle so that it adapts to the window size:
\list 1
\li In \uicontrol Navigator, select \e Rectangle.
\li In \uicontrol Properties, select
- \inlineimage icons/action-icon-binding.png
+ \imageactioniconbinding
next to \uicontrol Width and select \uicontrol {Set Binding}.
\li Enter \c {Window.width}
\image web-navigation-size-binding.png
@@ -194,7 +194,7 @@ main rectangle so that it adapts to the window size.
\c {Window.height}.
\endlist
-\section1 Creating the Navigation
+\section1 Creating the navigation
The final step is to create the navigation for the web page. To do this, use the buttons
that you created earlier.
@@ -213,7 +213,7 @@ First, create an animation to use when scrolling between the different pages:
\endlist
Next, connect the buttons to the number animation to scroll the content
-vertically to the correct place.
+vertically to the correct place:
\list 1
\li In \uicontrol Navigator, select \e rectangle and in \uicontrol Properties
@@ -223,7 +223,7 @@ vertically to the correct place.
\li \uicontrol {Fill color} to #e0e0e0.
\li \uicontrol {Z stack} to 1.
\endlist
- \li Select \inlineimage icons/action-icon-binding.png
+ \li Select \imageactioniconbinding
next to \uicontrol Width and select \uicontrol {Set Binding}.
\li Enter \c {parent.width}.
\image web-navigation-size-binding-2.png
diff --git a/doc/qtdesignstudio/src/overviews/qt-design-viewer.qdoc b/doc/qtdesignstudio/src/overviews/qt-design-viewer.qdoc
index 88dbe9e00a1..e3f4c9f3926 100644
--- a/doc/qtdesignstudio/src/overviews/qt-design-viewer.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qt-design-viewer.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2019 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage creator-live-preview-devices.html
\nextpage design-viewer-single-page-navigation.html
- \title Sharing Applications Online
+ \title Sharing applications online
\image qt-design-viewer.webp
@@ -24,7 +24,7 @@
The loaded applications remain locally in your browser. No data is uploaded
into the cloud.
- \section1 Sharing your Application Online
+ \section1 Sharing your application online
To share your \QDS application online:
@@ -45,7 +45,7 @@
\image share-online-manage.webp
- \section1 Best Practices
+ \section1 Best practices
- \l {Creating a Single Page Navigation Web Application}
+ \l {Creating a single page navigation web application}
*/
diff --git a/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc b/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc
index aea873fd9c4..8b12650e230 100644
--- a/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc
@@ -6,7 +6,7 @@
\previouspage qtquick-creating-ui-logic.html
\nextpage qtquick-placeholder-data.html
- \title Simulating Complex Experiences
+ \title Simulating complex experiences
\QDS enables you to connect UIs to different forms of data from various
sources, such as QML-based data models, JavaScript files, and backend
@@ -15,23 +15,23 @@
\list
- \li \l{Loading Placeholder Data}
+ \li \l{Loading placeholder data}
You can create QML files that contain placeholder data, so that
you can test grid, list, or path views, even though you don't
have access to real data.
- \li \l{Simulating Application Logic}
+ \li \l{Simulating application logic}
You can use JavaScript to generate mock data for your UI.
- \li \l{Simulating Dynamic Systems}
+ \li \l{Simulating dynamic systems}
Use the Simulink connector to connect a Simulink Simulation Model to
your UI. Simulink is a MATLAB-based graphical programming environment
for modeling, simulating, and analyzing multi-domain dynamic systems.
- \li \l{Using QML Modules with Plugins}
+ \li \l{Using QML modules with plugins}
You can load C++ plugins for QML to simulate data.
\endlist
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc
index e6ae0295788..7e09578307f 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc
@@ -6,7 +6,7 @@
\previouspage qtquick-motion-design.html
\nextpage studio-timeline.html
- \title Introduction to Animation Techniques
+ \title Introduction to animation techniques
\image timeline-rotation-animation.gif "Timeline animation of rotation and opacity"
@@ -19,7 +19,7 @@
\li Data-driven UI logic animations
\endlist
- \section1 Common Motion Design Techniques
+ \section1 Common motion design techniques
The following table summarizes common motion design techniques for 2D and
3D and their typical use cases.
@@ -27,13 +27,13 @@
\table
\header
\li Technique
- \li Use Case
+ \li Use case
\row
\li \l{Timeline}{Timeline animation}
\li Linear interpolation through intermediate values at specified
keyframes instead of immediately changing to the target value.
\row
- \li \l{Editing Easing Curves}{Easing curves} attached to keyframes
+ \li \l{Editing easing curves}{Easing curves} attached to keyframes
\li Nonlinear interpolation between keyframes to make components
appear to pick up speed, slow down, or bounce back at the end
of the animation.
@@ -44,7 +44,7 @@
simultaneously.
\endtable
- \section2 Timeline and Keyframe Based Animation
+ \section2 Timeline and keyframe based animation
Timeline animation is based on \e keyframes. In \QDS, keyframes determine the
value of the property of a \l{glossary_component}{component} at a certain
@@ -57,7 +57,7 @@
In the middle of the animation, the y property has the value of 50 since
keyframes are interpolated linearly by default.
- \section2 Easing Curves
+ \section2 Easing curves
Sometimes you don't want linear movement but would rather like the rectangle
to move faster at the beginning and slower at the end of the animation. To
@@ -67,7 +67,7 @@
easing curves can make components appear to pick up speed, slow down, or
bounce back at the end of the animation.
- \section2 Animation Curves
+ \section2 Animation curves
While easing curves work well for most simple UI animations, more complex
3D animations require several keyframes, so it becomes necessary to visualize
@@ -78,13 +78,13 @@
simultaneously so that you can see the animation for the x position
and the animation for the y position side-by-side.
- \section1 State-to-State Animations
+ \section1 State-to-state animations
To navigate between UI states, use transitions between different states of the UI
using a transition timeline that is based on keyframes. You can apply easing
curves to the keyframes.
- \section2 Transitions Between States
+ \section2 Transitions between states
UIs are designed to present different UI configurations in different
scenarios, or to modify their appearances in response to user
@@ -118,10 +118,10 @@
In \l {Transitions}, you can set the start frame, end frame,
and duration for the transition of each property. You can also set
- an \l{Editing Easing Curves}{easing curve} for each animation and
+ an \l{Editing easing curves}{easing curve} for each animation and
the maximum duration of the whole transition.
- \section1 Data-Driven UI Logic Animations
+ \section1 Data-driven UI logic animations
The following table summarizes techniques used for animating the UI logic
by using real or mock data from a backend.
@@ -129,7 +129,7 @@
\table
\header
\li Technique
- \li Use Case
+ \li Use case
\row
\li Data-driven timeline animation
\li Using real or mock data from a backend to control motion.
@@ -139,7 +139,7 @@
transitions.
\endtable
- \section2 Data-Driven Timeline Animation
+ \section2 Data-driven timeline animation
You can connect property values to data backends to drive timeline
animation. You can fetch data from various sources, such as data models,
@@ -156,7 +156,7 @@
For more information, see \l{Simulating Complex Experiences}.
- \section2 Programmatic Animation
+ \section2 Programmatic animation
You can control property animation programmatically. Property animations
are created by binding \uicontrol Animation components to property
@@ -180,7 +180,7 @@
\table
\header
\li Component
- \li Use Case
+ \li Use case
\row
\li \uicontrol {Property Animation}
\li Applying animation when the value of a property changes. Color
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc
index ee21695251c..3f2d3f2a27c 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc
@@ -6,7 +6,7 @@
\previouspage qtquick-positioning.html
\nextpage qtquick-prototyping.html
- \title Annotating Designs
+ \title Annotating designs
You can submit your designs to review or further development as QML files.
You can annotate your designs to provide reviewers or developers with
@@ -50,10 +50,10 @@
\li Select \uicontrol OK.
\endlist
- To add more comments about the component, select the \inlineimage icons/plus.png
+ To add more comments about the component, select the \imageplus
(\uicontrol {Add Comment}) button.
- To remove the active comment, select the \inlineimage icons/minus.png
+ To remove the active comment, select the \imageminus
(\uicontrol {Remove Comment}) button. To remove the annotation, right-click
the annotation icon, and then select \uicontrol {Remove Annotation}.
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc
index 1ea19bac4b7..b77fabc1ce9 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage qtquick-prototyping.html
\nextpage studio-simulation-overview.html
- \title Creating UI Logic
+ \title Creating UI logic
Turn your wireframe into an interactive prototype by adding UI logic that
enables your components to apply actions or react to mock data from backend
@@ -23,7 +23,7 @@
components by emitting a signal that indicates a change in the value.
To reference a property of a component from another component, you can
- create \l{Adding Property Aliases}{property aliases} that hold a reference
+ create \l{Adding property aliases}{property aliases} that hold a reference
to another property. Unlike an ordinary property definition, which
allocates a new, unique storage space for the property, a property
alias connects the newly declared property (called the
@@ -32,13 +32,13 @@
exported as a public property of the relevant component. For example,
a speedometer should have a property for speed to which the UI is bound.
- You can declare various \l{Working with States}{UI states} that describe how
+ You can declare various \l{Working with states}{UI states} that describe how
property values change from a base state. States can be a useful way of
organizing your UI logic. You can associate transitions with components
to define how their properties will animate when they change due to a
state change.
- The \l{Log In UI - States} example illustrates using states to create
+ The \l{Login UI: States} tutorial illustrates using states to create
two UI screens and signals emitted by buttons to apply the states.
The button components also switch states when they are pressed down.
@@ -50,7 +50,7 @@
component types. This reduces the loading and compilation time as well as
the package size of the final application.
- The preset \l{UI Controls}{UI controls} have default properties and states
+ The preset \l{UI controls} have default properties and states
that you can modify. If you need additional properties, you can turn
instances of the controls into custom components and specify new properties
for them.
@@ -77,38 +77,38 @@
\table
\header
- \li To Learn About
- \li Go To
+ \li To learn about
+ \li Go to
\row
\li Responding to application events
- \li \l{Connecting Components to Signals}
+ \li \l{Connecting components to signals}
\row
\li Formatting connections
- \li \l{Actions and Conditions}
+ \li \l{Actions and conditions}
\row
\li Dynamically changing the behavior of a component
- \li \l{Adding Bindings Between Properties}
+ \li \l{Adding bindings between properties}
\row
\li Formatting property bindings
- \li \l{Setting Bindings}
+ \li \l{Setting bindings}
\row
\li Referencing a property of a component from another component
- \li \l{Adding Property Aliases}
+ \li \l{Adding property aliases}
\row
\li Referencing a state from within a specific component
- \li \l{Working with States}
+ \li \l{Working with states}
\row
\li Switching to a state when a particular property changes
- \li \l{Applying States}
+ \li \l{Applying states}
\row
\li Using preset UI controls that have default properties and states
- \li \l{UI Controls}
+ \li \l{UI controls}
\row
\li Creating conditional conditions
\li \l{Logic Helpers}
\row
\li Adding custom properties for a particular component type
- \li \l{Specifying Custom Properties}
+ \li \l{Specifying custom properties}
\omit
\row
\li Adding properties for controlling states
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc
index f083f85f8e4..bd01ba56d7b 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc
@@ -4,16 +4,16 @@
/*!
\page creator-exporting-qml.html
\previouspage studio-importing-3d.html
- \nextpage qt-using-effect-maker-effects.html
+ \nextpage sharing-assets.html
- \title Exporting Components
+ \title Exporting components
\note In this section, you are using advanced menu items. These are not
visible by default. To toggle the visibility of advanced menu items, see
\l{Customizing the Menu Bar}.
- \l{glossary-component}{Components} contained in \l{UI Files}
- {UI files} (.ui.qml) can be exported to JSON metadata format and PNG assets.
+ \l{glossary-component}{Components} contained in \l{UI files} (.ui.qml)
+ can be exported to JSON metadata format and PNG assets.
To export the UI files from the current project, select \uicontrol Build >
\uicontrol {Export Components}.
@@ -33,13 +33,15 @@
components generate assets as PNG files.
\endlist
- \section1 Configuring QML Export
+ \section1 Configuring the QML export
You can configure the export in the \uicontrol {Export Components} dialog,
which lists the UI files (.ui.qml) of the current project.
\image qtquick-qml-export-dialog.png "Export Components dialog"
+ To configure the export:
+
\list 1
\li In the \uicontrol {Export path} field, specify the path where
the metadata file and assets are exported.
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc
index d2f6745df5e..2929f5d6cd6 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc
@@ -6,7 +6,7 @@
\previouspage studio-importing-2d.html
\nextpage studio-importing-3d.html
- \title Using Custom Fonts
+ \title Using custom fonts
For your UI to use custom fonts when you preview it on a device,
you have to import the fonts to the project folder. \QDS deploys them to
@@ -19,7 +19,7 @@
\list 1
\li Select \uicontrol Assets
- > \inlineimage icons/plus.png
+ > \imageplus
.
\li Browse to the folder that contains the font files and select them,
and then select \uicontrol Open.
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-live-preview.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-live-preview.qdoc
index d286c41c7a1..eabfe99bc6b 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-live-preview.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-live-preview.qdoc
@@ -6,7 +6,7 @@
\previouspage quick-states.html
\nextpage studio-live-preview-desktop.html
- \title Validating with Target Hardware
+ \title Validating with target hardware
Preview a UI file or the entire UI on the desktop, as well as on embedded
Linux devices to instantly view the changes you make to the UI. On Android
@@ -20,18 +20,18 @@
don't have \QC.
\list
- \li \l{Previewing on Desktop}
+ \li \l{Previewing on desktop}
Preview individual QML files or the whole UI.
- \li \l{Previewing on Devices}
+ \li \l{Previewing on devices}
Connect your devices to your computer.
- \li \l{Sharing Applications Online}
+ \li \l{Sharing applications online}
Share applications online and view them in a web browser.
- \li \l{Viewing Applications on Android}
+ \li \l{Viewing applications on Android}
Preview \QDS projects with \QUV on an Android device.
\endlist
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc
index 80e0a844507..611dd4b1969 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc
@@ -3,7 +3,7 @@
/*!
\page qtquick-motion-design.html
- \previouspage qt-using-effect-maker-effects.html
+ \previouspage sharing-assets.html
\nextpage quick-animation-overview.html
\title Motion Design
@@ -19,29 +19,29 @@
\endtable
\list
- \li \l {Introduction to Animation Techniques}
+ \li \l {Introduction to animation techniques}
Learn more about which animation techniques are supported by \QDS
and the use cases they are most suitable for.
- \li \l {Creating Timeline Animations}
+ \li \l {Creating timeline animations}
You can use a timeline and keyframe based editor in the
\l Timeline view to animate the properties of UI
components. Animating properties enables their values to
move through intermediate values at specified keyframes
instead of immediately changing to the target value.
- \li \l{Editing Easing Curves}
+ \li \l{Editing easing curves}
Specify easing curves for nonlinear interpolation between
keyframes in timeline animations, as well as between original
and new property values in property animations and between
transitions.
- \li \l {Production Quality}
+ \li \l {Production quality}
After the wireframing and prototyping phases, you can use previewing
and profiling tools to fine-tune your UI for production.
- \li \l{Optimizing Designs}
+ \li \l{Optimizing designs}
You can test your UIs on the target devices to make sure you get
the best performance out of your animations. To solve performance
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc
index 937362450b4..f00018846bf 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,27 +6,27 @@
\previouspage qtquick-production-quality-animation.html
\nextpage studio-optimized-3d-scenes.html
- \title Optimizing Designs
+ \title Optimizing designs
You can test your UIs on the target devices to make sure you get the best
performance out of your animations. To solve performance problems, you
typically need to optimize the graphical assets used in the UI, such as
images, effects, or 3D scenes.
- How to optimize UIs for different target devices:
+ To optimize UIs for different target devices:
\list
- \li Minimize image size
- \li Use transparency sparingly
+ \li Minimize image size.
+ \li Use transparency sparingly.
\endlist
For more useful information for application developers, see
\l {QML Performance Considerations And Suggestions}.
For more information about optimizing 3D scenes, see
- \l{Creating Optimized 3D Scenes}.
+ \l{Creating optimized 3D scenes}.
- \section1 Minimizing Image Size
+ \section1 Minimizing image size
Images are a vital part of any user interface. Unfortunately, they are also
a big source of problems due to the time it takes to load them, the amount
@@ -38,7 +38,7 @@
For more information about how to use images efficiently in your UI, see
\l{Images}.
- \section1 Avoid Transparency
+ \section1 Avoiding transparency
Opaque content is generally a lot faster to draw than transparent because
the latter needs blending and the renderer can potentially optimize opaque
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc
index 033b0a135d8..58273d298cb 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc
@@ -6,7 +6,7 @@
\previouspage studio-simulation-overview.html
\nextpage studio-javascript.html
- \title Loading Placeholder Data
+ \title Loading placeholder data
\QDS supports views, models, and delegates, so that when you add
a Grid View, List View, or Path View component, the ListModel and
@@ -18,7 +18,7 @@
or in other component files. A typical example is a component that uses the
properties of its parent, such as \c parent.width.
- \section1 Using Dummy Models
+ \section1 Using dummy models
If you open a file in the \l {2D} view that references a C++ model, you see
nothing in it. If the data in the model is fetched from the
@@ -64,7 +64,7 @@
}
\endqml
- \section1 Creating Dummy Context
+ \section1 Creating dummy context
The following example presents a common pattern:
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc
index 068a7c140bc..23e6cc68a70 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc
@@ -6,7 +6,7 @@
\previouspage qtquick-editing-easing-curves.html
\nextpage qtquick-optimizing-designs.html
- \title Production Quality
+ \title Production quality
After the wireframing and prototyping phases, you can use previewing and
profiling tools to fine-tune your UI for production.
@@ -19,7 +19,7 @@
and stuttering.
\endlist
- \section1 FPS Refresh Rate
+ \section1 FPS refresh rate
As a general rule, animators strive to allow the rendering engine to
achieve a consistent 60 frames-per-second (FPS) refresh rate. 60 FPS
@@ -43,11 +43,11 @@
\endlist
For more information about previewing UIs on devices, see
- \l{Validating with Target Hardware}.
+ \l{Validating with target hardware}.
- \section1 Profiling UI Code
+ \section1 Profiling UI code
- You can use \l{Profiling QML Applications}{QML Profiler} that is integrated
+ You can use \l{Profiling QML applications}{QML Profiler} that is integrated
into \QDS to find causes for typical performance problems in your UI. For
example, your UI might be slow, unresponsive, or stuttering. Typically, such
problems are caused by executing too much JavaScript in too few frames. All
@@ -65,5 +65,5 @@
to optimize code without profiling is likely to result in very minor rather
than significant performance improvements.
- For more information, see \l{Profiling QML Applications}.
+ For more information, see \l{Profiling QML applications}.
*/
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc
index af936f1507f..ea9cc8da1e2 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc
@@ -24,13 +24,13 @@
\list
- \li \l {Creating UI Logic}
+ \li \l {Creating UI logic}
You can turn your wireframe into an interactive prototype by
adding the logic that enables your components to apply actions
or react to mock data from backend systems to simulate complex
experiences.
- \li \l{Simulating Complex Experiences}
+ \li \l{Simulating complex experiences}
You can connect UIs to different forms of data from various
sources, such as QML-based data models, JavaScript files, and
@@ -38,20 +38,20 @@
You can also connect your UI to Simulink to load live data from
a Simulink simulation.
- \li \l {Dynamic Behaviors}
+ \li \l {Dynamic behaviors}
You can create connections between components to enable them to
communicate with each other. The connections can be triggered by
changes in component property values or in UI states.
- \li \l {Validating with Target Hardware}
+ \li \l {Validating with target hardware}
You can use the live preview feature to preview a UI file or the
entire UI on the desktop, as well as on Android and embedded Linux
devices. The changes you make to the UI are instantly visible
to you in the preview.
- \li \l {Asset Creation with Other Tools}
+ \li \l {Asset creation with other tools}
Describes how to export designs containing 2D and 3D assets into
files that you can import to projects in \QDS, how to import them,
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
index 74063602795..7273f55ce50 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
@@ -38,7 +38,7 @@
the developer documentation by pressing \key F1.
\list
- \li \l {Using Components}
+ \li \l {Using components}
\QDS comes with \e {preset components} that you can use in
wireframes and prototypes by creating instances of them.
@@ -46,7 +46,7 @@
of the component instances and combine them. You can import
designs and assets from other tools as components.
- \li \l {Specifying Component Properties}
+ \li \l {Specifying component properties}
You can specify values for the properties of a component to change
its appearance and behavior. All components have a set of predefined
@@ -55,7 +55,7 @@
component. You can specify values for properties of component
instances in the \l Properties view.
- \li \l {Scalable Layouts}
+ \li \l {Scalable layouts}
The position of a component in a UI can be either absolute
or relative to other components. While manual positioning
@@ -63,7 +63,7 @@
methods, such as anchors, layouts, positioners, and property
bindings, for dynamic UIs.
- \li \l {Annotating Designs}
+ \li \l {Annotating designs}
You can annotate your designs to provide reviewers or developers
with additional information about them.
diff --git a/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc b/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc
index 22803b36f81..da703f7ec59 100644
--- a/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc
+++ b/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc
@@ -6,7 +6,7 @@
\previouspage studio-user-feedback.html
\nextpage studio-packaging.html
- \title Reporting Crashes
+ \title Reporting crashes
You can enable \QDS to report crashes automatically. \QDS uses Google
Crashpad to collect crashes and report them to the Sentry backend storage
diff --git a/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc b/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc
index 5feddcd2c97..f0546ae49c2 100644
--- a/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc
+++ b/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc
@@ -6,7 +6,7 @@
\previouspage collecting-usage-statistics.html
\nextpage studio-crashpad.html
- \title Collecting User Feedback
+ \title Collecting user feedback
A pop-up survey asking for your feedback will appear for some of the features
after you have been using them for some time. You will be asked to to rate
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
index e94d8700bc6..3cf03e85c9d 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ai.qdoc
@@ -6,7 +6,7 @@
\page qtbridge-ai.html
\nextpage psqtbridge.html
- \title Exporting Designs from Adobe Illustrator
+ \title Exporting designs from Adobe Illustrator
Even though \QDS does not provide a specific export bridge for Adobe
Illustrator, you can design UIs in it and export your designs to \QDS in
@@ -20,9 +20,9 @@
assets into formats supported by \QDS, such as PNG and JPEG.
\endlist
- \section1 Placing Illustrator Content into Photoshop
+ \section1 Placing the Illustrator content into Photoshop
- You can place Illustrator content into Photoshop in several ways. If you
+ You can place the Illustrator content into Photoshop in several ways. If you
select \uicontrol File > \uicontrol {Place linked} in Illustrator, the
content updates automatically. However, the whole file content is placed
on a single Photoshop layer, which means that you cannot use \QBPS to
@@ -39,9 +39,9 @@
smart objects, see the Illustrator and Photoshop documentation.
For more information about exporting designs from Photoshop, see
- \l{Exporting Designs from Adobe Photoshop}.
+ \l{Exporting designs from Adobe Photoshop}.
- \section1 Exporting Assets for Screens
+ \section1 Exporting assets for screens
Sometimes it is easier to just export layers and artboards from Illustrator
and to create scalable layouts and UI flows in \QDS. You can export assets
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-overview.qdoc
index 798ca9551c6..f93808d2619 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-overview.qdoc
@@ -8,7 +8,7 @@
\page figmaqtbridge.html
\nextpage qtbridge-figma-setup.html
- \title Exporting Designs from Figma
+ \title Exporting designs from Figma
You can use \QBF to export designs from Figma to a \e {.qtbridge}
archive that you can \l{Importing 2D Assets}{import} to projects in \QDS.
@@ -19,7 +19,7 @@
\list
- \li \l{Setting Up Qt Bridge for Figma}
+ \li \l{Setting up Qt Bridge for Figma}
You must install Figma and the \QBF export tool before you can use
the tool to export designs.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-setup.qdoc
index 00e9586df25..cb635e2ad73 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-setup.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-setup.qdoc
@@ -6,7 +6,7 @@
\page qtbridge-figma-setup.html
\nextpage qtbridge-figma-using.html
- \title Setting Up \QBF
+ \title Setting up \QBF
\note \QBF is included in the
\l{https://www.qt.io/pricing}{\QDS Enterprise license}.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-template.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-template.qdoc
index 29b161562db..f0cc8d8bab9 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-template.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-template.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2023 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\page qtbridge-figma-template.html
\nextpage exporting-3d-assets.html
- \title Using Figma Quick Control Template Components in \QDS
+ \title Using the Figma Quick Control Template components in \QDS
You can design with the template components created by \QDS in Figma
and import them to \QDS with \QBF. These template components are structured
@@ -14,7 +14,7 @@
\QBF, they generate functional QML components for \QDS. So, you can edit components both in
\QDS and Figma.
- \section1 Using Figma Template Components
+ \section1 Using the Figma Template components
You should have these prerequisites available:
\list
@@ -27,11 +27,11 @@
for that.
\endlist
- \section2 Creating Figma Design with Template Components
+ \section2 Creating a Figma design with the Template components
\list 1
\li Sign in to Figma.
- \li Go to the Template provided by \QDS team
+ \li Go to the Template provided by the \QDS team
\externallink {https://www.figma.com/community/file/1185200043286168239}{here}.
\li Select \uicontrol {Get a copy} and then your account to have a copy
on your Figma workspace.
@@ -59,7 +59,7 @@
Toggle them active to use in a project.
\endlist
- \section2 Importing the Figma Design to \QDS with \QBF
+ \section2 Importing the Figma design to \QDS with \QBF
\list 1
\li In Figma, do one of the following:
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc
index 3c58268c60a..2559a9a3f67 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc
@@ -8,7 +8,7 @@
\title Using \QBF
- \section1 Organizing Designs
+ \section1 Organizing designs
To get the best results during export and import, follow these guidelines
when working with Figma:
@@ -46,9 +46,9 @@
To use the fonts that you use in Figma also in \QDS, you need to add
them to \QDS as assets. \QDS deploys them to devices when you preview the
- UI. For more information, see \l{Using Custom Fonts}.
+ UI. For more information, see \l{Using custom fonts}.
- \section2 Items You Can Export
+ \section2 Items you can export
You can export the following parts of your design using \QBF:
\list
@@ -65,27 +65,27 @@
\li Groups
\endlist
- \section2 Using Frames
+ \section2 Using frames
Frames are exported as components of the \l Rectangle type by default.
However, if you have applied effects to the frames that \QBF cannot
handle, such as gradient fill colors or a mixed radius, the frames are
exported as images.
- \section2 Using Variables
+ \section2 Using variables
With \QDS 4.6, variables are exported as a QML module named \e DesignSystem. A QML singleton
is created for each collection. Modes of the collection are exported as theme objects.
A collection has a \e currentTheme property, updating the property changes the active theme.
-
+
When a variable is bound to a property of a layer, the \e DesignSystem module import
is added to the generated code and the property binding is created accordingly.
-
+
To export variables, select \uicontrol {Export Variables} from \l{Settings}.
\note Remote variables are not supported. Setting the active mode on the page or
layer does not affect the generated code.
-
- \section2 Using Variants
+
+ \section2 Using variants
Figma variants are exported as a component with states. All variants
inside a \e component-set are merged together and the differences across
the variants are translated into states.
@@ -103,7 +103,7 @@
encouraged to create the variant differences.
\endlist
- \section1 Exporting Designs
+ \section1 Exporting designs
\image qt-figma-bridge.png "Qt Bridge for Figma"
@@ -118,7 +118,7 @@
\QBF exports everything into a .qtbridge archive. You can import the archive
into a project in \QDS, as described in \l{Importing 2D Assets}.
- \section1 Export Settings
+ \section1 Export settings
You can specify export settings in the \uicontrol Home tab and in the
\uicontrol Settings tab.
@@ -139,7 +139,7 @@
to avoid duplicate IDs when the layer and the respective artwork
are imported into \QDS.
\note Once the ID is edited, the automatic assignment of ID from
- layer name stops for this layer. Use \inlineimage figma-binding-reset.png
+ layer name stops for this layer. Use \imagefigmabindingreset
button next to \uicontrol ID to reset the ID back to automatic assignment.
\row
\li \uicontrol {Export as}
@@ -159,7 +159,7 @@
into one component.
\li \uicontrol Skipped completely skips the selected layer.
\endlist
- \note Use \inlineimage figma-binding-reset.png button next to
+ \note Use \imagefigmabindingreset button next to
\uicontrol {Export as} to reset to default value.
\row
\li \uicontrol {Custom Component Type}
@@ -212,8 +212,8 @@
onVisibleChanged: console.log(original_Text.visible)
}
\endcode
- \note The code must have a scope of a component(e.g. Item, MouseArea,
- Connections etc.) with a valid syntax for \l {UI Files}.
+ \note The code must have a scope of a component (such as Item, MouseArea,
+ Connections) with a valid syntax for \l {UI files}.
\note Add respective imports for your snippet in \uicontrol {Imports}.
\row
\li \uicontrol Alias
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
index 7c62a994f8a..2d937ee2783 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-overview.qdoc
@@ -6,10 +6,10 @@
\page qtbridge-overview.html
\nextpage qtbridge-ai.html
- \title Exporting from Design Tools
+ \title Exporting from design tools
When working with 2D assets, you can use \QB to export them from design
- tools into a metadata format that you can then \l{Importing Designs}{import}
+ tools into a metadata format that you can then \l{Importing designs}{import}
into \QDS.
When working with 3D assets, you can use the export functions provided by
@@ -19,39 +19,39 @@
For best results when importing assets, follow
the guidelines for creating and exporting them.
- \section1 2D Assets
+ \section1 2D assets
You can use \QOI to install \QB if you have a
\QDS enterprise license.
\table
\row
- \li \inlineimage ai-logo.png
- \li \inlineimage ps-logo.png
- \li \inlineimage xd-logo.png
- \li \inlineimage sketch-logo.png
- \li \inlineimage figma-logo.png
+ \li \imageailogo
+ \li \imagepslogo
+ \li \imagexdlogo
+ \li \imagesketchlogo
+ \li \imagefigmalogo
\row
- \li \l{Exporting Designs from Adobe Illustrator}{Adobe Illustrator}
- \li \l{Exporting Designs from Adobe Photoshop}{Adobe Photoshop}
- \li \l{Exporting Designs from Adobe XD}{Adobe XD}
- \li \l{Exporting Designs from Sketch}{Sketch}
- \li \l{Exporting Designs from Figma}{Figma}
+ \li \l{Exporting designs from Adobe Illustrator}{Adobe Illustrator}
+ \li \l{Exporting designs from Adobe Photoshop}{Adobe Photoshop}
+ \li \l{Exporting designs from Adobe XD}{Adobe XD}
+ \li \l{Exporting designs from Sketch}{Sketch}
+ \li \l{Exporting designs from Figma}{Figma}
\endtable
- \section1 3D Assets
+ \section1 3D assets
You can import files you created using 3D graphics applications and
stored in several widely-used formats, such as .blend, .dae, .fbx,
.glb, .gltf, .obj, .uia, or .uip.
- For an overview, see \l{Exporting 3D Assets}.
+ For an overview, see \l{Exporting 3D assets}.
\table
\row
- \li \inlineimage blender-logo.png
- \li \inlineimage maya-logo.png
- \li \inlineimage qt-3ds-logo.png
+ \li \imageblenderlogo
+ \li \imagemayalogo
+ \li \imageqt3dslogo
\row
\li \l{Exporting from Blender}{Blender}
\li \l{Exporting from Maya}{Maya}
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
index 11747b6dab2..80c41467290 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-overview.qdoc
@@ -8,7 +8,7 @@
\page psqtbridge.html
\nextpage qtbridge-ps-setup.html
- \title Exporting Designs from Adobe Photoshop
+ \title Exporting designs from Adobe Photoshop
You can use \QBPS to export designs from Adobe Photoshop to \e {.metadata}
format that you can \l{Importing 2D Assets}{import} to projects in \QDS.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc
index 864e12c9e47..3b27cc9f0c1 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-setup.qdoc
@@ -6,7 +6,7 @@
\page qtbridge-ps-setup.html
\nextpage qtbridge-ps-using.html
- \title Setting Up \QBPS
+ \title Setting up \QBPS
\QBPS is included in the
\l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}.
@@ -67,7 +67,7 @@
\note On \macos \QBPS fails to load when Adobe Photoshop runs natively on an ARM
processor (Apple silicon). For more information, see \l {Running \QBPS on Apple Silicon}.
- \section1 Enabling Remote Connections
+ \section1 Enabling remote connections
To set up \QBPS:
@@ -94,7 +94,7 @@
\note
- \section1 Running \QBPS on Apple Silicon
+ \section1 Running \QBPS on Apple silicon
If you are using \macos on an ARM processor (Apple silicon), \QBPS may not be listed
in Adobe Photoshop under \uicontrol Window > \uicontrol {Extensions (Legacy)}.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
index ed046b416fc..f6d78347464 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc
@@ -8,7 +8,7 @@
\title Using \QBPS
- \section1 Organizing Assets
+ \section1 Organizing assets
To get the best results when you use \QBPS to export designs from Adobe
Photoshop for importing them to \QDS, follow these guidelines when working
@@ -26,13 +26,13 @@
To use the fonts that you use in Photoshop also in \QDS, you need to load
them to \QDS. \QDS deploys them to devices when you preview the UI. For more
- information, see \l{Using Custom Fonts}.
+ information, see \l{Using custom fonts}.
\note You can export only files that are saved in the Photoshop file format,
such as \e {.psd} and \e {.psb}. For all other document formats, \QDS
displays the following error message: \e {Document is not supported.}
- \section2 Items You Can Export
+ \section2 Items you can export
You can export the following parts of your design using \QBPS:
\list
@@ -48,14 +48,14 @@
\li Frames
\endlist
- \section2 Using Artboards
+ \section2 Using artboards
The relationships between the groups and layers on an artboard are preserved
when you export designs from Adobe Photoshop and import them into \QDS.
When you use \QBPS to export your designs, you will determine how you want
each group or layer exported: as a \e component or \e child. A component
- will be imported as a single \l {UI Files}{UI file} that can contain other
+ will be imported as a single \l {UI files}{UI file} that can contain other
assets. A child will be imported as a single image file that you can use
within UI files.
@@ -88,7 +88,7 @@
\QB imports the control as a custom component that you can program in
\QDS.
- \section1 Exporting Assets
+ \section1 Exporting assets
Each artboard is exported automatically as a component, which means that it
will be imported as a separate file that contains all the artwork on the
@@ -135,7 +135,7 @@
\image qt-bridge.png
- \section2 Specifying Settings for Exporting Assets
+ \section2 Specifying settings for exporting assets
To export your design using \QBPS:
@@ -212,7 +212,7 @@
\li Select \uicontrol {Cascade properties} to apply the current set of
properties to all the children of the selected layer.
\li In the \uicontrol Annotations field, specify annotation for the
- component. See \l {Annotating Designs}.
+ component. See \l {Annotating designs}.
\li Select \uicontrol Export to copy your assets to the export path you
specified.
\li When the exporting is done, select \uicontrol OK.
@@ -222,7 +222,7 @@
might take a little while depending on the complexity of your project.
You can now create a project in \QDS and import the assets to it, as
- described in \l {Creating Projects} and \l{Importing Designs}.
+ described in \l {Creating projects} and \l{Importing designs}.
\note
Exporting your design using \QBPS can be slow for documents with large number
@@ -240,7 +240,7 @@
\image qt-bridge-qml-id-settings.png
- \section1 Cloning Documents
+ \section1 Cloning documents
\QBPS enables creating a clone of the current document. The clone workflow
allows the user to filter out certain kind of layers and groups. In the \QBPS
@@ -248,7 +248,7 @@
\image qt-bridge-clone.png
- \section2 Clone Options
+ \section2 Clone options
The following exclusion options can be selected to exclude certain kind of layers and
groups in the cloned document:
\list
@@ -261,7 +261,7 @@
the other selected exclusion options.
\endlist
- \section1 Sanitizing Documents
+ \section1 Sanitizing documents
\QBPS enables removing all \QBPS related metadata from the active
document. In the \QBPS \uicontrol Settings dialog, select
@@ -279,8 +279,8 @@
You can change the default behavior of \QBPS with the help of a JSX script. One can write
specific functions in the script that are called by \QBPS with useful parameters.
- \section2 Overridable JSX Functions
- You can define the following functions in the override JSX.
+ \section2 Overridable JSX functions
+ Define the following functions in the override JSX:
\list
\li preExport(document)
This function is called before the document is exported. The parameter \a document is
@@ -306,10 +306,10 @@
In the \QBPS \uicontrol Settings dialog, select \uicontrol {Override JSX Script} to set the
override JSX script.
- \section1 Importing Metadata & Assets
+ \section1 Importing metadata and assets
\QBPS can import metadata generated from other tools and generate a Photoshop document. A
- conventional workflow would be to generate metadata and assets by \l {Exporting Components} {exporting}
+ conventional workflow would be to generate metadata and assets by \l {Exporting components} {exporting}
a QML project from \QDS and use \QBPS to generate a Photoshop document.
Imported text and the assets are organized into Artboards, layers, and groups.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
index 42369e70584..12156d6733b 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-overview.qdoc
@@ -1,14 +1,14 @@
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
-// Note: The \page value is hard-coded as a link in Qt Bridge for Sketch.
+// Note: The \page value is hard-coded as a link in \QBSK.
/*!
\previouspage qtbridge-xd-using.html
\page sketchqtbridge.html
\nextpage qtbridge-sketch-setup.html
- \title Exporting Designs from Sketch
+ \title Exporting designs from Sketch
You can use \QBSK to export designs from Sketch to \e {.metadata}
format that you can \l{Importing 2D Assets}{import} to projects in \QDS.
@@ -19,12 +19,12 @@
\list
- \li \l{Setting Up Qt Bridge for Sketch}
+ \li \l{Setting up \QBSK}
You must install Sketch and the \QBSK export tool before you can use
the tool to export designs.
- \li \l{Using Qt Bridge for Sketch}
+ \li \l{Using \QBSK}
To get the best results when you use \QBSK to export designs from
Sketch, you should follow the guidelines for working with Sketch and
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc
index 9fbccf11714..2abc617918e 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-setup.qdoc
@@ -6,7 +6,7 @@
\page qtbridge-sketch-setup.html
\nextpage qtbridge-sketch-using.html
- \title Setting Up \QBSK
+ \title Setting up \QBSK
\QBSK is included in the
\l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
index 06f23a29967..d052bf3138c 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc
@@ -8,7 +8,7 @@
\title Using \QBSK
- \section1 Organizing Assets
+ \section1 Organizing assets
To get the best results when you use \QBSK to export designs from Sketch
to \QDS, follow these guidelines when working with Sketch:
@@ -48,7 +48,7 @@
To use the fonts that you use in Sketch also in \QDS, you need to import
them to \QDS as assets. \QDS deploys them to devices when you preview the
- UI. For more information, see \l{Using Custom Fonts}.
+ UI. For more information, see \l{Using custom fonts}.
For more information, see the \QBSK tutorials that are also accessible from
the \uicontrol Tutorials tab of the Welcome mode:
@@ -60,7 +60,7 @@
{Sketch Bridge Tutorial Part 2}
\endlist
- \section2 Items You Can Export
+ \section2 Items you can export
You can export the following parts of your design using \QBSK:
\list
@@ -79,7 +79,7 @@
\li Libraries
\endlist
- \section2 Using Artboards
+ \section2 Using artboards
The relationships between artboards and layers are preserved when you export
designs from Sketch and import them into \QDS.
@@ -104,7 +104,7 @@
If you want to use the assets on an artboard in \QDS as they are in Sketch,
you can import the artboard without generating code for it.
- \section2 Using Layers and Groups
+ \section2 Using layers and groups
When you use \QBSK to export your designs, you will determine how you want
each layer or group to be exported: as \e merged or as \e child. Each
@@ -130,7 +130,7 @@
recommend that you do not change the IDs after the first time you export
the assets, to avoid problems.
- \section1 Exporting Assets
+ \section1 Exporting assets
By default, assets are exported as follows:
@@ -162,7 +162,7 @@
\image qt-sketch-bridge.png
- \section2 Specifying Settings for Exporting Assets
+ \section2 Specifying settings for exporting assets
To export your design using \QBSK:
@@ -234,7 +234,7 @@
\li Select the \uicontrol Visible check box to determine the visibility
of the layer.
\li In the \uicontrol Annotations field, specify annotation for the
- component. See \l {Annotating Designs}.
+ component. See \l {Annotating designs}.
\li Select the \uicontrol Settings tab to specify the export path and
asset format.
\li Select \uicontrol Export to export the document into a .qtbridge archive.
@@ -246,9 +246,9 @@
your project.
You can now create a project in \QDS and import the .qtbridge archive to it, as
- described in \l {Creating Projects} and \l{Importing Designs}.
+ described in \l {Creating projects} and \l{Importing designs}.
- \section1 Specifying Export Path and Asset Format
+ \section1 Specifying export path and asset format
You can export assets into JPG, PNG, or SVG format. To specify export path
and asset format, select \uicontrol Settings.
@@ -286,7 +286,7 @@
\note Using invalid characters or reservered file names for the page name will result into
imports errors as page name is used for the directory name to organize the UI files in \QDS .
- \section1 Exporting Library Symbols
+ \section1 Exporting library symbols
\QBSK can handle symbols used from a local library. Before you use \QBSK to export a document
that contains remote symbols, you must prepare the Sketch document of the local library with
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-tutorial-links.qdocinc b/doc/qtdesignstudio/src/qtbridge/qtbridge-tutorial-links.qdocinc
index 194c8ddf9fa..ef690111b89 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-tutorial-links.qdocinc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-tutorial-links.qdocinc
@@ -3,7 +3,7 @@
//! [qtsketchbridge tutorials]
- \section2 \QBSK Tutorials
+ \section2 \QBSK tutorials
For more information, read the tutorials about using \QBSK that are also
accessible from the \uicontrol Tutorials tab of the Welcome mode:
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-overview.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-overview.qdoc
index 36913c3d4ba..13442251676 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-overview.qdoc
@@ -8,7 +8,7 @@
\page xdqtbridge.html
\nextpage qtbridge-xd-setup.html
- \title Exporting Designs from Adobe XD
+ \title Exporting designs from Adobe XD
\note This is a \e {Technical Preview} release of the \QBXD. Some design
elements might not be exported and imported into \QDS as expected.
@@ -22,7 +22,7 @@
\list
- \li \l{Setting Up Qt Bridge for Adobe XD}
+ \li \l{Setting up Qt Bridge for Adobe XD}
You must install and set up the \QBXD export plugin before you can use
it to export designs.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-setup.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-setup.qdoc
index 392a3c1f7a3..a20bfddd969 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-setup.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-setup.qdoc
@@ -6,7 +6,7 @@
\page qtbridge-xd-setup.html
\nextpage qtbridge-xd-using.html
- \title Setting Up \QBXD
+ \title Setting up \QBXD
\QBXD is included in the
\l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}.
diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc
index 3a10de0147d..0bc76b1eca5 100644
--- a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc
+++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc
@@ -8,7 +8,7 @@
\title Using \QBXD
- \section1 Organizing Assets
+ \section1 Organizing assets
To get the best results when you use \QBXD to export designs from Adobe XD
to \QDS, follow these guidelines when working with Adobe XD:
@@ -26,10 +26,10 @@
To use the fonts that you use in Adobe XD also in \QDS, you need to import
them to \QDS as assets. \QDS deploys them to devices when you preview the
- UI. For more information, see \l{Using Custom Fonts}.
+ UI. For more information, see \l{Using custom fonts}.
- \section2 Supported Design Elements
+ \section2 Supported design elements
You can export the following parts of your design using \QBXD:
\list
@@ -39,7 +39,7 @@
\li Text
\endlist
- The following design elements might not be exported as expected.
+ The following design elements might not be exported as expected:
\list
\li Component states
\li Component overrides
@@ -51,7 +51,7 @@
for XD Components is limited. This might change in the future and \QBXD might
extend the XD Component support.
- \section2 Using Artboards
+ \section2 Using artboards
The hierarchical relationships between artboards and layers are preserved
when you export designs from Adobe XD and import them into \QDS. The
@@ -62,22 +62,18 @@
be imported as a separate file that contains the artwork and text on the
artboard.
- \section2 Annotate Layers for Export
+ \section2 Annotate layers for export
With \QBXD, layers can be annotated to hint how each layer or group must be
- exported. \uicontrol The {Home} panel displays and allows layer annotation for
- export:
+ exported. The \uicontrol {Home} panel displays and allows layer annotation for
+ export.
\image qt-bridge-xd-home.png
\list 1
- \li \QBXD automatically proposes identifiers for all groups and layers
- that you can change in the \uicontrol {ID} field. Use unique and
- descriptive IDs to avoid duplicate IDs when the layer and the
- respective artwork is imported into \QDS. Even though the importer
- in \QDS is capable of fixing duplicate IDs, doing so will generate
- warnings. It is recommend that you should manually check all the
- IDs to make them unique and descriptive.
+ \li In the \uicontrol ID field, enter a unique and descriptive name.
+ Although the importer can resolve duplicate IDs, this generates warnings.
+ Always manually verify and adjust IDs to maintain their uniqueness and clarity.
\li In the \uicontrol {Export As} field, select the export type for the
group or layer:
@@ -138,8 +134,8 @@
onVisibleChanged: console.log(original_Text.visible)
}
\endcode
- \note The code must have a scope of a component(e.g. Item, MouseArea, Connections etc.)
- with a valid syntax for \l {UI Files}.
+ \note The code must have a scope of a component (such as Item, MouseArea, Connections)
+ with a valid syntax for \l {UI files}.
\note Add respective imports for your snippet in \uicontrol Imports.
\li Select the \uicontrol Clip check box to enable clipping in the
component generated from the layer. The generated component will clip
@@ -157,14 +153,13 @@
\uicontrol {Render Text} is selected.
- \section2 Export Defaults
+ \section2 Export defaults
\QBXD assigns the following defaults to the layers:
- By default:
\list
\li Artboards and XD Components are exported as \e components.
- \li Component instances, Text layers and immediate children of an Artboard
+ \li Components, Text layers, and immediate children of an Artboard
are exported as \e child.
\li Any layer not falling under the aforementioned criteria is exported
as \e merged.
@@ -176,28 +171,30 @@
might take a little while depending on the complexity of your project.
You can now create a project in \QDS and import the assets to it, as
- described in \l {Creating Projects} and \l{Importing Designs}.
+ described in \l {Creating projects} and \l{Importing designs}.
- \section1 \QBXD Settings
-
- Select \uicontrol Settings to change the export settings.
-
- \image qt-bridge-xd-menu.png
-
- \image qt-bridge-xd-settings.png
+ \section1 \QBXD settings
+ To edit export settings:
\list 1
- \li Select \uicontrol {Reset All} to remove all of the \QB data
- stored in the document. Use \uicontrol {Edit} > \uicontrol {Undo}
- to restore the data if you accidentally removed it.
- \li You can export images into PNG, JPG or SVG format. In the section
- \uicontrol {Export Formats}, select the image format to
- export.
- \li Depending on the image format selected for export, the
- \uicontrol {Format Options} allows fine tuning the exported
- image.
- \list
+ \li Select \uicontrol Settings.
+
+ \image qt-bridge-xd-menu.png
+ \image qt-bridge-xd-settings.png
+ \li You can now edit the following settings:
+
+ \list
+ \li Select \uicontrol {Reset All} to remove all of the \QB data
+ stored in the document. Use \uicontrol {Edit} > \uicontrol {Undo}
+ to restore the data if you accidentally removed it.
+ \li You can export images into PNG, JPG or SVG format. In the section
+ \uicontrol {Export Formats}, select the image format to
+ export.
+ \li Depending on the image format selected for export, the
+ \uicontrol {Format Options} allows fine tuning the exported
+ image.
+ \list
\li Select \uicontrol {Hi-DPI Assets} to generate Hi-DPI
images alongside normal scale images. Being a vector format,
this option is not available for SVG format.
@@ -205,21 +202,21 @@
\li Select \uicontrol {JPG Quality} to specify the JPG
compression quality in the range [1, 100].
\endlist
+ \endlist
\endlist
- \section1 Suggestions and Tips
-
- You can export assets using the default settings and make all the changes
- later in \QDS. If you are familiar with the \l{QML Syntax Basics}
- {QML syntax}, you can modify the settings to tailor the generated code to
- a certain degree. For example, you can specify the component or
- \l {Shapes}{Qt Quick Studio Component} to use for a component or
- layer. If you have drawn an arc that you mean to animate, you can export it
- as an \l Arc component to avoid having to replace the arc image with an Arc
- component in \QDS. Or you could export a button as a Qt Quick Controls
- \l Button component.
+ \section1 Suggestions and tips
\list
+ \li You can export assets with the default settings and later adjust these in \QDS.
+ \li If you are familiar with the \l{QML Syntax Basics} {QML syntax},
+ you can modify the settings to tailor the generated code to
+ a certain degree. For example, you can specify the component or
+ \l {Shapes}{Qt Quick Studio Component} to use for a component or
+ layer. If you have drawn an arc that you mean to animate, you can
+ export it as an \l Arc component to avoid having to replace the arc
+ image with an Arc component in \QDS. Or you could export a button as
+ a Qt Quick Controls \l Button component.
\li Name the layers in exactly the same way as your IDs, to be able to
find artwork later, especially as the export files can grow very
large and complicated as they approach the level of a complete UI
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc
index fbc362f6c8c..f9b2f7c1f3c 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\page studio-advanced.html
\nextpage creator-quick-ui-forms.html
- \title Advanced Designer Topics
+ \title Advanced designer topics
\table
\row
@@ -18,12 +18,12 @@
\list
- \li \l{UI Files}
+ \li \l{UI files}
Some of the wizard templates create projects that contain UI files.
You should always edit UI files in the \l {2D}
and \l Properties view, to avoid breaking the code.
- \li \l{Managing Data Collection}
+ \li \l{Managing data collection}
You can enable \QDS to report crashes automatically. If you enable
the telemetry plugin, you can turn on the pseudonymous user
@@ -31,7 +31,7 @@
and transmitted to the backend storage. You can also modify
settings for collecting user feedback.
- \li \l{Packaging Applications}
+ \li \l{Packaging applications}
When you are ready to deliver your application to users or upload
it to app stores, you can use \QDS to create suitable packages that
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
index d0ab93d9289..07dfde82cb3 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
@@ -1,9 +1,9 @@
-// Copyright (C) 2022 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
//! [creating studio components]
- \section1 Creating Custom Controls
+ \section1 Creating custom controls
You can use project wizard templates to create stylable UI controls based
on the components in the Qt Quick Controls module:
@@ -28,7 +28,7 @@
\endtable
You can edit the properties of the controls in all the preset
- \l{Working with States}{states} to apply your own style to them.
+ \l{Working with states}{states} to apply your own style to them.
\note For buttons and check boxes, you can disable the misbehaving hover
effects by selecting \l Properties > \uicontrol Control, and then disabling
@@ -49,12 +49,12 @@
\li Edit component properties in the \l Properties view.
The available properties depend on the component type. You can
- \l{Specifying Custom Properties}{add properties for components} on
+ \l{Specifying custom properties}{add properties for components} on
the \uicontrol Properties tab in the {Connections} view.
\endlist
For an example of using the \uicontrol Button template to create a button
- and styling it, see \l{Creating a Push Button} in the \l{Log In UI - Components}
+ and styling it, see \l{Creating a Push Button} in the \l{Login UI: Components}
tutorial.
In addition, you can create starting points for different types of screens:
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc
index 09cd1d0f584..3abc8cb6471 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-debugging.qdoc
@@ -6,21 +6,21 @@
\page studio-debugging.html
\nextpage creator-debugging-qml.html
- \title Debugging and Profiling
+ \title Debugging and profiling
\list
- \li \l{Debugging Qt Quick Projects}
+ \li \l{Debugging Qt Quick projects}
You can use the integrated debugger to debug JavaScript functions,
to execute JavaScript expressions to get information about the state
of the UI, and to inspect QML properties and JavaScript
variables and change them temporarily at runtime.
- \li \l{Debugging a Qt Quick Application}
+ \li \l{Debugging a Qt Quick Application}{Debugging a Qt Quick application}
This section uses the \l{QML Advanced Tutorial}{Same Game} example
application to illustrate how to debug Qt Quick applications in the
\uicontrol Debug mode.
- \li \l{Profiling QML Applications}
+ \li \l{Profiling QML applications}
You can use QML Profiler to find causes for typical performance
problems in your UIs, such as slowness, freezing, and stuttering.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-developer-topics.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-developer-topics.qdoc
index bc99a9c2c0d..51482e37d47 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-developer-topics.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-developer-topics.qdoc
@@ -6,7 +6,7 @@
\page studio-developer-topics.html
\nextpage studio-finding-the-qt-runtime-version.html
- \title Developer Topics
+ \title Developer topics
\table
\row
@@ -17,7 +17,7 @@
\endtable
\list
- \li \l{Finding the Qt Runtime Version}
+ \li \l{Finding the Qt runtime version}
\QDS runs projects using a specific version of Qt. Identify
which version of Qt your \QDS uses.
@@ -28,17 +28,18 @@
the developers can keep up with your changes. Store and edit only
project source files and configuration files. Do not store
generated files.
- \li \l{Converting UI Projects to Applications}
- \QDS projects are useful for creating UIs. To use them for
- application development in Qt Creator, you have to convert
- them to Qt Quick Application projects that contain .pro,
- .cpp, and .qrc files.
\li \l{Use external tools}
You can use external tools directly from \QDS. Qt Linguist,
QML utilities, the default text editor for your system, and the
\c sort tool are preconfigured for use. You can change their default
configurations and configure new tools.
+
+ \li \l{Accessing output, issue, and warning messages}
+
+ \QDS projects generate output information for the user to represent the
+ executed processes. It also shows you the issues that stop a project from
+ getting executed or gives you warnings about probable failures.
\endlist
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
index 5827d89d4e5..1f5b7ec32d5 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
@@ -17,7 +17,7 @@
\list 1
\li Select the example project to open it. \QDS makes all necessary
downloads.
- \li Select \inlineimage icons/run_small.png
+ \li Select \imagerunsmall
(\uicontrol {Run}) to run the example.
\endlist
@@ -26,6 +26,6 @@
on the \uicontrol Welcome page. Select the icon to download the latest
version of the example project.
- \section1 Example Documentation
+ \section1 Example documentation
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-exporting-and-importing.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-exporting-and-importing.qdoc
index a02bf70b77c..bc5ccdc12ab 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-exporting-and-importing.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-exporting-and-importing.qdoc
@@ -6,7 +6,7 @@
\page studio-exporting-and-importing.html
\nextpage qtbridge-overview.html
- \title Asset Creation with Other Tools
+ \title Asset creation with other tools
Typically, you as a designer would like to use specialized UI design tools,
such as Adobe Photoshop, Sketch, Figma, Blender, or Maya, and then send the
@@ -26,14 +26,14 @@
\list 1
\li Export your design from a design tool into a metadata
format supported by \QDS.
- \li \l{Creating Projects}{Create a project} in \QDS and import the
+ \li \l{Creating projects}{Create a project} in \QDS and import the
metadata file to it.
\li Edit the imported components and create more components in
the \l {2D} and \l {3D} view.
\li Animate your design in \l {Transitions} or \l Timeline
and \l {Curves}.
\li Create interactions in \l States and \l {Connections}.
- \li \l{Validating with Target Hardware}{Preview} your design in
+ \li \l{Validating with target hardware}{Preview} your design in
real time, on the desktop or on a mobile or an embedded device.
\endlist
@@ -43,11 +43,11 @@
\youtube pEETxSxYazg
\list
- \li \l {Exporting from Design Tools}
+ \li \l {Exporting from design tools}
Export designs containing 2D and 3D assets into a metadata format
that you can import to projects in \QDS.
- \li \l{Importing Designs}
+ \li \l{Importing designs}
Import assets that you exported from design tools to a \QDS project
and edit them in the \uicontrol Design mode to create a UI.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc
index 10f780ce468..8f0a655a6aa 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-finding-qt-runtime-version.qdoc
@@ -6,16 +6,16 @@
\page studio-finding-the-qt-runtime-version.html
\nextpage creator-vcs-git.html
- \title Finding the Qt Runtime Version
+ \title Finding the Qt runtime version
\include qtdesignstudio-qt-runtime-version.qdocinc qt-runtime-version
- Find Qt runtime versions for previous \QDS releases in the table below.
+ Find the Qt runtime versions for previous \QDS releases in the table below.
\table
\header
\li \QDS
- \li Qt Runtime Version
+ \li The Qt runtime version
\row
\li 4.0
\li 6.4.1 and 5.15.5
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
index a975dfe7fc6..75cfb78045a 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
@@ -6,7 +6,7 @@
\page studio-getting-started.html
\nextpage studio-installation.html
- \title Getting Started
+ \title Getting started
\table
\row
@@ -29,10 +29,10 @@
Follow a set of hands-on tutorials that illustrate how to use the
features of \QDS.
- \li \l {User Interface}
+ \li \l {User interface}
Describes the parts and basic features of \QDS.
- \li \l {Creating Projects}
+ \li \l {Creating projects}
To wireframe or prototype an application, you need a project.
Setting up a new project in \QDS is aided by a wizard that
@@ -43,10 +43,10 @@
You can use wizards to create projects for the desktop or embedded
Linux and Android devices. In addition, you can add individual QML
files, components, and JavaScript files to your projects.
- \li \l {Use Cases}
+ \li \l {Use cases}
Describes the main use cases of \QDS at a general level.
- \li \l{Concepts and Terms}
+ \li \l{Concepts and terms}
Describes main \QDS concepts and terms.
\li \l{Examples}
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc
index 36fbc8c0155..247c97a9db0 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc
@@ -22,7 +22,7 @@
and index functions to find particular topics in the helps, or
request context-sensitive help by pressing \key F1 in the Design
mode.
- \li \l{Supported Platforms}
+ \li \l{Supported platforms}
You can install and run \QDS on several operating systems to design
UIs for multiple desktop, embedded, and mobile device platforms.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc
index d19ede682f7..67d507f54ef 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc
@@ -6,7 +6,7 @@
\page studio-implementing-applications.html
\nextpage studio-designer-developer-workflow.html
- \title Implementing Applications
+ \title Implementing applications
\table
\row
@@ -23,9 +23,9 @@
\list
- \li \l{Designer-Developer Workflow}
+ \li \l{Designer-developer workflow}
- In \QDS projects, you work on \l{UI Files}{UI files} (.ui.qml),
+ In \QDS projects, you work on \l{UI files} (.ui.qml),
while developers work on the .qml and C++ source files in
Qt Creator to create an application that you can build and
run on target hardware.
@@ -35,7 +35,7 @@
understands the QML language as code, not just as plain text, so it
can offer useful features, such as semantic highlighting, checking
code syntax, code completion, and refactoring actions.
- \li \l{Debugging and Profiling}
+ \li \l{Debugging and profiling}
\QDS comes with a JavaScript debugger. In the \uicontrol Debug mode,
you can inspect the state of your UI while debugging.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc
index 3ce7c52cde2..e187994d03c 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-importing-2d.qdoc
@@ -14,7 +14,7 @@
To import an asset, drag-and-drop the external file containing the asset from,
for example, File Explorer on Windows, to the \uicontrol {2D},
\uicontrol Navigator, or \uicontrol {Code} view. Alternatively, select
- \uicontrol Assets > \inlineimage icons/plus.png
+ \uicontrol Assets > \imageplus
and follow the instructions in the \uicontrol {Asset Import} dialog. You can
also multiselect several external asset files to drag-and-drop them to
\QDS simultaneously.
@@ -28,7 +28,7 @@
will only appear in \uicontrol Assets, and you can then
drag-and-drop them to a suitable view.
- \section1 Importing Designs From Other Design Tools
+ \section1 Importing designs from other design tools
\image studio-imported-assets.webp "UI imported into Qt Design Studio"
@@ -44,7 +44,7 @@
The following instructions use an empty project as an example. For more
information about the options you have, see
- \l {Creating Projects}.
+ \l {Creating projects}.
To import the exported assets to \QDS projects:
@@ -54,7 +54,7 @@
the project and select \uicontrol Create.
\li In \uicontrol Projects, double-click \e Screen01.ui.qml to move to
the Design mode.
- \li Select \uicontrol Assets > \inlineimage icons/plus.png
+ \li Select \uicontrol Assets > \imageplus
.
\li Select the folder where you exported the assets.
\li Select \uicontrol {Compressed Metadata (*.qtbridge)} or
@@ -100,12 +100,13 @@
\uicontrol {Asset Import} dialog while importing, fix the issues in
design tool and export the assets again.
- \section2 Merging QML Files
+ \section2 Merging QML files
When you re-import a QML component, the changes done in \QDS are preserved.
The QML item changes in the existing QML component are copied to the corresponding
QML item in the new component.
- The following rules are observed while merging QML components.
+ \QDS follows a set of rules while merging QML components:
+
\list
\li While importing, a unique identifier (UUID) is added for each QML item in the
component. The UUID is used to find the corresponding QML item in the existing
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc
index 6e6cea54a78..26f5878f867 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-importing-designs.qdoc
@@ -6,18 +6,18 @@
\page studio-importing-designs.html
\nextpage studio-importing-2d.html
- \title Importing Designs
+ \title Importing designs
You can import 2D and 3D assets to \QDS projects. You need to use \QB for
exporting the 2D assets from design tools, whereas you can directly import
3D assets saved in widely-used 3D graphics formats.
\list
- \li \l{Importing 2D Assets}
+ \li \l{Importing 2D assets}
You can import 2D assets that you exported with \QB to a \QDS
project as image and QML files and edit them in the Design mode.
- \li \l{Importing 3D Assets}
+ \li \l{Importing 3D assets}
You can import 3D assets that you created using 3D graphics
applications and stored in one of the supported file formats.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
index 28a9d7cd091..27de04f2bf7 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
@@ -14,13 +14,15 @@
get \QDS using the Qt Edu license.
\QDS is available on several operating systems. For more information, see
- \l{Supported Platforms}.
+ \l{Supported platforms}.
\section1 Using \QOI
Download \QOI from your Qt Account. If you don't have a Qt Account,
create one \l {Qt Account}{here}.
+ To install \QDS with \QOI:
+
\list 1
\li Open \QOI.
\li Select \uicontrol {\QDS}.
@@ -36,6 +38,8 @@
\QMT is included in each Qt installation. If you already have Qt, use \QMT to install \QDS.
+ To install \QDS with \QMT:
+
\list 1
\li Open \QMT.
\li Select \uicontrol {Add or remove components}.
@@ -52,5 +56,6 @@
\section1 Using Qt Edu license
Students and teachers can get a licensing package for learning purposes.
- To apply for the educational license and install \QDS, see \l {Qt Edu for Designers}.
+ To apply for the educational license and install \QDS, see
+ \l {Qt Edu for Designers}{Qt Edu for designers}.
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc
index 06f5975b8af..f3c5f1eeb50 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-javascript.qdoc
@@ -6,12 +6,12 @@
\page studio-javascript.html
\nextpage studio-simulink.html
- \title Simulating Application Logic
+ \title Simulating application logic
You can use JavaScript to simulate application logic that brings your UI to
life.
- You will need the following files:
+ You need the following files:
\list
\li Component file (.qml) that will specify the API of the UI
@@ -117,7 +117,7 @@
import Data 1.0
\endcode
\li Returning to the \uicontrol {2D} view, locate the property that
- should be bound to the simulated values. Select \inlineimage icons/action-icon.png
+ should be bound to the simulated values. Select \imageactionicon
and \uicontrol {Set Binding} for the property and enter the
simulated Value property. For example, you would set the following
expression to bind to the example \c name1 property:
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc
index 4158a7b545d..e2e68aa21eb 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\previouspage studio-crashpad.html
\nextpage studio-developer-topics.html
- \title Packaging Applications
+ \title Packaging applications
\note In this section, you are using advanced menu items. These are not
visible by default. To toggle the visibility of advanced menu items, see
@@ -16,7 +16,7 @@
app stores, you can use \QDS to create suitable packages that contain all
the necessary files, such as fonts, images, components, and modules.
- \section1 Adding Resources to Packages
+ \section1 Adding resources to packages
\QDS supports the \e{Qt Resource System} (QRC), which is a
platform-independent mechanism for storing files in the application's
@@ -42,7 +42,7 @@
resource collection file, you can recreate the resource collection
file to remove them also from there.
- \section1 Embedding Resources into Applications
+ \section1 Embedding resources into applications
Alternatively, you can embed the resources into your application by
selecting \uicontrol File > \uicontrol {Export Project} >
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc
index 501e30adc77..6d7c3e3c6dc 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-platforms.qdoc
@@ -6,12 +6,12 @@
\page studio-platforms.html
\nextpage technical-support.html
- \title Supported Platforms
+ \title Supported platforms
You can install and run \QDS on several operating systems to create
applications for multiple desktop, embedded, and mobile device platforms.
- \section1 Host Platforms
+ \section1 Host platforms
\QDS is available in binary packages for the following operating systems:
@@ -31,7 +31,7 @@
minimum hardware and software: Intel Core i7 with 8GB of RAM and integrated
Intel Graphics.
- \section1 Design Tools
+ \section1 Design tools
\QB is available for the following design tools:
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc
index 86b2bcdbf37..f35212ab7fe 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc
@@ -1,4 +1,4 @@
-// Copyright (C) 2021 The Qt Company Ltd.
+// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -6,7 +6,7 @@
\page studio-projects-managing.html
\nextpage studio-projects.html
- \title Managing Projects
+ \title Managing projects
One of the major advantages of \QDS is that it allows a team of designers
and developers to share a project across different development platforms
@@ -21,7 +21,7 @@
project source files and configuration files. Do not store generated
files.
- \li \l {Converting UI Projects to Applications}
+ \li \l {Converting \QDS projects to applications}
\QDS projects are useful for creating UIs. To use them
for application development in Qt Creator, you have to convert them
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc
index c65469d8cd0..cbb562bfcb6 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc
@@ -6,7 +6,7 @@
\previouspage studio-keyboard-shortcuts.html
\nextpage studio-use-cases.html
- \title Creating Projects
+ \title Creating projects
One of the major advantages of \QDS is that it allows a team of designers
and developers to share a project across different development platforms
@@ -16,7 +16,7 @@
\list
\li Group files together.
- \li Include \l{UI Files}{UI files} (.ui.qml), component files (.qml),
+ \li Include \l{UI files} (.ui.qml), component files (.qml),
and assets files.
\li Specify settings for previewing UIs.
\endlist
@@ -34,7 +34,7 @@
\li Purpose
\row
\li Recents
- \li
+ \li \e {Not applicable}
\li Lists your most recently used presets.
\row
\li {1,3} General
@@ -56,7 +56,7 @@
\li MCU
\li Creates an application that uses a subset of default components
(as supported by \QMCU) that you can deploy, run, and debug
- on MCU boards. For more information, see \l {Creating Projects for MCUs}.
+ on MCU boards. For more information, see \l {Creating projects for MCUs}.
\row
\li {1,3} Mobile
\li Scroll
@@ -77,7 +77,7 @@
images, and text, and defines a launcher application.
\row
\li Custom
- \li
+ \li \e {Not applicable}
\li Lists your saved custom presets.
\note This tab is not visible if there are no saved custom presets.
\endtable
@@ -86,13 +86,13 @@
To test how well your designs work, you can preview the
UIs on the desktop, embedded Linux devices, or Android devices. For more
- information, see \l{Validating with Target Hardware}.
+ information, see \l{Validating with target hardware}.
You can export designs from other design tools and import them to projects.
- For more information, see \l{Exporting from Design Tools} and
- \l{Importing Designs From Other Design Tools}.
+ For more information, see \l{Exporting from design tools} and
+ \l{Importing designs from other design tools}.
- \section1 Creating a Project
+ \section1 Creating a project
To create a project:
@@ -127,7 +127,7 @@
\table
\header
- \li File/Folder
+ \li File or folder
\li Description
\row
\li ProjectName.qmlproject
@@ -170,7 +170,7 @@
\row
\li Screen01.ui.qml
\li This file defines a custom component that you can edit in the \uicontrol {2D} view.
- For more information, see \l {UI Files}.
+ For more information, see \l {UI files}.
The project wizard generates this as the first scene.
\row
\li qtquickcontrols2.conf
@@ -184,7 +184,7 @@
\table
\header
- \li File/Folder
+ \li File or folder
\li Description
\row
\li \c {Generated} (folder)
@@ -213,10 +213,10 @@
\endtable
To use JavaScript and image files in the UI, select
- \uicontrol Assets > \inlineimage icons/plus.png
+ \uicontrol Assets > \imageplus
.
- \section1 Using Custom Presets
+ \section1 Using custom presets
You can save project settings as custom presets. All saved custom presets
are available on the \uicontrol Custom tab in the
@@ -231,7 +231,7 @@
preset.
\endlist
- \section1 Adding Files to Projects
+ \section1 Adding files to projects
You can use wizard templates to add individual files to projects.
@@ -244,13 +244,13 @@
\table
\header
\li Category
- \li Wizard Template
+ \li Wizard template
\li Purpose
\row
\li {1,4} Qt Quick Files
\li Qt Quick File
\li Generates a component with one of the following default components
- or \l{Using Positioners}{positioners} as the root component:
+ or \l{Using positioners}{positioners} as the root component:
\l {basic-item}{Item}, \l {basic-rectangle}{Rectangle}, \l {Images}
{Image}, \l {Border Image}, \l Flickable, Row, Column, Flow, or
Grid.
@@ -261,7 +261,7 @@
\row
\li Qt Quick Views
\li Generates a Grid View or a List View. For more information, see
- \l{List and Grid Views}.
+ \l{List Views and Grid Views}.
\row
\li Qt Quick UI Form
\li Creates a UI file along with a matching QML file for
@@ -304,6 +304,6 @@
\li Generates files that you can use to write the application logic.
This is useful for testing the application before the developers
implement the application logic in C++, for example. For more
- information, see \l {Simulating Application Logic}.
+ information, see \l {Simulating application logic}.
\endtable
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc
index c3c8af08c92..cc345cc5b60 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc
@@ -7,7 +7,7 @@
\page qt-ui-viewer.html
\nextpage studio-exporting-and-importing.html
- \title Viewing Applications on Android
+ \title Viewing applications on Android
View \QDS projects that you have shared online in \QUV.
Bring all the projects from a \QDS ID to \QUV, or establish a direct
@@ -34,9 +34,7 @@
\section1 Connecting a \QDS ID with \QUV
- Connect your \QDS ID to \QUV to access all your shared \QDS projects in \QUV.
-
- To do that:
+ Connect your \QDS ID to \QUV to access all your shared \QDS projects in \QUV:
\list 1
\li Open \QDS on your computer.
\li Open or create a project in \QDS.
@@ -53,7 +51,7 @@
\note Only one \QDS ID can be connected to the \QUV at a time.
- \section1 Running a \QDS Project in \QUV
+ \section1 Running a \QDS project in \QUV
Once the projects are in \QUV:
\list 1
@@ -76,7 +74,7 @@
ID connection.
\endlist
- \section1 Creating a Network Connection between \QDS and \QUV
+ \section1 Creating a network connection between \QDS and \QUV
To create a direct connection with a \QDS project without using a
\QDS ID, first, get your Android device's \e {Local IP} from \QUV.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-sharing-assets.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-sharing-assets.qdoc
index a968c8aeac0..52ab0eb0015 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-sharing-assets.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-sharing-assets.qdoc
@@ -2,12 +2,12 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \previouspage qt-using-effect-maker-effects.html
+ \previouspage creator-exporting-qml.html
\page sharing-assets.html
\nextpage qtquick-motion-design.html
\sa {Content Library}
- \title Sharing Assets
+ \title Sharing assets
With \QDS Bundle files (\e{.qdsbundle}), you can import and export 3D components (such as
cameras, lights, and models) and materials easily.
@@ -21,7 +21,7 @@
\uicontrol {Export Material}.
\endlist
- \section1 Importing Bundles
+ \section1 Importing bundles
To import a 3D component or material bundle, do one of the following:
\list
\li In the \uicontrol {3D}, \uicontrol {2D}, or \uicontrol {Navigator} view, right-click
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc
index 6bad9919d54..67bbc421fb8 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc
@@ -6,7 +6,7 @@
\page studio-simulink.html
\nextpage creator-qml-modules-with-plugins.html
- \title Simulating Dynamic Systems
+ \title Simulating dynamic systems
Use the Simulink connector to connect simulation to your UI. Simulink is a
MATLAB-based graphical programming environment for modeling, simulating,
@@ -55,7 +55,7 @@
{Qt/QML Send} blocks.
\endlist
- \section2 Address and Port
+ \section2 Address and port
An \uicontrol Address block delivers the IP address of a server to the
\uicontrol {Simulink-Qt Client} block as a typical IP address string.
@@ -107,7 +107,7 @@
Signal or \uicontrol Property value.
\endlist
- \section2 Specifying Property Names in Simulink
+ \section2 Specifying property names in Simulink
Double-click the \uicontrol {Qt/SML Send} or \uicontrol {Qt/QML Receive}
block in Simulink to specify a property name. A pop-up for \uicontrol
@@ -118,13 +118,13 @@
\image simulink-qt-send-example-property.png "Example property of the Qt Send block"
- \section1 Integrating the Simulink Model to \QDS
+ \section1 Integrating the Simulink model to \QDS
- \section2 Importing the Simulink Connector
+ \section2 Importing the Simulink connector
To integrate the Simulink model into \QDS, you first need to add the
Simulink connector module to your project. In the \uicontrol Components
- view, select \inlineimage icons/plus.png
+ view, select \imageplus
> \uicontrol SimulinkConnector. \QDS is now ready to communicate with the
Simulink model.
@@ -134,7 +134,7 @@
\uicontrol SimulinkConnector item in \l Navigator and set the IP address
and/or port in the \l Properties view. If you cannot see
\uicontrol SimulinkConnector in \uicontrol Navigator, you need to click
- \inlineimage icons/filtericon.png
+ \imagefiltericon
(\uicontrol {Filter Tree}) and unselect \uicontrol {Show only visible items}.
To communicate with a specific model in Simulink, you need to create
@@ -143,13 +143,13 @@
Navigator to add the properties on the \uicontrol Properties tab in the
\l Connections view.
- See \l {Specifying Custom Properties} for a detailed description of how
+ See \l {Specifying custom properties} for a detailed description of how
to add a custom property. The name of the property and the data type
need to match those of the send or receive property of the Simulink model.
\image studio-connection-view-properties.png "The Properties tab in the Connections view"
- \section2 Creating Bindings
+ \section2 Creating bindings
Next, you need to bind the value of the property you just created to the
desired properties of UI components.
@@ -162,11 +162,11 @@
To bind the root item property to a component property, select the component
either by clicking on it on the canvas or in \uicontrol Navigator. In the
\uicontrol Properties view, find the component property to which you want to
- bind the root item property. Select the \inlineimage icons/action-icon.png
+ bind the root item property. Select the \imageactionicon
(\uicontrol Actions) menu next to a property, and then select
\uicontrol {Set Binding}. In the \uicontrol {Binding Editor}, select the
text field and type in \c {.}, for example
- \c rectangle.speedProp. For more information, see \l {Setting Bindings}.
+ \c rectangle.speedProp. For more information, see \l {Setting bindings}.
\image studio-binding-editor.png "The Binding Editor window"
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
index 00464f7447a..d87919ced3e 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
@@ -6,7 +6,7 @@
\previouspage studio-use-cases.html
\nextpage best-practices.html
- \title Concepts and Terms
+ \title Concepts and terms
This topic describes main \QDS concepts and terms:
@@ -65,8 +65,8 @@
Read more about bindings:
\list
- \li \l{Adding Bindings Between Properties}
- \li \l{Setting Bindings}
+ \li \l{Adding bindings between properties}
+ \li \l{Setting bindings}
\endlist
\section1 Component
@@ -83,10 +83,10 @@
Some of the \l {Component Types}{preset components} represent simple shapes,
text, or images, while others represent complex UI controls with full
functionality, such as spin boxes or sliders. You can also add instances of
- preset \l {3D Components}{3D components} to your UIs. You can find all
+ preset \l {3D components}{3D components} to your UIs. You can find all
the preset components in \l Components.
- To build \l {Creating Component Instances}{your own components}, you can
+ To build \l {Creating component instances}{your own components}, you can
modify the \l{glossary-property}{properties} of the component instances
and combine them.
@@ -94,16 +94,16 @@
\e ui.qml or \e .qml). For example, a Button component may be defined
in Button.ui.qml. Typically, the visual appearance of a component is
defined in a \e {UI file}. To create component files, you can use
- \l{Creating Components from Scratch}{wizard templates}, or
- \l{Turning Component Instances into Custom Components}
+ \l{Creating components from scratch}{wizard templates}, or
+ \l{Turning component instances into custom components}
{move component instances into separate component files}.
Read more about components:
\list
- \li \l {Preset Components}
- \li \l {Creating Component Instances}
- \li \l {Creating Custom Components}
+ \li \l {Preset components}
+ \li \l {Creating component instances}
+ \li \l {Creating custom components}
\endlist
\section1 Connection
@@ -121,7 +121,7 @@
\list
\li \l{Connections}
- \li \l{Working with Connections}
+ \li \l{Working with connections}
\endlist
\section1 Device
@@ -132,7 +132,7 @@
Read more about devices:
\list
- \li \l{Previewing on Devices}
+ \li \l{Previewing on devices}
\endlist
\section1 Mode
@@ -175,7 +175,7 @@
Read more about projects:
\list
- \li \l{Creating Projects}
+ \li \l{Creating projects}
\endlist
\section1 Property
@@ -193,10 +193,10 @@
\list
\li \l{Properties}
- \li \l{Preset Components}
- \li \l{Specifying Component Properties}
- \li \l{Adding Bindings Between Properties}
- \li \l{Specifying Custom Properties}
+ \li \l{Preset components}
+ \li \l{Specifying component properties}
+ \li \l{Adding bindings between properties}
+ \li \l{Specifying custom properties}
\endlist
\section1 Signal
@@ -221,7 +221,7 @@
Read more about signals:
\list
- \li \l{Connecting Components to Signals}
+ \li \l{Connecting components to signals}
\li \l{Mouse Area}
\endlist
@@ -248,7 +248,7 @@
\list
\li \l{States}
- \li \l{Working with States}
+ \li \l{Working with states}
\endlist
\section1 Transition
@@ -264,7 +264,7 @@
\list
\li \l{Transitions}
- \li \l{Animating Transitions Between States}
+ \li \l{Animating transitions between states}
\endlist
\omit
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
index dfe679ef114..5c001add704 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
@@ -10,9 +10,9 @@
\list
\li \l{Installing \QDS}
\li \l{Tutorials}
- \li \l{User Interface}
+ \li \l{User interface}
\list
- \li \l{Design Views}
+ \li \l{Design views}
\list
\li \l{2D}
\li \l{3D}
@@ -40,44 +40,44 @@
\li \l{Transitions}
\li \l{Translations}
\endlist
- \li \l{Managing Workspaces}
+ \li \l{Managing workspaces}
\li \l{Manage sessions}
- \li \l{Keyboard Shortcuts}
+ \li \l{Keyboard shortcuts}
\endlist
- \li \l{Creating Projects}
- \li \l{Use Cases}
- \li \l{Concepts and Terms}
- \li \l{Best Practices}
+ \li \l{Creating projects}
+ \li \l{Use cases}
+ \li \l{Concepts and terms}
+ \li \l{Best practices}
\li \l{Examples}
\endlist
\li \l{Wireframing}
\list
- \li \l {Using Components}
+ \li \l {Using components}
\list
- \li \l{Preset Components}
+ \li \l{Preset components}
\list
\li \l{Shapes}
\li \l{Text}
\li \l{Images}
- \li \l{User Interaction Methods}
- \li \l{UI Controls}
- \li \l{Lists and Other Data Models}
- \li \l{2D Effects}
+ \li \l{User interaction methods}
+ \li \l{UI controls}
+ \li \l{Lists and other data models}
+ \li \l{2D effects}
\li \l{Design Effects}
- \li \l{Logic Helpers}
+ \li \l{Logic helpers}
\li \l{Animations}
\li \l{3D Views}
\li \l{Node}
\li \l{Group}
- \li \l{Instanced Rendering}
- \li \l{Skeletal Animation}
- \li \l{3D Models}
- \li \l{Materials and Shaders}
+ \li \l{Instanced rendering}
+ \li \l{Skeletal animation}
+ \li \l{3D models}
+ \li \l{Materials and shaders}
\li \l{Textures}
- \li \l{3D Materials}
- \li \l{3D Effects}
- \li \l{Custom Shaders}
- \li \l{Custom Effects and Materials}
+ \li \l{3D materials}
+ \li \l{3D effects}
+ \li \l{Custom shaders}
+ \li \l{Custom effects and materials in Qt 5}
\li \l{Lights}
\li \l{Cameras}
\li \l{Scene Environments}
@@ -87,159 +87,158 @@
\li \l{Particles}
\list
\li \l {Particle System}
- \li \l {Logical Particles}
- \li \l {Particle Emitters}
- \li \l {Particle Affectors}
- \li \l {Particle Directions}
+ \li \l {Logical particles}
+ \li \l {Particle emitters}
+ \li \l {Particle affectors}
+ \li \l {Particle directions}
\endlist
\endlist
- \li \l {Creating Component Instances}
- \li \l {Creating Custom Components}
+ \li \l {Creating component instances}
+ \li \l {Creating custom components}
\list
- \li \l{Creating Buttons}
- \li \l{Creating Scalable Buttons and Borders}
+ \li \l{Creating buttons}
+ \li \l{Creating scalable buttons and borders}
\endlist
\endlist
- \li \l{Specifying Component Properties}
- \li \l{Scalable Layouts}
- \li \l{Annotating Designs}
+ \li \l{Specifying component properties}
+ \li \l{Scalable layouts}
+ \li \l{Annotating designs}
\endlist
\li \l{Prototyping}
\list
- \li \l{Creating UI Logic}
+ \li \l{Creating UI logic}
\li \l{Effects}
- \li \l{Simulating Complex Experiences}
+ \li \l{Simulating complex experiences}
\list
- \li \l{Loading Placeholder Data}
- \li \l{Simulating Application Logic}
- \li \l{Simulating Dynamic Systems}
- \li \l{Using QML Modules with Plugins}
+ \li \l{Loading placeholder data}
+ \li \l{Simulating application logic}
+ \li \l{Simulating dynamic systems}
+ \li \l{Using QML modules with plugins}
\endlist
- \li \l{Dynamic Behaviors}
+ \li \l{Dynamic behaviors}
\list
- \li \l{Working with Connections}
+ \li \l{Working with connections}
\list
- \li\l{Connecting Components to Signals}
- \li\l{Adding Bindings Between Properties}
- \li\l{Specifying Custom Properties}
+ \li\l{Connecting components to signals}
+ \li\l{Adding bindings between properties}
+ \li\l{Specifying custom properties}
\endlist
- \li \l{Working with States}
+ \li \l{Working with states}
\endlist
- \li \l{Validating with Target Hardware}
+ \li \l{Validating with target hardware}
\list
- \li \l{Previewing on Desktop}
- \li \l{Previewing on Devices}
- \li \l{Sharing Applications Online}
+ \li \l{Previewing on desktop}
+ \li \l{Previewing on devices}
+ \li \l{Sharing applications online}
\list
- \li \l{Creating a Single Page Navigation Web Application}
+ \li \l{Creating a single page navigation web application}
\endlist
- \li \l {Viewing Applications on Android}
+ \li \l {Viewing applications on Android}
\endlist
- \li \l {Asset Creation with Other Tools}
+ \li \l {Asset creation with other tools}
\list
- \li \l{Exporting from Design Tools}
+ \li \l{Exporting from design tools}
\list
- \li \l{Exporting Designs from Adobe Illustrator}
- \li \l{Exporting Designs from Adobe Photoshop}
+ \li \l{Exporting designs from Adobe Illustrator}
+ \li \l{Exporting designs from Adobe Photoshop}
\list
- \li \l{Setting Up Qt Bridge for Adobe Photoshop}
+ \li \l{Setting up Qt Bridge for Adobe Photoshop}
\li \l{Using Qt Bridge for Adobe Photoshop}
\endlist
- \li \l{Exporting Designs from Adobe XD}
+ \li \l{Exporting designs from Adobe XD}
\list
- \li \l{Setting Up Qt Bridge for Adobe XD}
+ \li \l{Setting up Qt Bridge for Adobe XD}
\li \l{Using Qt Bridge for Adobe XD}
\endlist
- \li \l{Exporting Designs from Sketch}
+ \li \l{Exporting designs from Sketch}
\list
- \li \l{Setting Up Qt Bridge for Sketch}
- \li \l{Using Qt Bridge for Sketch}
+ \li \l{Setting up \QBSK}
+ \li \l{Using \QBSK}
\endlist
- \li \l{Exporting Designs from Figma}
+ \li \l{Exporting designs from Figma}
\list
- \li \l{Setting Up Qt Bridge for Figma}
+ \li \l{Setting up Qt Bridge for Figma}
\li \l{Using Qt Bridge for Figma}
- \li \l{Using Figma Quick Control Template Components in Qt Design Studio}
+ \li \l{Using the Figma Quick Control Template components in \QDS}
\endlist
\endlist
- \li \l {Exporting 3D Assets}
+ \li \l {Exporting 3D assets}
\list
\li \l{Exporting from Blender}
\li \l{Exporting from Maya}
\li \l{Exporting from Qt 3D Studio}
\endlist
- \li \l{Importing Designs}
+ \li \l{Importing designs}
\list
- \li \l{Importing 2D Assets}
+ \li \l{Importing 2D assets}
\list
- \li \l{Using Custom Fonts}
+ \li \l{Using custom fonts}
\endlist
- \li \l{Importing 3D Assets}
+ \li \l{Importing 3D assets}
\endlist
- \li \l{Exporting Components}
- \li \l{Using Qt Quick Effect Maker Effects}
- \li \l{Sharing Assets}
+ \li \l{Exporting components}
+ \li \l{Using the Qt Quick Effect Maker effects}
+ \li \l{Sharing assets}
\endlist
\endlist
\li \l{Motion Design}
\list
- \li \l{Introduction to Animation Techniques}
- \li \l{Creating Timeline Animations}
- \li \l{Editing Easing Curves}
- \li \l{Production Quality}
- \li \l{Optimizing Designs}
+ \li \l{Introduction to animation techniques}
+ \li \l{Creating timeline animations}
+ \li \l{Editing easing curves}
+ \li \l{Production quality}
+ \li \l{Optimizing designs}
\list
- \li \l{Creating Optimized 3D Scenes}
+ \li \l{Creating optimized 3D scenes}
\endlist
\endlist
- \li \l{Implementing Applications}
+ \li \l{Implementing applications}
\list
- \li \l{Designer-Developer Workflow}
- \li \l{Debugging and Profiling}
+ \li \l{Designer-developer workflow}
+ \li \l{Debugging and profiling}
\list
- \li \l{Debugging Qt Quick Projects}
+ \li \l{Debugging Qt Quick projects}
\list
- \li \l{Viewing Call Stack Trace}
- \li \l{Setting Breakpoints}
- \li \l{Local Variables and Function Parameters}
- \li \l{Evaluating Expressions}
+ \li \l{Viewing call stack trace}
+ \li \l{Setting breakpoints}
+ \li \l{Local variables and function parameters}
+ \li \l{Evaluating expressions}
\endlist
- \li \l{Debugging a Qt Quick Application}
- \li \l{Profiling QML Applications}
+ \li \l{Debugging a Qt Quick application}
+ \li \l{Profiling QML applications}
\list
\li \l{Profile QML applications}
\endlist
\endlist
\endlist
- \li \l{Advanced Designer Topics}
+ \li \l{Advanced designer topics}
\list
\omit
\li Extending Component Functionality
\endomit
- \li \l{UI Files}
- \li \l{Managing Data Collection}
+ \li \l{UI files}
+ \li \l{Managing data collection}
\list
- \li \l {Collecting Usage Statistics}
- \li \l {Collecting User Feedback}
- \li \l {Reporting Crashes}
+ \li \l {Collecting usage statistics}
+ \li \l {Collecting user feedback}
+ \li \l {Reporting crashes}
\endlist
- \li \l {Packaging Applications}
+ \li \l {Packaging applications}
\endlist
- \li \l{Developer Topics}
+ \li \l{Developer topics}
\list
- \li \l{Finding the Qt Runtime Version}
+ \li \l{Finding the Qt runtime version}
\li \l{Using Git}
- \li \l{Converting Qt 5 Projects into Qt 6 Projects}
- \li \l{Converting UI Projects to Applications}
\li \l{Use external tools}
+ \li \l{Accessing output, issue, and warning messages}
\li \l{\QDS on MCUs}
\list
- \li \l {\QMCU Framework}
- \li \l {\QDS Version Compatibility with \QMCU SDKs}
- \li \l {\QDS Features on MCU Projects}
- \li \l {Creating Projects for MCUs}
+ \li \l {\QMCU framework}
+ \li \l {\QDS version compatibility with \QMCU SDKs}
+ \li \l {\QDS features on MCU projects}
+ \li \l {Creating projects for MCUs}
\li \l {Creating UIs for MCUs}
- \li \l {Developing Applications for MCUs}
+ \li \l {Developing applications for MCUs}
\li \l {Connecting MCUs with Qt Creator}
\endlist
\endlist
@@ -256,10 +255,10 @@
\li \l {Search from documentation}
\li \l {Select the help start page}
\endlist
- \li \l{Supported Platforms}
+ \li \l{Supported platforms}
\endlist
- \li \l{Technical Support}
- \li \l{Licenses and Acknowledgments}
- \li \l{What's New}
+ \li \l{Technical support}
+ \li \l{Licenses and acknowledgments}{Licenses and acknowledgments}
+ \li \l{What's new}
\endlist
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
index e1d3357b9bf..b9a02b4bc4b 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
@@ -8,29 +8,28 @@
\title Tutorials
- \image loginui4.gif "Log In UI"
+ \image loginui4.gif "Login UI"
- \section1 Video Tutorials
+ \section1 Video tutorials
- When you run \QDS, the \uicontrol Tutorials tab in \uicontrol Welcome mode contains links
- to video tutorials. To watch a tutorial on YouTube,
- select it.
+ When you run \QDS, the \uicontrol Tutorials tab in the \uicontrol Welcome mode
+ contains links to video tutorials. Select a tutorial to watch it on YouTube.
- \section1 Written Tutorials
+ \section1 Written tutorials
You can follow a set of hands-on tutorials that
illustrate how to use the features of \QDS. Even if you plan to export your
designs from a design tool, it is useful to go through tutorials to learn to
- use \QDS. In particular, \l {Log In UI - Components}
+ use \QDS. In particular, \l {Login UI: Components}
describes the terms and concepts that you will run into when exporting
designs with \QB.
Before you start, take a look at the following topics to familiarize
yourself with the parts of \QDS in general, and the \uicontrol Design
- mode in particular: \l{User Interface} and \l{Design Views}.
+ mode in particular: \l{User interface} and \l{Design views}.
In addition to these tutorials, \QDS comes with examples that you can open
- from the \uicontrol Examples and tabs in the \uicontrol Welcome mode. For more
+ from the \uicontrol Examples tab in the \uicontrol Welcome mode. For more
information, see \l {Examples}.
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-use-cases.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-use-cases.qdoc
index 54e90305c0c..f18adab6fdc 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-use-cases.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-use-cases.qdoc
@@ -6,17 +6,17 @@
\previouspage studio-projects.html
\nextpage studio-terms.html
- \title Use Cases
+ \title Use cases
The following table summarizes the main use cases of \QDS with links to
more information:
\table
\row
- \li \inlineimage qds-front-ui.png
- \li \inlineimage studio-flow.png
- \li \inlineimage qds-studio-3d-scenes.png
- \li \inlineimage qds-front-projects.png
+ \li \image qds-front-ui.png
+ \li \image studio-flow.png
+ \li \image qds-studio-3d-scenes.png
+ \li \image qds-front-projects.png
\row
\li \b {Creating UI wireframes}
\li \b {Creating UI prototypes}
@@ -39,7 +39,7 @@
\row
\li \l{Wireframing}
\li \l{Prototyping}
- \li \l{Asset Creation with Other Tools}
- \li \l{Implementing Applications}
+ \li \l{Asset creation with other tools}
+ \li \l{Implementing applications}
\endtable
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-using-effect-maker-effects.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-using-effect-maker-effects.qdoc
index 1e53c53ba0f..42588f7d2b4 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-using-effect-maker-effects.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-using-effect-maker-effects.qdoc
@@ -7,7 +7,7 @@
\nextpage qtquick-motion-design.html
\previouspage creator-exporting-qml.html
- \title Using Qt Quick Effect Maker Effects
+ \title Using the Qt Quick Effect Maker effects
\QQEM is integrated into \QDS for creating shader effects. To create an
effect, you first create the effect file in \QDS, and then you edit it in \QQEM.
@@ -15,7 +15,7 @@
For more information about \QQEM, see the
\l{https://doc.qt.io/qt-6/qtquickeffectmaker-index.html}{Qt Quick Effect Maker Manual}.
- \section1 Creating an Effect File
+ \section1 Creating an effect file
To create an effect file in \QDS:
@@ -33,7 +33,7 @@
Now, you can close \QQEM and return to \QDS and apply the
effect.
- \section1 Applying an Effect
+ \section1 Applying an effect
You can apply effects to components in \QDS. To do so, drag the effect
from the \uicontrol Assets view to the component in the \uicontrol 2D or
diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc
index cedc8b80460..710e6a444b0 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc
@@ -5,8 +5,8 @@
\page index.html
\nextpage studio-getting-started.html
- \keyword {Qt Design Studio Manual}
- \title Qt Design Studio Documentation
+ \keyword {Qt Design Studio documentation}
+ \title Qt Design Studio documentation
\raw HTML