Struct gdnative_bindings_lily::editor_file_dialog::EditorFileDialog

pub struct EditorFileDialog { /* fields omitted */ }

tools class EditorFileDialog inherits ConfirmationDialog (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Class hierarchy

EditorFileDialog inherits methods from:

• ConfirmationDialog
• AcceptDialog
• WindowDialog
• Popup
• Control
• CanvasItem
• Node
• Object

Tool

This class is used to interact with Godot’s editor.

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 EditorFileDialog

Constants

pub const ACCESS_FILESYSTEM: i64

pub const ACCESS_RESOURCES: i64

pub const ACCESS_USERDATA: i64

pub const DISPLAY_LIST: i64

pub const DISPLAY_THUMBNAILS: i64

pub const MODE_OPEN_ANY: i64

pub const MODE_OPEN_DIR: i64

pub const MODE_OPEN_FILE: i64

pub const MODE_OPEN_FILES: i64

pub const MODE_SAVE_FILE: i64

impl EditorFileDialog

pub fn add_filter(&self, filter: impl Into<GodotString>)

Adds a comma-delimited file extension filter option to the EditorFileDialog with an optional semi-colon-delimited label. For example, "*.tscn, *.scn; Scenes" results in filter text “Scenes (*.tscn, *.scn)”.

pub fn clear_filters(&self)

Removes all filters except for “All Files (*)”.

pub fn access(&self) -> Access

The location from which the user may select a file, including res://, user://, and the local file system.

pub fn current_dir(&self) -> GodotString

The currently occupied directory.

pub fn current_file(&self) -> GodotString

The currently selected file.

pub fn current_path(&self) -> GodotString

The file system path in the address bar.

pub fn display_mode(&self) -> DisplayMode

The view format in which the EditorFileDialog displays resources to the user.

pub fn mode(&self) -> Mode

The purpose of the EditorFileDialog, which defines the allowed behaviors.

pub fn get_vbox(&self) -> Option<Ref<VBoxContainer, Shared>>

Returns the VBoxContainer used to display the file system.

pub fn invalidate(&self)

Notify the EditorFileDialog that its view of the data is no longer accurate. Updates the view contents on next view update.

pub fn is_overwrite_warning_disabled(&self) -> bool

If true, the EditorFileDialog will not warn the user before overwriting files.

pub fn is_showing_hidden_files(&self) -> bool

If true, hidden files and directories will be visible in the EditorFileDialog.

pub fn set_access(&self, access: i64)

The location from which the user may select a file, including res://, user://, and the local file system.

pub fn set_current_dir(&self, dir: impl Into<GodotString>)

The currently occupied directory.

pub fn set_current_file(&self, file: impl Into<GodotString>)

The currently selected file.

pub fn set_current_path(&self, path: impl Into<GodotString>)

The file system path in the address bar.

pub fn set_disable_overwrite_warning(&self, disable: bool)

If true, the EditorFileDialog will not warn the user before overwriting files.

pub fn set_display_mode(&self, mode: i64)

The view format in which the EditorFileDialog displays resources to the user.

pub fn set_mode(&self, mode: i64)

The purpose of the EditorFileDialog, which defines the allowed behaviors.

pub fn set_show_hidden_files(&self, show: bool)

If true, hidden files and directories will be visible in the EditorFileDialog.

Methods from Deref<Target = ConfirmationDialog>

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

Returns the cancel button.

Trait Implementations

impl Debug for EditorFileDialog

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

Formats the value using the given formatter.

impl Deref for EditorFileDialog

type Target = ConfirmationDialog

The resulting type after dereferencing.

fn deref(&self) -> &ConfirmationDialog

Dereferences the value.

impl DerefMut for EditorFileDialog

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

Mutably dereferences the value.

impl GodotObject for EditorFileDialog

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl QueueFree for EditorFileDialog

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for EditorFileDialog

impl SubClass<AcceptDialog> for EditorFileDialog

impl SubClass<CanvasItem> for EditorFileDialog

impl SubClass<ConfirmationDialog> for EditorFileDialog

impl SubClass<Control> for EditorFileDialog

impl SubClass<Node> for EditorFileDialog

impl SubClass<Object> for EditorFileDialog

impl SubClass<Popup> for EditorFileDialog

impl SubClass<WindowDialog> for EditorFileDialog