EditorFileDialog

Hérite de : ConfirmationDialog < AcceptDialog < Window < Viewport < Node < Object

Une version modifié du FileDialog utilisé par l'éditeur.

Description

EditorFileDialog is an enhanced version of FileDialog available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list.

Unlike FileDialog, EditorFileDialog does not have a property for using native dialogs. Instead, native dialogs can be enabled globally via the EditorSettings.interface/editor/use_native_file_dialogs editor setting. They are also enabled automatically when running in sandbox (e.g. on macOS).

Propriétés

Access	access	`0`
String	current_dir
String	current_file
String	current_path
bool	dialog_hide_on_ok	`false` (overrides AcceptDialog)
bool	disable_overwrite_warning	`false`
DisplayMode	display_mode	`0`
FileMode	file_mode	`4`
PackedStringArray	filters	`PackedStringArray()`
int	option_count	`0`
bool	show_hidden_files	`false`
String	title	`"Save a File"` (overrides Window)

Méthodes

void	add_filter(filter: String, description: String = "")
void	add_option(name: String, values: PackedStringArray, default_value_index: int)
void	add_side_menu(menu: Control, title: String = "")
void	clear_filename_filter()
void	clear_filters()
String	get_filename_filter() const
LineEdit	get_line_edit()
int	get_option_default(option: int) const
String	get_option_name(option: int) const
PackedStringArray	get_option_values(option: int) const
Dictionary	get_selected_options() const
VBoxContainer	get_vbox()
void	invalidate()
void	popup_file_dialog()
void	set_filename_filter(filter: String)
void	set_option_default(option: int, default_value_index: int)
void	set_option_name(option: int, name: String)
void	set_option_values(option: int, values: PackedStringArray)

Signaux

dir_selected(dir: String) 🔗

Émis lors de la sélection d'un répertoire.

file_selected(path: String) 🔗

Émis lorsqu’un fichier est sélectionné.

filename_filter_changed(filter: String) 🔗

Émis lorsque le filtre pour les noms de fichiers change.

files_selected(paths: PackedStringArray) 🔗

Émis lorsque plusieurs fichiers sont sélectionnés.

Énumérations

enum FileMode: 🔗

FileMode FILE_MODE_OPEN_FILE = 0

Le EditorFileDialog ne peut sélectionner qu'un seul fichier. Accepter cette fenêtre ouvrira le fichier sélectionné.

FileMode FILE_MODE_OPEN_FILES = 1

Le EditorFileDialog permet de sélectionner plusieurs fichiers. Valider le dialogue ouvrira toutes ces fichiers.

FileMode FILE_MODE_OPEN_DIR = 2

Le EditorFileDialog ne peut sélectionner qu'un seul dossier. Accepter la fenêtre ouvrira le dossier sélectionné.

FileMode FILE_MODE_OPEN_ANY = 3

Le EditorFileDialog peut sélectionner un fichier ou un dossier. Le bouton de validation de la fenêtre l'ouvrira.

FileMode FILE_MODE_SAVE_FILE = 4

Le EditorFileDialog ne peut sélectionner qu'un seul fichier. Le bouton de validation de la fenêtre le sauvegardera.

enum Access: 🔗

Access ACCESS_RESOURCES = 0

Le EditorFileDialog ne peut afficher que le contenu des dossiers dans res://.

Access ACCESS_USERDATA = 1

Le EditorFileDialog ne peut afficher que le contenu des dossiers dans user://.

Access ACCESS_FILESYSTEM = 2

Le EditorFileDialog peut voir l'entièreté du système de fichier local.

enum DisplayMode: 🔗

DisplayMode DISPLAY_THUMBNAILS = 0

Le EditorFileDialog affiche les ressources sous forme de miniatures.

DisplayMode DISPLAY_LIST = 1

Le EditorFileDialog affiche les ressources comme une liste de nom de fichiers.

Descriptions des propriétés

Access access = 0 🔗

void set_access(value: Access)
Access get_access()

L'emplacement à partir duquel l'utilisateur peut sélectionner un fichier, y compris res://, user://, et le système de fichiers local.

String current_dir 🔗

void set_current_dir(value: String)
String get_current_dir()

Le répertoire actuellement occupé.

String current_file 🔗

void set_current_file(value: String)
String get_current_file()

Le fichier actuellement sélectionné.

String current_path 🔗

void set_current_path(value: String)
String get_current_path()

Le chemin dans le système de fichier dans la barre d'adresse.

bool disable_overwrite_warning = false 🔗

void set_disable_overwrite_warning(value: bool)
bool is_overwrite_warning_disabled()

