From 5e32318984260ae7e19cd7dd7632bd81edaeb88c Mon Sep 17 00:00:00 2001 From: Mitch Curtis Date: Tue, 25 Apr 2017 11:12:18 +0200 Subject: =?UTF-8?q?Doc:=20improve=20the=20documentation=20for=20Popup?= =?UTF-8?q?=E2=80=99s=20modal=20property?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-60358 Change-Id: I935722f0740140c30ff27192d78c6cf3586723c5 Reviewed-by: J-P Nurmi --- src/quicktemplates2/qquickpopup.cpp | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'src') 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 { -- cgit v1.2.3