aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2/qquickpopup.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2019-02-05 11:55:22 +0100
committerMitch Curtis <mitch.curtis@qt.io>2019-02-05 11:54:29 +0000
commita59ab3ec93bc873225ccbd118ec81d023b5cb62d (patch)
tree0056078a0b21a2981bd5e430ce678dcc9d35d277 /src/quicktemplates2/qquickpopup.cpp
parente0fe7bfde975055f12d9812e3317ec07529283f7 (diff)
Doc: elaborate on event behavior with Popup::modal
Change-Id: I598bffe4a7908b5731ea12076d8bafaa447b2b5d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquickpopup.cpp')
-rw-r--r--src/quicktemplates2/qquickpopup.cpp8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/quicktemplates2/qquickpopup.cpp b/src/quicktemplates2/qquickpopup.cpp
index 1bb896bd..98c2127d 100644
--- a/src/quicktemplates2/qquickpopup.cpp
+++ b/src/quicktemplates2/qquickpopup.cpp
@@ -1807,11 +1807,15 @@ bool QQuickPopup::hasActiveFocus() const
Modal popups often have a distinctive background dimming effect defined
in \l {Overlay::modal}{Overlay.modal}, and do not allow press
- or release events through to items beneath them.
+ or release events through to items beneath them. For example, if the user
+ accidentally clicks outside of a popup, any item beneath that popup at
+ the location of the click will not receive the event.
On desktop platforms, it is common for modal popups to be closed only when
the escape key is pressed. To achieve this behavior, set
- \l closePolicy to \c Popup.CloseOnEscape.
+ \l closePolicy to \c Popup.CloseOnEscape. By default, \c closePolicy
+ is set to \c {Popup.CloseOnEscape | Popup.CloseOnPressOutside}, which
+ means that clicking outside of a modal popup will close it.
The default value is \c false.