aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@theqtcompany.com>2016-05-24 10:38:21 +0200
committerNico Vertriest <nico.vertriest@theqtcompany.com>2016-05-27 07:39:05 +0000
commit04c494d8ebb85cae398f661216db3930351e6aab (patch)
tree902b8f9021839d001ad4196b098d4636a0d86c97
parentb18aae4e229c9c70d06d71861cdd28e2d7e4f303 (diff)
Doc: completed overview page popups
Change-Id: I6cf17b655b89ac588f1bc7700c50baaf9359af62 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/imports/controls/doc/images/qtquickcontrols2-popup-settings.pngbin0 -> 12440 bytes
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc35
2 files changed, 32 insertions, 3 deletions
diff --git a/src/imports/controls/doc/images/qtquickcontrols2-popup-settings.png b/src/imports/controls/doc/images/qtquickcontrols2-popup-settings.png
new file mode 100644
index 00000000..787de5d4
--- /dev/null
+++ b/src/imports/controls/doc/images/qtquickcontrols2-popup-settings.png
Binary files differ
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
*/