From 155fb45ca20da20bcc57c6bcbad9cbc2bb007f56 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Wed, 15 Aug 2018 20:08:18 +0200
Subject: Doc: Clarify usage of dialog_hide_on_ok and caveat for FileDialog

Fixes #20817.
---
 doc/classes/AcceptDialog.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml
index 20d8bebd6b..7e871d68cb 100644
--- a/doc/classes/AcceptDialog.xml
+++ b/doc/classes/AcceptDialog.xml
@@ -60,7 +60,8 @@
 	</methods>
 	<members>
 		<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok">
-			If [code]true[/code] the dialog is hidden when accepted. Default value: [code]true[/code].
+			If [code]true[/code] the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. Default value: [code]true[/code].
+			Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK.
 		</member>
 		<member name="dialog_text" type="String" setter="set_text" getter="get_text">
 			The text displayed by this dialog.
@@ -69,7 +70,7 @@
 	<signals>
 		<signal name="confirmed">
 			<description>
-				Emitted when the dialog is accepted.
+				Emitted when the dialog is accepted, i.e. the OK button is pressed.
 			</description>
 		</signal>
 		<signal name="custom_action">
-- 
cgit v1.2.3