feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Document the designer-developer workflow

Browse Source 
Fixes: QDS-4506
Change-Id: Iff581a36c699764b91788e166af82faee282f2d4
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2021-11-18 15:25:02 +01:00
parent f8f7f47ec3
commit 6124bd4124
7 changed files with 98 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/qtcreator/src/editors/creator-coding.qdoc
View File

@@ -32,7 +32,7 @@
/*!
\page creator-coding.html
\if defined(qtdesignstudio)
\previouspage studio-implementing-applications.html
\previouspage studio-designer-developer-workflow.html
\else
\previouspage creator-usability.html
\endif

27
doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc
View File

@@ -29,7 +29,7 @@
\previouspage studio-porting-projects.html
\nextpage creator-editor-external.html
\else
\previouspage quick-projects.html
\previouspage creator-qtquickdesigner-plugin.html
\nextpage creator-quick-ui-forms.html
\endif
@@ -39,9 +39,9 @@
use them for application development in Qt Creator you have to add:
\list
\li Project configuration file (.pro)
\li Project configuration file (CMakeLists.txt or .pro)
\li C++ code (.cpp)
\li Resource files (.qrc)
\li Resource files
\li Code needed for deploying applications to \l{glossary-device}
{devices}
\endlist
@@ -49,9 +49,22 @@
For more information about integrating QML and C++, see
\l{Overview - QML and C++ Integration}.
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.
\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.
\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
@@ -80,7 +93,7 @@
your Qt to be able to build your project. For more information, see
\l{Adding Qt Quick Timeline Module to Qt Installations}.
\section1 Converting Projects
\section1 Converting into qmake Projects
To convert a project that has a .qmlproject file to one that has a .pro
file:

BIN
doc/qtdesignstudio/images/studio-project-structure.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

64
doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc Normal file
View File

@@ -0,0 +1,64 @@
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page studio-designer-developer-workflow.html
\previouspage studio-implementing-applications.html
\nextpage creator-coding.html
\title Designer-Developer Workflow
\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),
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.
Use the \l{Using Git}{Git} version control system to ensure that changes
are not lost when files are passed back and forth between designers and
developers.
\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.
\QDS continues to use the \e .qmlproject file format, while \QC uses a
\e CMakeLists.txt file as the project file. This enables you to share
your project as a fully working C++ application with developers.
If you add or remove QML files in \QDS, you have to regenerate the
\e CMakeLists.txt project configuration file by selecting \uicontrol Build
> \uicontrol Run > \uicontrol {Generate CMakeLists.txt Files}.
If you use Git, you can clone an example project
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/playground/AuroraCluster0}
{here}.
The following image shows the example project structure and contents in the
\l Projects and \l {File System} views in \QDS and Qt Creator:
\image studio-project-structure.png "\QDS project in \QDS and Qt Creator views"
*/

16
doc/qtdesignstudio/src/qtdesignstudio-implementing-applications.qdoc
View File

@@ -26,7 +26,7 @@
/*!
\previouspage studio-optimized-3d-scenes.html
\page studio-implementing-applications.html
\nextpage creator-coding.html
\nextpage studio-designer-developer-workflow.html
\title Implementing Applications
@@ -38,13 +38,19 @@
the default configuration allows you to start wireframing,
prototyping, and validating UIs with very little effort.
However, you might want to use the \l{Text Editor} view
sometimes to edit your component files (.qml). If you use
JavaScript, you might also want to debug and profile you
UIs to find and fix problems in them.
You can use the \l{Text Editor} view to edit your component
files (.qml). If you use JavaScript, you can debug and profile
your UIs to find and fix problems in them.
\endtable
\list
\li \l{Designer-Developer Workflow}
In \QDS projects, you work on \l{UI Files}{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.
\li \l{Coding}
You can use the code editor in the \uicontrol {Text Editor} view or

13
doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
View File

@@ -207,9 +207,7 @@
\endlist
\li \l{Implementing Applications}
\list
\omit
\li Using Flows in Production
\endomit
\li \l{Designer-Developer Workflow}
\li \l{Coding}{Cross-Platform Development}
\list
\li \l{Writing Code}
@@ -245,15 +243,6 @@
\li \l{Debugging a Qt Quick Example Application}
\li \l{Profiling QML Applications}
\endlist
\omit
\li \l{Designer-Developer Workflow}
\list
\li \l{Reusable Prototypes and Full UI Implementation}
\li \l{Optimizing Specification and Implementation}
\li \l{Parallel Development}
\li \l{One Toolchain}
\endlist
\endomit
\endlist
\li \l{Advanced Designer Topics}
\list

1
doc/qtdesignstudio/src/qtdesignstudio.qdoc
View File

@@ -87,6 +87,7 @@
\row
\li \b {\l{Implementing Applications}}
\list
\li \l{Designer-Developer Workflow}
\li \l{Coding}{Cross-Platform Development}
\li \l{Debugging and Profiling}
\endlist