aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-06-01 13:18:06 +0200
committerLiang Qi <liang.qi@qt.io>2016-06-01 13:19:21 +0200
commit14e08bafc88824f3d16602b04b5e60ae8c4005b0 (patch)
tree47a831782fe60e26e6bba7ff8e5a0c3ac0a81c42 /src/imports/controls/doc/src
parent2ebb1fdcafaba9d3b0e7fbb42ccd5c3ffde38fbf (diff)
parentceaf6177a8be6db22e629ff05a625e278025b071 (diff)
Merge remote-tracking branch 'origin/5.7' into dev
Comparing colors in tst_material.qml works fine now. Conflicts: examples/quickcontrols2/gallery/qtquickcontrols2.conf tests/auto/material/data/tst_material.qml Task-number: QTBUG-53556 Change-Id: I59970442a09bd72bf0ce53fe838c560ca8daf325
Diffstat (limited to 'src/imports/controls/doc/src')
-rw-r--r--src/imports/controls/doc/src/includes/qquickswitch.qdocinc4
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc2
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-default.qdoc2
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc124
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-material.qdoc28
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc35
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc47
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc28
8 files changed, 235 insertions, 35 deletions
diff --git a/src/imports/controls/doc/src/includes/qquickswitch.qdocinc b/src/imports/controls/doc/src/includes/qquickswitch.qdocinc
index aee93a26..32ccbb89 100644
--- a/src/imports/controls/doc/src/includes/qquickswitch.qdocinc
+++ b/src/imports/controls/doc/src/includes/qquickswitch.qdocinc
@@ -4,7 +4,7 @@ This property holds the logical position of the thumb indicator.
The position is defined as a percentage of the indicator's size, scaled to
\c 0.0 - \c 1.0. The position can be used for example to determine whether
-the thumb has been dragged past the halfway. For visualizing a thumb
+the thumb has been dragged past the halfway point. For visualizing a thumb
indicator, the right-to-left aware \l visualPosition should be used instead.
\sa visualPosition
@@ -21,7 +21,7 @@ The position is defined as a percentage of the indicator's size, scaled to
value is equal to \c {1.0 - position}. This makes the value suitable for
visualizing the thumb indicator taking right-to-left support into account.
In order to for example determine whether the thumb has been dragged past
-the halfway, the logical \l position should be used instead.
+the halfway point, the logical \l position should be used instead.
\sa position
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
index 19f1889e..559c89f0 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc
@@ -585,7 +585,7 @@
SwipeDelegate consists of six visual items: \l {Control::background}{background},
\l {Control::contentItem}{content item}, \l {AbstractButton::indicator}{indicator},
- \c exposure.left, \c exposure.right, and \c exposure.behind.
+ \c swipe.left, \c swipe.right, and \c swipe.behind.
\image qtquickcontrols2-swipedelegate-custom.png
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-default.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-default.qdoc
index 8ff518f5..88faf25a 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-default.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-default.qdoc
@@ -45,6 +45,8 @@
does not implement a certain control, the Default style implementation of
that control is selected.
+ \b {See also} \l {Material Style}, \l {Universal Style}
+
\section1 Related Information
\list
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc
index c80f8ccd..31c8b196 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-differences.qdoc
@@ -130,7 +130,7 @@
\li C++
\endtable
- \b {* No hover support}
+ \b {* No hover effects}
\section2 Porting Qt Quick Controls Code
@@ -180,15 +180,18 @@
This works with both modules, and will reduce the amount of work needed
when the migration begins.
- \section3 Type Changes
+ \section3 Type Comparison Table
\table
\header
- \li Qt Quick Controls
- \li Qt Quick Controls 2
+ \li Qt Quick Controls 1, Qt Quick Extras
+ \li Qt Quick Controls 2, Qt Labs Calendar
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {AbstractButton}
\row
\li \l [QML QtQuickControls] {Action}
- \li No equivalent; see \l [QML QtQuick] {Shortcut} instead.
+ \li \span {} {\mdash \nbsp \sub {(see \l [QML QtQuick] {Shortcut} instead)}}
\row
\li \l [QML QtQuickControls] {ApplicationWindow}
\li \l [QML QtQuickControls2] {ApplicationWindow}
@@ -199,23 +202,52 @@
\li \l [QML QtQuickControls] {Button}
\li \l [QML QtQuickControls2] {Button}
\row
+ \li \l [QML QtQuickExtras] {CircularGauge}
+ \li \mdash
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Control}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Container}
+ \row
\li \l [QML QtQuickControls] {Calendar}
- \li No equivalent; see \l [QML] {MonthGrid}, \l [QML] {DayOfWeekRow} and \l [QML] {WeekNumberColumn} instead.
+ \li \l [QML QtLabsCalendar] {MonthGrid},
+ \l [QML QtLabsCalendar] {DayOfWeekRow},
+ \l [QML QtLabsCalendar] {WeekNumberColumn}
\row
\li \l [QML QtQuickControls] {CheckBox}
\li \l [QML QtQuickControls2] {CheckBox}
\row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {CheckDelegate}
+ \row
\li \l [QML QtQuickControls] {ComboBox}
\li \l [QML QtQuickControls2] {ComboBox}
\row
+ \li \l [QML QtQuickExtras] {DelayButton}
+ \li \mdash
+ \row
+ \li \l [QML QtQuickExtras] {Dial}
+ \li \l [QML QtQuickControls2] {Dial}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Drawer}
+ \row
\li \l [QML QtQuickControls] {ExclusiveGroup}
\li \l [QML QtQuickControls2] {ButtonGroup}
\row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Frame}
+ \row
+ \li \l [QML QtQuickExtras] {Gauge}
+ \li \mdash
+ \row
\li \l [QML QtQuickControls] {GroupBox}
-
- \li \l [QtQuickControls2] {GroupBox}, or \l [QML QtQuickControls2] {Frame}
- if a title is not required.
-
+ \li \l [QML QtQuickControls2] {GroupBox}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {ItemDelegate}
\row
\li \l [QML QtQuickControls] {Label}
\li \l [QML QtQuickControls2] {Label}
@@ -223,12 +255,39 @@
\li \l [QML QtQuickControls] {Menu}
\li \l [QML QtQuickControls2] {Menu}
\row
+ \li \l [QML QtQuickControls] {MenuItem}
+ \li \l [QML QtQuickControls2] {MenuItem}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Page}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {PageIndicator}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Pane}
+ \row
+ \li \l [QML QtQuickExtras] {Picture}
+ \li \mdash
+ \row
+ \li \l [QML QtQuickExtras] {PieMenu}
+ \li \mdash
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {Popup}
+ \row
\li \l [QML QtQuickControls] {ProgressBar}
\li \l [QML QtQuickControls2] {ProgressBar}
\row
\li \l [QML QtQuickControls] {RadioButton}
\li \l [QML QtQuickControls2] {RadioButton}
\row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {RadioDelegate}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {RangeSlider}
+ \row
\li \l [QML QtQuickControls] {ScrollView}
\li \l [QML QtQuickControls2] {ScrollBar},
\l [QML QtQuickControls2] {ScrollIndicator}
@@ -239,24 +298,36 @@
\li \l [QML QtQuickControls] {SpinBox}
\li \l [QML QtQuickControls2] {SpinBox}
\row
- \li \l [QML QtQuickControls] {Stack},
- \l [QML QtQuickControls] {StackView},
- \l [QML QtQuickControls] {StackViewDelegate}
+ \li \l [QML QtQuickControls] {StackView},
+ \l [QML QtQuickControls] {StackViewDelegate},
+ \l [QML QtQuickControls] {Stack}
\li \l [QML QtQuickControls2] {StackView}
\row
\li \l [QML QtQuickControls] {StatusBar}
- \li No equivalent
+ \li \mdash
+ \row
+ \li \l [QML QtQuickExtras] {StatusIndicator}
+ \li \mdash
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {SwipeDelegate}
+ \row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {SwipeView}
\row
\li \l [QML QtQuickControls] {Switch}
\li \l [QML QtQuickControls2] {Switch}
\row
- \li \l [QML QtQuickControls] {Tab},
- \l [QML QtQuickControls] {TabView}
- \li \l [QML QtQuickControls2] {TabBar} in combination with, for example,
- \l [QML QtQuickControls2] {SwipeView}.
+ \li \mdash
+ \li \l [QML QtQuickControls2] {SwitchDelegate}
+ \row
+ \li \l [QML QtQuickControls] {TabView},
+ \l [QML QtQuickControls] {Tab}
+ \li \l [QML QtQuickControls2] {TabBar},
+ \l [QML QtQuickControls2] {TabButton}
\row
\li \l [QML QtQuickControls] {TableView}
- \li No equivalent
+ \li \mdash
\row
\li \l [QML QtQuickControls] {TextArea}
\li \l [QML QtQuickControls2] {TextArea}
@@ -264,21 +335,32 @@
\li \l [QML QtQuickControls] {TextField}
\li \l [QML QtQuickControls2] {TextField}
\row
+ \li \l [QML QtQuickExtras] {ToggleButton}
+ \li \mdash
+ \row
\li \l [QML QtQuickControls] {ToolBar}
\li \l [QML QtQuickControls2] {ToolBar}
\row
\li \l [QML QtQuickControls] {ToolButton}
\li \l [QML QtQuickControls2] {ToolButton}
\row
+ \li \mdash
+ \li \l [QML QtQuickControls2] {ToolTip}
+ \row
\li \l [QML QtQuickControls] {TreeView}
- \li No equivalent
+ \li \mdash
+ \row
+ \li \l [QML QtQuickExtras] {Tumbler},
+ \l [QML QtQuickExtras] {TumblerColumn}
+ \li \l [QML QtQuickControls2] {Tumbler}
\endtable
\section1 Related Information
\list
\li \l{Qt Quick}
- \li \l{Qt Quick Controls}
\li \l{Qt Quick Controls 2 QML Types}
+ \li \l{Qt Quick Controls QML Types}
+ \li \l{Qt Quick Extras QML Types}
\endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index b96ffaa0..cf5d8840 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -32,7 +32,7 @@
The Material Style is based on the Google Material Design Guidelines.
\l{detailed-desc-material}{More...}
- \styleimport {QtQuick.Controls.Material 2.0}
+ \styleimport {QtQuick.Controls.Material 2.0} {Qt 5.7}
\section1 Attached Properties
@@ -44,6 +44,12 @@
\li \l {theme-attached-prop}{\b theme} : enumeration
\endlist
+ \section1 Attached Methods
+
+ \list
+ \li color \l {color-attached-method}{\b color}(enumeration predefined)
+ \endlist
+
\section1 Detailed Description
\target detailed-desc-material
@@ -200,6 +206,8 @@
\value Material.Grey \stylecolor {#9E9E9E} {}
\value Material.BlueGrey \stylecolor {#607D8B} {}
+ \b {See also} \l {Default Style}, \l {Universal Style}
+
\section1 Attached Property Documentation
\styleproperty {Material.accent} {color} {accent-attached-prop}
@@ -262,6 +270,24 @@
\endstyleproperty
+ \section1 Attached Method Documentation
+
+ \stylemethod {color} {color} {enumeration} {predefined} {color-attached-method}
+ \target color-attached-method
+ This attached method returns the color value of the specified \l {pre-defined colors}
+ {pre-defined color}.
+
+ \qml
+ import QtQuick 2.0
+ import QtQuick.Controls.Material 2.0
+
+ Rectangle {
+ color: Material.color(Material.Red)
+ }
+ \endqml
+
+ \endstylemethod
+
\section1 Related Information
\list
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
index 0d70028f..2ea21f3f 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
@@ -42,20 +42,49 @@
\l Drawer provides a swipe-based side panel, similar to those often used
in touch interfaces to provide a central location for navigation.
+ The drawer can be positioned at any of the four edges of the screen. It allows
+ the user to add navigation without taking up valuable screen space. The user can
+ show and hide the drawer at any time with a simple swipe movement.
+
\section1 Menu Control
\image qtquickcontrols2-menu.png
- \l Menu is a traditional menu.
+ 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.
\section1 Popup Control
- \l Popup is the base type of popup-like user interface controls.
+ \image qtquickcontrols2-popup-settings.png
+
+ A \l Popup displays content over other application content.
+ It prompts the user to make a decision or enter information.
+
+ Popups can be modal or non-modal. A modal popup blocks users from interacting
+ with the application until they have made a choice and closed the popup.
+
+ A popup can be used for:
+
+ \list
+ \li communicating a message to the user that he must read and acknowledge.
+ \li displaying an error message.
+ \li prompting the user to make a choice and/or enter a value.
+ \endlist
\section1 ToolTip Control
\image qtquickcontrols2-tooltip.png
\l ToolTip shows a short piece of text that informs the user of a control's
- function. It is typically placed above or below the parent control.
+ function.
+
+ Recommendations:
+ \list
+ \li Use a tooltip if a control has little or no descriptive text, or needs
+ a short explanation.
+ \li Use a tooltip only if the information on a particular control is not
+ available elsewhere in the screen.
+ \li Keep the tooltip text short so that it does not cover other content
+ while being displayed.
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
index d2c4c5f3..98f9a212 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
@@ -29,11 +29,46 @@
\page qtquickcontrols2-styles.html
\title Styling Qt Quick Controls 2
- Qt Quick Controls 2 comes with a selection of styles. The \l {Default Style}
- {Default} style is a simple and light-weight all-round style that offers
- the maximum performance for Qt Quick Controls 2. The more advanced
- \l {Universal Style}{Universal} and \l {Material Style}{Material} styles
- offer an appealing design, but require more system resources.
+ Qt Quick Controls 2 comes with a selection of styles.
+
+ \raw HTML
+ <table style="background:transparent; border:0px">
+ <tr>
+ <td style="border:0px">
+ <a href="qtquickcontrols2-default.html">
+ <img src="images/qtquickcontrols2-default.png" width="45%"/>
+ </a>
+ </td>
+ <td style="border:0px">
+ <a href="qtquickcontrols2-material.html">
+ <img src="images/qtquickcontrols2-material.png" width="75%"/>
+ </a>
+ </td>
+ <td style="border:0px">
+ <a href="qtquickcontrols2-universal.html">
+ <img src="images/qtquickcontrols2-universal.png" width="75%"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="border:0px">
+ The <a href="qtquickcontrols2-default.html">Default</a> style is
+ a simple and light-weight all-round style that offers the maximum
+ performance for Qt Quick Controls 2.
+ </td>
+ <td style="border:0px">
+ The <a href="qtquickcontrols2-material.html">Material</a> style offers an appealing design
+ based on the <a href="https://www.google.com/design/spec/material-design/introduction.html">
+ Google Material Design Guidelines</a>, but requires more system resources than the Default style.
+ </td>
+ <td style="border:0px">
+ The <a href="qtquickcontrols2-universal.html">Universal</a> style offers an appealing design
+ based on the <a href="https://dev.windows.com/design">Microsoft Universal Design Guidelines</a>,
+ but requires more system resources than the Default style.
+ </td>
+ </tr>
+ </table>
+ \endraw
\section1 Using Styles in Qt Quick Controls 2
@@ -48,7 +83,7 @@
\section2 Using QQuickStyle in C++
- \l QQuickStyle provides API configuring a specific style. The following
+ \l QQuickStyle provides API for configuring a specific style. The following
example runs a Qt Quick Controls 2 application with the Material style:
\code
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
index ac2c051d..fbfca8d1 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
@@ -32,7 +32,7 @@
The Universal Style is based on the Microsoft Universal Design Guidelines.
\l {detailed-desc-universal}{More...}
- \styleimport {QtQuick.Controls.Universal 2.0}
+ \styleimport {QtQuick.Controls.Universal 2.0} {Qt 5.7}
\section1 Attached Properties
@@ -43,6 +43,12 @@
\li \l {theme-attached-prop}{\b theme} : enumeration
\endlist
+ \section1 Attached Methods
+
+ \list
+ \li color \l {color-attached-method}{\b color}(enumeration predefined)
+ \endlist
+
\section1 Detailed Description
\target detailed-desc-universal
@@ -159,6 +165,8 @@
style-specific tweaks can be applied without creating a hard dependency to
a style.
+ \b {See also} \l {Default Style}, \l {Material Style}
+
\section1 Attached Property Documentation
\styleproperty {Universal.accent} {color} {accent-attached-prop}
@@ -225,6 +233,24 @@
\endstyleproperty
+ \section1 Attached Method Documentation
+
+ \stylemethod {color} {color} {enumeration} {predefined} {color-attached-method}
+ \target color-attached-method
+ This attached method returns the color value of the specified \l {pre-defined colors}
+ {pre-defined color}.
+
+ \qml
+ import QtQuick 2.0
+ import QtQuick.Controls.Universal 2.0
+
+ Rectangle {
+ color: Universal.color(Universal.Red)
+ }
+ \endqml
+
+ \endstylemethod
+
\section1 Related Information
\list