aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/quicktemplates2/qquickpopup.cpp12
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
{