Struct gdnative::api::FileDialog

pub struct FileDialog { /* fields omitted */ }

core class FileDialog inherits ConfirmationDialog (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.

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

FileDialog inherits methods from:

• ConfirmationDialog
• AcceptDialog
• 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 FileDialog

Constants

pub const ACCESS_FILESYSTEM: i64

pub const ACCESS_RESOURCES: i64

pub const ACCESS_USERDATA: 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 FileDialog

pub fn new() -> Ref<FileDialog, 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_filter(&self, filter: impl Into<GodotString>)

Adds [code]filter[/code] as a custom filter; [code]filter[/code] should be of the form [code]"filename.extension ; Description"[/code]. For example, [code]"*.png ; PNG Images"[/code].

pub fn clear_filters(&self)

Clear all the added filters in the dialog.

pub fn deselect_items(&self)

Clear currently selected items in the dialog.

pub fn access(&self) -> Access

The file system access scope. See enum [code]Access[/code] constants.
			[b]Warning:[/b] Currently, in sandboxed environments such as HTML5 builds or sandboxed macOS apps, FileDialog cannot access the host file system. See [url=https://github.com/godotengine/godot-proposals/issues/1123]godot-proposals#1123[/url].

pub fn current_dir(&self) -> GodotString

The current working directory of the file dialog.

pub fn current_file(&self) -> GodotString

The currently selected file of the file dialog.

pub fn current_path(&self) -> GodotString

The currently selected file path of the file dialog.

pub fn filters(&self) -> TypedArray<GodotString>

The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].

pub fn get_line_edit(&self) -> Option<Ref<LineEdit, Shared>>

Returns the LineEdit for the selected file.

pub fn mode(&self) -> Mode

The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants.

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

Returns the vertical box container of the dialog, custom controls can be added to it.

pub fn invalidate(&self)

Invalidate and update the current dialog content list.

pub fn is_mode_overriding_title(&self) -> bool

If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File").

pub fn is_showing_hidden_files(&self) -> bool

If [code]true[/code], the dialog will show hidden files.

pub fn set_access(&self, access: i64)

The file system access scope. See enum [code]Access[/code] constants.
			[b]Warning:[/b] Currently, in sandboxed environments such as HTML5 builds or sandboxed macOS apps, FileDialog cannot access the host file system. See [url=https://github.com/godotengine/godot-proposals/issues/1123]godot-proposals#1123[/url].

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

The current working directory of the file dialog.

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

The currently selected file of the file dialog.

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

The currently selected file path of the file dialog.

pub fn set_filters(&self, filters: TypedArray<GodotString>)

The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].

pub fn set_mode(&self, mode: i64)

The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants.

pub fn set_mode_overrides_title(&self, _override: bool)

If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File").

pub fn set_show_hidden_files(&self, show: bool)

If [code]true[/code], the dialog will show hidden files.

Methods from Deref<Target = ConfirmationDialog>

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

Returns the cancel button.

Trait Implementations

impl Debug for FileDialog

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

Formats the value using the given formatter.

impl Deref for FileDialog

type Target = ConfirmationDialog

The resulting type after dereferencing.

fn deref(&self) -> &ConfirmationDialog

Dereferences the value.

impl DerefMut for FileDialog

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

Mutably dereferences the value.

impl GodotObject for FileDialog

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 FileDialog

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

impl QueueFree for FileDialog

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<AcceptDialog> for FileDialog

impl SubClass<CanvasItem> for FileDialog

impl SubClass<ConfirmationDialog> for FileDialog

impl SubClass<Control> for FileDialog

impl SubClass<Node> for FileDialog

impl SubClass<Object> for FileDialog

impl SubClass<Popup> for FileDialog

impl SubClass<WindowDialog> for FileDialog