Doc: Describe MCU support for types and properties

Fixes: QDS-3072
Change-Id: I3050b706b597d6f9171932c0ab5884b7d8ee094c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Leena Miettinen
2020-11-19 11:38:45 +01:00
parent a812bd7303
commit 095970a57b
5 changed files with 65 additions and 2 deletions

View File

@@ -25,6 +25,14 @@
**
****************************************************************************/
/*!
\externalpage https://doc.qt.io/QtForMCUs/index.html
\title Qt for MCUs
*/
/*!
\externalpage https://doc.qt.io/QtForMCUs/qtul-qmltypes.html
\title Qt for MCUs - All QML Types
*/
/*!
\externalpage https://doc.qt.io/QtForMCUs/qtul-supported-platforms.html
\title Qt for MCUs - Supported Target Platforms

View File

@@ -0,0 +1,45 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator 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.
**
****************************************************************************/
/*!
//! [mcu qtquick components]
\section1 Creating UIs for MCUs
\l{Qt for MCUs} enables you to use subsets of QML and Qt Quick Controls
types to create UIs for devices that are powered by microcontroller units
(MCU). The subset of supported types depends on the Qt for MCUs version
that you use for development. In this manual, we indicate which components
are supported at the time of writing, but you should always check the
\l{Qt for MCUs - All QML Types}{listing of supported QML types} for the
latest state.
To develop for MCUs, \l{Using Project Wizards}{create an MCU project}.
Only a subset of properties is supported for the supported types. The
properties that are not available on MCUs are marked in the
\uicontrol Properties view by enclosing them in square brackets.
//! [mcu qtquick components]
*/

View File

@@ -222,33 +222,39 @@
The following table lists the QML types that you can use to draw shapes.
The \e Location column contains the tab name where you can find the type
in \uicontrol Library.
in \uicontrol Library. The \e MCU column indicates which types are supported
on MCUs.
\table
\header
\li Icon
\li Name
\li Location
\li MCU
\li Purpose
\row
\li \inlineimage icons/item-arc-16px.png
\li \l Arc
\li Studio Components
\li
\li An arc that begins and ends at given positions.
\row
\li \inlineimage icons/custom-border-16px.png
\li \l Border
\li Studio Components
\li
\li A line with four segments that you can show and shape individually.
\row
\li \inlineimage icons/item-pie-16px.png
\li \l Pie
\li Studio Components
\li
\li A pie slice or a pie with a slice missing from it.
\row
\li \inlineimage rect-icon16.png
\li \l Rectangle
\li Qt Quick - Basic
\li \inlineimage ok
\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.
@@ -256,6 +262,7 @@
\li \inlineimage icons/custom-rectangle-16px.png
\li \l{Studio Rectangle}{Rectangle}
\li Studio Components
\li
\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.
@@ -263,6 +270,7 @@
\li \inlineimage icons/item-triangle-16px.png
\li \l Triangle
\li Studio Components
\li
\li A triangle with different dimensions and shapes that is
enclosed in an invisible rectangle.
\endtable

View File

@@ -156,6 +156,8 @@
\include qtdesignstudio-visual-effects.qdocinc qml visual effects
\endif
\include qtquick-mcu-support.qdocinc mcu qtquick components
\section1 Styling Controls
Qt Quick Controls provide lightweight QML types for creating performant

View File

@@ -63,7 +63,7 @@
or create them from scratch using the following wizards:
\list
\li \uicontrol {MCU Support Application} creates an application that
\li \uicontrol {Qt for MCUs Application} creates an application that
uses a subset of \l{Qt QML} and \l{Qt Quick Controls} types (as
supported by Qt for MCUs) that you can deploy, run, and debug on
MCU boards.