aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@theqtcompany.com>2016-05-30 16:17:05 +0200
committerNico Vertriest <nico.vertriest@theqtcompany.com>2016-06-02 11:17:05 +0000
commitf043b64c37d35775f5d6498a5d9dfe42cd28b0d7 (patch)
tree39c782d59a7eb1e0f592d2f172401ef27547e979 /src/imports/controls/doc/src
parentceaf6177a8be6db22e629ff05a625e278025b071 (diff)
Doc: Updated doc on usage Controls 2.
Change-Id: If256dafc53d63b174b5cfd03eb91635e062d7c69 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/imports/controls/doc/src')
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc14
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc10
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-input.qdoc28
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc12
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc20
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc4
7 files changed, 81 insertions, 14 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc
index 1786a4f1..c7a68968 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-containers.qdoc
@@ -41,7 +41,8 @@
\image qtquickcontrols2-applicationwindow-wireframe.png
- \l ApplicationWindow contains optional header and footer items.
+ \l ApplicationWindow creates the root window of an application, and makes
+ it easy to add an optional header and footer to that window.
\section1 Frame Control
@@ -62,19 +63,26 @@
\image qtquickcontrols2-page-wireframe.png
\l Page provides page-specific header and footer items.
+ It is perfectly possible to use ApplicationWindow for setting the header
+ and the footer, but if you have a header and footer which varies per
+ screen, then it is better to use \l Page.
\section1 Pane Control
\image qtquickcontrols2-pane.png
\l Pane provides a background color that matches with the application
- style and theme.
+ style and theme. Pane does not provide a layout of its own, but requires
+ you to position its contents, for instance by using a \l RowLayout or
+ a \l ColumnLayout.
\section1 StackView Control
\image qtquickcontrols2-stackview-wireframe.png
- \l StackView organizes content pages into a stack.
+ \l StackView organizes content pages into a stack using a last-in-first-out
+ principle: the last item to be "pushed" onto the stack is the first one to
+ be removed, and the top-most item is always the one that is visible.
\section1 SwipeView Control
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
index 3c8d5ea7..41e9ced4 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
@@ -52,5 +52,15 @@
\l RadioDelegate presents a checkable control that can be toggled on
(checked) or off (unchecked). Radio delegates are typically used to select
one option from a set of options.
+
+ \b {See also} \l {RadioButton Control}.
+
+ \section1 SwitchDelegate Control
+
+ \image qtquickcontrols2-switchdelegate.gif
+
+ \l SwitchDelegate presents a switchable delegate that can be toggled on or off.
+
+ \b {See also} \l {Switch Control}.
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
index dcc0ff9e..0d6818ce 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
@@ -47,8 +47,8 @@
\image qtquickcontrols2-pageindicator.png
- \l PageIndicator is used to indicate the currently active page in
- a container of multiple pages.
+ \l BusyIndicator can be used to show that an operation is in progress,
+ and that the UI has to wait for the operation to complete.
\section1 ScrollBar Control
@@ -63,5 +63,6 @@
\image qtquickcontrols2-scrollindicator.png
\l ScrollIndicator is a non-interactive indicator that indicates the
- current scroll position in a \l Flickable.
+ current scroll position, and can be used to scroll to a specific position in a
+ \l {Flickable}.
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
index 60b2250f..e9aa3646 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
@@ -42,13 +42,30 @@
\image qtquickcontrols2-combobox.png
- \l ComboBox is used to select a value from a drop-down list.
+ \l ComboBox is used to select a value from a static multiple-line drop-down list.
+ It is not possible to add new values, and only one option can be selected.
+
+ Recommendations:
+ \list
+ \li If the number of values is very large, consider applying a filter.
+ \li If the list is very limited, consider using RadioButton. This has the
+ advantage that the user can see all options at the same time.
+ \li Select a default value, the value that will be chosen most often.
+ \endlist
+
+ \b {See also} \l {CheckBox Control}, \l {Tumbler Control}.
\section1 Dial Control
\image qtquickcontrols2-dial.png
- \l Dial is a circular dial that is rotated to set a value.
+ \l Dial is similar to a traditional dial knob that is found on devices such
+ as stereos or industrial equipment.
+
+ The dial is rotated by clicking and dragging, with the handle indicating the
+ value of the dial.
+
+ \b {See also} \l {Tumbler Control}.
\section1 TextArea Control
@@ -62,6 +79,8 @@
\l TextField is a single line text editor.
+ \b {See also} \l {Tumbler Control}.
+
\section1 Slider Control
\image qtquickcontrols2-slider.png
@@ -75,9 +94,14 @@
\l RangeSlider is used to select a range specified by two values,
by sliding each handle along a track.
+
+ \b {See also} \l {Slider Control}.
+
\section1 Tumbler Control
\image qtquickcontrols2-tumbler.png
\l Tumbler is a spinnable wheel of items that can be selected.
+
+ \b {See also} \l {ComboBox Control}.
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
index d54b360c..22b96e96 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
@@ -39,5 +39,15 @@
\image qtquickcontrols2-menu.png
- \l Menu is a traditional menu.
+ \l Menu control can be used for context menus; for example, after
+ right-clicking. It can also be used for popup menus; for example, a
+ menu that is shown after clicking a button.
+
+ \l MenuItem is an item in the Menu control. Each item in a menu:
+ \list
+ \li displays text to the user
+ \li allows checking/unchecking
+ \li is highlighted (for example, on keyboard navigation)
+ \li performs some action on activation
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
index 8ddc2f3a..9180d480 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
@@ -40,17 +40,29 @@
\image qtquickcontrols2-stackview-wireframe.png
- \l StackView provides a stack-based navigation model.
+ \l StackView provides a stack-based navigation model which can be used
+ with a set of interlinked pages. StackView works according to a last-in
+ first-out principle: the page pushed last on the stack is the one visible.
+ Popping a page removes the last page and makes the previous one visible.
\section1 SwipeView Control
\image qtquickcontrols2-swipeview-wireframe.png
- \l SwipeView provides a swipe-based navigation model.
+ \l SwipeView provides a navigation model that simplifies horizontal paged
+ scrolling. The page indicator on the bottom shows which is the presently
+ active page.
- \section1 TabBar and TabButton Controls
+ \section1 TabBar
\image qtquickcontrols2-tabbar-wireframe.png
- \l TabBar and \l TabButton provide a tab-based navigation model.
+ \l TabBar is a bar with icons or text that allows the user to switch
+ between different subtasks, views, or modes.
+
+ \section1 TabButton Control
+
+ \image qtquickcontrols2-tabbutton.png
+
+ \l TabButton is a button with a layout suitable for a TabBar control.
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
index 2ea21f3f..c93f13e4 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
@@ -53,6 +53,8 @@
The \l Menu control displays a vertical list of items that can be selected. It can
be used for offering a list of actions that can be taken in a given context.
+ \b {See also} \l {Drawer Control}.
+
\section1 Popup Control
\image qtquickcontrols2-popup-settings.png
@@ -76,7 +78,7 @@
\image qtquickcontrols2-tooltip.png
\l ToolTip shows a short piece of text that informs the user of a control's
- function.
+ function. It is typically placed above or below the parent control.
Recommendations:
\list