Struct gdnative::api::WindowDialog

pub struct WindowDialog { /* fields omitted */ }

core class WindowDialog inherits Popup (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.

WindowDialog is a reference-only type. Persistent references can only exist in the unsafe Ref<WindowDialog> 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

WindowDialog inherits methods from:

• 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 WindowDialog

pub fn new() -> Ref<WindowDialog, 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 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.

Methods from Deref<Target = Popup>

pub const NOTIFICATION_POPUP_HIDE: i64

pub const NOTIFICATION_POST_POPUP: i64

pub fn is_exclusive(&self) -> bool

If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event.
			[b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code].

pub fn popup(&self, bounds: Rect<f32, UnknownUnit>)

Popup (show the control in modal form).

Default Arguments

• bounds - Rect2( 0, 0, 0, 0 )

pub fn popup_centered(&self, size: Vector2D<f32, UnknownUnit>)

Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by [code]size[/code].

Default Arguments

• size - Vector2( 0, 0 )

pub fn popup_centered_clamped(
    &self,
    size: Vector2D<f32, UnknownUnit>,
    fallback_ratio: f64
)

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to [code]size[/code], then ensuring the popup is no larger than the viewport size multiplied by [code]fallback_ratio[/code].

Default Arguments

• size - Vector2( 0, 0 )
• fallback_ratio - 0.75

pub fn popup_centered_minsize(&self, minsize: Vector2D<f32, UnknownUnit>)

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than [code]minsize[/code].

Default Arguments

• minsize - Vector2( 0, 0 )

pub fn popup_centered_ratio(&self, ratio: f64)

Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen.

Default Arguments

• ratio - 0.75

pub fn set_as_minsize(&self)

Shrink popup to keep to the minimum size of content.

pub fn set_exclusive(&self, enable: bool)

If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event.
			[b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code].

Trait Implementations

impl Debug for WindowDialog

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

Formats the value using the given formatter.

impl Deref for WindowDialog

type Target = Popup

The resulting type after dereferencing.

fn deref(&self) -> &Popup

Dereferences the value.

impl DerefMut for WindowDialog

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

Mutably dereferences the value.

impl GodotObject for WindowDialog

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 WindowDialog

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

impl QueueFree for WindowDialog

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for WindowDialog

impl SubClass<Control> for WindowDialog

impl SubClass<Node> for WindowDialog

impl SubClass<Object> for WindowDialog

impl SubClass<Popup> for WindowDialog

impl SubClass<WindowDialog> for ScriptCreateDialog

impl SubClass<WindowDialog> for AcceptDialog

impl SubClass<WindowDialog> for ConfirmationDialog

impl SubClass<WindowDialog> for FileDialog

impl SubClass<WindowDialog> for EditorFileDialog