Si true, le EditorFileDialog n'avertira pas l'utilisateur avant d'écraser des fichiers.

DisplayMode display_mode = 0 🔗

void set_display_mode(value: DisplayMode)
DisplayMode get_display_mode()

Le format de vue dans lequel le EditorFileDialog affiche les ressources à l'utilisateur.

FileMode file_mode = 4 🔗

void set_file_mode(value: FileMode)
FileMode get_file_mode()

Le mode d'ouverture ou de sauvegarde de la fenêtre, qui affecte le comportement de la sélection.

PackedStringArray filters = PackedStringArray() 🔗

void set_filters(value: PackedStringArray)
PackedStringArray get_filters()

The available file type filters. For example, this shows only .png and .gd files: set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"])). Multiple file types can also be specified in a single filter. "*.png, *.jpg, *.jpeg ; Supported Images" will show both PNG and JPEG files when selected.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

int option_count = 0 🔗

void set_option_count(value: int)
int get_option_count()

Le nombre d'OptionButtons et de CheckBoxs supplémentaires dans la fenêtre.

bool show_hidden_files = false 🔗

void set_show_hidden_files(value: bool)
bool is_showing_hidden_files()

If true, hidden files and directories will be visible in the EditorFileDialog. This property is synchronized with EditorSettings.filesystem/file_dialog/show_hidden_files.

Descriptions des méthodes

void add_filter(filter: String, description: String = "") 🔗

Adds a comma-separated file name filter option to the EditorFileDialog with an optional description, which restricts what files can be picked.

A filter should be of the form "filename.extension", where filename and extension can be * to match any string. Filters starting with . (i.e. empty filenames) are not allowed.

For example, a filter of "*.tscn, *.scn" and a description of "Scenes" results in filter text "Scenes (*.tscn, *.scn)".

void add_option(name: String, values: PackedStringArray, default_value_index: int) 🔗

Ajoute un OptionButton supplémentaire au dialogue de fichier. Si values est vide, une CheckBox est ajoutée à la place.

default_value_index devrait être un index de la valeur dans les values. Si values est vide, il doit valoir soit 1 (coché), soit 0 (non coché).

Adds the given menu to the side of the file dialog with the given title text on top. Only one side menu is allowed.

void clear_filename_filter() 🔗

Vide le filtre pour les noms de fichier.

void clear_filters() 🔗

Removes all filters except for "All Files (*.*)".

String get_filename_filter() const 🔗

Returns the value of the filter for file names.

LineEdit get_line_edit() 🔗

Renvoie le LineEdit pour le fichier sélectionné.

Avertissement : Il s'agit d'un nœud interne nécessaire, le retirer et le libérer peut causer un plantage. Si vous voulez le cacher lui ou l'un de ses enfants, utilisez plutôt CanvasItem.visible.

int get_option_default(option: int) const 🔗

Renvoie l'index de valeur par défaut de l'OptionButton ou de la CheckBox avec l'index option.

String get_option_name(option: int) const 🔗

Renvoie le nom de l'OptionButton ou de la CheckBox avec l'index option.

PackedStringArray get_option_values(option: int) const 🔗

Renvoie un tableau des valeurs de l'OptionButton avec l'index option.

Dictionary get_selected_options() const 🔗

Renvoie un Dictionary avec les valeurs sélectionnées des OptionButtons et/ou des CheckBoxs supplémentaires. Les clés du Dictionary sont des noms et les valeurs sont les indices des valeur sélectionnées.

VBoxContainer get_vbox() 🔗

Renvoie le VBoxContainer utilisé pour afficher le système de fichiers.

Avertissement : Il s'agit d'un nœud requis en interne, l'enlever et le libérer peut causer un plantage. Si vous voulez le cacher lui ou un de ses enfants, utilisez leur propriété CanvasItem.visible.

void invalidate() 🔗

Notifie le EditorFileDialog que sa vue que son contenu n'est plus à jour. Mettre à jour le contenu de la vue sur la prochaine mise à jour de la vue.

Shows the EditorFileDialog at the default size and position for file dialogs in the editor, and selects the file name if there is a current file.

void set_filename_filter(filter: String) 🔗

Sets the value of the filter for file names.

void set_option_default(option: int, default_value_index: int) 🔗

Définit l'index de valeur par défaut de l'OptionButton ou de la CheckBox avec l'index option.

void set_option_name(option: int, name: String) 🔗

Définit le nom de l'OptionButton ou de la CheckBox avec l'index option.

void set_option_values(option: int, values: PackedStringArray) 🔗

Définit les valeurs des options de l'OptionButton avec l'index option.