aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2016-11-01 16:36:28 +0100
committerJ-P Nurmi <jpnurmi@qt.io>2016-11-02 10:12:21 +0000
commitac53939d496c2b3802f785d2bdf0047ecad7f876 (patch)
tree54319a7a75b6e8cf73540caa01452095a1b14e64 /src
parent359b307398100ec4a7c427ad55f669fd36e4331d (diff)
Doc: BusyIndicator vs. indeterminate ProgressBar
Change-Id: I48bb051bdfe18923749f71f9f0be39a0361723f5 Task-number: QTBUG-55904 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/quicktemplates2/qquickbusyindicator.cpp12
-rw-r--r--src/quicktemplates2/qquickprogressbar.cpp24
2 files changed, 36 insertions, 0 deletions
diff --git a/src/quicktemplates2/qquickbusyindicator.cpp b/src/quicktemplates2/qquickbusyindicator.cpp
index 73181ec7..dc7acbd4 100644
--- a/src/quicktemplates2/qquickbusyindicator.cpp
+++ b/src/quicktemplates2/qquickbusyindicator.cpp
@@ -61,6 +61,18 @@ QT_BEGIN_NAMESPACE
}
\endqml
+ BusyIndicator is similar to an indeterminate \l ProgressBar. Both can be
+ used to indicate background activity. The main difference is visual, and
+ that ProgressBar can also present a concrete amount of progress (when it
+ can be determined). Due to the visual difference, busy indicators and
+ indeterminate progress bars fit different places in user interfaces.
+ Typical places for a busy indicator:
+ \list
+ \li in the corner of a \l ToolBar
+ \li as an overlay on top of a \l Page
+ \li on the side of an \l ItemDelegate
+ \endlist
+
\sa {Customizing BusyIndicator}, {Indicator Controls}, ProgressBar
*/
diff --git a/src/quicktemplates2/qquickprogressbar.cpp b/src/quicktemplates2/qquickprogressbar.cpp
index 7bf30318..5d5503e6 100644
--- a/src/quicktemplates2/qquickprogressbar.cpp
+++ b/src/quicktemplates2/qquickprogressbar.cpp
@@ -59,6 +59,30 @@ QT_BEGIN_NAMESPACE
}
\endcode
+ ProgressBar also supports a special \l indeterminate mode, which is useful,
+ for example, when unable to determine the size of the item being downloaded,
+ or if the download progress gets interrupted due to a network disconnection.
+
+ \image qtquickcontrols2-progressbar-indeterminate.gif
+
+ \code
+ ProgressBar {
+ indeterminate: true
+ }
+ \endcode
+
+ The indeterminate mode is similar to a \l BusyIndicator. Both can be used
+ to indicate background activity. The main difference is visual, and that
+ ProgressBar can also present a concrete amount of progress (when it can be
+ determined). Due to the visual difference, indeterminate progress bars and
+ busy indicators fit different places in user interfaces. Typical places for
+ an indeterminate progress bar:
+ \list
+ \li at the bottom of a \l ToolBar
+ \li inline within the content of a \l Page
+ \li in an \l ItemDelegate to show the progress of a particular item
+ \endlist
+
\sa {Customizing ProgressBar}, BusyIndicator, {Indicator Controls}
*/