Class AcceptDialog

A base dialog used for user notification.

Inheritance

Window

Viewport

Node

Object

AcceptDialog

Derived

ConfirmationDialog

Remarks

The default use of AcceptDialog is to allow it to only be accepted or closed, with the same result. However, the confirmed and canceled signals allow to make the two actions different, and the AcceptDialog.add_button method allows to add custom buttons and actions.

Properties

dialog_autowrap

Sets autowrapping for the text in the dialog.

var dialog_autowrap : bool = false

Property Value

bool

Remarks

• void set_autowrap(bool value)
• bool has_autowrap

dialog_close_on_escape

If true, the dialog will be hidden when the escape key (@GlobalScope.KEY_ESCAPE) is pressed.

var dialog_close_on_escape : bool = true

Property Value

bool

Remarks

• void set_close_on_escape(bool value)
• bool get_close_on_escape

dialog_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 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 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 FileDialog to disable hiding the dialog when pressing OK.

var dialog_hide_on_ok : bool = true

Property Value

bool

Remarks

• void set_hide_on_ok(bool value)
• bool get_hide_on_ok

dialog_text

The text displayed by the dialog.

var dialog_text : String = ""

Property Value

String

Remarks

• void set_text(String value)
• String get_text

ok_button_text

The text displayed by the OK button (see get_ok_button).

var ok_button_text : String = "OK"

Property Value

String

Remarks

• void set_ok_button_text(String value)
• String get_ok_button_text

buttons_min_height

Theme Property

The minimum height of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.

 = ``0``

Property Value

int

buttons_min_width

Theme Property

The minimum width of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.

 = ``0``

Property Value

int

buttons_separation

Theme Property

The size of the vertical space between the dialog's content and the button row.

 = ``10``

Property Value

int

panel

Theme Property

The panel that fills the background of the window.

StyleBox panel

Property Value

StyleBox

Methods

add_button(String, bool, String)

Adds a button with label text and a custom action to the dialog and returns the created button. action will be passed to the AcceptDialog.custom_action signal when pressed.

If true, right will place the button to the right of any sibling buttons.

You can use AcceptDialog.remove_button method to remove a button created with this method from the dialog.

Button add_button(String text, bool right, String action)

Parameters

text String

right bool

action String

add_cancel_button(String)

Adds a button with label name and a cancel action to the dialog and returns the created button.

You can use AcceptDialog.remove_button method to remove a button created with this method from the dialog.

Button add_cancel_button(String name)

Parameters

name String

get_label

Returns the label used for built-in text.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their visible property.

Label get_label

get_ok_button

Returns the OK Button instance.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their visible property.

Button get_ok_button

register_text_enter(LineEdit)

Registers a LineEdit in the dialog. When the enter key is pressed, the dialog will be accepted.

void register_text_enter(LineEdit line_edit)

Parameters

line_edit LineEdit

remove_button(Button)

Removes the button from the dialog. Does NOT free the button. The button must be a Button added with AcceptDialog.add_button or AcceptDialog.add_cancel_button method. After removal, pressing the button will no longer emit this dialog's AcceptDialog.custom_action or canceled signals.

void remove_button(Button button)

Parameters

button Button

Events

canceled

Emitted when the dialog is closed or the button created with AcceptDialog.add_cancel_button is pressed.

signal canceled

confirmed

Emitted when the dialog is accepted, i.e. the OK button is pressed.

signal confirmed

custom_action(StringName)

Emitted when a custom button is pressed. See AcceptDialog.add_button.

signal custom_action(StringName action)

Parameters

action StringName