Doc: Update create project docs

Update docs to include new project wizard.

Task-number: QDS-5939
Change-Id: Ic152f5d558c81ae8c5ce536ef26e8c9461a81c34
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Tanja Remes <tanja.remes@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
This commit is contained in:
Mats Honkamaa
2022-01-12 11:03:16 +02:00
parent fd6380f935
commit cbcdf4c2f2
4 changed files with 50 additions and 59 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 109 KiB

View File

@@ -48,95 +48,83 @@
prompt you to enter the settings needed for a particular type of project prompt you to enter the settings needed for a particular type of project
and create the necessary files for you. and create the necessary files for you.
\QDS projects are useful for creating UIs. You cannot use them for To test how well your designs work, you can preview the
application development, because they do not contain: UIs on the desktop, embedded Linux devices, or Android devices. For more
\list
\li C++ code
\li Resource files (.qrc)
\li Code needed for deploying applications to devices.
\endlist
Because the projects do not contain any C++ code, you do not need
to build them. To test how well your designs work, you can preview the
UIs on the desktop or embedded Linux devices. For more
information, see \l{Validating with Target Hardware}. information, see \l{Validating with Target Hardware}.
\image studio-project-wizards.png "A list of project wizards" \image studio-project-wizards.png "A list of project wizards"
You can export designs from other design tools and import them to projects You can export designs from other design tools and import them to projects
or create them from scratch using the following wizard templates: or create them from scratch using the following wizard presets:
\table \table
\header \header
\li Category \li Category
\li Wizard Template \li Wizard Preset
\li Purpose \li Purpose
\row \row
\li {1,2} General \li {1,2} General
\li Qt Quick Application - Empty \li Empty
\li Creates a project that uses default components and preset UI \li Creates a project that uses default components such as rectangles,
controls and can be run on all target platforms. images, and text. You can run the application on all target
platforms.
\row \row
\li Qt Quick 3D Application \li 3D
\li Creates a project that uses default components, UI controls, and \li Creates a project that uses default and 3D components such as
3D components. cameras, lights, 3D models, and materials.
\row \row
\li Qt for MCUs \li Qt for MCUs
\li Qt for MCUs Application \li MCU
\li Creates an application that uses a subset of preset components \li Creates an application that uses a subset of default components
(as supported by Qt for MCUs) that you can deploy, run, and debug (as supported by Qt for MCUs) that you can deploy, run, and debug
on MCU boards. on MCU boards.
\row \row
\li {1,2} Mobile \li {1,3} Mobile
\li Qt Quick Application - Scroll \li Scroll
\li Creates an application that uses UI controls to implement a \li Creates an application that uses Qt Quick controls to implement a
scrollable list. scrollable list.
\row \row
\li Qt Quick Application - Stack \li Stack
\li Creates an application that uses UI controls to implement a \li Creates an application that uses Qt Quick controls to implement a
set of pages with a stack-based navigation model. set of pages with a stack-based navigation model.
\row
\li Swipe
\li Creates an application that uses Qt Quick controls to implement a
swipable screen.
\row \row
\li Desktop \li Desktop
\li Qt Quick Application - Launcher \li Launcher
\li Creates a project that uses default components and UI controls and \li Creates a project that uses default components such as rectangles,
defines a launcher application. images, and text, and defines a launcher application.
\endtable \endtable
For an example of creating a \uicontrol {Qt Quick 3D Application} project,
watch the following video:
\youtube 9ihYeC0YJ0M
\section1 Using Project Wizards \section1 Using Project Wizards
To create a new project:
\list 1 \list 1
\li Select \uicontrol File > \uicontrol {New Project}. \li Select \uicontrol File > \uicontrol {New Project}.
\li Select a wizard template, and then select \uicontrol Choose. \li In the \uicontrol Presets tab, select a wizard preset.
\li In the \uicontrol Name field, enter a name for the project. \li In the \uicontrol Details tab:
Keep in mind that projects cannot be easily renamed later. \list
\image studio-project-location.png "Project Location dialog" \li Enter a name for the project. Keep in mind that projects
\li In the \uicontrol {Create in} field, enter the path for the project cannot be easily renamed later.
files. You can move project folders later without problems. \li Select the path for the project files. You can move project
\li Select \uicontrol Next (or \uicontrol Continue on \macos). folders later.
\li In the \uicontrol {Screen resolution} field, select the screen \li Set the screen resolution for previewing the UI on the
resolution for previewing the UI on the desktop or on a device. desktop or on a device. This determines the screen size. You can
This determines the screen size. change the screen size later in \l Properties.
\image studio-project-custom-screen-size.png "Define Project Details dialog" \li Select \uicontrol {Use Qt Virtual Keyboard} to
\li To use a custom screen size, specify the width and height of the enable users to enter text using a virtual keyboard.
screen in the \uicontrol {Custom screen width} and \li In \uicontrol {Target Qt Version}, select the Qt
\uicontrol {Custom screen height} fields. version to use for developing the application. While you can
You can easily change the screen size later in \l Properties. change the Qt version later in the \uicontrol {Run Settings}
\li In the \uicontrol {Qt Quick Controls Style} field, select one of of the project, keep in mind that the two versions are not fully
compatible.
\endlist
\li In the \uicontrol {Style} tab, select one of
the predefined \l{Styling Qt Quick Controls}{UI styles} to use. the predefined \l{Styling Qt Quick Controls}{UI styles} to use.
\li Select the \uicontrol {Use Qt Virtual Keyboard} check box to enable \li Select \uicontrol Create to create the project.
users to enter text using a virtual keyboard.
\li In the \uicontrol {Target Qt Version} field, select the Qt version
to use for developing the application. While you can change the
Qt version later in the \uicontrol {Run Settings} of the project,
keep in mind that the two versions are not fully compatible.
\li Select \uicontrol Finish (or \uicontrol Done on \macos) to create
the project.
\endlist \endlist
\QDS creates the following files and folders: \QDS creates the following files and folders:
@@ -155,6 +143,9 @@
Specifically, if you export and import designs using \QB, your main Specifically, if you export and import designs using \QB, your main
file is most likely called something else. For more information, file is most likely called something else. For more information,
see \l {Exporting from Design Tools}. see \l {Exporting from Design Tools}.
\li \e CMakeLists.txt project configuration file allowing you to
share your project as a fully working C++ application with
developers.
\li qtquickcontrols2.conf file specifies the preferred style and some \li qtquickcontrols2.conf file specifies the preferred style and some
style-specific arguments. style-specific arguments.
\li \e fonts folder contains font files that you have added in \li \e fonts folder contains font files that you have added in