Commit 8399fe14 authored by Riitta-Leena Miettinen's avatar Riitta-Leena Miettinen
Browse files

Doc: Fix ambiguous links



Use the [QML] specifier to make sure that the links lead
to QML type documentation.

Change-Id: I93afda14a72cdfe5e941378e332f66bdfe131352
Reviewed-by: Topi Reiniö's avatarTopi Reiniö <topi.reinio@qt.io>
parent bf8f998b
......@@ -106,8 +106,8 @@
\endlist
To create a graphical button that scales beautifully without using vector
graphics, use the \l{BorderImage} type. For more information, see
\l{Creating Scalable Buttons and Borders}.
graphics, use the \l [QML]{BorderImage}{Border Image} type. For more
information, see \l{Creating Scalable Buttons and Borders}.
*/
......@@ -121,17 +121,17 @@
\title Creating Scalable Buttons and Borders
You can use the
\l{BorderImage} type to display an image, such as a PNG file, as a border
and a background.
You can use the \l [QML]{BorderImage}{Border Image} type to display an
image, such as a PNG file, as a border and a background.
Use two border images and suitable graphics to make it look like the
button is pushed down when it is clicked. One of the border images
is visible by default. You can specify that it is hidden and the other one
becomes visible when the mouse is clicked.
Add a \l MouseArea type that covers the whole area and emits the clicked
signal (\c {item.clicked()}) when it detects a mouse click.
Add a \l [QML]{MouseArea}{Mouse Area} type that covers the whole area and
emits the clicked signal (\c {item.clicked()}) when it detects a mouse
click.
You can add text to the button and set it up as a property. The text can
then be initialized from the outside, making the button a reusable UI
......
......@@ -48,28 +48,28 @@
\list
\li \l{BorderImage} uses an image as a border or background.
\li \l [QML]{BorderImage}{Border Image} uses an image as a border or background.
\li \l{Image}
\li \l [QML]{Image}
adds a bitmap to the scene. You can stretch and tile images.
\li \l{Item}
\li \l [QML]{Item}
is the most basic of all visual types in QML. Even though it has no
visual appearance, it defines all the properties that are common
across visual types, such as the x and y position, width and height,
anchoring, and key handling.
\li \l{Rectangle}
\li \l [QML]{Rectangle}
adds a rectangle that is painted with a solid fill color and an
optional border. You can also use the radius property to create
rounded rectangles.
\li \l{Text} adds formatted read-only text.
\li \l [QML]{Text} adds formatted read-only text.
\li \l{TextEdit}
\li \l [QML]{TextEdit}{Text Edit}
adds a single line of editable formatted text that can be validated.
\li \l{TextInput}
\li \l [QML]{TextInput}{Text Input}
adds a single line of editable plain text that can be validated.
\omit
......
......@@ -376,8 +376,8 @@
You can double-click objects on the canvas to edit their text, color, or
source properties inline.
Because you can specify several of these properties for some QML types, such
as TextEdit, you can also right-click objects to open the inline editors
from a context-menu.
as \l [QML]{TextEdit}{Text Edit}, you can also right-click objects to open
the inline editors from a context-menu.
\image qmldesigner-inline-editing.png
......
......@@ -40,8 +40,9 @@
You can export designs from graphics software, such as Adobe Photoshop and
GIMP, to QML files. Each scene is converted into a single QML file with an
Image or a Text item for each layer and saved on the development PC.
Top-level layer groups are converted into merged QML Image types.
\l [QML]{Image} or a \l [QML]{Text} item for each layer and saved on the
development PC. Top-level layer groups are converted into merged QML
\l [QML]{Image} types.
\note GIMP does not support grouping, and therefore, each layer is exported
as an item in GIMP.
......@@ -74,8 +75,8 @@
\li Offset, size, ordering and opacity are preserved.
\li Text layers are converted to Text items, unless you specify that
they be converted to Image items.
\li Text layers are converted to \l [QML]{Text} items, unless you
specify that they be converted to \l [QML]{Image} items.
\li Hidden layers can be exported, and their visibility is set to
hidden.
......@@ -93,7 +94,7 @@
\li To minimize the number of items, minimize the number of layers or
use top-level layer groups, because each layer or layer group is
exported as a Text or Image item.
exported as a \l [QML]{Text} or \l [QML]{Image} item.
\li To make sure that all related items are exported to the same
item, use top-level layer groups.
......@@ -153,10 +154,10 @@
location for the QML file.
\li Select the \uicontrol {Rasterize text} check box to export text layers as
images, not as Text items.
images, not as \l [QML]{Text} items.
\li Select the \uicontrol {Group layers} check box to export each top-level
group as a merged QML Image item.
group as a merged QML \l [QML]{Image} item.
\li Select the \uicontrol {Export hidden} check box to export hidden layers
and to set their visibility property to hidden.
......
......@@ -218,15 +218,15 @@
\list
\li \l{Column} arranges its child items vertically.
\li \l[QML] {Column} arranges its child items vertically.
\li \l{Row} arranges its child items horizontally.
\li \l[QML] {Row} arranges its child items horizontally.
\li \l{Grid}
\li \l[QML] {Grid}
arranges its child items so that they are aligned in a grid and
are not overlapping.
\li \l{Flow}
\li \l[QML] {Flow}
arranges its child items side by side, wrapping as necessary.
\endlist
......@@ -376,7 +376,7 @@
assists in keyboard focus handling when building reusable QML
components.
\li MouseArea enables simple mouse handling.
\li \l [QML]{MouseArea}{Mouse Area} enables simple mouse handling.
\endlist
......
......@@ -54,7 +54,7 @@
\section1 Previewing Images
The Qt Quick Toolbar for images allows you to edit the properties of
BorderImage and \l{Image} items.
\l [QML]{BorderImage}{Border Image} and \l [QML]{Image} items.
You can scale and tile the images, replace them with other images,
preview them, and change the image margins.
......@@ -95,7 +95,7 @@
\section1 Editing Rectangles
The Qt Quick Toolbar for rectangles allows you to edit the properties of
\l{Rectangle} items. You can change the fill and border colors and add
\l [QML]{Rectangle} items. You can change the fill and border colors and add
gradients.
\image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles"
......
......@@ -53,7 +53,7 @@
\li Other bindings than pure expressions
\li Signal handlers
\li States in other items than the root item
\li Root items that are not derived from \l QQuickItem or \l Item
\li Root items that are not derived from \l QQuickItem or \l [QML]{Item}
\endlist
The following types are not supported:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment