aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/qtquick
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-06-25 17:46:23 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-06-25 15:48:15 +0000
commite2e55a2f88934aa3956915ffacf1f2228c902af0 (patch)
treeba164b5f0f52f9230c6ee1a82fc3bc7c083be2d6 /doc/src/qtquick
parentef40f8445e1fee91753659e88d81cbf5c8045f1a (diff)
Doc: Replace "Qt Quick Designer" with "Design mode" or \QMLD
To make source text usable also for Qt Design Studio manual. Change-Id: I7a5090ea2308a3091c34193cce3a8b57da1eb498 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'doc/src/qtquick')
-rw-r--r--doc/src/qtquick/creator-mobile-app-tutorial.qdoc7
-rw-r--r--doc/src/qtquick/qtquick-app-development.qdoc4
-rw-r--r--doc/src/qtquick/qtquick-app-tutorial.qdoc6
-rw-r--r--doc/src/qtquick/qtquick-components.qdoc8
-rw-r--r--doc/src/qtquick/qtquick-creating.qdoc7
-rw-r--r--doc/src/qtquick/qtquick-designer.qdoc52
-rw-r--r--doc/src/qtquick/qtquick-exporting-qml.qdoc6
-rw-r--r--doc/src/qtquick/qtquick-modules-with-plugins.qdoc29
-rw-r--r--doc/src/qtquick/qtquick-screens.qdoc17
9 files changed, 71 insertions, 65 deletions
diff --git a/doc/src/qtquick/creator-mobile-app-tutorial.qdoc b/doc/src/qtquick/creator-mobile-app-tutorial.qdoc
index f0fddbacfd..f580ea7d06 100644
--- a/doc/src/qtquick/creator-mobile-app-tutorial.qdoc
+++ b/doc/src/qtquick/creator-mobile-app-tutorial.qdoc
@@ -78,12 +78,12 @@
The image appears in \uicontrol Resources. You can also use any other
image or a QML type, instead.
- To create the UI in the \uicontrol Design mode:
+ To create the UI in the Design mode:
\list 1
\li In the \uicontrol Projects view, double-click the \e Page1Form.ui.qml
- file to open it in \QMLD.
+ file to open it in the Design mode.
\li In the \uicontrol Navigator, select \uicontrol Label and press
\key Delete to delete it.
@@ -119,7 +119,8 @@
\endlist
We want to modify the properties of the bubble in ways that are not
- supported by \QMLD, and therefore we create a custom QML type for it:
+ supported in the Design mode, and therefore we create a custom QML
+ type for it:
\list 1
diff --git a/doc/src/qtquick/qtquick-app-development.qdoc b/doc/src/qtquick/qtquick-app-development.qdoc
index 8d373449e1..855f2c7150 100644
--- a/doc/src/qtquick/qtquick-app-development.qdoc
+++ b/doc/src/qtquick/qtquick-app-development.qdoc
@@ -50,10 +50,10 @@
(.ui.qml files). The forms use a purely declarative subset of the
QML language and you can edit them in the Design mode.
- \li \l {Using Qt Quick Designer}
+ \li \l {Editing QML Files in Design Mode}
You can use the \uicontrol {Form Editor} or the
- \uicontrol {Text Editor} of \QMLD in the \uicontrol Design mode to
+ \uicontrol {Text Editor} in the Design mode to
develop Qt Quick applications.
\li \l {Editing PathView Properties}
diff --git a/doc/src/qtquick/qtquick-app-tutorial.qdoc b/doc/src/qtquick/qtquick-app-tutorial.qdoc
index 147df44a43..7809916e82 100644
--- a/doc/src/qtquick/qtquick-app-tutorial.qdoc
+++ b/doc/src/qtquick/qtquick-app-tutorial.qdoc
@@ -48,8 +48,8 @@
\image qmldesigner-tutorial.png "States and transitions example"
- For more information about using \QMLD, see
- \l{Developing Qt Quick Applications}.
+ For more information about developing Qt Quick applications in the Design
+ mode, see \l{Developing Qt Quick Applications}.
For examples of using Qt Quick Controls 2, see
\l{Qt Quick Controls 2 Examples}.
@@ -69,7 +69,7 @@
\list 1
\li In the \uicontrol Projects view, double-click the \e Page1Form.ui.qml
- file to open it in \QMLD.
+ file to open it in the Design mode.
\image qmldesigner-tutorial-design-mode.png "Transitions project in Design Mode"
diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc
index 81897f0a5d..7ddfecf073 100644
--- a/doc/src/qtquick/qtquick-components.qdoc
+++ b/doc/src/qtquick/qtquick-components.qdoc
@@ -92,13 +92,13 @@
Qt Quick Controls 2 achieve improved efficiency by employing a simplified
\l {Styling Qt Quick Controls 2}{styling architecture} when compared to
- Qt Quick Controls, on which the module is based. \QMLD reads the
+ Qt Quick Controls, on which the module is based. The visual editor reads the
\c qtquickcontrols2.conf file that specifies the preferred style and some
style-specific arguments. To change the style, select another style from
the list on the toolbar. This enables you to check how your UI looks when
using the available styles.
- For an example of defining your own style and using it in \QMLD, see
+ For an example of defining your own style and using it in the Design mode, see
\l {Qt Quick Controls 2 - Flat Style}.
Qt Quick Controls 2 work in conjunction with Qt Quick and Qt Quick Layouts.
@@ -112,7 +112,7 @@
Some ready-made controls, such as a gauge, dial, status indicator, and
tumbler, are provided by the \l {Qt Quick Extras} module.
- \section1 Creating Components in Qt Quick Designer
+ \section1 Creating Components in Design Mode
\list 1
@@ -125,7 +125,7 @@
the \uicontrol Library only if the filename begins with a capital
letter.
- \li Click \uicontrol Design to open the .qml file in \QMLD.
+ \li Click \uicontrol Design to open the .qml file in the Design mode.
\li Drag and drop a QML type from the \uicontrol Library to the
\uicontrol Navigator or \uicontrol {Form Editor}.
diff --git a/doc/src/qtquick/qtquick-creating.qdoc b/doc/src/qtquick/qtquick-creating.qdoc
index 1dd045093f..db6397fa16 100644
--- a/doc/src/qtquick/qtquick-creating.qdoc
+++ b/doc/src/qtquick/qtquick-creating.qdoc
@@ -137,7 +137,8 @@
\endlist
- \QC generates a QML file, \e main.qml, that you can modify in \QMLD.
+ \QC generates a QML file, \e main.qml, that you can modify in the Design
+ mode.
\section1 Creating Qt Quick Controls 2 Applications
@@ -184,11 +185,11 @@
\endlist
For the Scroll application, \QC creates a QML file, \e main.qml, that you
- can modify in \QMLD.
+ can modify in the Design mode.
For the Stack and Swipe applications, \QC generates two UI files,
\e Page1Form.ui.qml and \e Page2Form.ui.qml, that you can modify in the
- \QMLD \uicontrol {Form Editor} and a QML file, \e main.qml, that you can
+ \uicontrol {Form Editor} and a QML file, \e main.qml, that you can
modify in the \uicontrol {Text Editor} to add the application logic.
\section1 Creating Qt Quick UI Projects
diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc
index 8c835d12c0..62e66312cc 100644
--- a/doc/src/qtquick/qtquick-designer.qdoc
+++ b/doc/src/qtquick/qtquick-designer.qdoc
@@ -35,16 +35,16 @@
\page creator-using-qt-quick-designer.html
\nextpage qmldesigner-pathview-editor.html
- \title Using Qt Quick Designer
+ \title Editing QML Files in Design Mode
- You can edit \l{Qt Quick UI Forms} (ui.qml files) in \QMLD. \QC opens the
- UI forms in the \uicontrol {Form Editor} tab in the \uicontrol Design mode.
- It is recommended that you use UI forms for components that you want to
- design in \QMLD.
+ \QC opens \l{Qt Quick UI Forms}{UI forms} (ui.qml files) in the
+ \uicontrol {Form Editor} tab in the Design mode. It is
+ recommended that you use UI forms for components that you want to
+ edit in the Design mode.
\image qmldesigner-visual-editor.png "Visual editor"
- Use \QMLD to manage your project:
+ To manage your project in the Design mode:
\list
@@ -170,9 +170,9 @@
\section2 Switching Parent Items
- When you drag and drop instances of QML types to the canvas, Qt Quick Designer
- adds the new item as a child of the item beneath it.
- When you move items on the canvas, Qt Quick Designer cannot determine
+ When you drag and drop instances of QML types to the canvas, the new item
+ is added as a child of the item beneath it. When you move items on the
+ canvas, it is not possible to determine
whether you want to adjust their position or attach them to a new
parent item. Therefore, the parent item is not automatically
changed. To change the parent of the item, press down the \key Shift
@@ -307,7 +307,7 @@
If you use text IDs instead of plain text, change the default call to
\c qsTrId(). Select \uicontrol Tools > \uicontrol Options >
- \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer}, and then select the
+ \uicontrol {Qt Quick} > \uicontrol {\QMLD}, and then select the
\uicontrol {qsTrId()} radio button in the \uicontrol Internationalization
group. For more information about text ID based translations, see
\l {Qt Linguist Manual: Text ID Based Translations}.
@@ -321,19 +321,20 @@
\section2 Loading Placeholder Data
- \QMLD supports views, models, and delegates, so that when you add a Grid
- View, List View, or Path View item, the ListModel and the delegate
+ The Design mode supports views, models, and delegates, so that when you add
+ a Grid View, List View, or Path View item, the ListModel and the delegate
item are added automatically.
- However, the missing context of the application presents a challenge for
- \QMLD. Specific models defined in C++ are the most obvious case. Often,
+ However, the missing context of the application presents a challenge.
+ Specific models defined in C++ are the most obvious case. Often,
the context is missing simple properties, which are either defined in C++,
or in other QML files. A typical example is an item that uses the
properties of its parent, such as \c parent.width.
\section3 Using Dummy Models
- If you open a file in \QMLD that references a C++ model, you see nothing on
+ If you open a file in the Design mode that references a C++ model, you see
+ nothing on
the canvas. If the data in the model is fetched from the internet, you have
no control over it. To get reliable data, \e {dummy data} was introduced.
@@ -387,8 +388,8 @@
}
\endqml
- This works nicely for applications but \QMLD displays a zero-sized item.
- A parent for the opened file does not exist, because the context is
+ This works nicely for applications but the Design mode displays a zero-sized
+ item. A parent for the opened file does not exist, because the context is
missing. To get around the missing context, the idea of a \e {dummy
context} is introduced. If you place a file with the same name as the
application (here, example.qml) in the \c {dummydata/context} directory,
@@ -462,7 +463,7 @@
\endlist
The \uicontrol State pane displays the different \l{State}{states}
- of the component in the Qt Quick Designer. The \uicontrol State pane is
+ of the component in the Design mode. The \uicontrol State pane is
collapsed by default to save space. Select \uicontrol Expand in the context
menu to view the whole pane.
@@ -502,8 +503,9 @@
Click the \inlineimage snapping_and_anchoring.png
button to anchor the item to the items that you snap to.
- Choose \uicontrol {Tools > Options > Qt Quick > Qt Quick Designer} to specify
- settings for snapping. In the \uicontrol {Parent item padding} field, specify the
+ Choose \uicontrol Tools > \uicontrol Options > \uicontrol {Qt Quick} >
+ \uicontrol {\QMLD} to specify settings for snapping. In the
+ \uicontrol {Parent item padding} field, specify the
distance in pixels between the parent item and the snapping lines. In the
\uicontrol {Sibling item spacing} field, specify the distance in pixels between
sibling items and the snapping lines.
@@ -515,7 +517,7 @@
\section2 Hiding Item Boundaries
- \QMLD displays the boundaries of items on the canvas. To hide
+ The Design mode displays the boundaries of items on the canvas. To hide
the boundaries, click the \inlineimage boundingrect.png
button.
@@ -549,14 +551,14 @@
\section2 Specifying Canvas Size
- To change the canvas size, select \uicontrol {Tools > Options > Qt Quick
- > Qt Quick Designer} and
+ To change the canvas size, select \uicontrol Tools > \uicontrol Options >
+ \uicontrol {Qt Quick} > \uicontrol {\QMLD} and
specify the canvas width and height in the \uicontrol Canvas group.
\section2 Refreshing the Canvas
- When you open QML files in \QMLD, the items in the file are drawn on
- the canvas. When you edit the item properties in \QMLD, the QML file and
+ When you open QML files in the Design mode, the items in the file are drawn
+ on the canvas. When you edit the item properties, the QML file and
the image on the canvas might get out of sync. For example, when you change
the position of an item within a column or a row, the new position might
not be displayed correctly on the canvas.
diff --git a/doc/src/qtquick/qtquick-exporting-qml.qdoc b/doc/src/qtquick/qtquick-exporting-qml.qdoc
index d9ad262c81..c4ecf06c01 100644
--- a/doc/src/qtquick/qtquick-exporting-qml.qdoc
+++ b/doc/src/qtquick/qtquick-exporting-qml.qdoc
@@ -66,7 +66,7 @@
development PC. Each layer is exported as an item.
You can open the QML file in \QC for editing. By default, the export scripts
- generate Qt Quick 1 files. To edit the files in \QMLD, change the import
+ generate Qt Quick 1 files. To edit the files in the Design mode, change the import
statements in the export scripts to import Qt Quick 2. Or, you can change
the import statement in each file after generating the files.
@@ -146,8 +146,8 @@
On Linux, run the following command: \c {chmod u+rx}
- \li To generate QML files that you can edit in \QMLD, edit the import
- statement in \e qmlexporter.py. For example:
+ \li To generate QML files that you can edit in the Design mode, edit the
+ import statement in \e qmlexporter.py. For example:
\code
f.write('import QtQuick 2.5\n')
diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
index 816c6c934d..b3b70c0013 100644
--- a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
+++ b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
@@ -43,7 +43,7 @@
information for code completion and the semantic checks to work correctly.
To create a QML module and make it appear in the \uicontrol Library in
- \QMLD:
+ the Design mode:
\list 1
@@ -69,15 +69,15 @@
.pro file: \c {QML_IMPORT_PATH += path/to/module}.
For more information, see \l {Importing QML Modules}.
- \li Make sure that the QML emulation layer of \QMLD is built with
+ \li Make sure that the QML emulation layer used in the Design mode is built with
the same Qt version as your QML modules. For more information, see
- \l {Running QML Modules in Qt Quick Designer}. You can also try
+ \l {Running QML Modules in Design Mode}. You can also try
skipping this step and take it later, if necessary.
\endlist
Your module should now appear in the \uicontrol Imports tab in the
- \uicontrol Library in \QMLD. Your components should appear in the
+ \uicontrol Library in the Design mode. Your components should appear in the
\uicontrol {QML Types} tab if a valid \c .metainfo file is in place.
\section1 Registering QML Types
@@ -93,7 +93,7 @@
for QML modules with plugins before distributing them.
Classes registered with \c qmlRegisterType() can be used as backend objects
- in the \QMLD. For more information, see \l {Adding Connections}.
+ in the Design mode. For more information, see \l {Adding Connections}.
\section1 Generating qmltypes Files
@@ -150,10 +150,10 @@
The import path affects all the targets built by the CMake project.
- \section1 Running QML Modules in Qt Quick Designer
+ \section1 Running QML Modules in Design Mode
- \QMLD uses a QML emulation layer (also called QML Puppet) to render and
- preview images and to collect data. To be able to render custom types
+ A QML emulation layer (also called QML Puppet) is used in the Design mode to
+ render and preview images and to collect data. To be able to render custom types
correctly from QML modules, the emulation layer must be built with the same
Qt version as the QML modules.
@@ -163,20 +163,21 @@
To use an emulation layer that is built with the Qt
configured in the build and run kit for the project, select \uicontrol Tools >
- \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer} >
+ \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {\QMLD} >
\uicontrol {Use QML emulation layer which is built by the selected Qt} radio button.
- \QC builds the emulation layer when you select the \uicontrol Design mode.
+ \QC builds the emulation layer when you select the Design mode.
A plugin should behave differently depending on whether it is run by the
emulation layer or an application. For example, animations should not be run
- in the \uicontrol Design mode. You can use the value of the QML_PUPPET_MODE
+ in the Design mode. You can use the value of the QML_PUPPET_MODE
environment variable to check whether the plugin is currently being run
- by an application or edited in the \uicontrol Design mode.
+ by an application or edited in the Design mode.
- If you want to use a different module in \QMLD than in your actual
+ If you want to use a different module in the Design mode than in your actual
application for example to mockup C++ items, then you can use \c{QML_DESIGNER_IMPORT_PATH}
in the \c{.pro} file.
- Modules in the import paths defined in \c{QML_DESIGNER_IMPORT_PATH} will be used only in \QMLD.
+ Modules in the import paths defined in \c{QML_DESIGNER_IMPORT_PATH} will be
+ used only in the Design mode.
For an example, see \l {Qt Quick Controls 2 - Contact List}.
*/
diff --git a/doc/src/qtquick/qtquick-screens.qdoc b/doc/src/qtquick/qtquick-screens.qdoc
index 17dd3c2d39..fd035049ca 100644
--- a/doc/src/qtquick/qtquick-screens.qdoc
+++ b/doc/src/qtquick/qtquick-screens.qdoc
@@ -120,8 +120,8 @@
Property bindings are created implicitly in QML whenever a property is
assigned a JavaScript expression. To set JavaScript expressions as values of
- properties in \QMLD, click the circle icon next to a property to open a
- context menu, and select \uicontrol {Set Binding}.
+ properties in the Design mode, click the circle icon next to a property to
+ open a context menu, and select \uicontrol {Set Binding}.
\image qmldesigner-set-expression.png "Type properties context menu"
@@ -141,7 +141,8 @@
For more information on the JavaScript environment provided by QML, see
\l{Integrating QML and JavaScript}.
- Bindings are a black box for \QMLD and using them might have a negative impact on
+ Bindings are a black box for the Design mode and using them might have a
+ negative impact on
performance, so consider setting anchors and margins for items, instead.
For example, instead of setting \c {parent.width} for an item, you could
anchor the item to its sibling items on the left and the right.
@@ -167,8 +168,8 @@
(\uicontrol {Reset Anchors}) button to reset the anchors to their saved
state.
- Specifying the baseline anchor in \QMLD is not supported. You can specify it
- in the \uicontrol {Text Editor}.
+ You can specify the baseline anchor in the \uicontrol {Text Editor} in the
+ Design mode.
For performance reasons, you can only anchor an item to its siblings and
direct parent. By default, an item is anchored to its parent when you
@@ -393,9 +394,9 @@
\section2 Using SCXML State Machines
- To use QML and \QMLD together with an SCXML state machine, add states and
- bind them to the state machine in the \uicontrol Backends tab, as described
- in \l {Managing C++ Backend Objects}.
+ To use QML together with an SCXML state machine, add states and bind them to
+ the state machine in the \uicontrol Backends tab in the Design mode, as
+ described in \l {Managing C++ Backend Objects}.
In the \uicontrol States pane, you can edit the \c when condition of states
to map QML states to the states of the SCXML state machine. For an example,