class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeViewportWindow AcceptDialog
A base dialog used for user notification.

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 add_button() method allows to add custom buttons and actions.

 Signal canceled<>():Signal

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

 Signal confirmed<>():Signal

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

 Signal custom_action<>( StringName action=, action:StringName=, ):Signal

Emitted when a custom button is pressed. See add_button().

 bool dialog_autowrap<>():bool

Sets autowrapping for the text in the dialog.

 bool dialog_close_on_escape<>():bool

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

 bool dialog_hide_on_ok<>():bool

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<>():String

The text displayed by the dialog.

 String ok_button_text<>():String

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

 Button add_button<>( String text=, text:String=, bool right=false, right:bool=false, String action="", action:String="", ):Button

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_button<>( String name=, name:String=, ):Button

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<>():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_button<>():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 CanvasItem.visible property.

 void register_text_enter<>( LineEdit line_edit=, line_edit:LineEdit=, ):void

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

 void remove_button<>( Button button=, button:Button=, ):void

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


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...