123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704 |
- /**************************************************************************/
- /* file_dialog.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "file_dialog.h"
- #include "core/config/project_settings.h"
- #include "core/os/keyboard.h"
- #include "core/string/print_string.h"
- #include "scene/gui/check_box.h"
- #include "scene/gui/grid_container.h"
- #include "scene/gui/label.h"
- #include "scene/gui/option_button.h"
- #include "scene/theme/theme_db.h"
- FileDialog::GetIconFunc FileDialog::get_icon_func = nullptr;
- FileDialog::RegisterFunc FileDialog::register_func = nullptr;
- FileDialog::RegisterFunc FileDialog::unregister_func = nullptr;
- void FileDialog::popup_file_dialog() {
- popup_centered_clamped(Size2i(700, 500), 0.8f);
- _focus_file_text();
- }
- void FileDialog::_focus_file_text() {
- int lp = file->get_text().rfind_char('.');
- if (lp != -1) {
- file->select(0, lp);
- if (file->is_inside_tree() && !is_part_of_edited_scene()) {
- file->grab_focus();
- }
- }
- }
- void FileDialog::_native_popup() {
- // Show native dialog directly.
- String root;
- if (access == ACCESS_RESOURCES) {
- root = ProjectSettings::get_singleton()->get_resource_path();
- } else if (access == ACCESS_USERDATA) {
- root = OS::get_singleton()->get_user_data_dir();
- }
- if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_EXTRA)) {
- DisplayServer::get_singleton()->file_dialog_with_options_show(get_translated_title(), ProjectSettings::get_singleton()->globalize_path(dir->get_text()), root, file->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), processed_filters, _get_options(), callable_mp(this, &FileDialog::_native_dialog_cb_with_options));
- } else {
- DisplayServer::get_singleton()->file_dialog_show(get_translated_title(), ProjectSettings::get_singleton()->globalize_path(dir->get_text()), file->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), processed_filters, callable_mp(this, &FileDialog::_native_dialog_cb));
- }
- }
- bool FileDialog::_can_use_native_popup() {
- if (access == ACCESS_RESOURCES || access == ACCESS_USERDATA || options.size() > 0) {
- return DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE_EXTRA);
- }
- return DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG_FILE);
- }
- void FileDialog::popup(const Rect2i &p_rect) {
- _update_option_controls();
- #ifdef TOOLS_ENABLED
- if (is_part_of_edited_scene()) {
- ConfirmationDialog::popup(p_rect);
- return;
- }
- #endif
- if (_can_use_native_popup() && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
- _native_popup();
- } else {
- ConfirmationDialog::popup(p_rect);
- }
- }
- void FileDialog::set_visible(bool p_visible) {
- if (p_visible) {
- _update_option_controls();
- }
- #ifdef TOOLS_ENABLED
- if (is_part_of_edited_scene()) {
- ConfirmationDialog::set_visible(p_visible);
- return;
- }
- #endif
- if (_can_use_native_popup() && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
- if (p_visible) {
- _native_popup();
- }
- } else {
- ConfirmationDialog::set_visible(p_visible);
- }
- }
- void FileDialog::_native_dialog_cb(bool p_ok, const Vector<String> &p_files, int p_filter) {
- _native_dialog_cb_with_options(p_ok, p_files, p_filter, Dictionary());
- }
- void FileDialog::_native_dialog_cb_with_options(bool p_ok, const Vector<String> &p_files, int p_filter, const Dictionary &p_selected_options) {
- if (!p_ok) {
- file->set_text("");
- emit_signal(SNAME("canceled"));
- return;
- }
- if (p_files.is_empty()) {
- return;
- }
- Vector<String> files = p_files;
- if (access != ACCESS_FILESYSTEM) {
- for (String &file_name : files) {
- file_name = ProjectSettings::get_singleton()->localize_path(file_name);
- }
- }
- selected_options = p_selected_options;
- String f = files[0];
- if (mode == FILE_MODE_OPEN_FILES) {
- emit_signal(SNAME("files_selected"), files);
- } else {
- if (mode == FILE_MODE_SAVE_FILE) {
- if (p_filter >= 0 && p_filter < filters.size()) {
- bool valid = false;
- String flt = filters[p_filter].get_slice(";", 0);
- int filter_slice_count = flt.get_slice_count(",");
- for (int j = 0; j < filter_slice_count; j++) {
- String str = (flt.get_slice(",", j).strip_edges());
- if (f.match(str)) {
- valid = true;
- break;
- }
- }
- if (!valid && filter_slice_count > 0) {
- String str = (flt.get_slice(",", 0).strip_edges());
- f += str.substr(1, str.length() - 1);
- }
- }
- emit_signal(SNAME("file_selected"), f);
- } else if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
- emit_signal(SNAME("file_selected"), f);
- } else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
- emit_signal(SNAME("dir_selected"), f);
- }
- }
- file->set_text(f);
- dir->set_text(f.get_base_dir());
- filter->select(p_filter);
- }
- VBoxContainer *FileDialog::get_vbox() {
- return vbox;
- }
- void FileDialog::_validate_property(PropertyInfo &p_property) const {
- if (p_property.name == "dialog_text") {
- // File dialogs have a custom layout, and dialog nodes can't have both a text and a layout.
- p_property.usage = PROPERTY_USAGE_NONE;
- }
- }
- void FileDialog::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_READY: {
- #ifdef TOOLS_ENABLED
- if (is_part_of_edited_scene()) {
- return;
- }
- #endif
- // Replace the built-in dialog with the native one if it started visible.
- if (is_visible() && _can_use_native_popup() && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
- ConfirmationDialog::set_visible(false);
- _native_popup();
- }
- } break;
- case NOTIFICATION_VISIBILITY_CHANGED: {
- if (!is_visible()) {
- set_process_shortcut_input(false);
- }
- invalidate(); // Put it here to preview in the editor.
- } break;
- case NOTIFICATION_THEME_CHANGED: {
- dir_up->set_button_icon(theme_cache.parent_folder);
- if (vbox->is_layout_rtl()) {
- dir_prev->set_button_icon(theme_cache.forward_folder);
- dir_next->set_button_icon(theme_cache.back_folder);
- } else {
- dir_prev->set_button_icon(theme_cache.back_folder);
- dir_next->set_button_icon(theme_cache.forward_folder);
- }
- refresh->set_button_icon(theme_cache.reload);
- show_hidden->set_button_icon(theme_cache.toggle_hidden);
- makedir->set_button_icon(theme_cache.create_folder);
- show_filename_filter_button->set_button_icon(theme_cache.toggle_filename_filter);
- dir_up->begin_bulk_theme_override();
- dir_up->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- dir_up->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- dir_up->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- dir_up->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
- dir_up->end_bulk_theme_override();
- dir_prev->begin_bulk_theme_override();
- dir_prev->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- dir_prev->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- dir_prev->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- dir_prev->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
- dir_prev->end_bulk_theme_override();
- dir_next->begin_bulk_theme_override();
- dir_next->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- dir_next->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- dir_next->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- dir_next->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
- dir_next->end_bulk_theme_override();
- refresh->begin_bulk_theme_override();
- refresh->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- refresh->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- refresh->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- refresh->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
- refresh->end_bulk_theme_override();
- show_hidden->begin_bulk_theme_override();
- show_hidden->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- show_hidden->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- show_hidden->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- show_hidden->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
- show_hidden->end_bulk_theme_override();
- makedir->begin_bulk_theme_override();
- makedir->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- makedir->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- makedir->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- makedir->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
- makedir->end_bulk_theme_override();
- show_filename_filter_button->begin_bulk_theme_override();
- show_filename_filter_button->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
- show_filename_filter_button->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
- show_filename_filter_button->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
- show_filename_filter_button->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
- show_filename_filter_button->end_bulk_theme_override();
- invalidate();
- } break;
- case NOTIFICATION_TRANSLATION_CHANGED: {
- update_filters();
- } break;
- }
- }
- void FileDialog::shortcut_input(const Ref<InputEvent> &p_event) {
- ERR_FAIL_COND(p_event.is_null());
- Ref<InputEventKey> k = p_event;
- if (k.is_valid() && has_focus()) {
- if (k->is_pressed()) {
- bool handled = true;
- switch (k->get_keycode()) {
- case Key::H: {
- if (k->is_command_or_control_pressed()) {
- set_show_hidden_files(!show_hidden_files);
- } else {
- handled = false;
- }
- } break;
- case Key::F: {
- if (k->is_command_or_control_pressed()) {
- show_filename_filter_button->set_pressed(!show_filename_filter_button->is_pressed());
- } else {
- handled = false;
- }
- } break;
- case Key::F5: {
- invalidate();
- } break;
- case Key::BACKSPACE: {
- _dir_submitted("..");
- } break;
- #ifdef MACOS_ENABLED
- // Cmd + Shift + G (matches Finder's "Go To" shortcut).
- case Key::G: {
- if (k->is_command_or_control_pressed() && k->is_shift_pressed()) {
- dir->grab_focus();
- dir->select_all();
- } else {
- handled = false;
- }
- } break;
- #endif
- // Ctrl + L (matches most Windows/Linux file managers' "focus on path bar" shortcut,
- // plus macOS Safari's "focus on address bar" shortcut).
- case Key::L: {
- if (k->is_command_or_control_pressed()) {
- dir->grab_focus();
- dir->select_all();
- } else {
- handled = false;
- }
- } break;
- default: {
- handled = false;
- }
- }
- if (handled) {
- set_input_as_handled();
- }
- }
- }
- }
- void FileDialog::set_enable_multiple_selection(bool p_enable) {
- tree->set_select_mode(p_enable ? Tree::SELECT_MULTI : Tree::SELECT_SINGLE);
- }
- Vector<String> FileDialog::get_selected_files() const {
- Vector<String> list;
- TreeItem *item = tree->get_root();
- item = tree->get_next_selected(item);
- while (item) {
- list.push_back(dir_access->get_current_dir().path_join(item->get_text(0)));
- item = tree->get_next_selected(item);
- }
- return list;
- }
- void FileDialog::update_dir() {
- if (root_prefix.is_empty()) {
- dir->set_text(dir_access->get_current_dir(false));
- } else {
- dir->set_text(dir_access->get_current_dir(false).trim_prefix(root_prefix).trim_prefix("/"));
- }
- if (drives->is_visible()) {
- if (dir_access->get_current_dir().is_network_share_path()) {
- _update_drives(false);
- drives->add_item(ETR("Network"));
- drives->set_item_disabled(-1, true);
- drives->select(drives->get_item_count() - 1);
- } else {
- drives->select(dir_access->get_current_drive());
- }
- }
- // Deselect any item, to make "Select Current Folder" button text by default.
- deselect_all();
- }
- void FileDialog::_dir_submitted(String p_dir) {
- _change_dir(root_prefix.path_join(p_dir));
- file->set_text("");
- _push_history();
- }
- void FileDialog::_file_submitted(const String &p_file) {
- _action_pressed();
- }
- void FileDialog::_save_confirm_pressed() {
- String f = dir_access->get_current_dir().path_join(file->get_text());
- emit_signal(SNAME("file_selected"), f);
- hide();
- }
- void FileDialog::_post_popup() {
- ConfirmationDialog::_post_popup();
- if (mode == FILE_MODE_SAVE_FILE) {
- file->grab_focus();
- } else {
- tree->grab_focus();
- }
- set_process_shortcut_input(true);
- // For open dir mode, deselect all items on file dialog open.
- if (mode == FILE_MODE_OPEN_DIR) {
- deselect_all();
- file_box->set_visible(false);
- } else {
- file_box->set_visible(true);
- }
- local_history.clear();
- local_history_pos = -1;
- _push_history();
- }
- void FileDialog::_push_history() {
- local_history.resize(local_history_pos + 1);
- String new_path = dir_access->get_current_dir();
- if (local_history.size() == 0 || new_path != local_history[local_history_pos]) {
- local_history.push_back(new_path);
- local_history_pos++;
- dir_prev->set_disabled(local_history_pos == 0);
- dir_next->set_disabled(true);
- }
- }
- void FileDialog::_action_pressed() {
- if (mode == FILE_MODE_OPEN_FILES) {
- TreeItem *ti = tree->get_next_selected(nullptr);
- String fbase = dir_access->get_current_dir();
- Vector<String> files;
- while (ti) {
- files.push_back(fbase.path_join(ti->get_text(0)));
- ti = tree->get_next_selected(ti);
- }
- if (files.size()) {
- emit_signal(SNAME("files_selected"), files);
- hide();
- }
- return;
- }
- String file_text = file->get_text();
- String f = file_text.is_absolute_path() ? file_text : dir_access->get_current_dir().path_join(file_text);
- if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
- emit_signal(SNAME("file_selected"), f);
- hide();
- } else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
- String path = dir_access->get_current_dir();
- path = path.replace("\\", "/");
- TreeItem *item = tree->get_selected();
- if (item) {
- Dictionary d = item->get_metadata(0);
- if (d["dir"] && d["name"] != "..") {
- path = path.path_join(d["name"]);
- }
- }
- emit_signal(SNAME("dir_selected"), path);
- hide();
- }
- if (mode == FILE_MODE_SAVE_FILE) {
- bool valid = false;
- if (filter->get_selected() == filter->get_item_count() - 1) {
- valid = true; // match none
- } else if (filters.size() > 1 && filter->get_selected() == 0) {
- // match all filters
- for (int i = 0; i < filters.size(); i++) {
- String flt = filters[i].get_slice(";", 0);
- for (int j = 0; j < flt.get_slice_count(","); j++) {
- String str = flt.get_slice(",", j).strip_edges();
- if (f.match(str)) {
- valid = true;
- break;
- }
- }
- if (valid) {
- break;
- }
- }
- } else {
- int idx = filter->get_selected();
- if (filters.size() > 1) {
- idx--;
- }
- if (idx >= 0 && idx < filters.size()) {
- String flt = filters[idx].get_slice(";", 0);
- int filterSliceCount = flt.get_slice_count(",");
- for (int j = 0; j < filterSliceCount; j++) {
- String str = (flt.get_slice(",", j).strip_edges());
- if (f.match(str)) {
- valid = true;
- break;
- }
- }
- if (!valid && filterSliceCount > 0) {
- String str = (flt.get_slice(",", 0).strip_edges());
- f += str.substr(1, str.length() - 1);
- file->set_text(f.get_file());
- valid = true;
- }
- } else {
- valid = true;
- }
- }
- String file_name = file_text.strip_edges().get_file();
- if (!valid || file_name.is_empty()) {
- exterr->popup_centered(Size2(250, 80));
- return;
- }
- if (dir_access->file_exists(f)) {
- confirm_save->set_text(vformat(atr(ETR("File \"%s\" already exists.\nDo you want to overwrite it?")), f));
- confirm_save->popup_centered(Size2(250, 80));
- } else {
- emit_signal(SNAME("file_selected"), f);
- hide();
- }
- }
- }
- void FileDialog::_cancel_pressed() {
- file->set_text("");
- invalidate();
- hide();
- }
- bool FileDialog::_is_open_should_be_disabled() {
- if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_SAVE_FILE) {
- return false;
- }
- TreeItem *ti = tree->get_next_selected(tree->get_root());
- while (ti) {
- TreeItem *prev_ti = ti;
- ti = tree->get_next_selected(tree->get_root());
- if (ti == prev_ti) {
- break;
- }
- }
- // We have something that we can't select?
- if (!ti) {
- return mode != FILE_MODE_OPEN_DIR; // In "Open folder" mode, having nothing selected picks the current folder.
- }
- Dictionary d = ti->get_metadata(0);
- // Opening a file, but selected a folder? Forbidden.
- return ((mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES) && d["dir"]) || // Flipped case, also forbidden.
- (mode == FILE_MODE_OPEN_DIR && !d["dir"]);
- }
- void FileDialog::_go_up() {
- _change_dir("..");
- _push_history();
- }
- void FileDialog::_go_back() {
- if (local_history_pos <= 0) {
- return;
- }
- local_history_pos--;
- _change_dir(local_history[local_history_pos]);
- dir_prev->set_disabled(local_history_pos == 0);
- dir_next->set_disabled(local_history_pos == local_history.size() - 1);
- }
- void FileDialog::_go_forward() {
- if (local_history_pos >= local_history.size() - 1) {
- return;
- }
- local_history_pos++;
- _change_dir(local_history[local_history_pos]);
- dir_prev->set_disabled(local_history_pos == 0);
- dir_next->set_disabled(local_history_pos == local_history.size() - 1);
- }
- void FileDialog::deselect_all() {
- // Clear currently selected items in file manager.
- tree->deselect_all();
- // And change get_ok title.
- if (!tree->is_anything_selected()) {
- get_ok_button()->set_disabled(_is_open_should_be_disabled());
- switch (mode) {
- case FILE_MODE_OPEN_FILE:
- case FILE_MODE_OPEN_FILES:
- set_ok_button_text(ETR("Open"));
- break;
- case FILE_MODE_OPEN_DIR:
- set_ok_button_text(ETR("Select Current Folder"));
- break;
- case FILE_MODE_OPEN_ANY:
- case FILE_MODE_SAVE_FILE:
- // FIXME: Implement, or refactor to avoid duplication with set_mode
- break;
- }
- }
- }
- void FileDialog::_tree_multi_selected(Object *p_object, int p_cell, bool p_selected) {
- _tree_selected();
- }
- void FileDialog::_tree_selected() {
- TreeItem *ti = tree->get_selected();
- if (!ti) {
- return;
- }
- Dictionary d = ti->get_metadata(0);
- if (!d["dir"]) {
- file->set_text(d["name"]);
- } else if (mode == FILE_MODE_OPEN_DIR) {
- set_ok_button_text(ETR("Select This Folder"));
- }
- get_ok_button()->set_disabled(_is_open_should_be_disabled());
- }
- void FileDialog::_tree_item_activated() {
- TreeItem *ti = tree->get_selected();
- if (!ti) {
- return;
- }
- Dictionary d = ti->get_metadata(0);
- if (d["dir"]) {
- _change_dir(d["name"]);
- if (mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES || mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
- file->set_text("");
- }
- _push_history();
- } else {
- _action_pressed();
- }
- }
- void FileDialog::update_file_name() {
- int idx = filter->get_selected() - 1;
- if ((idx == -1 && filter->get_item_count() == 2) || (filter->get_item_count() > 2 && idx >= 0 && idx < filter->get_item_count() - 2)) {
- if (idx == -1) {
- idx += 1;
- }
- String filter_str = filters[idx];
- String file_str = file->get_text();
- String base_name = file_str.get_basename();
- Vector<String> filter_substr = filter_str.split(";");
- if (filter_substr.size() >= 2) {
- file_str = base_name + "." + filter_substr[0].strip_edges().get_extension().to_lower();
- } else {
- file_str = base_name + "." + filter_str.strip_edges().get_extension().to_lower();
- }
- file->set_text(file_str);
- }
- }
- void FileDialog::update_file_list() {
- tree->clear();
- // Scroll back to the top after opening a directory
- tree->get_vscroll_bar()->set_value(0);
- dir_access->list_dir_begin();
- if (dir_access->is_readable(dir_access->get_current_dir().utf8().get_data())) {
- message->hide();
- } else {
- message->set_text(ETR("You don't have permission to access contents of this folder."));
- message->show();
- }
- TreeItem *root = tree->create_item();
- List<String> files;
- List<String> dirs;
- bool is_hidden;
- String item = dir_access->get_next();
- while (!item.is_empty()) {
- if (item == "." || item == "..") {
- item = dir_access->get_next();
- continue;
- }
- is_hidden = dir_access->current_is_hidden();
- if (show_hidden_files || !is_hidden) {
- if (!dir_access->current_is_dir()) {
- files.push_back(item);
- } else {
- dirs.push_back(item);
- }
- }
- item = dir_access->get_next();
- }
- dirs.sort_custom<FileNoCaseComparator>();
- files.sort_custom<FileNoCaseComparator>();
- String filename_filter_lower = file_name_filter.to_lower();
- while (!dirs.is_empty()) {
- const String &dir_name = dirs.front()->get();
- if (filename_filter_lower.is_empty() || dir_name.to_lower().contains(filename_filter_lower)) {
- TreeItem *ti = tree->create_item(root);
- ti->set_text(0, dir_name);
- ti->set_icon(0, theme_cache.folder);
- ti->set_icon_modulate(0, theme_cache.folder_icon_color);
- Dictionary d;
- d["name"] = dir_name;
- d["dir"] = true;
- ti->set_metadata(0, d);
- }
- dirs.pop_front();
- }
- List<String> patterns;
- // build filter
- if (filter->get_selected() == filter->get_item_count() - 1) {
- // match all
- } else if (filters.size() > 1 && filter->get_selected() == 0) {
- // match all filters
- for (int i = 0; i < filters.size(); i++) {
- String f = filters[i].get_slice(";", 0);
- for (int j = 0; j < f.get_slice_count(","); j++) {
- patterns.push_back(f.get_slice(",", j).strip_edges());
- }
- }
- } else {
- int idx = filter->get_selected();
- if (filters.size() > 1) {
- idx--;
- }
- if (idx >= 0 && idx < filters.size()) {
- String f = filters[idx].get_slice(";", 0);
- for (int j = 0; j < f.get_slice_count(","); j++) {
- patterns.push_back(f.get_slice(",", j).strip_edges());
- }
- }
- }
- String base_dir = dir_access->get_current_dir();
- while (!files.is_empty()) {
- bool match = patterns.is_empty();
- String match_str;
- for (const String &E : patterns) {
- if (files.front()->get().matchn(E)) {
- match_str = E;
- match = true;
- break;
- }
- }
- if (match && (filename_filter_lower.is_empty() || files.front()->get().to_lower().contains(filename_filter_lower))) {
- TreeItem *ti = tree->create_item(root);
- ti->set_text(0, files.front()->get());
- if (get_icon_func) {
- Ref<Texture2D> icon = get_icon_func(base_dir.path_join(files.front()->get()));
- ti->set_icon(0, icon);
- } else {
- ti->set_icon(0, theme_cache.file);
- }
- ti->set_icon_modulate(0, theme_cache.file_icon_color);
- if (mode == FILE_MODE_OPEN_DIR) {
- ti->set_custom_color(0, theme_cache.file_disabled_color);
- ti->set_selectable(0, false);
- }
- Dictionary d;
- d["name"] = files.front()->get();
- d["dir"] = false;
- ti->set_metadata(0, d);
- if (file->get_text() == files.front()->get() || match_str == files.front()->get()) {
- ti->select(0);
- }
- }
- files.pop_front();
- }
- if (mode != FILE_MODE_SAVE_FILE && mode != FILE_MODE_OPEN_DIR) {
- // Select the first file from list if nothing is selected.
- if (tree->get_root() && tree->get_root()->get_first_child() && tree->get_selected() == nullptr) {
- tree->get_root()->get_first_child()->select(0);
- }
- }
- }
- void FileDialog::_filter_selected(int) {
- update_file_name();
- update_file_list();
- }
- void FileDialog::_filename_filter_changed() {
- update_filename_filter();
- update_file_list();
- callable_mp(this, &FileDialog::_tree_select_first).call_deferred();
- }
- void FileDialog::_tree_select_first() {
- if (tree->get_root() && tree->get_root()->get_first_child()) {
- tree->get_root()->get_first_child()->select(0);
- }
- }
- void FileDialog::_filename_filter_selected() {
- TreeItem *item = tree->get_selected();
- if (item) {
- file->set_text(item->get_text(0));
- file->emit_signal("text_submitted", file->get_text());
- }
- }
- void FileDialog::update_filters() {
- filter->clear();
- processed_filters.clear();
- if (filters.size() > 1) {
- String all_filters;
- String all_filters_full;
- const int max_filters = 5;
- for (int i = 0; i < MIN(max_filters, filters.size()); i++) {
- String flt = filters[i].get_slicec(';', 0).strip_edges();
- if (i > 0) {
- all_filters += ", ";
- }
- all_filters += flt;
- }
- for (int i = 0; i < filters.size(); i++) {
- String flt = filters[i].get_slicec(';', 0).strip_edges();
- if (i > 0) {
- all_filters_full += ",";
- }
- all_filters_full += flt;
- }
- if (max_filters < filters.size()) {
- all_filters += ", ...";
- }
- String f = atr(ETR("All Recognized")) + " (" + all_filters + ")";
- filter->add_item(f);
- processed_filters.push_back(all_filters_full + ";" + f);
- }
- for (int i = 0; i < filters.size(); i++) {
- String flt = filters[i].get_slicec(';', 0).strip_edges();
- String desc = filters[i].get_slice(";", 1).strip_edges();
- if (desc.length()) {
- String f = atr(desc) + " (" + flt + ")";
- filter->add_item(f);
- processed_filters.push_back(flt + ";" + f);
- } else {
- String f = "(" + flt + ")";
- filter->add_item(f);
- processed_filters.push_back(flt + ";" + f);
- }
- }
- String f = atr(ETR("All Files")) + " (*)";
- filter->add_item(f);
- processed_filters.push_back("*.*;" + f);
- }
- void FileDialog::clear_filename_filter() {
- set_filename_filter("");
- update_filename_filter_gui();
- invalidate();
- }
- void FileDialog::update_filename_filter_gui() {
- filename_filter_box->set_visible(show_filename_filter);
- if (!show_filename_filter) {
- file_name_filter.clear();
- }
- if (filename_filter->get_text() == file_name_filter) {
- return;
- }
- filename_filter->set_text(file_name_filter);
- }
- void FileDialog::update_filename_filter() {
- if (filename_filter->get_text() == file_name_filter) {
- return;
- }
- set_filename_filter(filename_filter->get_text());
- }
- void FileDialog::clear_filters() {
- filters.clear();
- update_filters();
- invalidate();
- }
- void FileDialog::add_filter(const String &p_filter, const String &p_description) {
- ERR_FAIL_COND_MSG(p_filter.begins_with("."), "Filter must be \"filename.extension\", can't start with dot.");
- if (p_description.is_empty()) {
- filters.push_back(p_filter);
- } else {
- filters.push_back(vformat("%s ; %s", p_filter, p_description));
- }
- update_filters();
- invalidate();
- }
- void FileDialog::set_filters(const Vector<String> &p_filters) {
- if (filters == p_filters) {
- return;
- }
- filters = p_filters;
- update_filters();
- invalidate();
- }
- void FileDialog::set_filename_filter(const String &p_filename_filter) {
- if (file_name_filter == p_filename_filter) {
- return;
- }
- file_name_filter = p_filename_filter;
- update_filename_filter_gui();
- emit_signal(SNAME("filename_filter_changed"), filter);
- invalidate();
- }
- Vector<String> FileDialog::get_filters() const {
- return filters;
- }
- String FileDialog::get_filename_filter() const {
- return file_name_filter;
- }
- String FileDialog::get_current_dir() const {
- return dir->get_text();
- }
- String FileDialog::get_current_file() const {
- return file->get_text();
- }
- String FileDialog::get_current_path() const {
- return dir->get_text().path_join(file->get_text());
- }
- void FileDialog::set_current_dir(const String &p_dir) {
- _change_dir(p_dir);
- _push_history();
- }
- void FileDialog::set_current_file(const String &p_file) {
- if (file->get_text() == p_file) {
- return;
- }
- file->set_text(p_file);
- update_dir();
- invalidate();
- _focus_file_text();
- }
- void FileDialog::set_current_path(const String &p_path) {
- if (!p_path.size()) {
- return;
- }
- int pos = MAX(p_path.rfind_char('/'), p_path.rfind_char('\\'));
- if (pos == -1) {
- set_current_file(p_path);
- } else {
- String path_dir = p_path.substr(0, pos);
- String path_file = p_path.substr(pos + 1, p_path.length());
- set_current_dir(path_dir);
- set_current_file(path_file);
- }
- }
- void FileDialog::set_root_subfolder(const String &p_root) {
- root_subfolder = p_root;
- ERR_FAIL_COND_MSG(!dir_access->dir_exists(p_root), "root_subfolder must be an existing sub-directory.");
- local_history.clear();
- local_history_pos = -1;
- dir_access->change_dir(root_subfolder);
- if (root_subfolder.is_empty()) {
- root_prefix = "";
- } else {
- root_prefix = dir_access->get_current_dir();
- }
- invalidate();
- update_dir();
- }
- String FileDialog::get_root_subfolder() const {
- return root_subfolder;
- }
- void FileDialog::set_mode_overrides_title(bool p_override) {
- mode_overrides_title = p_override;
- }
- bool FileDialog::is_mode_overriding_title() const {
- return mode_overrides_title;
- }
- void FileDialog::set_file_mode(FileMode p_mode) {
- ERR_FAIL_INDEX((int)p_mode, 5);
- if (mode == p_mode) {
- return;
- }
- mode = p_mode;
- switch (mode) {
- case FILE_MODE_OPEN_FILE:
- set_ok_button_text(ETR("Open"));
- if (mode_overrides_title) {
- set_title(ETR("Open a File"));
- }
- makedir->hide();
- break;
- case FILE_MODE_OPEN_FILES:
- set_ok_button_text(ETR("Open"));
- if (mode_overrides_title) {
- set_title(ETR("Open File(s)"));
- }
- makedir->hide();
- break;
- case FILE_MODE_OPEN_DIR:
- set_ok_button_text(ETR("Select Current Folder"));
- if (mode_overrides_title) {
- set_title(ETR("Open a Directory"));
- }
- makedir->show();
- break;
- case FILE_MODE_OPEN_ANY:
- set_ok_button_text(ETR("Open"));
- if (mode_overrides_title) {
- set_title(ETR("Open a File or Directory"));
- }
- makedir->show();
- break;
- case FILE_MODE_SAVE_FILE:
- set_ok_button_text(ETR("Save"));
- if (mode_overrides_title) {
- set_title(ETR("Save a File"));
- }
- makedir->show();
- break;
- }
- if (mode == FILE_MODE_OPEN_FILES) {
- tree->set_select_mode(Tree::SELECT_MULTI);
- } else {
- tree->set_select_mode(Tree::SELECT_SINGLE);
- }
- get_ok_button()->set_disabled(_is_open_should_be_disabled());
- }
- FileDialog::FileMode FileDialog::get_file_mode() const {
- return mode;
- }
- void FileDialog::set_access(Access p_access) {
- ERR_FAIL_INDEX(p_access, 3);
- if (access == p_access) {
- return;
- }
- switch (p_access) {
- case ACCESS_FILESYSTEM: {
- dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- } break;
- case ACCESS_RESOURCES: {
- dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- } break;
- case ACCESS_USERDATA: {
- dir_access = DirAccess::create(DirAccess::ACCESS_USERDATA);
- } break;
- }
- access = p_access;
- root_prefix = "";
- root_subfolder = "";
- _update_drives();
- invalidate();
- update_filters();
- update_dir();
- }
- void FileDialog::invalidate() {
- if (!is_visible() || is_invalidating) {
- return;
- }
- is_invalidating = true;
- callable_mp(this, &FileDialog::_invalidate).call_deferred();
- }
- void FileDialog::_invalidate() {
- if (!is_invalidating) {
- return;
- }
- update_file_list();
- is_invalidating = false;
- }
- FileDialog::Access FileDialog::get_access() const {
- return access;
- }
- void FileDialog::_make_dir_confirm() {
- Error err = dir_access->make_dir(makedirname->get_text().strip_edges());
- if (err == OK) {
- _change_dir(makedirname->get_text().strip_edges());
- update_filters();
- _push_history();
- } else {
- mkdirerr->popup_centered(Size2(250, 50));
- }
- makedirname->set_text(""); // reset label
- }
- void FileDialog::_make_dir() {
- makedialog->popup_centered(Size2(250, 80));
- makedirname->grab_focus();
- }
- void FileDialog::_select_drive(int p_idx) {
- String d = drives->get_item_text(p_idx);
- _change_dir(d);
- file->set_text("");
- _push_history();
- }
- void FileDialog::_change_dir(const String &p_new_dir) {
- if (root_prefix.is_empty()) {
- dir_access->change_dir(p_new_dir);
- } else {
- String old_dir = dir_access->get_current_dir();
- dir_access->change_dir(p_new_dir);
- if (!dir_access->get_current_dir(false).begins_with(root_prefix)) {
- dir_access->change_dir(old_dir);
- return;
- }
- }
- invalidate();
- update_dir();
- }
- void FileDialog::_update_drives(bool p_select) {
- int dc = dir_access->get_drive_count();
- if (dc == 0 || access != ACCESS_FILESYSTEM) {
- drives->hide();
- } else {
- drives->clear();
- Node *dp = drives->get_parent();
- if (dp) {
- dp->remove_child(drives);
- }
- dp = dir_access->drives_are_shortcuts() ? shortcuts_container : drives_container;
- dp->add_child(drives);
- drives->show();
- for (int i = 0; i < dir_access->get_drive_count(); i++) {
- drives->add_item(dir_access->get_drive(i));
- }
- if (p_select) {
- drives->select(dir_access->get_current_drive());
- }
- }
- }
- bool FileDialog::default_show_hidden_files = false;
- TypedArray<Dictionary> FileDialog::_get_options() const {
- TypedArray<Dictionary> out;
- for (const FileDialog::Option &opt : options) {
- Dictionary dict;
- dict["name"] = opt.name;
- dict["values"] = opt.values;
- dict["default"] = (int)selected_options.get(opt.name, opt.default_idx);
- out.push_back(dict);
- }
- return out;
- }
- void FileDialog::_option_changed_checkbox_toggled(bool p_pressed, const String &p_name) {
- if (selected_options.has(p_name)) {
- selected_options[p_name] = p_pressed;
- }
- }
- void FileDialog::_option_changed_item_selected(int p_idx, const String &p_name) {
- if (selected_options.has(p_name)) {
- selected_options[p_name] = p_idx;
- }
- }
- void FileDialog::_update_option_controls() {
- if (!options_dirty) {
- return;
- }
- options_dirty = false;
- while (grid_options->get_child_count() > 0) {
- Node *child = grid_options->get_child(0);
- grid_options->remove_child(child);
- child->queue_free();
- }
- selected_options.clear();
- for (const FileDialog::Option &opt : options) {
- Label *lbl = memnew(Label);
- lbl->set_text(opt.name);
- grid_options->add_child(lbl);
- if (opt.values.is_empty()) {
- CheckBox *cb = memnew(CheckBox);
- cb->set_pressed(opt.default_idx);
- grid_options->add_child(cb);
- cb->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::_option_changed_checkbox_toggled).bind(opt.name));
- selected_options[opt.name] = (bool)opt.default_idx;
- } else {
- OptionButton *ob = memnew(OptionButton);
- for (const String &val : opt.values) {
- ob->add_item(val);
- }
- ob->select(opt.default_idx);
- grid_options->add_child(ob);
- ob->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_option_changed_item_selected).bind(opt.name));
- selected_options[opt.name] = opt.default_idx;
- }
- }
- }
- Dictionary FileDialog::get_selected_options() const {
- return selected_options;
- }
- String FileDialog::get_option_name(int p_option) const {
- ERR_FAIL_INDEX_V(p_option, options.size(), String());
- return options[p_option].name;
- }
- Vector<String> FileDialog::get_option_values(int p_option) const {
- ERR_FAIL_INDEX_V(p_option, options.size(), Vector<String>());
- return options[p_option].values;
- }
- int FileDialog::get_option_default(int p_option) const {
- ERR_FAIL_INDEX_V(p_option, options.size(), -1);
- return options[p_option].default_idx;
- }
- void FileDialog::set_option_name(int p_option, const String &p_name) {
- if (p_option < 0) {
- p_option += get_option_count();
- }
- ERR_FAIL_INDEX(p_option, options.size());
- options.write[p_option].name = p_name;
- options_dirty = true;
- if (is_visible()) {
- _update_option_controls();
- }
- }
- void FileDialog::set_option_values(int p_option, const Vector<String> &p_values) {
- if (p_option < 0) {
- p_option += get_option_count();
- }
- ERR_FAIL_INDEX(p_option, options.size());
- options.write[p_option].values = p_values;
- if (p_values.is_empty()) {
- options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, 1);
- } else {
- options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, options[p_option].values.size() - 1);
- }
- options_dirty = true;
- if (is_visible()) {
- _update_option_controls();
- }
- }
- void FileDialog::set_option_default(int p_option, int p_index) {
- if (p_option < 0) {
- p_option += get_option_count();
- }
- ERR_FAIL_INDEX(p_option, options.size());
- if (options[p_option].values.is_empty()) {
- options.write[p_option].default_idx = CLAMP(p_index, 0, 1);
- } else {
- options.write[p_option].default_idx = CLAMP(p_index, 0, options[p_option].values.size() - 1);
- }
- options_dirty = true;
- if (is_visible()) {
- _update_option_controls();
- }
- }
- void FileDialog::add_option(const String &p_name, const Vector<String> &p_values, int p_index) {
- Option opt;
- opt.name = p_name;
- opt.values = p_values;
- if (opt.values.is_empty()) {
- opt.default_idx = CLAMP(p_index, 0, 1);
- } else {
- opt.default_idx = CLAMP(p_index, 0, opt.values.size() - 1);
- }
- options.push_back(opt);
- options_dirty = true;
- if (is_visible()) {
- _update_option_controls();
- }
- }
- void FileDialog::set_option_count(int p_count) {
- ERR_FAIL_COND(p_count < 0);
- if (options.size() == p_count) {
- return;
- }
- options.resize(p_count);
- options_dirty = true;
- notify_property_list_changed();
- if (is_visible()) {
- _update_option_controls();
- }
- }
- int FileDialog::get_option_count() const {
- return options.size();
- }
- void FileDialog::_bind_methods() {
- ClassDB::bind_method(D_METHOD("_cancel_pressed"), &FileDialog::_cancel_pressed);
- ClassDB::bind_method(D_METHOD("clear_filters"), &FileDialog::clear_filters);
- ClassDB::bind_method(D_METHOD("add_filter", "filter", "description"), &FileDialog::add_filter, DEFVAL(""));
- ClassDB::bind_method(D_METHOD("set_filters", "filters"), &FileDialog::set_filters);
- ClassDB::bind_method(D_METHOD("get_filters"), &FileDialog::get_filters);
- ClassDB::bind_method(D_METHOD("clear_filename_filter"), &FileDialog::clear_filename_filter);
- ClassDB::bind_method(D_METHOD("set_filename_filter", "filter"), &FileDialog::set_filename_filter);
- ClassDB::bind_method(D_METHOD("get_filename_filter"), &FileDialog::get_filename_filter);
- ClassDB::bind_method(D_METHOD("get_option_name", "option"), &FileDialog::get_option_name);
- ClassDB::bind_method(D_METHOD("get_option_values", "option"), &FileDialog::get_option_values);
- ClassDB::bind_method(D_METHOD("get_option_default", "option"), &FileDialog::get_option_default);
- ClassDB::bind_method(D_METHOD("set_option_name", "option", "name"), &FileDialog::set_option_name);
- ClassDB::bind_method(D_METHOD("set_option_values", "option", "values"), &FileDialog::set_option_values);
- ClassDB::bind_method(D_METHOD("set_option_default", "option", "default_value_index"), &FileDialog::set_option_default);
- ClassDB::bind_method(D_METHOD("set_option_count", "count"), &FileDialog::set_option_count);
- ClassDB::bind_method(D_METHOD("get_option_count"), &FileDialog::get_option_count);
- ClassDB::bind_method(D_METHOD("add_option", "name", "values", "default_value_index"), &FileDialog::add_option);
- ClassDB::bind_method(D_METHOD("get_selected_options"), &FileDialog::get_selected_options);
- ClassDB::bind_method(D_METHOD("get_current_dir"), &FileDialog::get_current_dir);
- ClassDB::bind_method(D_METHOD("get_current_file"), &FileDialog::get_current_file);
- ClassDB::bind_method(D_METHOD("get_current_path"), &FileDialog::get_current_path);
- ClassDB::bind_method(D_METHOD("set_current_dir", "dir"), &FileDialog::set_current_dir);
- ClassDB::bind_method(D_METHOD("set_current_file", "file"), &FileDialog::set_current_file);
- ClassDB::bind_method(D_METHOD("set_current_path", "path"), &FileDialog::set_current_path);
- ClassDB::bind_method(D_METHOD("set_mode_overrides_title", "override"), &FileDialog::set_mode_overrides_title);
- ClassDB::bind_method(D_METHOD("is_mode_overriding_title"), &FileDialog::is_mode_overriding_title);
- ClassDB::bind_method(D_METHOD("set_file_mode", "mode"), &FileDialog::set_file_mode);
- ClassDB::bind_method(D_METHOD("get_file_mode"), &FileDialog::get_file_mode);
- ClassDB::bind_method(D_METHOD("get_vbox"), &FileDialog::get_vbox);
- ClassDB::bind_method(D_METHOD("get_line_edit"), &FileDialog::get_line_edit);
- ClassDB::bind_method(D_METHOD("set_access", "access"), &FileDialog::set_access);
- ClassDB::bind_method(D_METHOD("get_access"), &FileDialog::get_access);
- ClassDB::bind_method(D_METHOD("set_root_subfolder", "dir"), &FileDialog::set_root_subfolder);
- ClassDB::bind_method(D_METHOD("get_root_subfolder"), &FileDialog::get_root_subfolder);
- ClassDB::bind_method(D_METHOD("set_show_hidden_files", "show"), &FileDialog::set_show_hidden_files);
- ClassDB::bind_method(D_METHOD("is_showing_hidden_files"), &FileDialog::is_showing_hidden_files);
- ClassDB::bind_method(D_METHOD("set_use_native_dialog", "native"), &FileDialog::set_use_native_dialog);
- ClassDB::bind_method(D_METHOD("get_use_native_dialog"), &FileDialog::get_use_native_dialog);
- ClassDB::bind_method(D_METHOD("deselect_all"), &FileDialog::deselect_all);
- ClassDB::bind_method(D_METHOD("invalidate"), &FileDialog::invalidate);
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "mode_overrides_title"), "set_mode_overrides_title", "is_mode_overriding_title");
- ADD_PROPERTY(PropertyInfo(Variant::INT, "file_mode", PROPERTY_HINT_ENUM, "Open File,Open Files,Open Folder,Open Any,Save"), "set_file_mode", "get_file_mode");
- ADD_PROPERTY(PropertyInfo(Variant::INT, "access", PROPERTY_HINT_ENUM, "Resources,User Data,File System"), "set_access", "get_access");
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "root_subfolder"), "set_root_subfolder", "get_root_subfolder");
- ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "filters"), "set_filters", "get_filters");
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "filename_filter"), "set_filename_filter", "get_filename_filter");
- ADD_ARRAY_COUNT("Options", "option_count", "set_option_count", "get_option_count", "option_");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "show_hidden_files"), "set_show_hidden_files", "is_showing_hidden_files");
- ADD_PROPERTY(PropertyInfo(Variant::BOOL, "use_native_dialog"), "set_use_native_dialog", "get_use_native_dialog");
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_dir", PROPERTY_HINT_DIR, "", PROPERTY_USAGE_NONE), "set_current_dir", "get_current_dir");
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_file", PROPERTY_HINT_FILE, "*", PROPERTY_USAGE_NONE), "set_current_file", "get_current_file");
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_current_path", "get_current_path");
- ADD_SIGNAL(MethodInfo("file_selected", PropertyInfo(Variant::STRING, "path")));
- ADD_SIGNAL(MethodInfo("files_selected", PropertyInfo(Variant::PACKED_STRING_ARRAY, "paths")));
- ADD_SIGNAL(MethodInfo("dir_selected", PropertyInfo(Variant::STRING, "dir")));
- ADD_SIGNAL(MethodInfo("filename_filter_changed", PropertyInfo(Variant::STRING, "filter")));
- BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILE);
- BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILES);
- BIND_ENUM_CONSTANT(FILE_MODE_OPEN_DIR);
- BIND_ENUM_CONSTANT(FILE_MODE_OPEN_ANY);
- BIND_ENUM_CONSTANT(FILE_MODE_SAVE_FILE);
- BIND_ENUM_CONSTANT(ACCESS_RESOURCES);
- BIND_ENUM_CONSTANT(ACCESS_USERDATA);
- BIND_ENUM_CONSTANT(ACCESS_FILESYSTEM);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, parent_folder);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, forward_folder);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, back_folder);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, reload);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, toggle_hidden);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, folder);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, toggle_filename_filter);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, file);
- BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, create_folder);
- BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, folder_icon_color);
- BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_icon_color);
- BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_disabled_color);
- // TODO: Define own colors?
- BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_normal_color, "font_color", "Button");
- BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_hover_color, "font_hover_color", "Button");
- BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_focus_color, "font_focus_color", "Button");
- BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_pressed_color, "font_pressed_color", "Button");
- Option defaults;
- base_property_helper.set_prefix("option_");
- base_property_helper.set_array_length_getter(&FileDialog::get_option_count);
- base_property_helper.register_property(PropertyInfo(Variant::STRING, "name"), defaults.name, &FileDialog::set_option_name, &FileDialog::get_option_name);
- base_property_helper.register_property(PropertyInfo(Variant::PACKED_STRING_ARRAY, "values"), defaults.values, &FileDialog::set_option_values, &FileDialog::get_option_values);
- base_property_helper.register_property(PropertyInfo(Variant::INT, "default"), defaults.default_idx, &FileDialog::set_option_default, &FileDialog::get_option_default);
- PropertyListHelper::register_base_helper(&base_property_helper);
- }
- void FileDialog::set_show_hidden_files(bool p_show) {
- if (show_hidden_files == p_show) {
- return;
- }
- show_hidden_files = p_show;
- invalidate();
- }
- void FileDialog::set_show_filename_filter(bool p_show) {
- if (p_show == show_filename_filter) {
- return;
- }
- if (p_show) {
- filename_filter->grab_focus();
- } else {
- if (filename_filter->has_focus()) {
- tree->call_deferred("grab_focus");
- }
- }
- show_filename_filter = p_show;
- update_filename_filter_gui();
- invalidate();
- }
- bool FileDialog::get_show_filename_filter() const {
- return show_filename_filter;
- }
- bool FileDialog::is_showing_hidden_files() const {
- return show_hidden_files;
- }
- void FileDialog::set_default_show_hidden_files(bool p_show) {
- default_show_hidden_files = p_show;
- }
- void FileDialog::set_use_native_dialog(bool p_native) {
- use_native_dialog = p_native;
- #ifdef TOOLS_ENABLED
- if (is_part_of_edited_scene()) {
- return;
- }
- #endif
- // Replace the built-in dialog with the native one if it's currently visible.
- if (is_inside_tree() && is_visible() && _can_use_native_popup() && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
- ConfirmationDialog::set_visible(false);
- _native_popup();
- }
- }
- bool FileDialog::get_use_native_dialog() const {
- return use_native_dialog;
- }
- FileDialog::FileDialog() {
- show_hidden_files = default_show_hidden_files;
- vbox = memnew(VBoxContainer);
- add_child(vbox, false, INTERNAL_MODE_FRONT);
- mode = FILE_MODE_SAVE_FILE;
- set_title(TTRC("Save a File"));
- HBoxContainer *hbc = memnew(HBoxContainer);
- dir_prev = memnew(Button);
- dir_prev->set_theme_type_variation("FlatButton");
- dir_prev->set_tooltip_text(ETR("Go to previous folder."));
- dir_next = memnew(Button);
- dir_next->set_theme_type_variation("FlatButton");
- dir_next->set_tooltip_text(ETR("Go to next folder."));
- dir_up = memnew(Button);
- dir_up->set_theme_type_variation("FlatButton");
- dir_up->set_tooltip_text(ETR("Go to parent folder."));
- hbc->add_child(dir_prev);
- hbc->add_child(dir_next);
- hbc->add_child(dir_up);
- dir_prev->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_back));
- dir_next->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_forward));
- dir_up->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_go_up));
- hbc->add_child(memnew(Label(ETR("Path:"))));
- drives_container = memnew(HBoxContainer);
- hbc->add_child(drives_container);
- drives = memnew(OptionButton);
- drives->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_select_drive));
- hbc->add_child(drives);
- dir = memnew(LineEdit);
- dir->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
- hbc->add_child(dir);
- dir->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- refresh = memnew(Button);
- refresh->set_theme_type_variation("FlatButton");
- refresh->set_tooltip_text(ETR("Refresh files."));
- refresh->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::update_file_list));
- hbc->add_child(refresh);
- show_hidden = memnew(Button);
- show_hidden->set_theme_type_variation("FlatButton");
- show_hidden->set_toggle_mode(true);
- show_hidden->set_pressed(is_showing_hidden_files());
- show_hidden->set_tooltip_text(ETR("Toggle the visibility of hidden files."));
- show_hidden->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::set_show_hidden_files));
- hbc->add_child(show_hidden);
- show_filename_filter_button = memnew(Button);
- show_filename_filter_button->set_theme_type_variation("FlatButton");
- show_filename_filter_button->set_toggle_mode(true);
- show_filename_filter_button->set_pressed(false);
- show_filename_filter_button->set_tooltip_text(RTR("Toggle the visibility of the filter for file names."));
- show_filename_filter_button->connect(SceneStringName(toggled), callable_mp(this, &FileDialog::set_show_filename_filter));
- hbc->add_child(show_filename_filter_button);
- shortcuts_container = memnew(HBoxContainer);
- hbc->add_child(shortcuts_container);
- makedir = memnew(Button);
- makedir->set_theme_type_variation("FlatButton");
- makedir->set_tooltip_text(ETR("Create a new folder."));
- makedir->connect(SceneStringName(pressed), callable_mp(this, &FileDialog::_make_dir));
- hbc->add_child(makedir);
- vbox->add_child(hbc);
- tree = memnew(Tree);
- tree->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
- tree->set_hide_root(true);
- vbox->add_margin_child(ETR("Directories & Files:"), tree, true);
- message = memnew(Label);
- message->hide();
- message->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
- message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
- message->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
- tree->add_child(message);
- filename_filter_box = memnew(HBoxContainer);
- filename_filter_box->add_child(memnew(Label(RTR("Filter:"))));
- filename_filter = memnew(LineEdit);
- filename_filter->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
- filename_filter->set_stretch_ratio(4);
- filename_filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- filename_filter->set_clear_button_enabled(true);
- filename_filter_box->add_child(filename_filter);
- filename_filter_box->set_visible(false);
- vbox->add_child(filename_filter_box);
- file_box = memnew(HBoxContainer);
- file_box->add_child(memnew(Label(ETR("File:"))));
- file = memnew(LineEdit);
- file->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
- file->set_stretch_ratio(4);
- file->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- file_box->add_child(file);
- filter = memnew(OptionButton);
- filter->set_stretch_ratio(3);
- filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- filter->set_clip_text(true); // too many extensions overflows it
- file_box->add_child(filter);
- vbox->add_child(file_box);
- grid_options = memnew(GridContainer);
- grid_options->set_h_size_flags(Control::SIZE_SHRINK_CENTER);
- grid_options->set_columns(2);
- vbox->add_child(grid_options);
- dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- _update_drives();
- connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_action_pressed));
- tree->connect("multi_selected", callable_mp(this, &FileDialog::_tree_multi_selected), CONNECT_DEFERRED);
- tree->connect("cell_selected", callable_mp(this, &FileDialog::_tree_selected), CONNECT_DEFERRED);
- tree->connect("item_activated", callable_mp(this, &FileDialog::_tree_item_activated));
- tree->connect("nothing_selected", callable_mp(this, &FileDialog::deselect_all));
- dir->connect("text_submitted", callable_mp(this, &FileDialog::_dir_submitted));
- filename_filter->connect(SceneStringName(text_changed), callable_mp(this, &FileDialog::_filename_filter_changed).unbind(1));
- filename_filter->connect("text_submitted", callable_mp(this, &FileDialog::_filename_filter_selected).unbind(1));
- file->connect("text_submitted", callable_mp(this, &FileDialog::_file_submitted));
- filter->connect(SceneStringName(item_selected), callable_mp(this, &FileDialog::_filter_selected));
- confirm_save = memnew(ConfirmationDialog);
- add_child(confirm_save, false, INTERNAL_MODE_FRONT);
- confirm_save->connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_save_confirm_pressed));
- makedialog = memnew(ConfirmationDialog);
- makedialog->set_title(ETR("Create Folder"));
- VBoxContainer *makevb = memnew(VBoxContainer);
- makedialog->add_child(makevb);
- makedirname = memnew(LineEdit);
- makedirname->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
- makevb->add_margin_child(ETR("Name:"), makedirname);
- add_child(makedialog, false, INTERNAL_MODE_FRONT);
- makedialog->register_text_enter(makedirname);
- makedialog->connect(SceneStringName(confirmed), callable_mp(this, &FileDialog::_make_dir_confirm));
- mkdirerr = memnew(AcceptDialog);
- mkdirerr->set_text(ETR("Could not create folder."));
- add_child(mkdirerr, false, INTERNAL_MODE_FRONT);
- exterr = memnew(AcceptDialog);
- exterr->set_text(ETR("Invalid extension, or empty filename."));
- add_child(exterr, false, INTERNAL_MODE_FRONT);
- update_filters();
- update_filename_filter_gui();
- update_dir();
- set_hide_on_ok(false);
- set_size(Size2(640, 360));
- if (register_func) {
- register_func(this);
- }
- property_helper.setup_for_instance(base_property_helper, this);
- }
- FileDialog::~FileDialog() {
- if (unregister_func) {
- unregister_func(this);
- }
- }
|