| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AcceptDialog.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AcceptDialog:
- AcceptDialog
- ============
- **Inherits:** :ref:`WindowDialog<class_windowdialog>` **<** :ref:`Popup<class_popup>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Inherited By:** :ref:`ConfirmationDialog<class_confirmationdialog>`
- **Category:** Core
- Brief Description
- -----------------
- Base dialog for user notification.
- Member Functions
- ----------------
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Button<class_button>` | :ref:`add_button<class_AcceptDialog_add_button>` **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)** |
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Node<class_node>` line_edit **)** |
- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_AcceptDialog_confirmed:
- - **confirmed** **(** **)**
- Emitted when the dialog is accepted.
- .. _class_AcceptDialog_custom_action:
- - **custom_action** **(** :ref:`String<class_string>` action **)**
- Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_add_button>`.
- Member Variables
- ----------------
- .. _class_AcceptDialog_dialog_hide_on_ok:
- - :ref:`bool<class_bool>` **dialog_hide_on_ok** - If ``true`` the dialog is hidden when accepted. Default value: ``true``.
- .. _class_AcceptDialog_dialog_text:
- - :ref:`String<class_string>` **dialog_text** - The text displayed by this dialog.
- Description
- -----------
- This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.
- Member Function Description
- ---------------------------
- .. _class_AcceptDialog_add_button:
- - :ref:`Button<class_button>` **add_button** **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)**
- Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the custom_action signal when pressed.
- If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``.
- .. _class_AcceptDialog_add_cancel:
- - :ref:`Button<class_button>` **add_cancel** **(** :ref:`String<class_string>` name **)**
- Adds a button with label *name* and a cancel action to the dialog and returns the created button.
- .. _class_AcceptDialog_get_label:
- - :ref:`Label<class_label>` **get_label** **(** **)**
- Return the label used for built-in text.
- .. _class_AcceptDialog_get_ok:
- - :ref:`Button<class_button>` **get_ok** **(** **)**
- Return the OK Button.
- .. _class_AcceptDialog_register_text_enter:
- - void **register_text_enter** **(** :ref:`Node<class_node>` line_edit **)**
- Registers a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
|
