AcceptDialog

Inherits: WindowDialog < Popup < Control < CanvasItem < Node < Object

Inherited By: ConfirmationDialog

Base dialog for user notification.

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.

Properties

booldialog_autowrapfalse
booldialog_hide_on_oktrue
Stringdialog_text""
Stringwindow_titleO: "Alert!"

Methods

Buttonadd_button ( String text, bool right=false, String action=”” )
Buttonadd_cancel ( String name )
Labelget_label ( )
Buttonget_ok ( )
voidregister_text_enter ( Node line_edit )

Signals

  • confirmed ( )

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


  • custom_action ( String action )

Emitted when a custom button is pressed. See add_button.

Property Descriptions

  • bool dialog_autowrap
Defaultfalse
Setterset_autowrap(value)
Getterhas_autowrap()

Sets autowrapping for the text in the dialog.


  • bool dialog_hide_on_ok
Defaulttrue
Setterset_hide_on_ok(value)
Getterget_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.


Default""
Setterset_text(value)
Getterget_text()

The text displayed by the dialog.

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 custom_action signal when pressed.

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


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


Returns the label used for built-in text.


Returns the OK Button instance.


  • void register_text_enter ( Node line_edit )

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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.