file_dialog.cpp 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010
  1. /*************************************************************************/
  2. /* file_dialog.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "file_dialog.h"
  31. #include "core/os/keyboard.h"
  32. #include "core/print_string.h"
  33. #include "scene/gui/label.h"
  34. FileDialog::GetIconFunc FileDialog::get_icon_func = nullptr;
  35. FileDialog::GetIconFunc FileDialog::get_large_icon_func = nullptr;
  36. FileDialog::RegisterFunc FileDialog::register_func = nullptr;
  37. FileDialog::RegisterFunc FileDialog::unregister_func = nullptr;
  38. VBoxContainer *FileDialog::get_vbox() {
  39. return vbox;
  40. }
  41. void FileDialog::_notification(int p_what) {
  42. if (p_what == NOTIFICATION_ENTER_TREE || p_what == NOTIFICATION_THEME_CHANGED) {
  43. if (p_what == NOTIFICATION_ENTER_TREE) {
  44. dir_up->set_icon(get_icon("parent_folder"));
  45. refresh->set_icon(get_icon("reload"));
  46. show_hidden->set_icon(get_icon("toggle_hidden"));
  47. }
  48. Color font_color = get_color("font_color", "ToolButton");
  49. Color font_color_hover = get_color("font_color_hover", "ToolButton");
  50. Color font_color_focus = get_color("font_color_focus", "ToolButton");
  51. Color font_color_pressed = get_color("font_color_pressed", "ToolButton");
  52. dir_up->add_color_override("icon_color_normal", font_color);
  53. dir_up->add_color_override("icon_color_hover", font_color_hover);
  54. dir_up->add_color_override("font_color_focus", font_color_focus);
  55. dir_up->add_color_override("icon_color_pressed", font_color_pressed);
  56. refresh->add_color_override("icon_color_normal", font_color);
  57. refresh->add_color_override("icon_color_hover", font_color_hover);
  58. refresh->add_color_override("font_color_focus", font_color_focus);
  59. refresh->add_color_override("icon_color_pressed", font_color_pressed);
  60. show_hidden->add_color_override("icon_color_normal", font_color);
  61. show_hidden->add_color_override("icon_color_hover", font_color_hover);
  62. show_hidden->add_color_override("font_color_focus", font_color_focus);
  63. show_hidden->add_color_override("icon_color_pressed", font_color_pressed);
  64. } else if (p_what == NOTIFICATION_POPUP_HIDE) {
  65. set_process_unhandled_input(false);
  66. }
  67. }
  68. void FileDialog::_unhandled_input(const Ref<InputEvent> &p_event) {
  69. Ref<InputEventKey> k = p_event;
  70. if (k.is_valid() && is_window_modal_on_top()) {
  71. if (k->is_pressed()) {
  72. bool handled = true;
  73. switch (k->get_scancode()) {
  74. case KEY_H: {
  75. if (k->get_command()) {
  76. set_show_hidden_files(!show_hidden_files);
  77. } else {
  78. handled = false;
  79. }
  80. } break;
  81. case KEY_F5: {
  82. invalidate();
  83. } break;
  84. case KEY_BACKSPACE: {
  85. _dir_entered("..");
  86. } break;
  87. default: {
  88. handled = false;
  89. }
  90. }
  91. if (handled) {
  92. accept_event();
  93. }
  94. }
  95. }
  96. }
  97. void FileDialog::set_enable_multiple_selection(bool p_enable) {
  98. tree->set_select_mode(p_enable ? Tree::SELECT_MULTI : Tree::SELECT_SINGLE);
  99. };
  100. Vector<String> FileDialog::get_selected_files() const {
  101. Vector<String> list;
  102. TreeItem *item = tree->get_root();
  103. while ((item = tree->get_next_selected(item))) {
  104. list.push_back(dir_access->get_current_dir().plus_file(item->get_text(0)));
  105. };
  106. return list;
  107. };
  108. void FileDialog::update_dir() {
  109. dir->set_text(dir_access->get_current_dir_without_drive());
  110. if (drives->is_visible()) {
  111. drives->select(dir_access->get_current_drive());
  112. }
  113. // Deselect any item, to make "Select Current Folder" button text by default.
  114. deselect_items();
  115. }
  116. void FileDialog::_dir_entered(String p_dir) {
  117. dir_access->change_dir(p_dir);
  118. file->set_text("");
  119. invalidate();
  120. update_dir();
  121. }
  122. void FileDialog::_file_entered(const String &p_file) {
  123. _action_pressed();
  124. }
  125. void FileDialog::_save_confirm_pressed() {
  126. String f = dir_access->get_current_dir().plus_file(file->get_text());
  127. emit_signal("file_selected", f);
  128. hide();
  129. }
  130. void FileDialog::_post_popup() {
  131. ConfirmationDialog::_post_popup();
  132. if (invalidated) {
  133. update_file_list();
  134. invalidated = false;
  135. }
  136. if (mode == MODE_SAVE_FILE) {
  137. file->grab_focus();
  138. } else {
  139. tree->grab_focus();
  140. }
  141. set_process_unhandled_input(true);
  142. // For open dir mode, deselect all items on file dialog open.
  143. if (mode == MODE_OPEN_DIR) {
  144. deselect_items();
  145. file_box->set_visible(false);
  146. } else {
  147. file_box->set_visible(true);
  148. }
  149. }
  150. void FileDialog::_action_pressed() {
  151. if (mode == MODE_OPEN_FILES) {
  152. TreeItem *ti = tree->get_next_selected(nullptr);
  153. String fbase = dir_access->get_current_dir();
  154. PoolVector<String> files;
  155. while (ti) {
  156. files.push_back(fbase.plus_file(ti->get_text(0)));
  157. ti = tree->get_next_selected(ti);
  158. }
  159. if (files.size()) {
  160. emit_signal("files_selected", files);
  161. hide();
  162. }
  163. return;
  164. }
  165. String f = dir_access->get_current_dir().plus_file(file->get_text());
  166. if ((mode == MODE_OPEN_ANY || mode == MODE_OPEN_FILE) && dir_access->file_exists(f)) {
  167. emit_signal("file_selected", f);
  168. hide();
  169. } else if (mode == MODE_OPEN_ANY || mode == MODE_OPEN_DIR) {
  170. String path = dir_access->get_current_dir();
  171. path = path.replace("\\", "/");
  172. TreeItem *item = tree->get_selected();
  173. if (item) {
  174. Dictionary d = item->get_metadata(0);
  175. if (d["dir"] && d["name"] != "..") {
  176. path = path.plus_file(d["name"]);
  177. }
  178. }
  179. emit_signal("dir_selected", path);
  180. hide();
  181. }
  182. if (mode == MODE_SAVE_FILE) {
  183. bool valid = false;
  184. if (filter->get_selected() == filter->get_item_count() - 1) {
  185. valid = true; // match none
  186. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  187. // match all filters
  188. for (int i = 0; i < filters.size(); i++) {
  189. String flt = filters[i].get_slice(";", 0);
  190. for (int j = 0; j < flt.get_slice_count(","); j++) {
  191. String str = flt.get_slice(",", j).strip_edges();
  192. if (f.match(str)) {
  193. valid = true;
  194. break;
  195. }
  196. }
  197. if (valid) {
  198. break;
  199. }
  200. }
  201. } else {
  202. int idx = filter->get_selected();
  203. if (filters.size() > 1) {
  204. idx--;
  205. }
  206. if (idx >= 0 && idx < filters.size()) {
  207. String flt = filters[idx].get_slice(";", 0);
  208. int filterSliceCount = flt.get_slice_count(",");
  209. for (int j = 0; j < filterSliceCount; j++) {
  210. String str = (flt.get_slice(",", j).strip_edges());
  211. if (f.match(str)) {
  212. valid = true;
  213. break;
  214. }
  215. }
  216. if (!valid && filterSliceCount > 0) {
  217. String str = (flt.get_slice(",", 0).strip_edges());
  218. f += str.substr(1, str.length() - 1);
  219. file->set_text(f.get_file());
  220. valid = true;
  221. }
  222. } else {
  223. valid = true;
  224. }
  225. }
  226. if (!valid) {
  227. exterr->popup_centered_minsize(Size2(250, 80));
  228. return;
  229. }
  230. if (dir_access->file_exists(f)) {
  231. confirm_save->set_text(RTR("File exists, overwrite?"));
  232. confirm_save->popup_centered(Size2(200, 80));
  233. } else {
  234. emit_signal("file_selected", f);
  235. hide();
  236. }
  237. }
  238. }
  239. void FileDialog::_cancel_pressed() {
  240. file->set_text("");
  241. invalidate();
  242. hide();
  243. }
  244. bool FileDialog::_is_open_should_be_disabled() {
  245. if (mode == MODE_OPEN_ANY || mode == MODE_SAVE_FILE) {
  246. return false;
  247. }
  248. TreeItem *ti = tree->get_next_selected(tree->get_root());
  249. while (ti) {
  250. TreeItem *prev_ti = ti;
  251. ti = tree->get_next_selected(tree->get_root());
  252. if (ti == prev_ti) {
  253. break;
  254. }
  255. }
  256. // We have something that we can't select?
  257. if (!ti) {
  258. return mode != MODE_OPEN_DIR; // In "Open folder" mode, having nothing selected picks the current folder.
  259. }
  260. Dictionary d = ti->get_metadata(0);
  261. // Opening a file, but selected a folder? Forbidden.
  262. return ((mode == MODE_OPEN_FILE || mode == MODE_OPEN_FILES) && d["dir"]) || // Flipped case, also forbidden.
  263. (mode == MODE_OPEN_DIR && !d["dir"]);
  264. }
  265. void FileDialog::_go_up() {
  266. dir_access->change_dir("..");
  267. update_file_list();
  268. update_dir();
  269. }
  270. void FileDialog::deselect_items() {
  271. // Clear currently selected items in file manager.
  272. tree->deselect_all();
  273. // And change get_ok title.
  274. if (!tree->is_anything_selected()) {
  275. get_ok()->set_disabled(_is_open_should_be_disabled());
  276. switch (mode) {
  277. case MODE_OPEN_FILE:
  278. case MODE_OPEN_FILES:
  279. get_ok()->set_text(RTR("Open"));
  280. break;
  281. case MODE_OPEN_DIR:
  282. get_ok()->set_text(RTR("Select Current Folder"));
  283. break;
  284. case MODE_OPEN_ANY:
  285. case MODE_SAVE_FILE:
  286. // FIXME: Implement, or refactor to avoid duplication with set_mode
  287. break;
  288. }
  289. }
  290. }
  291. void FileDialog::_tree_multi_selected(Object *p_object, int p_cell, bool p_selected) {
  292. _tree_selected();
  293. }
  294. void FileDialog::_tree_selected() {
  295. TreeItem *ti = tree->get_selected();
  296. if (!ti) {
  297. return;
  298. }
  299. Dictionary d = ti->get_metadata(0);
  300. if (!d["dir"]) {
  301. file->set_text(d["name"]);
  302. } else if (mode == MODE_OPEN_DIR) {
  303. get_ok()->set_text(RTR("Select This Folder"));
  304. }
  305. get_ok()->set_disabled(_is_open_should_be_disabled());
  306. }
  307. void FileDialog::_tree_item_activated() {
  308. TreeItem *ti = tree->get_selected();
  309. if (!ti) {
  310. return;
  311. }
  312. Dictionary d = ti->get_metadata(0);
  313. if (d["dir"]) {
  314. dir_access->change_dir(d["name"]);
  315. if (mode == MODE_OPEN_FILE || mode == MODE_OPEN_FILES || mode == MODE_OPEN_DIR || mode == MODE_OPEN_ANY) {
  316. file->set_text("");
  317. }
  318. call_deferred("_update_file_list");
  319. call_deferred("_update_dir");
  320. } else {
  321. _action_pressed();
  322. }
  323. }
  324. void FileDialog::update_file_name() {
  325. int idx = filter->get_selected() - 1;
  326. if ((idx == -1 && filter->get_item_count() == 2) || (filter->get_item_count() > 2 && idx >= 0 && idx < filter->get_item_count() - 2)) {
  327. if (idx == -1) {
  328. idx += 1;
  329. }
  330. String filter_str = filters[idx];
  331. String file_str = file->get_text();
  332. String base_name = file_str.get_basename();
  333. file_str = base_name + "." + filter_str.strip_edges().to_lower();
  334. file->set_text(file_str);
  335. }
  336. }
  337. void FileDialog::update_file_list() {
  338. tree->clear();
  339. // Scroll back to the top after opening a directory
  340. tree->get_vscroll_bar()->set_value(0);
  341. dir_access->list_dir_begin();
  342. TreeItem *root = tree->create_item();
  343. Ref<Texture> folder = get_icon("folder");
  344. Ref<Texture> file_icon = get_icon("file");
  345. const Color folder_color = get_color("folder_icon_modulate");
  346. const Color file_color = get_color("file_icon_modulate");
  347. List<String> files;
  348. List<String> dirs;
  349. bool is_hidden;
  350. String item;
  351. while ((item = dir_access->get_next()) != "") {
  352. if (item == "." || item == "..") {
  353. continue;
  354. }
  355. is_hidden = dir_access->current_is_hidden();
  356. if (show_hidden_files || !is_hidden) {
  357. if (!dir_access->current_is_dir()) {
  358. files.push_back(item);
  359. } else {
  360. dirs.push_back(item);
  361. }
  362. }
  363. }
  364. dirs.sort_custom<NaturalNoCaseComparator>();
  365. files.sort_custom<NaturalNoCaseComparator>();
  366. while (!dirs.empty()) {
  367. String &dir_name = dirs.front()->get();
  368. TreeItem *ti = tree->create_item(root);
  369. ti->set_text(0, dir_name);
  370. ti->set_icon(0, folder);
  371. ti->set_icon_modulate(0, folder_color);
  372. Dictionary d;
  373. d["name"] = dir_name;
  374. d["dir"] = true;
  375. ti->set_metadata(0, d);
  376. dirs.pop_front();
  377. }
  378. List<String> patterns;
  379. // build filter
  380. if (filter->get_selected() == filter->get_item_count() - 1) {
  381. // match all
  382. } else if (filters.size() > 1 && filter->get_selected() == 0) {
  383. // match all filters
  384. for (int i = 0; i < filters.size(); i++) {
  385. String f = filters[i].get_slice(";", 0);
  386. for (int j = 0; j < f.get_slice_count(","); j++) {
  387. patterns.push_back(f.get_slice(",", j).strip_edges());
  388. }
  389. }
  390. } else {
  391. int idx = filter->get_selected();
  392. if (filters.size() > 1) {
  393. idx--;
  394. }
  395. if (idx >= 0 && idx < filters.size()) {
  396. String f = filters[idx].get_slice(";", 0);
  397. for (int j = 0; j < f.get_slice_count(","); j++) {
  398. patterns.push_back(f.get_slice(",", j).strip_edges());
  399. }
  400. }
  401. }
  402. String base_dir = dir_access->get_current_dir();
  403. while (!files.empty()) {
  404. bool match = patterns.empty();
  405. String match_str;
  406. for (List<String>::Element *E = patterns.front(); E; E = E->next()) {
  407. if (files.front()->get().matchn(E->get())) {
  408. match_str = E->get();
  409. match = true;
  410. break;
  411. }
  412. }
  413. if (match) {
  414. TreeItem *ti = tree->create_item(root);
  415. ti->set_text(0, files.front()->get());
  416. if (get_icon_func) {
  417. Ref<Texture> icon = get_icon_func(base_dir.plus_file(files.front()->get()));
  418. ti->set_icon(0, icon);
  419. } else {
  420. ti->set_icon(0, file_icon);
  421. }
  422. ti->set_icon_modulate(0, file_color);
  423. if (mode == MODE_OPEN_DIR) {
  424. ti->set_custom_color(0, get_color("files_disabled"));
  425. ti->set_selectable(0, false);
  426. }
  427. Dictionary d;
  428. d["name"] = files.front()->get();
  429. d["dir"] = false;
  430. ti->set_metadata(0, d);
  431. if (file->get_text() == files.front()->get() || match_str == files.front()->get()) {
  432. ti->select(0);
  433. }
  434. }
  435. files.pop_front();
  436. }
  437. if (tree->get_root() && tree->get_root()->get_children() && tree->get_selected() == nullptr) {
  438. tree->get_root()->get_children()->select(0);
  439. }
  440. }
  441. void FileDialog::_filter_selected(int) {
  442. update_file_name();
  443. update_file_list();
  444. }
  445. void FileDialog::update_filters() {
  446. filter->clear();
  447. if (filters.size() > 1) {
  448. String all_filters;
  449. const int max_filters = 5;
  450. for (int i = 0; i < MIN(max_filters, filters.size()); i++) {
  451. String flt = filters[i].get_slice(";", 0).strip_edges();
  452. if (i > 0) {
  453. all_filters += ", ";
  454. }
  455. all_filters += flt;
  456. }
  457. if (max_filters < filters.size()) {
  458. all_filters += ", ...";
  459. }
  460. filter->add_item(RTR("All Recognized") + " (" + all_filters + ")");
  461. }
  462. for (int i = 0; i < filters.size(); i++) {
  463. String flt = filters[i].get_slice(";", 0).strip_edges();
  464. String desc = filters[i].get_slice(";", 1).strip_edges();
  465. if (desc.length()) {
  466. filter->add_item(String(tr(desc)) + " (" + flt + ")");
  467. } else {
  468. filter->add_item("(" + flt + ")");
  469. }
  470. }
  471. filter->add_item(RTR("All Files (*)"));
  472. }
  473. void FileDialog::clear_filters() {
  474. filters.clear();
  475. update_filters();
  476. invalidate();
  477. }
  478. void FileDialog::add_filter(const String &p_filter) {
  479. filters.push_back(p_filter);
  480. update_filters();
  481. invalidate();
  482. }
  483. void FileDialog::set_filters(const Vector<String> &p_filters) {
  484. filters = p_filters;
  485. update_filters();
  486. invalidate();
  487. }
  488. Vector<String> FileDialog::get_filters() const {
  489. return filters;
  490. }
  491. String FileDialog::get_current_dir() const {
  492. return dir->get_text();
  493. }
  494. String FileDialog::get_current_file() const {
  495. return file->get_text();
  496. }
  497. String FileDialog::get_current_path() const {
  498. return dir->get_text().plus_file(file->get_text());
  499. }
  500. void FileDialog::set_current_dir(const String &p_dir) {
  501. dir_access->change_dir(p_dir);
  502. update_dir();
  503. invalidate();
  504. }
  505. void FileDialog::set_current_file(const String &p_file) {
  506. file->set_text(p_file);
  507. update_dir();
  508. invalidate();
  509. int lp = p_file.find_last(".");
  510. if (lp != -1) {
  511. file->select(0, lp);
  512. if (file->is_inside_tree() && !get_tree()->is_node_being_edited(file)) {
  513. file->grab_focus();
  514. }
  515. }
  516. }
  517. void FileDialog::set_current_path(const String &p_path) {
  518. if (!p_path.size()) {
  519. return;
  520. }
  521. int pos = MAX(p_path.find_last("/"), p_path.find_last("\\"));
  522. if (pos == -1) {
  523. set_current_file(p_path);
  524. } else {
  525. String dir = p_path.substr(0, pos);
  526. String file = p_path.substr(pos + 1, p_path.length());
  527. set_current_dir(dir);
  528. set_current_file(file);
  529. }
  530. }
  531. void FileDialog::set_mode_overrides_title(bool p_override) {
  532. mode_overrides_title = p_override;
  533. }
  534. bool FileDialog::is_mode_overriding_title() const {
  535. return mode_overrides_title;
  536. }
  537. void FileDialog::set_mode(Mode p_mode) {
  538. ERR_FAIL_INDEX((int)p_mode, 5);
  539. mode = p_mode;
  540. switch (mode) {
  541. case MODE_OPEN_FILE:
  542. get_ok()->set_text(RTR("Open"));
  543. if (mode_overrides_title) {
  544. set_title(RTR("Open a File"));
  545. }
  546. makedir->hide();
  547. break;
  548. case MODE_OPEN_FILES:
  549. get_ok()->set_text(RTR("Open"));
  550. if (mode_overrides_title) {
  551. set_title(RTR("Open File(s)"));
  552. }
  553. makedir->hide();
  554. break;
  555. case MODE_OPEN_DIR:
  556. get_ok()->set_text(RTR("Select Current Folder"));
  557. if (mode_overrides_title) {
  558. set_title(RTR("Open a Directory"));
  559. }
  560. makedir->show();
  561. break;
  562. case MODE_OPEN_ANY:
  563. get_ok()->set_text(RTR("Open"));
  564. if (mode_overrides_title) {
  565. set_title(RTR("Open a File or Directory"));
  566. }
  567. makedir->show();
  568. break;
  569. case MODE_SAVE_FILE:
  570. get_ok()->set_text(RTR("Save"));
  571. if (mode_overrides_title) {
  572. set_title(RTR("Save a File"));
  573. }
  574. makedir->show();
  575. break;
  576. }
  577. if (mode == MODE_OPEN_FILES) {
  578. tree->set_select_mode(Tree::SELECT_MULTI);
  579. } else {
  580. tree->set_select_mode(Tree::SELECT_SINGLE);
  581. }
  582. }
  583. FileDialog::Mode FileDialog::get_mode() const {
  584. return mode;
  585. }
  586. void FileDialog::set_access(Access p_access) {
  587. ERR_FAIL_INDEX(p_access, 3);
  588. if (access == p_access) {
  589. return;
  590. }
  591. memdelete(dir_access);
  592. switch (p_access) {
  593. case ACCESS_FILESYSTEM: {
  594. dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  595. } break;
  596. case ACCESS_RESOURCES: {
  597. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  598. } break;
  599. case ACCESS_USERDATA: {
  600. dir_access = DirAccess::create(DirAccess::ACCESS_USERDATA);
  601. } break;
  602. }
  603. access = p_access;
  604. _update_drives();
  605. invalidate();
  606. update_filters();
  607. update_dir();
  608. }
  609. void FileDialog::invalidate() {
  610. if (is_visible_in_tree()) {
  611. update_file_list();
  612. invalidated = false;
  613. } else {
  614. invalidated = true;
  615. }
  616. }
  617. FileDialog::Access FileDialog::get_access() const {
  618. return access;
  619. }
  620. void FileDialog::_make_dir_confirm() {
  621. Error err = dir_access->make_dir(makedirname->get_text().strip_edges());
  622. if (err == OK) {
  623. dir_access->change_dir(makedirname->get_text().strip_edges());
  624. invalidate();
  625. update_filters();
  626. update_dir();
  627. } else {
  628. mkdirerr->popup_centered_minsize(Size2(250, 50));
  629. }
  630. makedirname->set_text(""); // reset label
  631. }
  632. void FileDialog::_make_dir() {
  633. makedialog->popup_centered_minsize(Size2(250, 80));
  634. makedirname->grab_focus();
  635. }
  636. void FileDialog::_select_drive(int p_idx) {
  637. String d = drives->get_item_text(p_idx);
  638. dir_access->change_dir(d);
  639. file->set_text("");
  640. invalidate();
  641. update_dir();
  642. }
  643. void FileDialog::_update_drives() {
  644. int dc = dir_access->get_drive_count();
  645. if (dc == 0 || access != ACCESS_FILESYSTEM) {
  646. drives->hide();
  647. } else {
  648. drives->clear();
  649. Node *dp = drives->get_parent();
  650. if (dp) {
  651. dp->remove_child(drives);
  652. }
  653. dp = dir_access->drives_are_shortcuts() ? shortcuts_container : drives_container;
  654. dp->add_child(drives);
  655. drives->show();
  656. for (int i = 0; i < dir_access->get_drive_count(); i++) {
  657. drives->add_item(dir_access->get_drive(i));
  658. }
  659. drives->select(dir_access->get_current_drive());
  660. }
  661. }
  662. bool FileDialog::default_show_hidden_files = false;
  663. void FileDialog::_bind_methods() {
  664. ClassDB::bind_method(D_METHOD("_unhandled_input"), &FileDialog::_unhandled_input);
  665. ClassDB::bind_method(D_METHOD("_tree_multi_selected"), &FileDialog::_tree_multi_selected);
  666. ClassDB::bind_method(D_METHOD("_tree_selected"), &FileDialog::_tree_selected);
  667. ClassDB::bind_method(D_METHOD("_tree_item_activated"), &FileDialog::_tree_item_activated);
  668. ClassDB::bind_method(D_METHOD("_dir_entered"), &FileDialog::_dir_entered);
  669. ClassDB::bind_method(D_METHOD("_file_entered"), &FileDialog::_file_entered);
  670. ClassDB::bind_method(D_METHOD("_action_pressed"), &FileDialog::_action_pressed);
  671. ClassDB::bind_method(D_METHOD("_cancel_pressed"), &FileDialog::_cancel_pressed);
  672. ClassDB::bind_method(D_METHOD("_filter_selected"), &FileDialog::_filter_selected);
  673. ClassDB::bind_method(D_METHOD("_save_confirm_pressed"), &FileDialog::_save_confirm_pressed);
  674. ClassDB::bind_method(D_METHOD("clear_filters"), &FileDialog::clear_filters);
  675. ClassDB::bind_method(D_METHOD("add_filter", "filter"), &FileDialog::add_filter);
  676. ClassDB::bind_method(D_METHOD("set_filters", "filters"), &FileDialog::set_filters);
  677. ClassDB::bind_method(D_METHOD("get_filters"), &FileDialog::get_filters);
  678. ClassDB::bind_method(D_METHOD("get_current_dir"), &FileDialog::get_current_dir);
  679. ClassDB::bind_method(D_METHOD("get_current_file"), &FileDialog::get_current_file);
  680. ClassDB::bind_method(D_METHOD("get_current_path"), &FileDialog::get_current_path);
  681. ClassDB::bind_method(D_METHOD("set_current_dir", "dir"), &FileDialog::set_current_dir);
  682. ClassDB::bind_method(D_METHOD("set_current_file", "file"), &FileDialog::set_current_file);
  683. ClassDB::bind_method(D_METHOD("set_current_path", "path"), &FileDialog::set_current_path);
  684. ClassDB::bind_method(D_METHOD("set_mode_overrides_title", "override"), &FileDialog::set_mode_overrides_title);
  685. ClassDB::bind_method(D_METHOD("is_mode_overriding_title"), &FileDialog::is_mode_overriding_title);
  686. ClassDB::bind_method(D_METHOD("set_mode", "mode"), &FileDialog::set_mode);
  687. ClassDB::bind_method(D_METHOD("get_mode"), &FileDialog::get_mode);
  688. ClassDB::bind_method(D_METHOD("get_vbox"), &FileDialog::get_vbox);
  689. ClassDB::bind_method(D_METHOD("get_line_edit"), &FileDialog::get_line_edit);
  690. ClassDB::bind_method(D_METHOD("set_access", "access"), &FileDialog::set_access);
  691. ClassDB::bind_method(D_METHOD("get_access"), &FileDialog::get_access);
  692. ClassDB::bind_method(D_METHOD("set_show_hidden_files", "show"), &FileDialog::set_show_hidden_files);
  693. ClassDB::bind_method(D_METHOD("is_showing_hidden_files"), &FileDialog::is_showing_hidden_files);
  694. ClassDB::bind_method(D_METHOD("_select_drive"), &FileDialog::_select_drive);
  695. ClassDB::bind_method(D_METHOD("_make_dir"), &FileDialog::_make_dir);
  696. ClassDB::bind_method(D_METHOD("_make_dir_confirm"), &FileDialog::_make_dir_confirm);
  697. ClassDB::bind_method(D_METHOD("_update_file_name"), &FileDialog::update_file_name);
  698. ClassDB::bind_method(D_METHOD("_update_file_list"), &FileDialog::update_file_list);
  699. ClassDB::bind_method(D_METHOD("_update_dir"), &FileDialog::update_dir);
  700. ClassDB::bind_method(D_METHOD("_go_up"), &FileDialog::_go_up);
  701. ClassDB::bind_method(D_METHOD("deselect_items"), &FileDialog::deselect_items);
  702. ClassDB::bind_method(D_METHOD("invalidate"), &FileDialog::invalidate);
  703. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "mode_overrides_title"), "set_mode_overrides_title", "is_mode_overriding_title");
  704. ADD_PROPERTY(PropertyInfo(Variant::INT, "mode", PROPERTY_HINT_ENUM, "Open File,Open Files,Open Folder,Open Any,Save"), "set_mode", "get_mode");
  705. ADD_PROPERTY(PropertyInfo(Variant::INT, "access", PROPERTY_HINT_ENUM, "Resources,User data,File system"), "set_access", "get_access");
  706. ADD_PROPERTY(PropertyInfo(Variant::POOL_STRING_ARRAY, "filters"), "set_filters", "get_filters");
  707. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "show_hidden_files"), "set_show_hidden_files", "is_showing_hidden_files");
  708. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_dir"), "set_current_dir", "get_current_dir");
  709. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_file"), "set_current_file", "get_current_file");
  710. ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_path"), "set_current_path", "get_current_path");
  711. ADD_SIGNAL(MethodInfo("file_selected", PropertyInfo(Variant::STRING, "path")));
  712. ADD_SIGNAL(MethodInfo("files_selected", PropertyInfo(Variant::POOL_STRING_ARRAY, "paths")));
  713. ADD_SIGNAL(MethodInfo("dir_selected", PropertyInfo(Variant::STRING, "dir")));
  714. BIND_ENUM_CONSTANT(MODE_OPEN_FILE);
  715. BIND_ENUM_CONSTANT(MODE_OPEN_FILES);
  716. BIND_ENUM_CONSTANT(MODE_OPEN_DIR);
  717. BIND_ENUM_CONSTANT(MODE_OPEN_ANY);
  718. BIND_ENUM_CONSTANT(MODE_SAVE_FILE);
  719. BIND_ENUM_CONSTANT(ACCESS_RESOURCES);
  720. BIND_ENUM_CONSTANT(ACCESS_USERDATA);
  721. BIND_ENUM_CONSTANT(ACCESS_FILESYSTEM);
  722. }
  723. void FileDialog::set_show_hidden_files(bool p_show) {
  724. show_hidden_files = p_show;
  725. invalidate();
  726. }
  727. bool FileDialog::is_showing_hidden_files() const {
  728. return show_hidden_files;
  729. }
  730. void FileDialog::set_default_show_hidden_files(bool p_show) {
  731. default_show_hidden_files = p_show;
  732. }
  733. FileDialog::FileDialog() {
  734. show_hidden_files = default_show_hidden_files;
  735. mode_overrides_title = true;
  736. VBoxContainer *vbc = memnew(VBoxContainer);
  737. add_child(vbc);
  738. mode = MODE_SAVE_FILE;
  739. set_title(RTR("Save a File"));
  740. HBoxContainer *hbc = memnew(HBoxContainer);
  741. dir_up = memnew(ToolButton);
  742. dir_up->set_tooltip(RTR("Go to parent folder."));
  743. hbc->add_child(dir_up);
  744. dir_up->connect("pressed", this, "_go_up");
  745. hbc->add_child(memnew(Label(RTR("Path:"))));
  746. drives_container = memnew(HBoxContainer);
  747. hbc->add_child(drives_container);
  748. drives = memnew(OptionButton);
  749. drives->connect("item_selected", this, "_select_drive");
  750. hbc->add_child(drives);
  751. dir = memnew(LineEdit);
  752. hbc->add_child(dir);
  753. dir->set_h_size_flags(SIZE_EXPAND_FILL);
  754. refresh = memnew(ToolButton);
  755. refresh->set_tooltip(RTR("Refresh files."));
  756. refresh->connect("pressed", this, "_update_file_list");
  757. hbc->add_child(refresh);
  758. show_hidden = memnew(ToolButton);
  759. show_hidden->set_toggle_mode(true);
  760. show_hidden->set_pressed(is_showing_hidden_files());
  761. show_hidden->set_tooltip(RTR("Toggle the visibility of hidden files."));
  762. show_hidden->connect("toggled", this, "set_show_hidden_files");
  763. hbc->add_child(show_hidden);
  764. shortcuts_container = memnew(HBoxContainer);
  765. hbc->add_child(shortcuts_container);
  766. makedir = memnew(Button);
  767. makedir->set_text(RTR("Create Folder"));
  768. makedir->connect("pressed", this, "_make_dir");
  769. hbc->add_child(makedir);
  770. vbc->add_child(hbc);
  771. tree = memnew(Tree);
  772. tree->set_hide_root(true);
  773. vbc->add_margin_child(RTR("Directories & Files:"), tree, true);
  774. file_box = memnew(HBoxContainer);
  775. file_box->add_child(memnew(Label(RTR("File:"))));
  776. file = memnew(LineEdit);
  777. file->set_stretch_ratio(4);
  778. file->set_h_size_flags(SIZE_EXPAND_FILL);
  779. file_box->add_child(file);
  780. filter = memnew(OptionButton);
  781. filter->set_stretch_ratio(3);
  782. filter->set_h_size_flags(SIZE_EXPAND_FILL);
  783. filter->set_clip_text(true); // too many extensions overflows it
  784. file_box->add_child(filter);
  785. vbc->add_child(file_box);
  786. dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  787. access = ACCESS_RESOURCES;
  788. _update_drives();
  789. connect("confirmed", this, "_action_pressed");
  790. tree->connect("multi_selected", this, "_tree_multi_selected", varray(), CONNECT_DEFERRED);
  791. tree->connect("cell_selected", this, "_tree_selected", varray(), CONNECT_DEFERRED);
  792. tree->connect("item_activated", this, "_tree_item_activated", varray());
  793. tree->connect("nothing_selected", this, "deselect_items");
  794. dir->connect("text_entered", this, "_dir_entered");
  795. file->connect("text_entered", this, "_file_entered");
  796. filter->connect("item_selected", this, "_filter_selected");
  797. confirm_save = memnew(ConfirmationDialog);
  798. confirm_save->set_as_toplevel(true);
  799. add_child(confirm_save);
  800. confirm_save->connect("confirmed", this, "_save_confirm_pressed");
  801. makedialog = memnew(ConfirmationDialog);
  802. makedialog->set_title(RTR("Create Folder"));
  803. VBoxContainer *makevb = memnew(VBoxContainer);
  804. makedialog->add_child(makevb);
  805. makedirname = memnew(LineEdit);
  806. makevb->add_margin_child(RTR("Name:"), makedirname);
  807. add_child(makedialog);
  808. makedialog->register_text_enter(makedirname);
  809. makedialog->connect("confirmed", this, "_make_dir_confirm");
  810. mkdirerr = memnew(AcceptDialog);
  811. mkdirerr->set_text(RTR("Could not create folder."));
  812. add_child(mkdirerr);
  813. exterr = memnew(AcceptDialog);
  814. exterr->set_text(RTR("Must use a valid extension."));
  815. add_child(exterr);
  816. update_filters();
  817. update_dir();
  818. set_hide_on_ok(false);
  819. vbox = vbc;
  820. invalidated = true;
  821. if (register_func) {
  822. register_func(this);
  823. }
  824. }
  825. FileDialog::~FileDialog() {
  826. if (unregister_func) {
  827. unregister_func(this);
  828. }
  829. memdelete(dir_access);
  830. }
  831. void LineEditFileChooser::_bind_methods() {
  832. ClassDB::bind_method(D_METHOD("_browse"), &LineEditFileChooser::_browse);
  833. ClassDB::bind_method(D_METHOD("_chosen"), &LineEditFileChooser::_chosen);
  834. ClassDB::bind_method(D_METHOD("get_button"), &LineEditFileChooser::get_button);
  835. ClassDB::bind_method(D_METHOD("get_line_edit"), &LineEditFileChooser::get_line_edit);
  836. ClassDB::bind_method(D_METHOD("get_file_dialog"), &LineEditFileChooser::get_file_dialog);
  837. }
  838. void LineEditFileChooser::_chosen(const String &p_text) {
  839. line_edit->set_text(p_text);
  840. line_edit->emit_signal("text_entered", p_text);
  841. }
  842. void LineEditFileChooser::_browse() {
  843. dialog->popup_centered_ratio();
  844. }
  845. LineEditFileChooser::LineEditFileChooser() {
  846. line_edit = memnew(LineEdit);
  847. add_child(line_edit);
  848. line_edit->set_h_size_flags(SIZE_EXPAND_FILL);
  849. button = memnew(Button);
  850. button->set_text(" .. ");
  851. add_child(button);
  852. button->connect("pressed", this, "_browse");
  853. dialog = memnew(FileDialog);
  854. add_child(dialog);
  855. dialog->connect("file_selected", this, "_chosen");
  856. dialog->connect("dir_selected", this, "_chosen");
  857. dialog->connect("files_selected", this, "_chosen");
  858. }