summaryrefslogtreecommitdiff
path: root/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-01-16 16:30:39 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-01-20 13:54:38 +0000
commit4a971127ac06fc81bc503085264ec8fecaa95bc3 (patch)
treeaa744fcc2591b14040c9be570c12e02b700dcb3f /doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
parent11b7074170c0e2278dd8fed60cd789b5846eee81 (diff)
downloadqt-creator-4a971127ac06fc81bc503085264ec8fecaa95bc3.tar.gz
Doc: Add Qt Design Studio Manual sources
To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
Diffstat (limited to 'doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc')
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
new file mode 100644
index 0000000000..71857f95a7
--- /dev/null
+++ b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc
@@ -0,0 +1,79 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the 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.
+**
+****************************************************************************/
+
+/*!
+//! [studio components]
+
+ \section1 Studio Components
+
+ A set of ready-made studio components are available for creating differently
+ shaped objects, such as arcs, pies, or triangles, as well as objects with
+ particular abilities, such as being visibly \e flipped between their front
+ and back sides, like a card. The studio components are built on top of
+ \l {Qt Quick Shapes QML Types}, with some additional properties.
+
+ You can drag-and-drop the following studio components from the
+ \uicontrol Library to the canvas or the \uicontrol Navigator:
+
+ \list
+ \li \l Arc adds an arc that begins and ends at given positions.
+ \li \l Border adds a border with corners that you can shape
+ independently of each other.
+ \li \l Flipable provides a surface that can be flipped.
+ \li \l Group provides an item with the size property.
+ \li \l Iso adds a container for an ISO 7000 icon.
+ \li \l Pie adds a pie slice or a pie with a slice missing from it.
+ \li \l Rectangle adds a rectangle with corners that you can shape
+ independently of each other.
+ \li \l SvgPath adds an SVG path.
+ \li \l Triangle adds a triangle.
+ \endlist
+
+//! [studio components]
+
+//! [creating studio components]
+
+ \section1 Creating Custom Controls
+
+ You can use the project wizard to create a starting point for a custom
+ \l [QtQuickControls2] {Button}, \l [QtQuickControls2] {Pane},
+ \l [QtQuickControls2] {StackView}{Stack View}, or
+ \l [QtQuickControls2] {Switch}.
+
+ \list 1
+ \li Select \uicontrol File > \uicontrol {New File or Project} >
+ \uicontrol {Files and Classes} > \uicontrol {Qt Quick Controls}.
+ \li Select the control to create, and then select \uicontrol Choose.
+
+ \note Components are listed in the \uicontrol {QML Components}
+ section of the \uicontrol Library only if the filename begins
+ with a capital letter.
+ \li Edit component properties in the \uicontrol Properties pane.
+
+ The available properties depend on the QML type.
+ \endlist
+
+//! [creating studio components]
+*/