EditorFileDialog

Eredita: ConfirmationDialog < AcceptDialog < Window < Viewport < Node < Object

Una versione modificata di FileDialog utilizzata dall'editor.

Descrizione

EditorFileDialog è una versione migliorata di FileDialog disponibile solo per le estensioni dell'editor. Le funzionalità aggiuntive includono l'elenco dei file preferiti/recenti e la possibilità di vedere i file come griglia di miniature anziché come elenco.

A differenza di FileDialog, EditorFileDialog non ha una proprietà per usare le finestre di dialogo native. Invece, è possibile abilitare le finestre di dialogo native globalmente tramite l'impostazione dell'editor EditorSettings.interface/editor/use_native_file_dialogs. Sono inoltre abilitate automaticamente se in esecuzione in modalità sandbox (ad esempio su macOS).

Proprietà

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)

Metodi

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)

Segnali

dir_selected(dir: String) 🔗

Emesso quando viene selezionata una cartella.

file_selected(path: String) 🔗

Emesso quando viene selezionata un file.

filename_filter_changed(filter: String) 🔗

Emesso quando il filtro per i nomi dei file cambia.

files_selected(paths: PackedStringArray) 🔗

Emesso quando vengono selezionati più file.

Enumerazioni

enum FileMode: 🔗

FileMode FILE_MODE_OPEN_FILE = 0

L'EditorFileDialog può selezionare solo un file. Accettando la finestra si aprirà il file.

FileMode FILE_MODE_OPEN_FILES = 1

L'EditorFileDialog può selezionare più file. Accettando la finestra si apriranno tutti i file.

FileMode FILE_MODE_OPEN_DIR = 2

L'EditorFileDialog può selezionare solo una cartella. Accettando la finestra si aprirà la cartella.

FileMode FILE_MODE_OPEN_ANY = 3

L'EditorFileDialog può selezionare un file o una cartella. Accettando la finestra si aprirà.

FileMode FILE_MODE_SAVE_FILE = 4

L'EditorFileDialog può selezionare solo un file. Accettando la finestra il file sarà salvato.

enum Access: 🔗

Access ACCESS_RESOURCES = 0

L'EditorFileDialog può visualizzare solo il contenuto della cartella res://.

Access ACCESS_USERDATA = 1

L'EditorFileDialog può visualizzare solo il contenuto della cartella user://.

Access ACCESS_FILESYSTEM = 2

L'EditorFileDialog può visualizzare l'interità del file system locale.

enum DisplayMode: 🔗

DisplayMode DISPLAY_THUMBNAILS = 0

L'EditorFileDialog visualizza le risorse sotto forma di miniature.

DisplayMode DISPLAY_LIST = 1

L'EditorFileDialog visualizza le risorse come un elenco di nomi di file.

Descrizioni delle proprietà

Access access = 0 🔗

La posizione da cui l'utente può selezionare un file, inclusi res://, user:// e il file system locale.

String current_dir 🔗

  • void set_current_dir(value: String)

  • String get_current_dir()

La cartella attualmente occupata.

String current_file 🔗

  • void set_current_file(value: String)

  • String get_current_file()

Il file attualmente selezionato.

String current_path 🔗

  • void set_current_path(value: String)

  • String get_current_path()

Il percorso del file system nella barra dell'indirizzo.

bool disable_overwrite_warning = false 🔗

  • void set_disable_overwrite_warning(value: bool)

  • bool is_overwrite_warning_disabled()

Se true, l'EditorFileDialog non avviserà l'utente prima di sovrascrivere i file.

DisplayMode display_mode = 0 🔗

Il formato di visualizzazione in cui l'EditorFileDialog mostra le risorse all'utente.

FileMode file_mode = 4 🔗

La modalità di apertura o salvataggio della finestra di dialogo, che influenza il comportamento di selezione.

PackedStringArray filters = PackedStringArray() 🔗

I filtri per i tipi di file disponibili. Ad esempio, questo mostra solo i file .png e .gd: set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"])). È possibile specificare più tipi di file in un singolo filtro. "*.png, *.jpg, *.jpeg ; Supported Images" mostrerà sia i file PNG sia JPEG quando selezionati.

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()

Numero di OptionButton e CheckBox aggiuntivi nella finestra di dialogo.

bool show_hidden_files = false 🔗

  • void set_show_hidden_files(value: bool)

  • bool is_showing_hidden_files()

Se true, i file e le cartelle nascosti saranno visibili nell'EditorFileDialog. Questa proprietà è sincronizzata con EditorSettings.filesystem/file_dialog/show_hidden_files.

Descrizioni dei metodi

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) 🔗

Aggiunge un OptionButton aggiuntivo alla finestra di dialogo dei file. Se values è vuoto, viene aggiunto un CheckBox.

default_value_index dovrebbe essere un indice del valore in values. Se values è vuoto, dovrebbe essere 1 (selezionato) o 0 (non selezionato).

void add_side_menu(menu: Control, title: String = "") 🔗

Aggiunge il menu specificato al lato della finestra di dialogo dei file con il testo del titolo title in cima. È consentito un solo menù laterale.

void clear_filename_filter() 🔗

Svuota il filtro per i nomi dei file.

void clear_filters() 🔗

Rimuove tutti i filtri tranne "Tutti i file (*.*)".

String get_filename_filter() const 🔗

Restituisce il valore del filtro per i nomi dei file.

LineEdit get_line_edit() 🔗

Restituisce il LineEdit per il file selezionato.

Attenzione: Questo è un nodo interno obbligatorio, rimuoverlo e liberarlo potrebbe causare un crash. Se desideri nascondere esso o uno dei suoi figli, usa la loro proprietà CanvasItem.visible.

int get_option_default(option: int) const 🔗

Restituisce l'indice di valore predefinito dell'OptionButton o della CheckBox con l'indice option.

String get_option_name(option: int) const 🔗

Restituisce il nome dell'OptionButton o della CheckBox con l'indice option.

PackedStringArray get_option_values(option: int) const 🔗

Restituisce un array di valori dell'OptionButton con l'indice option.

Dictionary get_selected_options() const 🔗

Restituisce un Dictionary con i valori selezionati degli OptionButton e/o CheckBox aggiuntivi. Le chiavi del Dictionary sono i nomi e i valori sono gli indici dei valori selezionati.

VBoxContainer get_vbox() 🔗

Restituisce il VBoxContainer utilizzato per visualizzare il file system.

Attenzione: Questo è un nodo interno obbligatorio, rimuoverlo e liberarlo potrebbe causare un crash. Se desideri nascondere esso o uno dei suoi figli, usa la loro proprietà CanvasItem.visible.

void invalidate() 🔗

Notifica a EditorFileDialog che la sua visualizzazione dei dati non è più accurata. Aggiorna il contenuto della visualizzazione al prossimo aggiornamento della visualizzazione.

void popup_file_dialog() 🔗

Mostra l'EditorFileDialog nelle dimensioni e posizione predefinite per le finestre di dialogo dei file nell'editor e seleziona il nome del file se è presente un file attuale.

void set_filename_filter(filter: String) 🔗

Imposta il valore del filtro per i nomi dei file.

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

Imposta l'indice di valore predefinito dell'OptionButton o della CheckBox con l'indice option.

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

Imposta il nome dell'OptionButton o della CheckBox con l'indice option.

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

Imposta i valori di opzione dell'OptionButton con l'indice option.