forked from qt-creator/qt-creator
Doc: Update Adding flow items
Fixes: QDS-11405 Change-Id: I1c6e1811a1e5db48e912159b817e2ba7edbc3761 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
committed by
Teea Põldsam
parent
1b52357d01
commit
8c23e1406e
Binary file not shown.
Before Width: | Height: | Size: 12 KiB |
BIN
doc/qtdesignstudio/images/studio-flow-item.webp
Normal file
BIN
doc/qtdesignstudio/images/studio-flow-item.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.0 KiB |
@@ -142,29 +142,26 @@
|
|||||||
|
|
||||||
\title Adding Flow Items
|
\title Adding Flow Items
|
||||||
|
|
||||||
After you create a \l{Adding Flow Views}{Flow View} component, you can
|
After you create a \l{Adding Flow Views}{Flow View} component, use a project wizard
|
||||||
use a project wizard template to add a \uicontrol {Flow Item} component
|
template to add a \uicontrol {Flow Item} component for each screen in the UI.
|
||||||
for each screen in the UI.
|
|
||||||
|
|
||||||
If you \l{Importing 2D Assets}{imported} your screen designs from a
|
If you \l{Importing 2D Assets}{imported} your screen designs from a
|
||||||
design tool as individual \l{glossary-component}{components}
|
design tool as individual \l{glossary-component}{components}
|
||||||
(\e {.ui.qml} files), you can use them as content for flow items.
|
(\e {.ui.qml} files), you can use them as content for flow items like any other components.
|
||||||
The imported components are listed in \uicontrol Components
|
The imported components are listed in \uicontrol Components
|
||||||
> \uicontrol {My Components}.
|
> \uicontrol {My Components}.
|
||||||
|
|
||||||
If you are building your UI from scratch in \QDS, you must first add
|
If you are building your UI from scratch in \QDS, add components to the flow items
|
||||||
components to the flow items to create the screens as you would any
|
first to create the screens as you would any components. For more information, see
|
||||||
components. For more information, see \l {Using Components}. The
|
\l {Using Components}. The flow items that you attach the components to are listed under
|
||||||
flow items that you attach the components to are listed under
|
|
||||||
\uicontrol {My Components}.
|
\uicontrol {My Components}.
|
||||||
|
|
||||||
\image studio-flow-item.png "Custom Flow Item in Components"
|
\image studio-flow-item.webp "Custom Flow Item in Components"
|
||||||
|
|
||||||
\note You must use the wizard to create the flow items. After you create
|
\note You must use the wizard to create the flow items. After you create
|
||||||
a flow view, the \uicontrol {Flow View} module is added to
|
a flow view, the \uicontrol {Flow View} module is added to
|
||||||
\uicontrol Components. It contains a \uicontrol {Flow Item} component that
|
\uicontrol Components. It contains the \uicontrol {Flow Item} component for
|
||||||
you can use to \l{Applying States in Flows}{apply states to flow items}, and
|
\l{Applying States in Flows}{applying states to flow items}, and solely for that purpose.
|
||||||
that you should use solely for that purpose.
|
|
||||||
|
|
||||||
To add flow items:
|
To add flow items:
|
||||||
|
|
||||||
@@ -175,7 +172,7 @@
|
|||||||
to create flow items for each screen in the UI.
|
to create flow items for each screen in the UI.
|
||||||
\li Add content to the flow item in one of the following ways:
|
\li Add content to the flow item in one of the following ways:
|
||||||
\list
|
\list
|
||||||
\li Drag-and-drop components from \uicontrol Components to a
|
\li Drag components from \uicontrol Components to a
|
||||||
flow item in the \l {2D} view or \l Navigator.
|
flow item in the \l {2D} view or \l Navigator.
|
||||||
\li Drag a screen from \uicontrol Components
|
\li Drag a screen from \uicontrol Components
|
||||||
> \uicontrol {My Components} to a flow item in
|
> \uicontrol {My Components} to a flow item in
|
||||||
@@ -184,10 +181,9 @@
|
|||||||
\li In \l Properties, edit the properties of each flow item.
|
\li In \l Properties, edit the properties of each flow item.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
You can now drag the flow items from \uicontrol Components
|
Now, drag the flow items from \uicontrol Components > \uicontrol {My Components} to the
|
||||||
> \uicontrol {My Components} to the flow view in the \uicontrol {2D}
|
flow view in the \uicontrol {2D} or \uicontrol Navigator view. When you have all the flow
|
||||||
or \uicontrol Navigator view. When you have all the flow items in place, you can
|
items in place, \l{Adding Action Areas and Transitions}{add action areas} to them to create
|
||||||
\l{Adding Action Areas and Transitions}{add action areas} to them to create
|
|
||||||
transitions between them.
|
transitions between them.
|
||||||
|
|
||||||
\section1 Flow Item Properties
|
\section1 Flow Item Properties
|
||||||
@@ -203,7 +199,7 @@
|
|||||||
properties are used to \l{Applying States in Flows}{apply states}
|
properties are used to \l{Applying States in Flows}{apply states}
|
||||||
in flows.
|
in flows.
|
||||||
|
|
||||||
To include another flow view into a flow view, select the UI file (.ui.qml)
|
To include another flow view as a flow item into a flow view, select the UI file (.ui.qml)
|
||||||
that specifies the flow view in the \uicontrol {Loader source} field.
|
that specifies the flow view in the \uicontrol {Loader source} field.
|
||||||
|
|
||||||
Usually, a flow item is inactive and invisible when it is not currently
|
Usually, a flow item is inactive and invisible when it is not currently
|
||||||
@@ -212,14 +208,11 @@
|
|||||||
can respond to events and trigger the opening of a dialog, for example,
|
can respond to events and trigger the opening of a dialog, for example,
|
||||||
select the \uicontrol {Force active} checkbox.
|
select the \uicontrol {Force active} checkbox.
|
||||||
|
|
||||||
By default, transitions are drawn from action areas to the target flow item.
|
In the flow view, transitions are drawn from action areas to the target flow item by default.
|
||||||
To draw the transitions from the edges of flow items instead, select the
|
To draw the transitions from the edges of flow items instead, select the
|
||||||
\uicontrol {Join lines} checkbox in the \uicontrol {Transition Lines}
|
\uicontrol {Join lines} checkbox in the \uicontrol {Transition Lines}
|
||||||
section.
|
section.
|
||||||
|
|
||||||
In the \uicontrol Layout tab, you can use \l{Setting Anchors and Margins}
|
|
||||||
{anchors} to position the component.
|
|
||||||
|
|
||||||
In the \uicontrol Advanced section, you can manage the more
|
In the \uicontrol Advanced section, you can manage the more
|
||||||
\l{Specifying Developer Properties}{advanced properties} of components.
|
\l{Specifying Developer Properties}{advanced properties} of components.
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user