diff options
Diffstat (limited to 'doc/classes/AcceptDialog.xml')
| -rw-r--r-- | doc/classes/AcceptDialog.xml | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index c1e28ffba3..c83ea8c60a 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -11,20 +11,20 @@ <methods> <method name="add_button"> <return type="Button" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="right" type="bool" default="false" /> - <argument index="2" name="action" type="String" default="""" /> + <param index="0" name="text" type="String" /> + <param index="1" name="right" type="bool" default="false" /> + <param index="2" name="action" type="String" default="""" /> <description> - Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. - If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. + Adds a button with label [param text] and a custom [param action] to the dialog and returns the created button. [param action] will be passed to the [signal custom_action] signal when pressed. + If [code]true[/code], [param right] will place the button to the right of any sibling buttons. You can use [method remove_button] method to remove a button created with this method from the dialog. </description> </method> <method name="add_cancel_button"> <return type="Button" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> - Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. + Adds a button with label [param name] and a cancel action to the dialog and returns the created button. You can use [method remove_button] method to remove a button created with this method from the dialog. </description> </method> @@ -44,16 +44,16 @@ </method> <method name="register_text_enter"> <return type="void" /> - <argument index="0" name="line_edit" type="Control" /> + <param index="0" name="line_edit" type="Control" /> <description> Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> <method name="remove_button"> <return type="void" /> - <argument index="0" name="button" type="Control" /> + <param index="0" name="button" type="Control" /> <description> - Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. + Removes the [param button] from the dialog. Does NOT free the [param button]. The [param button] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [param button] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. </description> </method> </methods> @@ -62,6 +62,7 @@ Sets autowrapping for the text in the dialog. </member> <member name="dialog_close_on_escape" type="bool" setter="set_close_on_escape" getter="get_close_on_escape" default="true"> + If [code]true[/code], the dialog will be hidden when the escape key ([constant @GlobalScope.KEY_ESCAPE]) is pressed. </member> <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok" default="true"> 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. @@ -71,6 +72,9 @@ The text displayed by the dialog. </member> <member name="exclusive" type="bool" setter="set_exclusive" getter="is_exclusive" overrides="Window" default="true" /> + <member name="ok_button_text" type="String" setter="set_ok_button_text" getter="get_ok_button_text" default=""OK""> + The text displayed by the OK button (see [method get_ok_button]). + </member> <member name="title" type="String" setter="set_title" getter="get_title" overrides="Window" default=""Alert!"" /> <member name="transient" type="bool" setter="set_transient" getter="is_transient" overrides="Window" default="true" /> <member name="visible" type="bool" setter="set_visible" getter="is_visible" overrides="Window" default="false" /> @@ -88,7 +92,7 @@ </description> </signal> <signal name="custom_action"> - <argument index="0" name="action" type="StringName" /> + <param index="0" name="action" type="StringName" /> <description> Emitted when a custom button is pressed. See [method add_button]. </description> |