AcceptDialog¶

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

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¶

bool	dialog_autowrap	`false`
bool	dialog_hide_on_ok	`true`
String	dialog_text	`""`
String	window_title	`"Alert!"` (overrides WindowDialog)

Methods¶

Button	add_button ( String text, bool right=false, String action="" )
Button	add_cancel ( String name )
Label	get_label ( )
Button	get_ok ( )
void	register_text_enter ( Node line_edit )
void	remove_button ( Control button )

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 = false

void set_autowrap ( bool value )
bool has_autowrap ( )

Sets autowrapping for the text in the dialog.

bool dialog_hide_on_ok = true

void set_hide_on_ok ( bool value )
bool 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 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.

String dialog_text = ""

void set_text ( String value )
String get_text ( )

The text displayed by the dialog.

Method Descriptions¶

Button add_button ( String text, bool right=false, 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.

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

Button add_cancel ( String name )

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

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

Label 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 CanvasItem.visible property.

Button get_ok ( )

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 CanvasItem.visible property.

void register_text_enter ( Node line_edit )

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

void remove_button ( Control button )

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