W3cubDocs

/Godot 3.1

FileDialog

Inherits: ConfirmationDialog < AcceptDialog < WindowDialog < Popup < Control < CanvasItem < Node < Object

Category: Core

Brief Description

Dialog for selecting files or directories in the filesystem.

Properties

Access access
String current_dir
String current_file
String current_path
PoolStringArray filters
Mode mode
bool mode_overrides_title
bool show_hidden_files

Methods

void add_filter ( String filter )
void clear_filters ( )
void deselect_items ( )
LineEdit get_line_edit ( )
VBoxContainer get_vbox ( )
void invalidate ( )

Theme Properties

Color files_disabled
Texture folder
Texture parent_folder
Texture reload

Signals

dir_selected ( String dir )

Event emitted when the user selects a directory.

file_selected ( String path )

Event emitted when the user selects a file (double clicks it or presses the OK button).

files_selected ( PoolStringArray paths )

Event emitted when the user selects multiple files.

Enumerations

enum Mode:

  • MODE_OPEN_FILE = 0 — The dialog allows the selection of one, and only one file.
  • MODE_OPEN_FILES = 1 — The dialog allows the selection of multiple files.
  • MODE_OPEN_DIR = 2 — The dialog functions as a folder selector, disallowing the selection of any file.
  • MODE_OPEN_ANY = 3 — The dialog allows the selection of a file or a directory.
  • MODE_SAVE_FILE = 4 — The dialog will warn when a file exists.

enum Access:

  • ACCESS_RESOURCES = 0 — The dialog allows the selection of file and directory.
  • ACCESS_USERDATA = 1 — The dialog allows access files under Resource path(res://) .
  • ACCESS_FILESYSTEM = 2 — The dialog allows access files in whole file system.

Description

FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.

Property Descriptions

Access access

Setter set_access(value)
Getter get_access()

The file system access scope. See enum Access constants.

String current_dir

Setter set_current_dir(value)
Getter get_current_dir()

The current working directory of the file dialog.

String current_file

Setter set_current_file(value)
Getter get_current_file()

The currently selected file of the file dialog.

String current_path

Setter set_current_path(value)
Getter get_current_path()

The currently selected file path of the file dialog.

PoolStringArray filters

Setter set_filters(value)
Getter get_filters()

Set file type filters. This example shows only .png and .gd files set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"])).

Mode mode

Setter set_mode(value)
Getter get_mode()

Set dialog to open or save mode, changes selection behavior. See enum Mode constants.

bool mode_overrides_title

Setter set_mode_overrides_title(value)
Getter is_mode_overriding_title()

If true, changing the Mode property will set the window title accordingly (e.g. setting mode to MODE_OPEN_FILE will change the window title to “Open a File”).

bool show_hidden_files

Setter set_show_hidden_files(value)
Getter is_showing_hidden_files()

If true, the dialog will show hidden files.

Method Descriptions

void add_filter ( String filter )

Add a custom filter. Example: add_filter("*.png ; PNG Images")

void clear_filters ( )

Clear all the added filters in the dialog.

void deselect_items ( )

Clear currently selected items in the dialog.

LineEdit get_line_edit ( )

Returns the LineEdit for the selected file.

VBoxContainer get_vbox ( )

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

void invalidate ( )

Invalidate and update the current dialog content list.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_filedialog.html