file_dialog.cpp 29 KB

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