diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2017-04-25 11:12:18 +0200 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2017-04-29 07:57:18 +0000 |
| commit | 5e32318984260ae7e19cd7dd7632bd81edaeb88c (patch) | |
| tree | 5afeedf2bea587e8c201a597e04f344de2612279 | |
| parent | c028ada0384ffaf22058536d0a7cba8e89f2106a (diff) | |
Doc: improve the documentation for Popup’s modal property
Task-number: QTBUG-60358
Change-Id: I935722f0740140c30ff27192d78c6cf3586723c5
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
| -rw-r--r-- | src/quicktemplates2/qquickpopup.cpp | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/quicktemplates2/qquickpopup.cpp b/src/quicktemplates2/qquickpopup.cpp index 45c4e86e..75dced8d 100644 --- a/src/quicktemplates2/qquickpopup.cpp +++ b/src/quicktemplates2/qquickpopup.cpp @@ -1574,7 +1574,17 @@ bool QQuickPopup::hasActiveFocus() const /*! \qmlproperty bool QtQuick.Controls::Popup::modal - This property holds whether the popup is modal. The default value is \c false. + This property holds whether the popup is modal. + + Modal popups often have a distinctive background dimming effect defined + in \l {ApplicationWindow::overlay}{overlay.modal}, and do not allow press + or release events through to items beneath them. + + 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. + + The default value is \c false. */ bool QQuickPopup::isModal() const { |