[−][src]Struct gdnative::api::ConfirmationDialog
core class ConfirmationDialog
inherits AcceptDialog
(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.
ConfirmationDialog
is a reference-only type. Persistent references can
only exist in the unsafe Ref<ConfirmationDialog>
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
ConfirmationDialog inherits methods from:
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 ConfirmationDialog
[src]
pub fn new() -> Ref<ConfirmationDialog, Unique>
[src]
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 get_cancel(&self) -> Option<Ref<Button, Shared>>
[src]
Returns the cancel button.
Methods from Deref<Target = AcceptDialog>
pub fn add_button(
&self,
text: impl Into<GodotString>,
right: bool,
action: impl Into<GodotString>
) -> Option<Ref<Button, Shared>>
[src]
&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>>
[src]
&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
[src]
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>>
[src]
Returns the label used for built-in text.
pub fn get_ok(&self) -> Option<Ref<Button, Shared>>
[src]
Returns the OK [Button] instance.
pub fn text(&self) -> GodotString
[src]
The text displayed by the dialog.
pub fn has_autowrap(&self) -> bool
[src]
Sets autowrapping for the text in the dialog.
pub fn register_text_enter(&self, line_edit: impl AsArg<Node>)
[src]
Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
pub fn set_autowrap(&self, autowrap: bool)
[src]
Sets autowrapping for the text in the dialog.
pub fn set_hide_on_ok(&self, enabled: bool)
[src]
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>)
[src]
The text displayed by the dialog.
Trait Implementations
impl Debug for ConfirmationDialog
[src]
impl Deref for ConfirmationDialog
[src]
type Target = AcceptDialog
The resulting type after dereferencing.
fn deref(&self) -> &AcceptDialog
[src]
impl DerefMut for ConfirmationDialog
[src]
fn deref_mut(&mut self) -> &mut AcceptDialog
[src]
impl GodotObject for ConfirmationDialog
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for ConfirmationDialog
[src]
fn construct() -> Ref<ConfirmationDialog, Unique>
[src]
impl QueueFree for ConfirmationDialog
[src]
unsafe fn godot_queue_free(obj: *mut c_void)
[src]
impl SubClass<AcceptDialog> for ConfirmationDialog
[src]
impl SubClass<CanvasItem> for ConfirmationDialog
[src]
impl SubClass<ConfirmationDialog> for EditorFileDialog
[src]
impl SubClass<ConfirmationDialog> for ScriptCreateDialog
[src]
impl SubClass<ConfirmationDialog> for FileDialog
[src]
impl SubClass<Control> for ConfirmationDialog
[src]
impl SubClass<Node> for ConfirmationDialog
[src]
impl SubClass<Object> for ConfirmationDialog
[src]
impl SubClass<Popup> for ConfirmationDialog
[src]
impl SubClass<WindowDialog> for ConfirmationDialog
[src]
Auto Trait Implementations
impl RefUnwindSafe for ConfirmationDialog
impl !Send for ConfirmationDialog
impl !Sync for ConfirmationDialog
impl Unpin for ConfirmationDialog
impl UnwindSafe for ConfirmationDialog
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,