feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: write QML type names as they appear in the UI

Browse Source 
Use the \l command where links are needed and normal text or
the \uicontrol command, otherwise.

Change-Id: I5da25819dcd051d3a06d48a08964a6e9052bd22a
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2016-11-28 13:59:41 +01:00
parent 96256d1ecc
commit 1d28a2c4ff
2 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/src/qtquick/qtquick-pathview-editor.qdoc
View File

@@ -31,14 +31,15 @@
\title Editing PathView Properties \title Editing PathView Properties
A \l{PathView} lays out data provided by data models on a \l{Path}. A \l{PathView}{Path View} lays out data provided by data models on a
\l{Path}.
A graphical spline editor enables you to specify PathView paths, which A graphical spline editor enables you to specify path view paths, which
is a non-trivial task to do in the code editor. is a non-trivial task to do in the code editor.
\image qmldesigner-pathview-editor.png "PathView editor" \image qmldesigner-pathview-editor.png "PathView editor"
To start editing the Path, double-click the PathView on the canvas. The To start editing the path, double-click the path view on the canvas. The
editor composes the path of PathCubic path objects. They are cubic Bezier editor composes the path of PathCubic path objects. They are cubic Bezier
curves to a given position with two control points. Drag and drop the curves to a given position with two control points. Drag and drop the
control points to construct the curve. control points to construct the curve.
@@ -47,7 +48,7 @@
To make a curve segment linear, select \uicontrol {Make Curve Segment Straight} in To make a curve segment linear, select \uicontrol {Make Curve Segment Straight} in
the context menu. the context menu.
By default, the Path is closed, which means that its start and end points By default, the path is closed, which means that its start and end points
are identical. To create separate start and end points for it, right-click are identical. To create separate start and end points for it, right-click
an edit point to open a context menu, and deselect \uicontrol {Closed Path}. an edit point to open a context menu, and deselect \uicontrol {Closed Path}.
@@ -55,7 +56,7 @@
in the context menu. in the context menu.
In the \uicontrol Properties pane, you can specify other properties for In the \uicontrol Properties pane, you can specify other properties for
the PathView. For example, what is the maximum distance from the path that the path view. For example, what is the maximum distance from the path that
initiates mouse dragging and what is the rate at which a flick will initiates mouse dragging and what is the rate at which a flick will
decelerate. decelerate.

32
doc/src/qtquick/qtquick-screens.qdoc
View File

@@ -79,18 +79,19 @@
\list \list
\li GridView provides a grid vizualization of a model. \li \l{GridView}{Grid View} provides a grid vizualization of a model.
\li ListView provides a list vizualization of a model. \li \l{ListView}{List View} provides a list vizualization of a model.
\li PathView visualizes the contents of a model along a path. \li \l{PathView}{Path View} visualizes the contents of a model along a
path.
\endlist \endlist
When you add a GridView, ListView, or PathView, the ListModel and the When you add a \l{GridView}{Grid View}, \l{ListView}{List View}, or
delegate component that creates an instance for each item in the model are \l{PathView}{Path View}, the ListModel and the delegate component that
added automatically. You can edit item properties creates an instance for each item in the model are added automatically.
in the \uicontrol Properties pane or You can edit item properties in the \uicontrol Properties pane or
in the code editor. You can also replace the default model and in the code editor. You can also replace the default model and
delegate with other, more complex models and delegates in the code editor. delegate with other, more complex models and delegates in the code editor.
@@ -231,9 +232,9 @@
\endlist \endlist
To lay out several items in a Column, Row, Grid, or Flow, select To lay out several items in a \uicontrol Column, \uicontrol Row,
the items on the canvas, and then select \uicontrol Layout in the context \uicontrol Grid, or \uicontrol Flow, select the items on the canvas, and
menu. then select \uicontrol Layout in the context menu.
\section2 Using Layouts \section2 Using Layouts
@@ -249,12 +250,13 @@
\li \l{Layout} provides attached properties for items pushed onto a \li \l{Layout} provides attached properties for items pushed onto a
\uicontrol {Column Layout}, \uicontrol {Row Layout}, or \uicontrol {Grid Layout}. \uicontrol {Column Layout}, \uicontrol {Row Layout}, or \uicontrol {Grid Layout}.
\li ColumnLayout provides a grid layout with only one column. \li \l{ColumnLayout}{Column Layout} provides a grid layout with only one
column.
\li RowLayout provides a grid layout with only one row. \li \l{RowLayout}{Row Layout} provides a grid layout with only one row.
\li GridLayout provides a way of dynamically arranging items in a \li \l{GridLayout}{Grid Layout} provides a way of dynamically arranging
grid. items in a grid.
\endlist \endlist
@@ -372,7 +374,7 @@
\li \l{Flickable} \li \l{Flickable}
items can be flicked horizontally or vertically. items can be flicked horizontally or vertically.
\li FocusScope \li \l{FocusScope}{Focus Scope}
assists in keyboard focus handling when building reusable QML assists in keyboard focus handling when building reusable QML
components. components.