godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 14:03:23 +02:00
parent 5402f28f59
commit a203daa272
397 changed files with 21934 additions and 16529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
classes/class_acceptdialog.rst
View File

@@ -21,13 +21,13 @@ Base dialog for user notification.
Properties
----------
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` |
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` |
+-----------------------------+-------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` |
+-----------------------------+-------------------------------------------------------------------------+
+-----------------------------+-------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`dialog_autowrap<class_AcceptDialog_property_dialog_autowrap>` | false |
+-----------------------------+-------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`dialog_hide_on_ok<class_AcceptDialog_property_dialog_hide_on_ok>` | true |
+-----------------------------+-------------------------------------------------------------------------+-------+
| :ref:`String<class_String>` | :ref:`dialog_text<class_AcceptDialog_property_dialog_text>` | "" |
+-----------------------------+-------------------------------------------------------------------------+-------+
Methods
-------
@@ -71,11 +71,13 @@ Property Descriptions
- :ref:`bool<class_bool>` **dialog_autowrap**
+----------+---------------------+
| *Setter* | set_autowrap(value) |
+----------+---------------------+
| *Getter* | has_autowrap() |
+----------+---------------------+
+-----------+---------------------+
| *Default* | false |
+-----------+---------------------+
| *Setter* | set_autowrap(value) |
+-----------+---------------------+
| *Getter* | has_autowrap() |
+-----------+---------------------+
Sets autowrapping for the text in the dialog.
@@ -83,13 +85,15 @@ Sets autowrapping for the text in the dialog.
- :ref:`bool<class_bool>` **dialog_hide_on_ok**
+----------+-----------------------+
| *Setter* | set_hide_on_ok(value) |
+----------+-----------------------+
| *Getter* | get_hide_on_ok() |
+----------+-----------------------+
+-----------+-----------------------+
| *Default* | true |
+-----------+-----------------------+
| *Setter* | set_hide_on_ok(value) |
+-----------+-----------------------+
| *Getter* | get_hide_on_ok() |
+-----------+-----------------------+
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic. Default value: ``true``.
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic.
**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 :ref:`FileDialog<class_FileDialog>` defaults to ``false``, 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 :ref:`FileDialog<class_FileDialog>` to disable hiding the dialog when pressing OK.
@@ -97,11 +101,13 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it
- :ref:`String<class_String>` **dialog_text**
+----------+-----------------+
| *Setter* | set_text(value) |
+----------+-----------------+
| *Getter* | get_text() |
+----------+-----------------+
+-----------+-----------------+
| *Default* | "" |
+-----------+-----------------+
| *Setter* | set_text(value) |
+-----------+-----------------+
| *Getter* | get_text() |
+-----------+-----------------+
The text displayed by the dialog.
@@ -114,7 +120,7 @@ Method Descriptions
Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button. ``action`` will be passed to the :ref:`custom_action<class_AcceptDialog_signal_custom_action>` signal when pressed.
If ``true``, ``right`` will place the button to the right of any sibling buttons. Default value: ``false``.
If ``true``, ``right`` will place the button to the right of any sibling buttons.
.. _class_AcceptDialog_method_add_cancel: