Doc: Update Login UI Components

- Simplified some of the steps.
- Improved ALT texts.
- Updated pics.

Task-number: QDS-14470
Change-Id: Ib4c63b38d63c991f2ab320e10bf4be906a5e986c
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Johanna Vanhatapio
2025-03-05 11:28:27 +02:00
parent 9d614131a2
commit 6a3ecf046a
33 changed files with 153 additions and 266 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.6 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.4 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.8 KiB

After

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.0 KiB

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 8.6 KiB

View File

@@ -1,4 +1,4 @@
// Copyright (C) 2024 The Qt Company Ltd. // Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*! /*!
@@ -10,11 +10,14 @@
\brief Illustrates how to use wizard templates to create a simple UI \brief Illustrates how to use wizard templates to create a simple UI
that contains a text label, images, and push buttons. that contains a text label, images, and push buttons.
\image loginui1.webp \image loginui1.webp The finished tutorial in Live Preview.
\e{Login UI: Components} is the first tutorial in a series of tutorials \e{Login UI: Components} is the first of the \QDS \e{Login UI} tutorials, which
that describes how to use the \QDS wizard templates to create a project and build on each other to illustrate how to create a simple UI with some basic UI
a button UI control, and how to modify the files generated by the wizard components, such as pages, buttons, and entry fields.
templates to design the UI.
This tutorial 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 a UI.
You can download the completed project from You can download the completed project from
\l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui1}{here}. \l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/Loginui1}{here}.
@@ -38,26 +41,25 @@
that projects cannot be easily renamed later. that projects cannot be easily renamed later.
\li Select the path (3) for the project files. You can move project \li Select the path (3) for the project files. You can move project
folders later. folders later.
\li Set \uicontrol Width (4) to 720 and \uicontrol Height (5) to 1280. \li Set \uicontrol Width to 720 and \uicontrol Height to 1280 (4).
You can change the screen size later in \l Properties. You can change the screen size later in \l Properties.
\endlist \endlist
\li Select \uicontrol Create (5) to create the project.
\li Select \uicontrol Create (6) to create the project. \image loginui1-new-project.webp Creating a new project in Qt Design Studio.
\image loginui1-new-project.webp "New Project window in Qt Design Studio."
\endlist \endlist
Your project should now look something like this in the \uicontrol Projects view: Your project should now look something like this in the \uicontrol Projects view:
\image loginui1-project.webp "A new project." \image loginui1-project.webp A new project in Qt Design Studio.
The wizard constructs the \e Screen01 \l{glossary-component}{component} The wizard constructs the \e Screen01 \l{glossary-component}{component}
using instances of a \l{basic-rectangle}{rectangle} component that forms using a \l{basic-rectangle}{rectangle} component as the background,
the background, a \l Button, and a \l Text component that displays some text. a \l Button, and a \l Text component that displays some text.
\note The visibility of views depends on the selected workspace, \note The visibility of views depends on the selection of views on the
so your \QDS might look somewhat different from the above image. selected workspace, so your \QDS might look somewhat different from the
To open hidden views, select \uicontrol View > \uicontrol Views. For more image above. To open and close views, select \uicontrol View > \uicontrol Views.
information about moving views around, see \l {Managing Workspaces}. For more information about arranging the \QDS workspace, see \l {Managing workspaces}.
Remove the button and the text component from the UI to have a clean workspace. Later 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. in this tutorial, you will add and modify them as you need.
@@ -67,12 +69,13 @@
Next, you will edit the values of the properties of the component instances Next, you will edit the values of the properties of the component instances
to create the main page of the UI. to create the main page of the UI.
\section1 Creating the Main Page
You will now add a text component instance to create a tag line using a custom font. \section1 Creating the main page
You will add the font as an asset and set it to be used in the properties of the component.
In addition, you will import a background image and logo as assets and You will now create the main page of your UI. First, you will download
add them to the page as instances of the \l{Images}{Image} component. a logo, a background image, and a custom font and import them to \QDS as
assets. You will then use these assets to add a background image, a logo,
and a tag line to your main page.
Download the logo and the background image from here: Download the logo and the background image from here:
@@ -93,39 +96,49 @@
To add the assets: To add the assets:
\list 1 \list 1
\li Select \uicontrol Assets > \imageplus \li Select \uicontrol Assets > \imageplus
(Select \uicontrol View > \uicontrol Views > \uicontrol Assets to enable it, (If you can't see the \uicontrol Assets view, select \uicontrol View >
if you can't find it). \uicontrol Views > \uicontrol Assets.)
\image loginui1-add-assets.webp "The Assets view." \image loginui1-add-assets.webp The Assets view.
\li Select the asset files, and then select \uicontrol Open. \li Select the asset files, and then select \uicontrol Open.
\li Select the location where the files will be saved in the \li Select the location where the files will be saved in the
\uicontrol {Add Resources} dialog. \uicontrol {Add Resources} dialog.
\li Select \uicontrol OK. \li Select \uicontrol OK.
\endlist \endlist
To preview the changes that you make, select the \uicontrol {Live Preview} button Alternatively, drag the asset files from the file browser to the \uicontrol Fonts
or select \key {Alt+P}. or \uicontrol Images tab in the \uicontrol Assets view.
The \e Screen01.ui.qml file that the wizard template created for you should To preview the changes that you make, select the run dropdown menu from the
top toolbar, and then select \uicontrol {Live Preview}, or select \key {Alt+P}.
\note If you can't see the changes that you make in the \uicontrol 2D view,
select \imagereset on the \uicontrol {2D} view toolbar to refresh the
\uicontrol{2D} view.
The \c 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 be open. If it is not, you can double-click it in the \uicontrol Projects view
to open it. to open it.
To modify the \e Screen01 component in the \uicontrol {2D} view: To modify the \e Screen01 component in the \uicontrol {2D} view:
\list 1 \list 1
\li Drag the background image (1) from \uicontrol Assets to the rectangle (2) \li Drag the background image (1) from \uicontrol Assets to the
in \l Navigator. \uicontrol 2D view (2). Use the guidelines (3) to drag the background
\image loginui1-add-image.webp "The project with the new background image." image so that it covers the whole \uicontrol 2D view.
\QDS automatically creates an instance of the \l{Images}{Image} \image loginui1-add-background.webp Adding the background image to the main page.
component for you with the path to the image file set as the Adding an image to the \uicontrol 2D view creates an \l{Images}{Image}
value of \uicontrol Properties > \uicontrol Image > \uicontrol Source. component to your project, which appears under \e rectangle in
\image loginui1-properties-image.webp "Image properties." \uicontrol Navigator. The component is created with the path to the image
\li Drag the Qt logo from \uicontrol Assets to the rectangle file set as the value of \uicontrol Properties > \uicontrol Image >
in \uicontrol Navigator in the same way as in the previous step and \uicontrol Source.
move it to the top-center of the background image in the \uicontrol {2D} view. \image loginui1-properties-image.webp Image properties.
\li Drag the Qt logo from \uicontrol Assets to the background image in
the \uicontrol {2D} view. Use the guidelines to drag the logo
precisely to the top horizontal center of the background image.
\li Drag a \uicontrol Text component from \uicontrol Components > \li Drag a \uicontrol Text component from \uicontrol Components >
\uicontrol {Default Components} > \uicontrol Basic to the rectangle and move it \uicontrol {Default Components} > \uicontrol Basic below the logo image
below the logo image in the \uicontrol {2D} view. in the \uicontrol {2D} view.
\li Select the instance of the text component to edit the text properties in the \li Select the \uicontrol Text component to edit the text properties in the
\uicontrol Properties view: \uicontrol Properties view:
\list \list
\li In \uicontrol Component > \uicontrol ID, enter the ID \li In \uicontrol Component > \uicontrol ID, enter the ID
@@ -133,37 +146,37 @@
\li In \uicontrol Character > \uicontrol Text, enter the tag \li In \uicontrol Character > \uicontrol Text, enter the tag
line: \e {Are you ready to explore?}. line: \e {Are you ready to explore?}.
\li In \uicontrol Character > \uicontrol Font, select \li In \uicontrol Character > \uicontrol Font, select
\e {Titillium Web ExtraLight}. \e {Titillium Web}.
\li In \uicontrol Character > \uicontrol Size, first select the scale to pixels \li In \uicontrol {Style name}, enter \uicontrol ExtraLight.
(\uicontrol px), and then set font size of the tag line to \e 50 (\uicontrol px). \li In \uicontrol Character > \uicontrol Size, set font size of the
tag line to \e 50 \e px.
\li In \uicontrol Character > \uicontrol {Text color}, set the text color to \li In \uicontrol Character > \uicontrol {Text color}, set the text color to
white (\e #ffffff). white (\e #ffffff).
\image loginui1-properties-text.webp "Text properties." \image loginui1-properties-text.webp Text properties.
\endlist \endlist
\li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S} \li Drag the tagline to the horizontal center below the logo using the guidelines.
to save your changes. \li Select \uicontrol File > \uicontrol Save or \key {Ctrl+S} to save
your changes.
\endlist \endlist
Your UI should now look something like this in the \uicontrol {2D} view Your UI should now look something like this in the \uicontrol {2D} view
and \uicontrol {Live Preview}: and \uicontrol {Live Preview}:
\image loginui1-project-main-page.webp "Modified UI with background image, logo, and text." \image loginui1-project-main-page.webp Modified UI with background image, logo, and text.
Resize the \uicontrol {Live Preview} window to see the whole screen.
You can resize the preview dialog to display the whole screen.
\section1 Creating a Push Button \section1 Creating a Push Button
You can use another wizard template to create a push button and to add it to Next, you will use another wizard template to create a push button and add it to
the project. The wizard template creates a reusable button component that the project. The wizard template creates a reusable button component that
appears in \uicontrol Components > \uicontrol {My Components}. appears in \uicontrol Components > \uicontrol {My Components}.
You can drag it to \uicontrol Navigator to create button instances and You can drag it to the \uicontrol 2D view and modify its properties in
modify their properties in the \uicontrol Properties view to change their the \uicontrol Properties view to change its appearance and functionality.
appearance and functionality.
If you cannot use the wizard template nor the preset If you cannot use the wizard template nor the preset \l {Button controls}{button controls}
button controls available in \uicontrol Components > to create the kind of push button that you want, you can create your button from scratch
\uicontrol {Qt Quick Controls} to create the kind of push button that you using default components. For more information, see \l {Creating buttons} and
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}. \l {Creating scalable buttons and borders}.
To create a push button by using the wizard template: To create a push button by using the wizard template:
@@ -172,33 +185,34 @@
\li Select \uicontrol File > \uicontrol {New File} > \li Select \uicontrol File > \uicontrol {New File} >
\uicontrol {Qt Quick Controls} > \uicontrol {Qt Quick Controls} >
\uicontrol {Custom Button} > \uicontrol Choose. \uicontrol {Custom Button} > \uicontrol Choose.
\image loginui1-new-button.webp "New File window." \image loginui1-new-button.webp The New File window for creating a button.
\li In the \uicontrol {Component name} field, enter a name for your \li In the \uicontrol {Component name} field, enter a name for your
button component: \e {EntryField}. button component: \e {EntryField}.
\li Select \uicontrol Finish (or \uicontrol Done on \macos) to create \li Select \uicontrol Finish (or \uicontrol Done on \macos) to create
the button UI file, \e EntryField.ui.qml. the button UI file, \c EntryField.ui.qml.
\endlist \endlist
Your button should now look something like this: Your button should now look something like this:
\image loginui1-button.webp "A new button." \image loginui1-button-new.webp A new button in Qt Design Studio.
Next, you will change the appearance of the EntryField component by Next, you will change the appearance of the EntryField component by
modifying its properties. modifying its properties.
\section1 Styling the button \section1 Styling the button
You can now modify the properties of the EntryField component to your To style your new button, you will edit some of the properties of
liking. To make the changes apply to all the EntryField instances, you the \e EntryField component. To make the changes apply to all the
must make them in the \e EntryField.ui.qml file. EntryField instances, you must make them in the \c EntryField.ui.qml file.
The Custom Button wizard template adds a \e normal state and a \e down state The \uicontrol {Custom Button} wizard template adds a \e normal state
to change the button background and text color when the button is clicked. and a \e down state to change the button background and the text color
You will now change the colors in all states. When you make changes to the when the button is clicked. You will now change the colors in all states.
button in the \e base state, they are automatically applied to the other When you make changes to the button in the \e {Base State}, they are
states. However, the property values that have been explicitly changed in automatically applied to the other states. However, the property values that
the \e normal or \e down state are not changed automatically and you have have been explicitly changed in the \uicontrol normal or \uicontrol down state
to either reset them to the base state or set them separately in that state. are not changed automatically, and you have to either reset them to the
\uicontrol {Base State} or set them separately in that state.
To change the button property values: To change the button property values:
@@ -209,8 +223,7 @@
width (\uicontrol W) to \e 500 and height (\uicontrol H) width (\uicontrol W) to \e 500 and height (\uicontrol H)
to \e 100, to match the width of the tag line. to \e 100, to match the width of the tag line.
\li In the \uicontrol Control section, clear the \uicontrol Hover \li In the \uicontrol Control section, clear the \uicontrol Hover
checkbox because we don't want the hover effect for the button. checkbox because you don't want the hover effect for the button.
\image loginui1-button-control-properties.webp "Control properties."
\li Select \e buttonBackground in \uicontrol Navigator to display its \li Select \e buttonBackground in \uicontrol Navigator to display its
properties in \uicontrol Properties. properties in \uicontrol Properties.
\li In \uicontrol Properties > \uicontrol Rectangle, set: \li In \uicontrol Properties > \uicontrol Rectangle, set:
@@ -220,13 +233,14 @@
\li \uicontrol {Border color} to white (\e #ffffff). \li \uicontrol {Border color} to white (\e #ffffff).
\li \uicontrol Radius to \e 50 to give the button rounded corners. \li \uicontrol Radius to \e 50 to give the button rounded corners.
\endlist \endlist
\image loginui1-button-background-properties-rectangle.webp "Background properties." \image loginui1-button-background-properties-rectangle.webp Background properties.
\li Select \e textItem in \uicontrol Navigator to display its properties \li Select \e textItem in \uicontrol Navigator to display its properties
in \uicontrol Properties. in \uicontrol Properties.
\li In \uicontrol Properties > \uicontrol Character, set: \li In \uicontrol Properties > \uicontrol Character, set:
\list \list
\li \uicontrol Font to \e {Titillium Web ExtraLight}. \li \uicontrol Font to \e {Titillium Web}
\li \uicontrol Size to \e 34 pixels (\uicontrol px). \li \uicontrol {Style name} to \e ExtraLight.
\li \uicontrol Size to \e 34 \e px.
\li \uicontrol {Text color} to white (\e #ffffff). \li \uicontrol {Text color} to white (\e #ffffff).
\li \uicontrol {Alignment H} to left to align the text horizontally to the left. \li \uicontrol {Alignment H} to left to align the text horizontally to the left.
\li \uicontrol {Alignment V} to center to align the text vertically to the center. \li \uicontrol {Alignment V} to center to align the text vertically to the center.
@@ -234,7 +248,7 @@
\li In \uicontrol Properties > \uicontrol Padding > \uicontrol Horizontal > \li In \uicontrol Properties > \uicontrol Padding > \uicontrol Horizontal >
\uicontrol Left, set the padding in the field between background \uicontrol Left, set the padding in the field between background
border and text to \e 50. border and text to \e 50.
\image loginui1-button-text-properties.webp "Text properties." \image loginui1-button-text-properties.webp Text properties of the Button component.
\li In the \uicontrol States view, select the \e normal state and \li In the \uicontrol States view, select the \e normal state and
repeat the changes in the background color and text properties, repeat the changes in the background color and text properties,
as necessary. Repeat for the \e down state. as necessary. Repeat for the \e down state.
@@ -244,7 +258,7 @@
Your button should now look something like this: Your button should now look something like this:
\image loginui1-entry-field-styled.webp "Modified button in the 2D view." \image loginui1-entry-field-styled.webp Modified button in the 2D view.
\note Do not edit the value of \uicontrol Text in the \uicontrol Character \note Do not edit the value of \uicontrol Text in the \uicontrol Character
property because this will break the connection, and later you won't be able property because this will break the connection, and later you won't be able
@@ -258,40 +272,37 @@
You will now add two entry fields to the UI and modify their properties: You will now add two entry fields to the UI and modify their properties:
\list 1 \list 1
\li Double-click \e Screen01.ui.qml in \uicontrol Projects \li Double-click \c Screen01.ui.qml in \uicontrol Projects
to open it in the \uicontrol {2D} view. to open it in the \uicontrol {2D} view.
\li Drag two instances of the EntryField component (1) from \li Drag two \e EntryField components (1) from \uicontrol Components >
\uicontrol Components > \uicontrol {My Components} to the rectangle (2) \uicontrol {My Components} below the tagline in the \uicontrol {2D} view.
in \uicontrol Navigator. Use the guidelines (2) to align the buttons directly below the tagline.
\image loginui1-add-entry-fields.webp "Adding entry fields from the Components view." \image loginui1-add-entry-fields.webp Aligning EntryFields in the 2D view.
\li Select the first EntryField instance in \uicontrol Navigator \li Select the first \e EntryField button in the \uicontrol 2D view or
to modify its ID and text in \uicontrol Properties. \uicontrol Navigator to modify it in \uicontrol Properties.
\li In \uicontrol Component > \uicontrol ID, enter \e username. \list
\li In \uicontrol {Button Content} > \uicontrol Text, enter \li In \uicontrol Component > \uicontrol ID, enter \e username.
\e {Username or Email} and select \uicontrol tr to mark the text \li In \uicontrol {Button Content} > \uicontrol Text, enter
\l {Mark Strings for Translation}{translatable}. \e {Username or Email} and select \uicontrol tr to mark the text
\image loginui1-entry-field-properties.webp "Entry field properties." \l {Mark Strings for Translation}{translatable}.
\li Select the second EntryField instance, and change its ID to \endlist
\image loginui1-entry-field-properties.webp Entry field properties.
\li Select the second \e EntryField, and change its ID to
\e password and text to \e Password. Again, mark the text \e password and text to \e Password. Again, mark the text
translatable. translatable.
\li Move the cursor on the selected button instance to make the
selection icon appear. You can now drag the button instance
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 select \key {Ctrl+S} \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
to save your changes. to save your changes.
\endlist \endlist
\section1 Creating another button \section1 Creating another button
We want to center-align the text of two additional push buttons and use Next, you will add two more buttons to your UI. This time, you want to center-align
brighter colors for them, so we create a second button component as the text of the buttons and use brighter colors for them, so you create a second
instructed in \l{Creating a Push Button}. This time we call it button component as instructed in \l{Creating a Push Button}. This time you call it
\e PushButton. \e PushButton.
To make the changes apply to all the PushButton instances, you To make the changes apply to all the PushButton instances, you
must make them in the \e PushButton.ui.qml file. must make them in the \c PushButton.ui.qml file.
To change the button property values: To change the button property values:
@@ -302,8 +313,8 @@
width (\uicontrol W) to \e 500 and height (\uicontrol H) width (\uicontrol W) to \e 500 and height (\uicontrol H)
to \e 100. to \e 100.
\li In the \uicontrol Control section, clear the \uicontrol Hover \li In the \uicontrol Control section, clear the \uicontrol Hover
checkbox because we don't want the hover effect for the button. checkbox because you don't want the hover effect for the button.
\image loginui1-button-control-properties.webp "Control properties." \image loginui1-button-control-properties.webp Control properties for the Button component.
\li Select \e buttonBackground in \uicontrol Navigator to display its \li Select \e buttonBackground in \uicontrol Navigator to display its
properties in \uicontrol Properties. properties in \uicontrol Properties.
\li In \uicontrol Properties > \uicontrol Rectangle, set: \li In \uicontrol Properties > \uicontrol Rectangle, set:
@@ -316,8 +327,9 @@
its properties in \uicontrol Properties. its properties in \uicontrol Properties.
\li In \uicontrol Properties > \uicontrol Character, set: \li In \uicontrol Properties > \uicontrol Character, set:
\list \list
\li \uicontrol Font to \e {Titillium Web ExtraLight}. \li \uicontrol Font to \e {Titillium Web}
\li \uicontrol Size to \e 34 pixels (\uicontrol px). \li \uicontrol {Style name} to \e ExtraLight..
\li \uicontrol Size to \e 34 \e px.
\li \uicontrol {Text color} to (\e #41cd52). \li \uicontrol {Text color} to (\e #41cd52).
\endlist \endlist
\image loginui1-button2-background-properties-character.webp "Text properties." \image loginui1-button2-background-properties-character.webp "Text properties."
@@ -332,33 +344,31 @@
to save your changes. to save your changes.
\endlist \endlist
Your button should now look something like this: Your button should now look something like this in \e {Base State}:
\image loginui1-button-styled.webp "Modified push button in the 2D view." \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 two buttons to the UI and modify their properties: You will now add two buttons to the UI and modify their properties:
\list 1 \list 1
\li Double-click \e Screen01.ui.qml in \uicontrol Projects \li Select the file dropdown menu (1) from the top toolbar, and then select
to open it in the \uicontrol {2D} view. \c Screen01.ui.qml to open it in the \uicontrol {2D} view.
\li Drag two instances of the PushButton component (1) from \li Drag two PushButton components (2) from \uicontrol Components >
\uicontrol Components > \uicontrol {My Components} to the rectangle (2) \uicontrol {My Components} to the bottom of the background image in
in \uicontrol Navigator. the \uicontrol {2D} view. Use the guidelines (3) to align the push buttons
\image loginui1-add-push-buttons.webp "Adding push buttons from the Components view." horizontally with the entry fields.
\li Drag the button instances to the bottom of the background image in \image loginui1-add-push-buttons.webp Adding push buttons from the Components view.
the \uicontrol {2D} view. Use the guidelines to align the button \li Select the first \e PushButton in \uicontrol Navigator or the \uicontrol 2D view
instances horizontally with the entry fields. to modify it in \uicontrol Properties.
\image loginui1-align-push-buttons.webp "Aligned push buttons." \list
\li Select the first PushButton instance in \uicontrol Navigator \li In \uicontrol Component > \uicontrol ID, enter \e login.
to modify its ID and text label in \uicontrol Properties. \li In \uicontrol {Button Content} > \uicontrol Text, enter \e Continue and
\li In \uicontrol Component > \uicontrol ID, enter \e login. select \uicontrol tr to mark the text translatable.
\li In \uicontrol {Button Content} > \uicontrol Text, enter \endlist
\e Continue and select \uicontrol tr to mark the text \image loginui1-push-button-properties.webp Push button properties.
translatable. \li Select the second \e PushButton and change its ID to
\image loginui1-push-button-properties.webp "Push button properties."
\li Select the second PushButton instance, and change its ID to
\e createAccount and text label to \e {Create Account}. Again, \e createAccount and text label to \e {Create Account}. Again,
mark the text translatable. mark the text translatable.
\li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S} \li Select \uicontrol File > \uicontrol Save or select \key {Ctrl+S}
@@ -368,146 +378,7 @@
The first iteration of your UI is now ready and should now look something The first iteration of your UI is now ready and should now look something
like this in the \uicontrol {2D} view and \uicontrol {Live Preview}: like this in the \uicontrol {2D} view and \uicontrol {Live Preview}:
\image loginui1-ready.webp "The finished UI in the 2D view and live preview." \image loginui1-ready.webp The finished UI in the 2D view and Live Preview.
\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
\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.
\image loginui1-project-files.png
\list
\li The \e {loginui1.qmlproject} project file defines that all
component, JavaScript, and image files in the project folder belong
to the project. Therefore, you do not need to individually list new
files when you add them to the project.
\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}.
By default, this is the main file in the project, but you can
change that in the .qmlproject file. 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 designs using \QB, your main
file is most likely called something else. For more information,
see \l {Exporting from Design Tools}.
\li The \e CMakeLists.txt project configuration file allowing you to
share your project as a fully working C++ application with
developers.
\li The \e {qtquickcontrols2.conf} file specifies the selected
\l {Styling Qt Quick Controls}{UI style} and some style-specific
arguments.
\li The \e imports folder contains \e {Constants.qml} and
\e {DirectoryFontLoader.qml} files that specify a font loader
and a \e qmldir module definition file that declares the Constant
component. For more information, see
\l {Module Definition qmldir Files}. The \e EventListModel.qml and
\e EventListSimulator.qml files are not used in this example, so
you can ignore them for now.
\endlist
\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
\QDS provides preset \l{glossary-component}{components} for creating
UIs, including components for creating and animating visual components,
receiving user input, and creating data models and views.
To be able to use the functionality of preset components, the wizard template
adds the following \e import statements to the UI files (.ui.qml) that it
creates:
\quotefromfile Loginui1/content/Screen01.ui.qml
\skipto import
\printuntil Controls
You can view the import statements in the \uicontrol {Code} view.
The \l Components view lists the components in each module that are
supported by \QDS. You can use the basic components to create your own
components, and they will be listed in \uicontrol {My Components}.
This section is only visible if you have created custom components.
The \l {basic-rectangle}{Rectangle}, \l Text, and \l {Images}{Image}
components used in this tutorial are based on the \l Item component.
It is the base component for all visual elements, with implementation
of basic functions and properties, such as component type, ID, position,
size, and visibility.
For more information, see \l{Use Case - Visual Elements In QML}. For
descriptions of all components, see \l{All QML Types} in the Qt reference
documentation.
\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
a solid fill color or a gradient. You can specify the border color separately.
By setting the value of the radius property, you can create shapes with
rounded corners.
If you want to specify the radius of each corner separately, you can use the
\l{studio-rectangle}{Rectangle} component from the
\uicontrol {Qt Quick Studio Components} module instead of the basic rectangle
component. It is available in \uicontrol Components
> \uicontrol {Qt Quick Studio Components}.
\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
properties for each text component, such as size in points or pixels,
weight, style, and spacing.
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
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
\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
The \e {Custom Button} wizard template creates a button component
based on the \l {Button} control in the \l {Qt Quick Controls} module. It
is a push-button control that can be pushed or clicked by the user. Buttons
are normally used to perform an action or to answer a question. The
properties and functionality inherited from the Button component enable
you to set text, display an icon, react to mouse clicks, and so on.
To be able to use the functionality of the Button control, the wizard template
adds the following \e import statements to the \e EntryField.ui.qml file:
\quotefromfile Loginui1/content/EntryField.ui.qml
\skipto import
\printuntil Controls
\section2 Component IDs
Each component and each instance of a component has an \e ID that uniquely
identifies it and enables other components' properties to be bound to it.
An ID must be unique, it must begin with a lower-case letter or an
underscore character, and it can contain only letters, numbers, and
underscore characters.
For more information, see \l{The id Attribute}.
\section1 Next steps \section1 Next steps
@@ -517,4 +388,6 @@
For a more advanced example of creating a menu button and using it to For a more advanced example of creating a menu button and using it to
construct a button bar, see \l {Side Menu}. construct a button bar, see \l {Side Menu}.
\sa {Creating projects}, {Rectangle}, {Text}, {Images}, {Use Case - Visual Elements In QML}
*/ */

View File

@@ -46,6 +46,16 @@
\li \l {Creating custom components} \li \l {Creating custom components}
\endlist \endlist
\section1 Component IDs
Each component and each instance of a component has an \e ID that uniquely
identifies it and enables other components' properties to be bound to it.
An ID must be unique, it must begin with a lower-case letter or an
underscore character, and it can contain only letters, numbers, and
underscore characters.
For more information, see \l{The id Attribute}.
\section1 Using components economically \section1 Using components economically
It is important to understand the performance costs associated with using It is important to understand the performance costs associated with using

View File

@@ -30,7 +30,7 @@
\row \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 \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. the distance between the components and add margins on the components.
\row \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 \li To align the unanchored components left, right, vertical, horizontal, top, and
@@ -85,7 +85,11 @@
In an \l{Important Concepts In Qt Quick - Positioning#anchors} In an \l{Important Concepts In Qt Quick - Positioning#anchors}
{anchor-based} layout, each component has a set of {anchor-based} layout, each component has a set of
invisible \e anchor lines: top, bottom, left, right, fill, horizontal invisible \e anchor lines: top, bottom, left, right, fill, horizontal
center, vertical center, and baseline. center, vertical center, and baseline. Use anchors to place a component either
adjacent to or inside of another component by attaching one or more of the
component's anchor lines to the anchor lines of the other component. If a
component changes, the components that are anchored to it will adjust
automatically to maintain the anchoring.
To set anchors and margins for components: To set anchors and margins for components: