EditorFileDialog

Успадковує: ConfirmationDialog < AcceptDialog < Window < Viewport < Node < Object

Редактор FileDialog.

Опис

EditorFileDialog — це вдосконалена версія FileDialog, доступна лише для плагінів редактора. Додаткові функції включають список обраних/останніх файлів і можливість перегляду файлів у вигляді сітки мініатюр замість списку.

На відміну від FileDialog, EditorFileDialog не має властивості для використання власних діалогів. Натомість рідні діалоги можна ввімкнути глобально за допомогою параметра редактора EditorSettings.interface/editor/use_native_file_dialogs. Вони також вмикаються автоматично під час роботи в пісочниці (наприклад, у macOS).

Властивості

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)

Методи

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)

Сигнали

dir_selected(dir: String) 🔗

Увімкніть, коли вибрано каталог.

file_selected(path: String) 🔗

Увімкніть, коли вибрано файл.

filename_filter_changed(filter: String) 🔗

Видається, коли змінюється фільтр імен файлів.

files_selected(paths: PackedStringArray) 🔗

Увімкніть, коли вибрано декілька файлів.

Переліки

enum FileMode: 🔗

FileMode FILE_MODE_OPEN_FILE = 0

The EditorFileDialog може вибрати тільки один файл. Прийняття вікна відкриє файл.

FileMode FILE_MODE_OPEN_FILES = 1

EditorFileDialog може вибрати декілька файлів. Прийняття вікна відкриє всі файли.

FileMode FILE_MODE_OPEN_DIR = 2

The EditorFileDialog може вибрати тільки один каталог. Прийняття вікна відкриє каталог.

FileMode FILE_MODE_OPEN_ANY = 3

The EditorFileDialog може вибрати файл або каталог. Прийняття вікна відкриється.

FileMode FILE_MODE_SAVE_FILE = 4

The EditorFileDialog може вибрати тільки один файл. Приймання вікна збереже файл.

enum Access: 🔗

Access ACCESS_RESOURCES = 0

The EditorFileDialog може переглянути лише res://.

Access ACCESS_USERDATA = 1

The EditorFileDialog може переглянути лише user://.

Access ACCESS_FILESYSTEM = 2

The EditorFileDialog може переглянути всю локальну файлову систему.

enum DisplayMode: 🔗

DisplayMode DISPLAY_THUMBNAILS = 0

The EditorFileDialog відображає ресурси як мініатюри.

DisplayMode DISPLAY_LIST = 1

The EditorFileDialog відображає ресурси як список назв файлів.

Описи властивостей

Access access = 0 🔗

Місцезнаходження з якого користувач може вибрати файл, включаючи res://, user://, а також локальну файлову систему.

String current_dir 🔗

  • void set_current_dir(value: String)

  • String get_current_dir()

В даний час зареєстрований каталог.

String current_file 🔗

  • void set_current_file(value: String)

  • String get_current_file()

В даний час вибраний файл.

String current_path 🔗

  • void set_current_path(value: String)

  • String get_current_path()

Шлях файлової системи в адресному рядку.

bool disable_overwrite_warning = false 🔗

  • void set_disable_overwrite_warning(value: bool)

  • bool is_overwrite_warning_disabled()

Якщо true, EditorFileDialog не попередить користувача перед перезаписом файлів.

DisplayMode display_mode = 0 🔗

Формат перегляду, в якому відображаються ресурси EditorFileDialog.

FileMode file_mode = 4 🔗

Режим відкриття або збереження діалогового вікна, який впливає на поведінку вибору.

PackedStringArray filters = PackedStringArray() 🔗

Доступні фільтри типу файлів. Наприклад, це показує тільки .png файли: set_filters(PackedStringArray("*.png ; PNG Images","*[code.gd `` ; GDScript Files"[code])``. Кілька типів файлів також можна вказати в одному фільтрі. ``"*.png, *.jpg, *.jpeg ; Підтримувані зображення. `` покаже як PNG, так і JPEG файли при вибраних.

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

Кількість додаткових OptionButtons і CheckBoxes в діалоговому вікні.

bool show_hidden_files = false 🔗

  • void set_show_hidden_files(value: bool)

  • bool is_showing_hidden_files()

Якщо true, приховані файли та каталоги будуть видимі в РедагорFileDialog. Ця властивість синхронізується з EditorSettings.filesystem/file_dialog/show_hidden_files.

Описи методів

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

Додає опцію filter для імені файлу, розділеного комами, до EditorFileDialog з необов'язковим description, який обмежує вибір файлів.

filter повинен мати вигляд "filename.extension", де filename та extension можуть бути * для відповідності будь-якому рядку. Фільтри, що починаються з . (тобто пусті імена файлів), не допускаються.

Наприклад, filter з "*.tscn, *.scn" та description з "Scenes" призведе до тексту фільтра "Scenes (*.tscn, *.scn)".

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

Додає додатковий OptionButton до діалогу файлів. Якщо values порожній, то замість цього додається CheckBox.

default_value_index повинен бути індексом значення в values. Якщо values є порожнім, він повинен бути або 1 (увімкнений), або 0 (вимкнений).

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

Додавання вказаного menu на бічну сторону діалогу файлів з наведеним title текст зверху. Допускається тільки одне меню.

void clear_filename_filter() 🔗

Очистіть фільтр імен файлів.

void clear_filters() 🔗

Видаляє всі фільтри, крім «Усі файли (*.*)».

String get_filename_filter() const 🔗

Повертає значення фільтра для імен файлів.

LineEdit get_line_edit() 🔗

Повертає рядок редагування для вибраного файлу.

Налаштування: Це необхідний внутрішній вузол, видаляючи і звільняючи його може призвести до аварії. Якщо ви хочете приховати його або будь-який з своїх дітей, скористайтеся їх CanvasItem.pic.

int get_option_default(option: int) const 🔗

Повертає значення за замовчуванням індексу OptionButton або CheckBox з індексом option.

String get_option_name(option: int) const 🔗

Повертає назву OptionButton або CheckBox з індексом option.

PackedStringArray get_option_values(option: int) const 🔗

Повертає масив значень OptionButton з індексом option.

Dictionary get_selected_options() const 🔗

Повертає Dictionary з вибраними значеннями додаткових OptionButton та/або CheckBox. Ключі Dictionary – це імена, а значення – індекси вибраних значень.

VBoxContainer get_vbox() 🔗

Повернення VBoxContainer використовується для відображення файлової системи.

Налаштування: Це необхідний внутрішній вузол, видаляючи і звільняючи його може призвести до аварії. Якщо ви хочете приховати його або будь-який з своїх дітей, скористайтеся їх CanvasItem.pic.

void invalidate() 🔗

Повідомити EditorFileDialog про те, що його представлення даних більше не є точним. Оновити вміст представлення під час наступного оновлення представлення.

void popup_file_dialog() 🔗

Показати EditorFileDialog у типовому форматі та позицію для діалогів файлів у редакторі та виберіть назву файлу, якщо є поточний файл.

void set_filename_filter(filter: String) 🔗

Встановлює значення фільтра для імен файлів.

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

Встановлює індекс значення за замовчуванням для OptionButton або CheckBox з індексом option.

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

Встановлює назву OptionButton або CheckBox з індексом option.

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

Встановлює значення параметрів OptionButton з індексом option.