Struct gdnative::api::AcceptDialog

pub struct AcceptDialog { /* fields omitted */ }

core class AcceptDialog inherits WindowDialog (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

AcceptDialog is a reference-only type. Persistent references can only exist in the unsafe Ref<AcceptDialog> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

AcceptDialog inherits methods from:

• WindowDialog
• Popup
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl AcceptDialog

pub fn new() -> Ref<AcceptDialog, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn add_button(
    &self,
    text: impl Into<GodotString>,
    right: bool,
    action: impl Into<GodotString>
) -> Option<Ref<Button, Shared>>

Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed.
				If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons.

Default Arguments

• right - false
• action - ""

pub fn add_cancel(
    &self,
    name: impl Into<GodotString>
) -> Option<Ref<Button, Shared>>

Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button.

pub fn hide_on_ok(&self) -> bool

If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic.
			[b]Note:[/b] 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 [code]false[/code], 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.

pub fn get_label(&self) -> Option<Ref<Label, Shared>>

Returns the label used for built-in text.

pub fn get_ok(&self) -> Option<Ref<Button, Shared>>

Returns the OK [Button] instance.

pub fn text(&self) -> GodotString

The text displayed by the dialog.

pub fn has_autowrap(&self) -> bool

Sets autowrapping for the text in the dialog.

pub fn register_text_enter(&self, line_edit: impl AsArg<Node>)

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

pub fn set_autowrap(&self, autowrap: bool)

Sets autowrapping for the text in the dialog.

pub fn set_hide_on_ok(&self, enabled: bool)

If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic.
			[b]Note:[/b] 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 [code]false[/code], 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.

pub fn set_text(&self, text: impl Into<GodotString>)

The text displayed by the dialog.

Methods from Deref<Target = WindowDialog>

pub fn get_close_button(&self) -> Option<Ref<TextureButton, Shared>>

Returns the close [TextureButton].

pub fn resizable(&self) -> bool

If [code]true[/code], the user can resize the window.

pub fn title(&self) -> GodotString

The text displayed in the window's title bar.

pub fn set_resizable(&self, resizable: bool)

If [code]true[/code], the user can resize the window.

pub fn set_title(&self, title: impl Into<GodotString>)

The text displayed in the window's title bar.

Trait Implementations

impl Debug for AcceptDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for AcceptDialog

type Target = WindowDialog

The resulting type after dereferencing.

fn deref(&self) -> &WindowDialog

Dereferences the value.

impl DerefMut for AcceptDialog

fn deref_mut(&mut self) -> &mut WindowDialog

Mutably dereferences the value.

impl GodotObject for AcceptDialog

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for AcceptDialog

fn construct() -> Ref<AcceptDialog, Unique>

impl QueueFree for AcceptDialog

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<AcceptDialog> for ConfirmationDialog

impl SubClass<AcceptDialog> for FileDialog

impl SubClass<AcceptDialog> for EditorFileDialog

impl SubClass<AcceptDialog> for ScriptCreateDialog

impl SubClass<CanvasItem> for AcceptDialog

impl SubClass<Control> for AcceptDialog

impl SubClass<Node> for AcceptDialog

impl SubClass<Object> for AcceptDialog

impl SubClass<Popup> for AcceptDialog

impl SubClass<WindowDialog> for AcceptDialog